Sumário

# Serviço SFDialogs.Dialog

O serviço Dialog contribui para o gerenciamento de diálogos criados com o Editor de Diálogos Basic ou diálogos criados dinamicamente. Cada instância da classe atual representa uma única caixa de diálogo exibida ao usuário.

Uma caixa de diálogo pode ser apresentada de forma modal ou não modal.

No modo modal, a caixa de diálogo é apresentada e a execução da macro é suspensa até que o botão OK ou Cancelar sejam pressionados. Enquanto isso, ações do usuário executadas na caixa de diálogo podem disparar ações específicas.

No modo não-modal a caixa de diálogo está "flutuando" no desktop do usuário e a execução do processo da macro continua normalmente. Um diálogo não-modal é fechado quando for finalizado com o método Terminate() ou quando a sessão LibreOffice é encerrada. O botão de fechar a janela é inativo em diálogos não-modais.

Caixas de diálogo desaparecem da memória após serem explicitamente encerradas.

O serviço SFDialogs.Dialog está intimamente relacionado ao serviço SFDialogs.DialogControl.

## Invocação e Uso do Serviço

Antes de utilizar o serviço Dialog, a biblioteca ScriptForge deve ser carregada ou importada:

• Macros BASIC precisam carregar a biblioteca ScriptForge usando a seguinte instrução:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Scripts Python exigem uma importação do módulo scriptforge:
from scriptforge import CreateScriptService

O serviço Dialog é invocado através do método CreateScriptService. São necessários três argumentos posicionais suplementares para especificar a caixa de diálogo a ser ativada:

Container: "GlobalScope" para bibliotecas pré-instalados o um nome de janela definido pelo serviço ScriptForge.UI. O valor padrão é uma String vazia "", o que indica o documento atual.

Library: Nome da biblioteca contida no "Container" como uma string sensível à caixa. O valor padrão é "Standard".

DialogName: String sensível à caixa designando a caixa de diálogo.

Os exemplos abaixo em Basic e Python mostram o diálogo dlgConsole que pertence à biblioteca compartilhada ScriptForge:

          Dim oDlg As Object, lButton As Long
          Dim Container As String, Library As String, DialogName As String
          Set oDlg = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "ScriptForge", "dlgConsole")
          '... Inicialização dos controles vêm aqui...
          lButton = oDlg.Execute()
          'Modo padrão = Modal
          If lButton = oDlg.OKBUTTON Then
          '...Processa os controles e faz o que é necessário aqui
          End If
          oDlg.Terminate()

Ou usando Python:

        dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
        # ... Inicialização dos controles vem aqui...
        rc = dlg.Execute()
        # Modo padrão = Modal
        if rc == dlg.OKBUTTON:
            # ...Processa os controles e faz o que é necessário aqui
        dlg.Terminate()

Use a string "GlobalScope" como o argumento container quando a caixa de diálogo estiver armazenada em Minhas macros e caixas de diálogo ou em Macros e diálogos da aplicação.

O serviço Dialog oferece métodos que criam novos controles dinamicamente em um diálogo existente predefinido com o Editor de Diálogos. Um diálogo é inicializado com controles no editor de diálogos e novos controles podem ser adicionados em tempo de execução antes ou depois da instrução Execute() do diálogo.

O serviço Dialog também pode ser invocado através do método CreateScriptService ao criar diálogos dinamicamente. Isso requer dois argumentos posicionais suplementares após o nome do serviço ad-hoc "NewDialog":

DialogName: String sensível à caixa designando a caixa de diálogo.

Place: A localização da janela da caixa de diálogo, podendo ser:

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

        Sub newDialog()
            Dim oDlg As Object
           oDlg = CreateScriptService("NewDialog", "myDialog1", Array(100,200, 40, 110))
           ' ...
        End Sub

Ou usando Python:

        def newDialog():
           dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))
           # ... Processa os controles e faz o que for necessário

Todas as propriedades e métodos aplicáveis às caixas de diálogo predefinidas estão disponíveis para essas novas caixas de diálogo. Em particular a série de métodos CreateXXX() para adicionar novos controles à caixa de diálogo.

## Recuperando a instância Dialog que disparou um evento de diálogo

Uma instância do serviço Dialog pode ser obtida usando o serviço SFDialogs.DialogEvent, desde que o diálogo tenha sido inicializado usando o serviço Dialog. No exemplo abaixo, oDlg contém a instância Dialog que disparou o evento de diálogo.

        Sub aDialogEventHander(ByRef poEvent As Object)
            Dim oDlg As Object
            Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
            ' ...
        End Sub

Ou usando Python:

        def control_event_handler(event: uno):
            dlg = CreateScriptService("SFDialogs.DialogEvent", event)
            # ...

Note que nos exemplos anteriores o prefixo "SFDialogs." pode ser omitido quando for considerado apropriado.

### Lidando com exceções em manipuladores de eventos

