Contenido

# Servicio SFWidgets.Toolbar

The Toolbar service allows to retrieve information related to the toolbars available for a specific document window. With this service it is possible to:

- Alternar la visibilidad de barras de herramientas específicas.

- Access information about the buttons available in each toolbar.

Cada aplicación de LibreOfficeDev cuenta con su propio conjunto de barras de herramientas disponibles. Este servicio administra tanto las barras de herramientas incorporadas como las personalizadas.

The status bar and the menu bar are not considered toolbars in the context of this service.

## Invocación del servicio

Before using the Toolbar service the ScriptForge library needs to be loaded or imported:

• Para cargar la biblioteca ScriptForge que necesitan las macros de Basic se debe usar la siguiente declaración:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Los scripts de Python necesitan importar el módulo scriptforge:
from scriptforge import CreateScriptService

The Toolbar service is invoked using the Toolbars method, which is available in SFDocuments.Document service.

##### En BASIC

The example below gets an Array with the names of the toolbars available in the current document.

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

Use the Toolbars method without arguments to retrieve an array with available toolbar names.

The example below toggles the visibility of the Standard toolbar:

        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

## Propiedades

Nombre | De solo lectura | Tipo | Descripción
--- | --- | --- | ---
BuiltIn | Sí | Boolean | Returns True when the toolbar is part of the set of standard toolbars shipped with LibreOfficeDev.
Docked | Sí | Boolean | Returns True when the toolbar is active in the window and docked.
HasGlobalScope | Sí | Boolean | Returns True when the toolbar is available in all documents of the same type.
Name | Sí | String | Devuelve el nombre de la barra de herramientas.
ResourceURL | Sí | String | Returns the resource URL of the toolbar, in the form private:toolbar/toolbar_name.
Visible | No | Boolean | Returns True when the toolbar is active and visible in the document window.
XUIElement | Sí | UNO Object | Returns the com.sun.star.ui.XUIElement UNO object that represents the toolbar.

Lista de métodos en el servicio Toolbar
ToolbarButtons |  |

## ToolbarButtons

Returns an Array containing the names of all toolbar buttons when called without arguments.

Provide the name of a toolbar button as argument to obtain a ToolbarButton service instance.

### Sintaxis:

svc.ToolbarButtons(opt buttonname: str): any

### Parámetros:

buttonname: The name of a toolbar button in the current toolbar.

### Ejemplo:

The example below returns the command executed when the button New is clicked in the Standard toolbar:

##### 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)

Inactive toolbars do not have buttons. Therefore, calling the ToolbarButtons method will make the toolbar visible.

Todas las rutinas o identificadores BASIC de ScriptForge precedidas por guion bajo «_» están reservadas para uso interno. No deben utilizarse en macros BASIC o secuencias Python.

Temas relacionados

Servicio SFWidgets.ToolbarButton

¡Necesitamos su ayuda!