Storitev SFWidgets.ToolbarButton

Storitev ToolbarButton omogoča pridobivanje informacij, ki se nanašajo na gumbe orodne vrstice, ki so na voljo v dani orodni vrstici. Ta storitev omogoča:

Preklopite vidljivost elementov orodne vrstice.
Izvede ukaz, povezan z danim gumbom orodne vrstice.

Priklic storitve

Pred uporabo storitve ToolbarButton je potrebno naložiti ali uvoziti knjižnico ScriptForge:

• Za makre Basic mora biti naložena knjižnica ScriptForge z naslednjim ukazom:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Za skripte Python mora biti opravljen uvoz iz modula scriptforge:
from scriptforge import CreateScriptService

Storitev ToolbarButton prikličete z uporabo metode ToolbarButtons iz storitve Toolbar.

V Basicu

Spodnji primer pridobi imena vseh gumbov, ki so na voljo v orodni vrstici Standardno.


    oDoc = CreateScriptService("Document", ThisComponent)
    oToolbar = oDoc.Toolbars("standardbar")
    arrToolbarButtons = oToolbar.ToolbarButtons()
    MsgBox SF_String.Represent(arrToolbarButtons)

Uporabite metodo ToolbarButtons brez argumentov za pridobivanje polja z imeni vseh razpoložljivih gumbov orodnih vrstic.

Spodnji primer preklopi vidnost gumba Natisni v orodni vrstici Standardno:


    oDoc = CreateScriptService("Document", ThisComponent)
    oToolbar = oDoc.Toolbars("standardbar")
    oToolbarButton = oToolbar.ToolbarButtons("Print")
    oToolbarButton.Visible = Not oToolbarButton.Visible

Ime gumba, podano kot argument metodi ToolbarButtons, je lokalizirano ime gumba, določenega v pogovornem oknu Orodja – Prilagodi – Orodne vrstice.

Nedejavne orodne vrstice nimajo gumbov. Zato klic metode ToolbarButtons povzroči, da je orodna vrstica vidna.

V Pythonu


    bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisComponent)
    toolbar = doc.Toolbars("standardbar")
    arr_toolbar_buttons = toolbar.ToolbarButtons()
    bas.MsgBox(repr(arr_toolbar_buttons))


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

Lastnosti

Ime	Samo za branje	Vrsta	Opis
Caption	Da	String	Vrne ime gumba.
Height	Da	Long	Vrne višino gumba v slikovnih točkah.
Index	Da	Long	Vrne indeks gumba v njegovi nadrejeni orodni vrstici.
OnClick	Ne	String	Ukaz UNO ali skript, ki se izvede ob pritisku gumba. Če želite izvedeti več o določanju nizov URI, si preberite stran wiki specifikacije URI ogrodja za skriptanje (v angl.).
Parent	Da	Storitev Toolbar	Vrne instanco storitve Toolbar, ki ustreza nadrejeni orodni vrstici trenutnega gumba orodne vrstice.
TipText	Ne	String	Namig oz. besedilo pomoči, ki se prikaže, če z miško postanete nad gumbom orodne vrstice.
Visible	Ne	Boolean	Določa, ali je gumb orodne vrstice viden ali ne.
Width	Da	Long	Vrne širino gumba v slikovnih točkah.
X	Da	Long	Vrne (vodoravno) koordinato X levega vrhnjega kota gumba v slikovnih točkah.
Y	Da	Long	Vrne (navpično) koordinato Y levega vrhnjega kota gumba v slikovnih točkah.

Uporaba ToolbarButton ob storitvi PopupMenu

Pogost primer rabe zgoraj opisanih lastnosti X in Y je pri odpiranju pojavnega menija na položaju, kjer se nahaja gumb orodne vrstice.

Recimo, da ustvarite spodnji skript in ga povežete z gumbom z imenom »Moj gumb« v standardbar (vrstici Standardno). Ko ga kliknete, se prikaže pojavni meni s tremi možnostmi, med katerimi lahko uporabnik izbira.

V Basicu


    Sub OpenPopupMenu()
        GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
        oDoc = CreateScriptService("Document", ThisComponent)
        oToolbar = oDoc.Toolbars("standardbar")
        oButton = oToolbar.ToolbarButtons("Moj gumb")
        oPopup = CreateScriptService("SFWidgets.PopupMenu", , oButton.X, oButton.Y + oButton.Height)
        oPopup.AddItem("Element A", "A")
        oPopup.AddItem("Element B", "B")
        oPopup.AddItem("Element C", "C")
        strResponse = oPopup.Execute(False)
        MsgBox "Vaš izbor: " & strResponse
    End Sub

V Pythonu


    def open_popup_menu(args=None):
        bas = CreateScriptService("Basic")
        doc = CreateScriptService("Document", bas.ThisComponent)
        toolbar = doc.Toolbars("standardbar")
        toolbutton = toolbar.ToolbarButtons("Moj gumb")
        popup = CreateScriptService("PopupMenu", None, toolbutton.X, toolbutton.Y + toolbutton.Height)
        popup.AddItem("Element A", "A")
        popup.AddItem("Element B", "B")
        popup.AddItem("Element C", "C")
        response = popup.Execute(False)
        bas.MsgBox(f"Vaš izbor: {response}")

Seznam metod v storitvi ToolbarButton
Execute

Execute

Izvede ukaz ali skript, povezan z gumbom orodne vrstice.

Ta metoda vrne vrednost, ki jo vrne izvedeni ukaz ali skript.

Uporabite lastnost OnClick za določanje ukaza ali skripta, ki naj se izvrši. Če ukaz/skript ne vrne nobene vrednosti, je vrnjena vrednost Null.

Skladnja:

svc.Execute(): any

Primer:

Spodnji primer izvede gumb Natisni iz orodne vrstice Standardno:

V Basicu


      oDoc = CreateScriptService("Document", ThisComponent)
      oToolbar = oDoc.Toolbars("standardbar")
      oToolbarButton = oToolbar.ToolbarButtons("Print")
      oToolbarButton.Execute()

V Pythonu


      bas = CreateScriptService("Basic")
    doc = CreateScriptService("Document", bas.ThisComponent)
    toolbar = doc.Toolbars("standardbar")
    toolbar_button = toolbar.ToolbarButtons("Print")
    toolbar_button.Execute()

Vsi podprogrami ali identifikatorji ScriptForge Basic s predpono podčrtaja (»_«) so rezervirani za interno uporabo. Uporabi v makrih Basic ali skriptih Python niso namenjeni.

Storitev SFDocuments.Toolbar