Ao criar um manipulador de evento para eventos de diálogo, considera-se boa prática tratar erros dentro da própria sub rotina. Por exemplo, suponha que o manipulador de eventos abaixo seja chamado quando o botão do mouse é pressionado na janela da caixa de diálogo.

        Sub OnMouseButtonPressed(ByRef oEvent As Object)
        On Local Error GoTo Catch
            Dim oDialog As Object
            oDialog = CreateScriptService("DialogEvent", oEvent)
            ' Processa o evento
            Exit Sub
        Catch:
            MsgBox SF_Exception.Description
            SF_Exception.Clear
        End Sub

Chame SF_Exception.Clear se você não quiser que o erro seja propagado após o término da execução do diálogo.

Em Python use blocos try/except nativos para tratar exceções conforme mostrado abaixo:

        def on_mouse_button_pressed(event=None):
            try:
                dlg = CreateScriptService("DialogEvent", event)
                # Processa o evento
            except Exception as e:
                # O objeto "bas" é uma instância do serviço Basic
                bas.MsgBox(str(e))

## Propriedades

Nome | Somente leitura | Tipo | Descrição
--- | --- | --- | ---
OKBUTTON | Sim | Integer | Valor = 1. Um botão OK foi pressionado.
CANCELBUTTON | Sim | Integer | Valor = 0. Um botão Cancelar foi pressionado.
Caption | Não | String | Especifica o título da caixa de diálogo.
Height | Não | Long | Especifica a altura da caixa de diálogo.
Modal | Sim | Boolean | Especifica se a caixa de diálogo está em execução no formato "modal".
Name | Sim | String | Nome da caixa de diálogo
Page | Não | Integer | Uma caixa de diálogo pode ter várias páginas que podem ser percorridas pelo usuário uma a uma. A propriedade "Page" do objeto "Dialog" define qual página está ativa no diálogo.
Visible | Não | Boolean | Especifica se a caixa de diálogo está visível na área de trabalho. Por padrão, ela não é visível até que o método "Execute" seja invocado. Após isso, a caixa de diálogo passa a ser visível.
XDialogModel | Sim | Objeto UNO | Objeto UNO representando o modelo do diálogo. Consulte XControlModel e UnoControlDialogModel na documentação da API para mais detalhes.
XDialogView | Sim | Objeto UNO | Objeto UNO representando a visualização do diálogo. Consulte XControl e UnoControlDialog na documentação da API para mais detalhes.
Width | Não | Long | Especifica a largura da caixa de diálogo.

## Propriedades de Evento

As propriedades do evento On… são strings URI que referenciam um script disparado para um evento. Consulte a sua especificação no framework de URI para scripts,.

Nome | Descrição da IDE Basic
--- | ---
OnFocusGained | Quando receber o foco
OnFocusLost | Quando perder o foco
OnKeyPressed | Tecla pressionada
OnKeyReleased | Ao soltar uma tecla
OnMouseDragged | Quando mover o mouse com tecla pressionada
OnMouseEntered | Quando o mouse estiver dentro
OnMouseExited | Quando o mouse estiver fora
OnMouseMoved | Ao mover o mouse
OnMousePressed | Ao pressionar o botão do mouse
OnMouseReleased | Ao soltar o botão do mouse

Dica: Todas as propriedades On… podem ser definidas programaticamente.
O exemplo Como exibir dados em um controle de árvore no Wiki LibreOffice demonstra isso.

Atribuir eventos com a IDE do Basic e atribuir eventos por meio de macros são mutuamente exclusivas.

Lista de métodos do serviço Dialog
Activate Center Controls CloneControl CreateButton CreateCheckBox CreateComboBox CreateCurrencyField CreateDateField CreateFileControl CreateFixedLine CreateFixedText | CreateFormattedField CreateGroupBox CreateHyperlink CreateImageControl CreateListBox CreateNumericField CreatePatternField CreateProgressBar CreateRadioButton CreateScrollBar CreateTableControl CreateTabPageContainer | CreateTextField CreateTimeField CreateTreeControl EndExecute Execute GetTextsFromL10N ImportControl OrderTabs Resize SetPageManager Terminate

Os controles TabPageContainer não estão disponíveis no Editor de Diálogos.

O dimensionamento de uma caixa de diálogo é feito usando unidades Map AppFont. Um modelo de diálogo ou controle também usa unidades AppFont, embora suas visualizações usem pixels.

## Activate

Coloca o foco na instância Dialog atual. Retorna True se a focalização foi bem-sucedida.

Este método é chamado a partir de uma caixa de diálogo ou evento de controle, o quando um diálogo é apresentado no modo "não modal".

### Sintaxe:

svc.Activate(): bool

### Exemplo:

          Dim oDlg As Object
          Set oDlg = CreateScriptService(,, "myDialog")
          oDlg.Execute()
          ' ...
          oDlg.Activate()

Exemplos em LibreOffice Basic e Python assume que o diálogo é armazenado na biblioteca Standard do documento corrente.

         dlg = CreateScriptService(,,'myDialog')
         dlg.Execute()
         # ...
         dlg.Activate()

## Center

Centraliza a caixa de diálogo atual no centro de sua janela pai. Sem argumentos, o método centraliza a caixa de diálogo no meio da janela atual.

Retorna True se bem-sucedida.

