OpenOffice.org BASIC Guide - OpenOffice.org wiki

Closing With the Close Button in the Title Bar
Working With Dialogs
You can close a dialog by clicking the close button on the title bar of the dialog window. The Execute method of
the dialog returns the value 0, which is the same as when you click Cancel.
Closing With an Explicit Program Call
You can also close an open dialog window with the endExecute method:
Dlg.endExecute()
The Execute method of the dialog returns the value 0, which is the same as when you click Cancel.
Access to Individual Control Elements
A dialog can contain any number of control elements. You can access these elements through the getControl
method that returns the control element by name.
Dim Ctl As Object
Ctl = Dlg.getControl("MyButton")
Ctl.Label = "New Label"
This code determines the object for the MyButton control element and then initializes the Ctl object variable
with a reference to the element. Finally the code sets the Label property of the control element to the New
Label value.
Note – Unlike OpenOffice.org Basic identifiers, the names of control elements are case sensitive.
Working With the Model of Dialogs and Control
Elements
The division between visible program elements (View) and the data or documents behind them (Model) occurs
at many places in OpenOffice.org API. In addition to the methods and properties of control elements, both
dialog and control element objects have a subordinate Model object. This object allows you to directly access the
content of a dialog or control element.
In dialogs, the distinction between data and depiction is not always as clear as in other API areas of
OpenOffice.org. Elements of the API are available through both the View and the Model.
The Model property provides program-controlled access to the model of dialog and control element objects.
Dim cmdNext As Object
cmdNext = Dlg.getControl("cmdNext")
cmdNext.Model.Enabled = False
This example deactivates the cmdNext button in the Dlg dialog with the aid of the model object from cmdNext.
Properties
Name and Title
Every control element has its own name that can be queried using the following model property:
Chapter 11 · Dialogs 153