Dienst SFWidgets.Toolbar

Der Dienst Toolbar ermöglicht das Abrufen von Informationen zu den Symbolleisten, die für ein bestimmtes Dokumentfenster verfügbar sind. Mit diesem Service ist es möglich:

Die Sichtbarkeit bestimmter Symbolleisten umzuschalten.
Auf Informationen zu den in den einzelnen Symbolleisten verfügbaren Schaltflächen zuzugreifen.

Jede Collabora Office-Anwendung hat einen einen eigenen Satz verfügbarer Symbolleisten. Dieser Dienst verwaltet sowohl integrierte als auch benutzerdefinierte Symbolleisten.

Die Statusleiste und die Menüleiste gelten im Kontext dieses Dienstes nicht als Symbolleisten.

Dienstaufruf

Vor der Verwendung des Dienstes Toolbar muss die Bibliothek ScriptForge geladen oder importiert werden:

• Grundlegende Makros erfordern das Laden der Bibliothek ScriptForge mit der folgenden Anweisung:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Python-Skripte erfordern einen Import aus dem Modul scriptforge:
from scriptforge import CreateScriptService

Der Dienst Toolbar wird mit der Methode Toolbars aufgerufen, die im Dienst SFDocuments.Document verfügbar ist.

In Basic

Das folgende Beispiel ruft eine Matrix mit den Namen der im aktuellen Dokument verfügbaren Symbolleisten ab.


    oDoc = CreateScriptService("Document", ThisComponent)
    arrToolbars = oDoc.Toolbars()
    MsgBox SF_String.Represent(arrToolbars)

Verwenden Sie die Methode Toolbars ohne Argumente, um eine Matrix mit verfügbaren Symbolleistennamen abzurufen.

Das folgende Beispiel schaltet die Sichtbarkeit der Symbolleiste Standard um:


    oDoc = CreateScriptService("Document", ThisComponent)
    toolbar = oDoc.Toolbars("standardbar")
    toolbar.Visible = Not toolbar.Visible

In Python


    bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisComponent)
    arr_toolbars = doc.Toolbars()
    bas.MsgBox(repr(toolbars))


    bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisComponent)
    toolbar = doc.Toolbars("standardbar")
    toolbar.Visible = not toolbar.Visible

Einstellungen

Namen	Schreibgeschützt	Typ	Beschreibung
BuiltIn	Ja	Boolean	Gibt True zurück, wenn die Symbolleiste Teil des Satzes von Standardsymbolleisten ist, die mit Collabora Office geliefert werden.
Docked	Ja	Boolean	Gibt True zurück, wenn die Symbolleiste im Fenster aktiv und angedockt ist.
HasGlobalScope	Ja	Boolean	Gibt True zurück, wenn die Symbolleiste in allen Dokumenten desselben Typs verfügbar ist.
Name	Ja	String	Gibt den Namen der Symbolleiste zurück.
ResourceURL	Ja	String	Gibt die Ressourcen-URL der Symbolleiste in der Form private:toolbar/toolbar_name zurück.
Visible	Nein	Boolean	Gibt True zurück, wenn die Symbolleiste aktiv und im Dokumentfenster sichtbar ist.
XUIElement	Ja	UNO Object	Gibt das UNO-Objekt com.sun.star.ui.XUIElement zurück, das die Symbolleiste darstellt.

Liste der Methoden im Dienst "Toolbar"
ToolbarButtons

ToolbarButtons

Gibt eine Matrix zurück, welche die Namen aller Symbolleistenschaltflächen enthält, wenn es ohne Argumente aufgerufen wird.

Geben Sie den Namen einer Symbolleistenschaltfläche als Argument an, um eine Dienstinstanz ToolbarButton zu erhalten.

Syntax:

svc.ToolbarButtons(opt buttonname: str): any

Parameter:

buttonname: Der Name einer Symbolleistenschaltfläche in der aktuellen Symbolleiste.

Beispiel:

Das folgende Beispiel gibt den Befehl zurück, der ausgeführt wird, wenn auf die Schaltfläche Neu in der Symbolleiste Standard geklickt wird:

In Basic


      oToolbar = oDoc.Toolbars("standardbar")
      oToolbarButton = oToolbar.ToolbarButtons("New")
      MsgBox oToolbarButton.OnClick

In Python


      toolbar = doc.Toolbars("standardbar")
      toolbar_button = toolbar.ToolbarButtons("New")
      bas.MsgBox(toolbar_button.OnClick)

Inaktive Symbolleisten verfügen über keine Schaltflächen. Daher wird die Symbolleiste durch den Aufruf der Methode ToolbarButtons sichtbar gemacht.

Alle ScriptForge Basic-Routinen oder Bezeichner, denen ein Unterstrich "_" vorangestellt ist, sind für den internen Gebrauch reserviert. Sie sind nicht für die Verwendung in Basic-Makros oder Python-Skripten vorgesehen.

Dienst SFWidgets.ToolbarButton