ServiceSFWidgets.Toolbar

Le service Toolbar permet de récupérer des informations relatives aux barres d'outils disponibles pour une fenêtre de document spécifique. Avec ce service, il est possible de :

Basculez la visibilité de barres d’outils spécifiques.
Accéder aux informations sur les boutons disponibles dans chaque barre d'outils.

Chaque application Collabora Office possède son propre ensemble de barres d'outils disponibles. Ce service gère les barres d'outils intégrées et personnalisées.

La barre d'état et la barre de menu ne sont pas considérées comme des barres d'outils dans le contexte de ce service.

Invocation du service

Avant d'utiliser le service Toolbar, la bibliothèque ScriptForge doit être chargée ou importée :

• Les macros Basic nécessitent de charger la bibliothèque ScriptForge à l'aide de l'instruction suivante :
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Les scripts Python nécessitent un import depuis le module scriptforge :
from scriptforge import CreateScriptService

Le service Toolbar est appelé à l'aide de la méthode Toolbars, disponible dans le service SFDocuments.Document.

En Basic :

L'exemple ci-dessous obtient une Array avec les noms des barres d'outils disponibles dans le document actuel.


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

Utilisez la méthode Toolbars sans arguments pour récupérer un tableau avec les noms de barres d'outils disponibles.

L'exemple ci-dessous bascule la visibilité de la barre d'outils Standard :


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

En 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

Propriétés

Nom	En lecture seule	Type	Description
BuiltIn	Oui	Boolean	Renvoie True lorsque la barre d'outils fait partie de l'ensemble des barres d'outils standard fournies avec Collabora Office.
Docked	Oui	Boolean	Renvoie True lorsque la barre d'outils est active dans la fenêtre et ancrée.
HasGlobalScope	Oui	Boolean	Renvoie True lorsque la barre d'outils est disponible dans tous les documents du même type.
Name	Oui	String	Renvoie le nom de la barre d'outils.
ResourceURL	Oui	String	Renvoie l'URL de la ressource de la barre d'outils, sous la forme private:toolbar/toolbar_name.
Visible	Non	Boolean	Renvoie True lorsque la barre d'outils est active et visible dans la fenêtre du document.
XUIElement	Oui	UNO Object	Renvoie l'objet UNO com.sun.star.ui.XUIElement qui représente la barre d'outils.

Liste des méthodes dans le service Toolbar
ToolbarButtons

ToolbarButtons

Renvoie une Array contenant les noms de tous les boutons de la barre d'outils quand appelé sans arguments.

Fournissez le nom d'un bouton de la barre d'outils comme argument pour obtenir une instance de service ToolbarButton.

Syntaxe :

svc.ToolbarButtons(opt buttonname: str): any

Paramètres :

buttonname : Le nom d'un bouton de la barre d'outils dans la barre d'outils actuelle.

Exemple :

L'exemple ci-dessous renvoie la commande exécutée lorsque le bouton New est cliqué dans la barre d'outils Standard :

En Basic :


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

En Python


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

Les barres d'outils inactives n'ont pas de boutons. Par conséquent, l’appel de la méthode ToolbarButtons rendra la barre d’outils visible.

Toutes les routines ou identifiants de base ScriptForge qui sont préfixés par un caractère de soulignement "_" sont réservés à un usage interne. Ils ne sont pas destinés à être utilisés dans des macros de base ou des scripts Python.

Service SFWidgets.ToolbarButton