### Sintaxe:

svc.Center(opt Parent: obj): bool

### Parâmetros:

Parent: Um objeto opcional que pode ser …

- um objeto de diálogo do tipo Dialog do ScriptForge

- um objeto ScriptForge com referência a um documento (Calc, Base, etc)

### Exemplo:

##### Em Basic

         Sub TriggerEvent(oEvent As Object)
             Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
             Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Caixa de diálogo que causou o evento
             Set oDialog2 = CreateScriptService("Dialog", ...) ' Abre uma segunda caixa de diálogo
             oDialog2.Center(oDialog1)
             lExec = oDialog2.Execute()
             Select Case lExec
                 ...
         End Sub

##### Em Python

         def triggerEvent(event: uno):
           dlg1 = CreateScriptService('DialogEvent.Dialog', event) # Caixa de diálogo que disparou o evento
           dlg2 = CreateScriptService('Dialog', ...) # Abre uma segunda caixa de diálogo
           dlg2.Center(dlg1)
           rc = dlg2.Execute()
           if rc is False:
             # ...

## CloneControl

Duplica um controle existente de qualquer tipo na caixa de diálogo. O controle duplicado permanece inalterado e pode ser realocado.

### Sintaxe:

svc.CloneControl(SourceName: str, ControlName: str, Left: num, Top: num): svc

### Parâmetros:

SourceName: nome do controle a ser duplicado.

ControlName: um nome de controle válido como uma string sensível à caixa. O controle não pode existir previamente.

Left, Top: as coordenadas do novo controle expressas na unidade Map AppFont.

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

          Set myButton2 = oDlg.CloneControl("Button1", "Button2", 30, 30)

##### Em Python

         dlg = dlg.CloneControl('Button1', 'Button2', 30, 30)

## Controls

Retorna:

- a lista dos controles contidos na caixa de diálogo

- Uma instância da classe DialogControl baseada em seu nome

### Sintaxe:

svc.Controls(): str[0..*]

svc.Controls(controlname: str): svc

### Parâmetros:

ControlName : String sensível à caixa com o nome válido de um controle. Se não for especificado, a lista de nomes de controles é retornada em um Array indexado em zero.

### Exemplo:

          Dim myDialog As Object, myList As Variant, myControl As Object
          Set myDialog = CreateScriptService("SFDialogs.Dialog", , "Standard", "Dialog1")
          myList = myDialog.Controls()
          Set myControl = myDialog.Controls("myTextBox")

         dlg = CreateScriptService('SFDialogs.Dialog','', 'Standard', 'Dialog1')
         ctrls = dlg.Controls()
         ctrl = dlg.Controls('myTextBox')

## CreateButton

Cria um novo controle do tipo Button na caixa de diálogo atual.

### Sintaxe:

svc.CreateButton(ControlName: str, Place: any, Toggle: bool = False, Push: str = ""): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Toggle: quando definido como True um botão de alternância é criado. O padrão é False

Push: "OK", "CANCEL" ou "" (padrão)

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myButton = oDlg.CreateButton("Button1", Array(20, 20, 60, 15))

##### Em Python

         myButton = dlg.CreateButton('Button1', (20, 20, 60, 15))

## CreateCheckBox

Cria um novo controle do tipo CheckBox na caixa de diálogo atual.

### Sintaxe:

svc.CreateCheckBox(ControlName: str, Place: any, Multiline: bool = False): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Multiline: Quando True (padrão = False), a legenda pode ser exibida em mais de uma linha.

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myCheckBox = oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15), MultiLine := True)

##### Em Python

         myCheckBox = dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15), MultiLine = True)

## CreateComboBox

Cria um novo controle do tipo ComboBox na caixa de diálogo atual.

### Sintaxe:

svc.CreateComboBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

DropDown: Quando True (padrão), um botão suspenso é exibido

LineCount: especifica a quantidade máxima de linhas exibida no menu suspenso (padrão = 5)

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myComboBox = oDlg.CreateComboBox("ComboBox1", Array(20, 20, 60, 15), Dropdown := True)

##### Em Python

         myComboBox = dlg.CreateComboBox('ComboBox1', (20, 20, 60, 15), Dropdown = True)

## CreateCurrencyField

Cria um novo controle do tipo CurrencyField na caixa de diálogo atual.

### Sintaxe:

