SFWidgets.Toolbar-tjenesten

Tjenesten Toolbar gør det muligt at hente information relateret til værktøjslinjer, som er tilgængelige for et specifikt dokumentvindue. Med denne tjeneste er det muligt at:

Skift synligheden af specifikke værktøjslinjer.
Få adgang til oplysninger om de tilgængelige knapper på hver værktøjslinje.

Hver LibreOffice-applikation har sit eget sæt af tilgængelige værktøjslinjer. Denne tjeneste håndterer både indbyggede og brugerdefinerede værktøjslinjer.

Statuslinjen og menulinjen betragtes ikke som værktøjslinjer i forbindelse med denne tjeneste.

Kald af tjeneste

Før du bruger tjenesten Toolbar, skal ScriptForge-biblioteket være indlæst eller importeret:

• Basic-makroer kræver, at biblioteket ScriptForge indlæses med følgende udtryk:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Python-scripts kræver import af scriptforge-modulet:
from scriptforge import CreateScriptService

Tjenesten Toolbar kaldes med Toolbars-metoden, som er tilgængelig i SFDocuments.Document-tjenesten.

I Basic

Eksemplet herunder modtager et Array med navnene på de værktøjslinjer, som er tilgængelige i det aktuelle dokument.


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

Brug metoden Toolbars (værktøjslinjer) uden argumenter for at hente et array med navne på de tilgængelige værktøjslinjer.

Eksemplet herunder skifter mellem synlighed eller ej af Standard-værktøjslinjen:


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

I 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

Egenskaber

Navn	Skrivebeskyttet	Type	Beskrivelse
BuiltIn	Ja	Boolean	Returnerer True når værktøjslinjen er blandt de standardværktøjslinjer, som kommer med LibreOffice.
Docked	Ja	Boolean	Returnerer True når værktøjslinjen er aktiv i vinduet og forankret.
HasGlobalScope	Ja	Boolean	Returnerer True når værktøjslinjen er tilgængelig i alle dokumenter af samme type.
Name	Ja	String	Returnerer navnet på værktøjslinjen.
ResourceURL	Ja	String	Returnerer ressource-URL'en for værktøjslinjen, på formen private:toolbar/toolbar_name (værktøjslinje/værktøjslinjenavn).
Visible	Nej	Boolean	Returnerer True når værktøjslinjen er aktiv og synlig i dokumentvinduet.
XUIElement	Ja	UNO Object	Returnerer det com.sun.star.ui.XUIElement UNO-objekt, som repræsenterer værktøjslinjen.

Liste over metoder i tjenesten Toolbar (værktøjslinje)
ToolbarButtons

ToolbarButtons

Returnerer et Array med navnene på alle værktøjslinjeknapper, når metoden kaldes uden argumenter.

Angiv navnet på en værktøjslinjeknap som argument for at få en ToolbarButton-tjenesteinstans.

Syntaks:

svc.ToolbarButtons(opt buttonname: str): any

Parametre:

buttonname: Navnet på en værktøjslinjeknap i en aktuelle værktøjslinje.

Eksempel:

Eksemplet nedenfor returnerer den kommando, som udføres når knappen Ny(t) klikkes på Standard-værktøjslinjen:

I Basic


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

I Python


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

Inaktive værktøjslinjer har ikke knapper. Derfor vil kald af ToolbarButtons-metoden gøre værktøjslinjen synlig.

Alle ScriptForge Basic-rutiner eller identifikatorer, der indledes med et understregstegn "_" er reserveret til internt brug. Det er ikke meningen, at de skal bruges i Basic-makroer eller Python-scripts.

Tjenesten SFWidgets.ToolbarButton