Servizio SFWidgets.Toolbar

Il servizio Toolbar consente di recuperare informazioni relative alle barre degli strumenti disponibili in una specifica finestra del documento. Con questo servizio è possibile:

Commutare la visibilità di specifiche barre degli strumenti.
Accedere a informazioni sui pulsanti disponibili in ciascuna barra degli strumenti.

Ogni applicazione di Collabora Office ha il suo proprio set di barre degli strumenti a disposizione. Questo servizio gestisce sia le barre degli strumenti predefinite, sia quelle personalizzate.

La barra di stato e la barra dei menu non son considerate barre degli strumenti nel contesto di questo servizio.

Invocazione del servizio

Prima di usare il servizio Toolbar è necessario caricare o importare le librerie ScriptForge:

• Le macro in Basic richiedono il caricamento della libreria ScriptForge usando la seguente istruzione:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Gli script in Python richiedono un'importazione dal modulo scriptforge:
from scriptforge import CreateScriptService

Il servizio Toolbar viene invocato usando il metodo Toolbars, che è disponibile nel servizio SFDocuments.Document.

In Basic

L'esempio sottostante recupera una matrice Array con i nomi delle barre degli strumenti disponibili nel documento corrente.


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

Usare il metodo Toolbars senza argomenti per recuperare una matrice con i nomi di tutte le barre degli strumenti disponibili.

L'esempio sottostante commuta la visibilità della barra degli strumenti Standard:


    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

Proprietà

Nome	Sola lettura	Tipo	Descrizione
BuiltIn	Sì	Boolean	Restituisce True quando la barra degli strumenti fa parte dell'insieme delle barre degli strumenti standard distribuite con Collabora Office.
Docked	Sì	Boolean	Restituisce True quando la barra degli strumenti è attiva nella finestra e ancorata.
HasGlobalScope	Sì	Boolean	Restituisce True quando la barra degli strumenti è disponibile in tutti i documenti dello stesso tipo.
Name	Sì	String	Restituisce il nome della barra degli strumenti.
ResourceURL	Sì	String	Restituisce l'URL della risorsa della barra degli strumenti, nel formato private:toolbar/toolbar_name.
Visible	No	Boolean	Restituisce True quando la barra degli strumenti è attiva e visibile nella finestra del documento.
XUIElement	Sì	UNO Object	Restituisce l'oggetto UNO com.sun.star.ui.XUIElement che rappresenta la barra degli strumenti.

Elenco dei metodi del servizio Toolbar
ToolbarButtons

ToolbarButtons

Restituisce una matrice Array contenente i nomi di tutti i pulsanti della barra degli strumenti, se chiamata senza argomenti.

Fornisce il nome di un pulsante della barra degli strumenti come argomento per ottenere un'istanza del servizio ToolbarButton.

Sintassi:

svc.ToolbarButtons(opt buttonname: str): any

Parametri:

buttonname: il nome del pulsante nella barra degli strumenti corrente.

Esempio:

L'esempio sottostante restituisce il comando eseguito quando si fa clic sul pulsante Nuovo nella barra degli strumenti Standard:

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)

Le barre degli strumenti inattive non hanno pulsanti. Perciò, chiamando il metodo ToolbarButtons si renderà visibile la barra degli strumenti.

Tutte le routine e gli identificatori Basic di ScriptForge che iniziano con un carattere di sottolineatura "_" sono riservati per uso interno. Non è previsto il loro utilizzo nelle macro in Basic o negli script in Python.

Servizio SFWidgets.ToolbarButton