svc.CreateCurrencyField(ControlName: str, Place: any, Border ="3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000, Increment: num = 1, Accuracy: num = 2): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

SpinButton: quando True (padrão = False), um botão giratório é mostrado

MinValue: o menor valor que pode ser inserido no controle. O padrão é -1000000

MaxValue: o maior valor que pode ser inserido no controle. O padrão é +1000000

Increment: o passo quando o botão giratório é pressionado. O valor padrão = 1

Accuracy: especifica a precisão decimal. Padrão = 2 dígitos decimais

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myCurrencyField = oDlg.CreateCurrencyField("CurrencyField1", Array(20, 20, 60, 15), SpinButton := True)

##### Em Python

         myCurrencyField = dlg.CreateCurrencyField('CurrencyField1', (20, 20, 60, 15), SpinButton = True)

## CreateDateField

Cria um novo controle do tipo DateField na caixa de diálogo atual.

### Sintaxe:

svc.CreateDateField(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = False, opt MinDate: datetime, opt MaxDate: datetime): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

DropDown: quando True (Padrão = False), um botão suspenso é mostrado

MinDate: a menor data que pode ser inserida no controle. O padrão é 1900-01-01

MaxDate: a maior data que pode ser inserida no controle. O padrão é 2200-12-31

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myDateField = oDlg.CreateDateField("DateField1", Array(20, 20, 60, 15), Dropdown := True)

##### Em Python

         myDateField = dlg.CreateDateField('DateField1', (20, 20, 60, 15), Dropdown = True)

## CreateFileControl

Cria um novo controle do tipo FileControl na caixa de diálogo atual.

### Sintaxe:

svc.CreateFileControl(ControlName: str, Place: any, Border: str = "3D"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myFileControl = oDlg.CreateFileControl("FileControl1", Array(20, 20, 60, 15))

##### Em Python

         myFileControl = dlg.CreateFileControl('FileControl1', (20, 20, 60, 15))

## CreateFixedLine

Cria um novo controle do tipo FixedLine na caixa de diálogo atual.

### Sintaxe:

svc.CreateFixedLine(ControlName: str, Place: any, Orientation: str): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Orientation: para orientação horizontal, use "H" ou "Horizontal"; para orientação vertical, use "V" ou "Vertical".

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myFixedLine = oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60, 15), Orientation := "vertical")

##### Em Python

         myFixedLine = dlg.CreateFixedLine('FixedLine1', (20, 20, 60, 15), Orientation = 'vertical')

## CreateFixedText

Cria um novo controle do tipo FixedText na caixa de diálogo atual.

### Sintaxe:

svc.CreateFixedText(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "NONE" (padrão), "FLAT" ou "3D"

Multiline: Quando True (padrão = False), a legenda pode ser exibida em mais de uma linha

Align: alinhamento horizontal, "LEFT" (padrão), "CENTER" ou "RIGHT"

VerticalAlign: alinhamento vertical, "TOP" (padrão), "MIDDLE" ou "BOTTOM"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myFixedText = oDlg.CreateFixedText("FixedText1", Array(20, 20, 60, 15), MultiLine := True)

##### Em Python

         myFixedText = dlg.CreateFixedText('FixedText1', (20, 20, 60, 15), MultiLine = True)

## CreateFormattedField

Cria um novo controle do tipo FormattedField na caixa de diálogo atual.

### Sintaxe:

svc.CreateFormattedField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

SpinButton: quando True (padrão = False), um botão giratório é mostrado

MinValue: o menor valor que pode ser inserido no controle. O padrão é -1000000

MaxValue: o maior valor que pode ser inserido no controle. O padrão é +1000000

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myFormattedField = oDlg.CreateFormattedField("FormattedField1", Array(20, 20, 60, 15), SpinButton := True)

##### Em Python

         myFormattedField = dlg.CreateFormattedField('FormattedField1', (20, 20, 60, 15), SpinButton = True)

## CreateGroupBox

Cria um novo controle do tipo GroupBox na caixa de diálogo atual.

### Sintaxe:

svc.CreateGroupBox(ControlName: str, Place: any): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myGroupBox = oDlg.CreateGroupBox("GroupBox1", Array(20, 20, 60, 15))

##### Em Python

         myGroupBox = dlg.CreateGroupBox('GroupBox1', (20, 20, 60, 15))

## CreateHyperlink

Cria um novo controle do tipo Hyperlink na caixa de diálogo atual.

### Sintaxe:

svc.CreateHyperlink(ControlName: str, Place: any, Border: str = "NONE", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "NONE" (padrão), "FLAT" ou "3D"

Multiline: Quando True (padrão = False), a legenda pode ser exibida em mais de uma linha

Align: alinhamento horizontal, "LEFT" (padrão), "CENTER" ou "RIGHT"

VerticalAlign: alinhamento vertical, "TOP" (padrão), "MIDDLE" ou "BOTTOM"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myHyperlink = oDlg.CreateHyperlink("Hyperlink1", Array(20, 20, 60, 15), MultiLine := True)

##### Em Python

         myHyperlink = dlg.CreateHyperlink('Hyperlink1', (20, 20, 60, 15), MultiLine = True)

## CreateImageControl

Cria um novo controle do tipo ImageControl na caixa de diálogo atual.

### Sintaxe:

svc.CreateImageControl(ControlName: str, Place: any, Border: str = "3D", Scale: str = "FITTOSIZE"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

Scale: Um dos seguintes valores: "FITTOSIZE" (padrão), "KEEPRATIO" ou "NO"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myImageControl = oDlg.CreateImageControl("ImageControl1", Array(20, 20, 60, 15))

##### Em Python

           myImageControl = dlg.CreateImageControl('ImageControl1", (20, 20, 60, 15))

## CreateListBox

Cria um novo controle do tipo ListBox na caixa de diálogo atual.

### Sintaxe:

svc.CreateListBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5, MultiSelect: bool = False): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

DropDown: Quando True (padrão), um botão suspenso é exibido

LineCount: especifica a quantidade máxima de linhas exibida no menu suspenso (padrão = 5)

MultiSelect: Quando True, mais de uma entrada pode ser selecionada. O padrão é False

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myListBox = oDlg.CreateListBox("ListBox1", Array(20, 20, 60, 15), Dropdown := True, MultiSelect := True)

##### Em Python

         myListBox = dlg.CreateListBox('ListBox1', (20, 20, 60, 15), Dropdown = True, MultiSelect = True)

## CreateNumericField

Cria um novo controle do tipo NumericField na caixa de diálogo atual.

### Sintaxe:

svc.CreateNumericField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = 1000000, Increment: num = 1, Accuracy: num = 2): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

SpinButton: quando True (padrão = False), um botão giratório é mostrado

MinValue: o menor valor que pode ser inserido no controle. O padrão é -1000000

MaxValue: o maior valor que pode ser inserido no controle. O padrão é +1000000

Increment: o passo quando o botão giratório é pressionado. O valor padrão = 1

Accuracy: especifica a precisão decimal. Padrão = 2 dígitos decimais

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myNumericField = oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15), SpinButton := True)

