SFWidgets.Toolbar-service

Met de service Toolbar kunt u informatie ophalen met betrekking tot de werkbalken die beschikbaar zijn voor een specifiek documentvenster. Met deze dienst is het mogelijk om:

Schakel de zichtbaarheid van specifieke werkbalken in of uit.
Krijg toegang tot informatie over de knoppen die beschikbaar zijn in elke werkbalk.

Elke LibreOffice-applicatie heeft zijn eigen set beschikbare werkbalken. Deze service verwerkt zowel ingebouwde als aangepaste werkbalken.

De statusbalk en de menubalk worden in de context van deze dienst niet als werkbalken beschouwd.

Service-aanroep

Voordat u de Toolbar-service gebruikt, moet de ScriptForge-bibliotheek worden geladen of geïmporteerd:

• Basic macro's kunnen de bibliotheek ScriptForge laden met de instructie:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Python scripts kunnen de module scriptforge importeren met:
from scriptforge import CreateScriptService

De Toolbar-service wordt aangeroepen met behulp van de Toolbars-methode, die beschikbaar is in SFDocuments.Document-service.

In BASIC

In het onderstaande voorbeeld wordt een Matrix weergegeven met de namen van de werkbalken die beschikbaar zijn in het huidige document.


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

Gebruik de methode Toolbars zonder argumenten om een matrix met beschikbare werkbalknamen op te halen.

In het onderstaande voorbeeld wordt de zichtbaarheid van de werkbalk Standaard in- en uitgeschakeld:


    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

Eigenschappen

Naam	Alleen-lezen	Type	Beschrijving
BuiltIn	Ja	Boolean	Retourneert True wanneer de werkbalk deel uitmaakt van de set standaardwerkbalken die bij LibreOffice wordt geleverd.
Docked	Ja	Boolean	Retourneert True wanneer de werkbalk actief is in het venster en is vastgezet.
HasGlobalScope	Ja	Boolean	Retourneert True wanneer de werkbalk beschikbaar is in alle documenten van hetzelfde type.
Name	Ja	String	Retourneert de naam van de werkbalk.
ResourceURL	Ja	String	Retourneert de bron-URL van de werkbalk, in de vorm privé:toolbar/toolbar_name.
Visible	Nee	Boolean	Retourneert True wanneer de werkbalk actief en zichtbaar is in het documentvenster.
XUIElement	Ja	UNO Object	Retourneert het com.sun.star.ui.XUIElement UNO-object dat de werkbalk vertegenwoordigt.

Lijst met methoden in de Toolbar-service
ToolbarButtons

ToolbarButtons

Retourneert een Matrix met de namen van alle werkbalkknoppen wanneer deze zonder argumenten wordt aangeroepen.

Geef de naam van een werkbalkknop op als argument om een service-instantie ToolbarButton te verkrijgen.

Syntaxis:

svc.ToolbarButtons(opt buttonname: str): any

Parameters:

buttonname: De naam van een werkbalkknop op de huidige werkbalk.

Voorbeeld:

Het onderstaande voorbeeld retourneert de opdracht die wordt uitgevoerd wanneer op de knop Nieuw wordt geklikt op de werkbalk Standaard:

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)

Inactieve werkbalken hebben geen knoppen. Daarom zal het aanroepen van de methode ToolbarButtons de werkbalk zichtbaar maken.

Alle ScriptForge Basic-routines of variabelen die beginnen met een underscore "_" zijn voor intern gebruik. Gebruik deze niet in een Basic of Python-macro.

SFWidgets.ToolbarButton-service