##### Em Python

         myNumericField = dlg.CreateNumericField('NumericField1', (20, 20, 60, 15), SpinButton = True)

## CreatePatternField

Cria um novo controle do tipo PatternField na caixa de diálogo atual.

### Sintaxe:

svc.CreatePatternField(ControlName: str, Place: any, Border: str = "3D", EditMask: str, opt LiteralMax: str): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

EditMask: um código de caracteres que determina o que o usuário pode inserir.
Leia a página Wiki Pattern_Field para maiores informações.

LiteralMask: contém os valores iniciais que são exibidos no campo

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myPatternField = oDlg.CreatePatternField("PatternField1", Array(20, 20, 60, 15), EditMask := "NNLNNLLLLL", LiteralMask := "__.__.2002")

##### Em Python

         myPatternField = dlg.CreatePatternField('PatternField1', (20, 20, 60, 15), EditMask = 'NNLNNLLLLL', LiteralMask = '__.__.2002')

## CreateProgressBar

Cria um novo controle do tipo ProgressBar na caixa de diálogo atual.

### Sintaxe:

svc.CreateProgressBar(ControlName: str, opt Place: any, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

MinValue: o menor valor que pode ser inserido no controle. O padrão = 0

MaxValue: o maior valor que pode ser inserido no controle. O padrão = 100

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myProgressBar = oDlg.CreateProgressBar("ProgressBar1", Array(20, 20, 60, 15), MaxValue := 1000)

##### Em Python

         myProgressBar = dlg.CreateProgressBar('ProgressBar1', (20, 20, 60, 15), MaxValue = 1000)

## CreateRadioButton

Cria um novo controle do tipo RadioButton na caixa de diálogo atual.

### Sintaxe:

svc.CreateRadioButton(ControlName: str, Place: any, MultiLine: bool = False): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Multiline: Quando True (padrão = False), a legenda pode ser exibida em mais de uma linha

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myRadioButton = oDlg.CreateRadioButton("RadioButton1", Array(20, 20, 60, 15), MultiLine := True)

##### Em Python

         myRadioButton = dlg.CreateRadioButton('RadioButton1', (20, 20, 60, 15), MultiLine = True)

## CreateScrollBar

Cria um novo controle do tipo ScrollBar na caixa de diálogo atual.

### Sintaxe:

svc.CreateScrollBar(ControlName: str, Place, Orientation: str, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Orientation: para orientação horizontal, use "H" ou "Horizontal"; para orientação vertical, use "V" ou "Vertical".

Border: "3D" (padrão), "FLAT" ou "NONE"

MinValue: o menor valor que pode ser inserido no controle. O padrão = 0

MaxValue: o maior valor que pode ser inserido no controle. O padrão = 100

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myScrollBar = oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60, 15), MaxValue := 1000)

##### Em Python

         myScrollBar = dialog.CreateScrollBar('ScrollBar1', (20, 20, 60, 15), MaxValue = 1000)

## CreateTableControl

Cria um novo controle do tipo TableControl na caixa de diálogo atual.

### Sintaxe:

svc.CreateTableControl(ControlName: str, Place: any, Border: str = "3D", RowHeaders: bool = True, ColumnHeaders: bool = True, ScrollBars: str = "N", GridLines: bool = False): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

RowHeaders: quando True (padrão), os cabeçalhos das linhas são mostrados

ColumnHeaders: quando True (padrão), os cabeçalhos da coluna são mostrados

ScrollBars: os valores possíveis são: "H" ou "Horizontal" (barras de rolagem horizontais), "V" ou "Vertical" (barras de rolagem verticais); "B" ou "Both" (ambas as barras de rolagem); "N" ou "None" (padrão) para nenhuma barra de rolagem. As barras de rolagem aparecem dinamicamente quando são necessárias.

GridLines: quando True (Padrão = False) linhas horizontais e verticais são colocadas entre as células da grade

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myTableControl = oDlg.CreateTableControl("TableControl1", Array(20, 20, 60, 15), ScrollBars := "B")

##### Em Python

         myTableControl = dlg.CreateTableControl('TableControl1', (20, 20, 60, 15), ScrollBars = 'B')

## CreateTabPageContainer

Cria um novo controle do tipo TabPageContainer na caixa de diálogo atual. As guias são distribuídas em linhas separadas dentro da caixa de diálogo, quando necessário. Não são suportados vários TabPageContainer.

A criação do controle TagePageContainer ocorre sempre por último na criação de uma caixa de diálogo.

### Sintaxe:

svc.CreateTabPageContainer(ControlName: str, Place: any, TabHeaders: str[1..*], Border: str = "3D"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

TabHeaders: Uma matriz de cadeias de caracteres que define cada rótulo individual para as guias

Borda: "3D" (padrão), "PLANA" ou "NENHUMA"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myTabPageContainer = oDlg.CreateTabPageContainer("someContainer", Array(20, 20, 60, 15), TabHeaders := Array("Modules", "Dialogs", "Libraries"))

##### Em Python

         myTabPageContainer = dlg.CreateTabPageContainer('theTabs', TabHeaders=('Modules', 'Dialogs', 'Libraries'), place=(20, 20, 60, 15))

## CreateTextField

Cria um novo controle do tipo TextField na caixa de diálogo atual.

### Sintaxe:

svc.CreateTextField(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, MaximumLength: num = 0, PasswordCharacter: str = ""): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

Multiline: Quando True (padrão = False), a legenda pode ser exibida em mais de uma linha

MaximumLength: a quantidade máxima de caracteres (o padrão é 0, o que significa uma quantidade ilimitada de caracteres).

PasswordCharacter: um único caractere especificando o eco para um campo de texto de senha (padrão = "")

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

    Set myTextField = oDlg.CreateTextField("TextField1", Array(20, 20, 120, 50), MultiLine := True)

##### Em Python

         myTextField = dlg.CreateTextField('TextField1', (20, 20, 120, 50), MultiLine = True)

## CreateTimeField

Cria um novo controle do tipo TimeField na caixa de diálogo atual.

### Sintaxe:

svc.CreateTimeField(ControlName: str, Place: any, Border: str = "3D", MinTime: num = 0, MaxTime: num = 24): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

MinTime: o menor tempo que pode ser inserido no controle. O padrão = 0

MaxTime: o maior tempo que pode ser inserido no controle. O padrão é=24h

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myTimeField = oDlg.CreateTimeField("TimeField1", Array(20, 20, 60, 15))

##### Em Python

         myTimeField = dlog.CreateTimeField('TimeField1', (20, 20, 60, 15))

## CreateTreeControl

Cria um novo controle do tipo TreeControl na caixa de diálogo atual.

### Sintaxe:

svc.CreateTreeControl(ControlName: str, Place: any, Border = "3D"): svc

### Parâmetros:

ControlName: o nome do novo controle. Este nome não pode existir previamente.

Place: Pode ser …

- um Array do Basic ou uma tupla do Python com 4 elementos: (X, Y, largura, altura)

- um objeto com.sun.star.awt.Rectangle [X, Y, Largura, Altura]

Todos os elementos são expressos em unidades Map AppFont.

Border: "3D" (padrão), "FLAT" ou "NONE"

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set myTreeControl = oDlg.CreateTreeControl("TreeControl1", Array(20, 20, 60, 15))

##### Em Python

         myTreeControl = dlg.CreateTreeControl('TreeControl1', (20, 20, 60, 15))

## EndExecute

Finaliza a apresentação de um diálogo modal e retorna o argumento como valor de retorno da ação Execute() atual.

EndExecute() está geralmente contido no processamento da macro disparada por uma caixa de diálogo ou evento de controle.

### Sintaxe:

svc.EndExecute(returnvalue: int)

### Parâmetros:

returnvalue: Valor passado para o método Execute() em execução.

### Exemplo:

##### Em Basic

          Sub OnEvent(poEvent As com.sun.star.lang.EventObject)
              Dim oDlg As Object
              Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
              oDlg.EndExecute(ReturnValue := 25)
          End Sub

##### Em Python

         from com.sun.star.lang import EventObject
         def on_event(event: EventObject):
             dlg = CreateScriptService("SFDialogs.DialogEvent", event)
             dlg.EndExecute(25)

As menções acima a com.sun.star.lang.EventObject são opcionais. Tais menções ajudam a identificar a API (Application Programming Interface) do LibreOffice.

## Execute

Mostra a caixa de diálogo, quando modal, e espera for sua finalização pelo usuário. O valor retornado é:

- 0 : Botão Cancelar pressionado

- 1 : Botão OK pressionado

- Caso contrário a caixa de diálogo foi finalizada com o comando EndExecute() lançado pelo diálogo ou um evento de controle

Para caixas de diálogo não modais o método sempre retorna 0 e a execução da macro continua.

### Sintaxe:

svc.Execute(modal: bool = True): int

### Parâmetros:

modal: É False quando a caixa de diálogo for não modal. Padrão = True.

### Exemplo:

Neste exemplo em Basic myDialog é armazenado na biblioteca Standard do documento corrente.

          Dim oDlg As Object, lReturn As Long
          Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")
          lReturn = oDlg.Execute(Modal := False)
          Select Case lReturn
              ' ...
          End Select

Este código em Python mostra o diálogo modal DlgConvert da biblioteca Basic compartilhada Euro.

         dlg = CreateScriptService("SFDialogs.Dialog", 'GlobalScope', 'Euro', "DlgConvert")
         rc = dlg.Execute()
         if rc == dlg.CANCELBUTTON:
             # ...

## GetTextsFromL10N

Substitui todas as strings de texto fixas em uma caixa de diálogo por suas versões traduzidas com base em uma instância de serviço L10N. Este método traduz as seguintes strings:

- O título da caixa de diálogo.

- Os rótulos dos seguintes tipos de controle: botão, caixa de seleção, linha fixa, texto fixo, caixa de grupo e botão de rádio.

- Strings estáticas em caixas de listas (ListBoxes) e caixas de combinação (ComboBoxes).

- A dica de ferramenta ou texto de ajuda exibido ao passar o mouse sobre o controle.

O método retorna True se for bem-sucedido.

Para criar uma lista de textos a traduzir numa caixa de diálogo, utilize o método AddTextsFromDialog do serviço L10N.

### Sintaxe:

svc.GetTextsFromL10N(l10n: svc): bool

### Parâmetros:

l10n: uma instância do serviço L10N do qual serão extraídas as strings a traduzir.

### Exemplo:

O exemplo a seguir carrega strings traduzidas e as aplica à caixa de diálogo "MyDialog".

##### Em Basic

         oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
         myPO = CreateScriptService("L10N", "/home/user/po_files/")
         oDlg.GetTextsFromL10N(myPO)
         oDlg.Execute()

##### Em Python

         dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
         myPO = CreateScriptService("L10N", "/home/user/po_files/")
         dlg.GetTextsFromL10N(myPO)
         dlg.Execute()

Acesse as páginas de ajuda do serviço L10N para saber mais sobre como os arquivos PO e POT são tratados.

## ImportControl

Importe e duplique um controle existente de qualquer tipo de uma caixa de diálogo para a caixa de diálogo atual. O controle duplicado permanece inalterado. O novo controle pode ser renomeado e reposicionado. Os manipuladores de eventos, quando presentes, também podem ser importados.

### Sintaxe:

svc.ImportControl(SourceDialog: svc, SourceName: str, opt ControlName: str, Page: num = 0, OffsetX: num = 0, OffsetY:num = 0, IncludeOnProperties: bool = False): svc

### Parâmetros:

SourceDialog: uma instância da classe SFDialogs.Dialog.

SourceName: o nome do controle a importar.

ControlName: o nome do novo controle. Não deve existir ainda. O padrão é SourceName

Página: o número da página do novo controle. Padrão = 0

OffsetX, OffsetY: o número de pixels a adicionar às coordenadas de controle de origem em unidades "Map AppFont". Padrão = 0, pode ser negativo.

IncludeOnProperties: inclui as propriedades do evento On.... Padrão = Falso.

### Tipo de retorno:

Uma instância do serviço SFDialogs.DialogControl ou Nothing.

### Exemplo:

##### Em Basic

         Set mCtrl = oDlg.ImportControl(srceDlg, "someCtrlName")

##### Em Python

         dlg.ImportControl(srceDlg, 'aCtrlName', includeOnProperties=true)

## OrderTabs

Define o índice de tabulação de uma série de controles. A sequência de controles é fornecida como uma lista de nomes de controles, do primeiro ao último.

Controles com índice >= 1 não são acessíveis com a tecla TAB se:
- forem omitidos da lista fornecida
- seu tipo for FixedLine, GroupBox ou ProgressBar
- estiverem desabilitados

### Sintaxe:

svc.TabsList(TabsList: num, Start: num = 1, Increment: num = 1): bool

### Parâmetros:

TabsList: uma lista de nomes de controle válidos na ordem de tabulação

Start: o índice da guia a ser atribuído ao primeiro controle da lista. O padrão = 1

Increment: a diferença entre dois índices de tabulação sucessivos. O padrão = 1

### Tipo de retorno:

Retorna True quando bem-sucedido.

### Exemplo:

##### Em Basic

         oDlg.OrderTabs(Array("myListBox", "myTextField", "myNumericField"), Start := 10)

##### Em Python

         dlg.OrderTabs(('myListBox', 'myTextField', 'myNumericField'), Start = 10)

## Resize

Move o canto superior esquerdo de uma caixa de diálogo para novas coordenadas e/ou modifica suas dimensões. Todas as distâncias são expressas em unidades AppFont. Sem argumentos, o método redefine as dimensões iniciais. Retorna True se o redimensionamento foi bem-sucedido.

### Sintaxe:

svc.Resize(opt Left: num, opt Top: num, opt Width: num, opt Height: num): bool

### Parâmetros:

Left: Distância horizontal do canto superior esquerdo

Top: Distância vertical do canto superior esquerdo

Width: Largura do retângulo que contém a caixa de diálogo

Height: Altura do retângulo que contém a caixa de diálogo

Os argumentos ausentes permanecem inalterados

### Exemplo:

##### Em Basic

         oDlg.Resize(1000, 2000, Height := 6000) ' A largura não é modificada

##### Em Python

         dlg.Resize(1000, 2000, Height = 6000)  # A largura não é modificada

## SetPageManager

Define quais controles em um diálogo são responsáveis por mudar de página, tornando mais fácil gerenciar a propriedade Page da caixa de diálogo e de seus controles.

Caixas de diálogo podem ter múltiplas páginas e a página visível é definida pela propriedade Page do diálogo. Se a propriedade Page não for modificada, a página visível padrão é igual a 0 (zero), o que significa que nenhuma página em particular está definida e todos os controles visíveis são mostrados independentemente de seus próprios valores da propriedade Page.

Quando a propriedade Page de um diálogo é modificada para um valor como 1, 2, 3 e assim por diante, então apenas os controles cujo valor Page forem iguais ao valor de página do diálogo serão mostrados.

Ao usar o método SetPageManager é possível definir quatro tipos de gerenciadores de página:

- Caixa de listagem ou caixa de combinação: neste caso, cada entrada na caixa de listagem ou caixa de combinação corresponde a uma página. O primeiro item refere-se à página 1, o segundo item refere-se à página 2 e assim por diante.

- Grupo de botões de opção: define um grupo de botões de opção que controlará qual página está visível.

- Sequence of buttons: define um conjunto de botões, cada um correspondendo a uma página de diálogo. Pode ser usado para emular uma interface com abas, colocando os botões lado a lado na caixa de diálogo.

- Botões Anterior/Próximo: define quais botões na caixa de diálogo serão usados para navegar para a página Anterior/Próxima na caixa de diálogo.

É possível usar mais de um mecanismo de gerenciamento de página ao mesmo tempo.

Este método deve ser chamado apenas uma vez antes de chamar o método Execute. As chamadas subsequentes são ignoradas.

Se for bem sucedido, este método retorna True.

### Sintaxe:

svc.SetPageManager(pilotcontrols: str = "", tabcontrols: str = "", wizardcontrols: str = "", opt lastpage: int): bool

### Parâmetros:

pilotcontrols: uma lista separada por vírgulas de nomes de controle ListBox, ComboBox ou RadioButton usados como gerenciadores de página. Para controles RadioButton, especifique o nome do primeiro controle no grupo a ser usado.

tabcontrols: uma lista separada por vírgulas de nomes de botões que serão usados como gerenciadores de página. A ordem em que são especificados neste argumento corresponde ao número da página a que estão associados.

wizardcontrols: uma lista separada por vírgulas com os nomes de dois botões que serão usados para os botões Anterior/Próximo.

lastpage: o número da última página disponível. Recomenda-se especificar esse valor ao usar o gerenciador de páginas Anterior/Próxima.

### Exemplo:

Considere um diálogo com três páginas. A caixa de diálogo possui um controle ListBox chamado "aPageList" que será usado para controlar a página visível. Além disso, há dois botões denominados "btnPrevious" e "btnNext" que serão usados como botões Anterior/Próximo na caixa de diálogo.

##### Em Basic

        oDlg.SetPageManager(PilotControls := "aPageList", _
                               WizardControls := "btnPrevious,btnNext", _
                               LastPage := 3)
        oDlg.Execute()

##### Em Python

        dlg.SetPageManager(pilotcontrols="aPageList",
                           wizardcontrols="btnPrevious,btnNext",
                           lastpage=3)
        dlg.Execute()

## Terminate

Finaliza o serviço Dialog para a instância atual. Retorna True se a finalização foi bem-sucedida.

### Sintaxe:

svc.Terminate(): bool

### Exemplo:

Os exemplos abaixo em Basic e Python abrem os diálogos não-modais DlgConsole e dlgTrace. Eles são armazenados, respectivamente, nas bibliotecas compartilhadas ScriptForge e Access2Base. Os botões de fechamento do diálogo são desabilitados e a terminação explícita é realizada ao final da execução do processo.

Neste exemplo um botão em DlgConsole está substituindo o fechamento inibido da janela:

##### Em Basic

         oDlg = CreateScriptService("SFDialogs.Dialog","GlobalScope","ScriptForge","DlgConsole")
         oDlg.Execute(modal:=False)
         Wait 5000
         oDlg.Terminate()

##### Em Python

         from time import sleep
         dlg = CreateScriptService('SFDialogs.Dialog',"GlobalScope",'Access2Base',"dlgTrace")
         dlg.Execute(modal=False)
         sleep 5
         dlg.Terminate()

Todas as rotinas ou identificadores do ScriptForge em Basic que possuem o caractere "_" como prefixo são reservadas para uso interno. Elas não devem ser usadas em macros escritas em Basic ou em Python.

Tópicos relacionados

Serviço SFDialogs.DialogControl

Serviço ScriptForge.UI