OpenOffice.org BASIC Guide - OpenOffice.org wiki

Control Element Forms
FontName (String)
name of font type
FontHeight (Single)
height of character in points (pt)
Tag (String)
string containing additional information, which can be saved in the button for program-controlled access
Label (String)
inscription of button
Printable (Boolean)
the control element can be printed
State (Short)
if 1, the option is activated, otherwise it is deactivated
RefValue (String)
string for saving additional information (for example, for administering data record IDs)
TextColor (Long)
text color of control element
HelpText (String)
automatically displayed help text, which is displayed if the mouse cursor is above the control element
HelpURL (String)
URL of online help for the corresponding control element
The mechanism for grouping option buttons distinguishes between the control elements for dialogs and forms.
Whereas control elements appearing one after another in dialogs are automatically combined to form a group,
grouping in forms is performed on the basis of names. To do this, all option buttons of a group must contain the
same name. OpenOffice.org combines the grouped control elements into an array so that the individual buttons
of a OpenOffice.org Basic program can be reached in the same way.
The following example shows how the model of a control element group can be determined.
Dim Doc As Object
Dim Forms As Object
Dim Form As Object
Dim Ctl As Object
Dim I as Integer
Doc = ThisComponent
Forms = Doc.Drawpage.Forms
For I = 0 To Forms.Count - 1
Form = Forms.GetbyIndex(I)
If Form.HasByName("MyOptions") Then
Ctl = Form. GetGroupbyName("MyOptions")
Exit Function
End If
Next I
The code corresponds to the previous example for determining a simple control element model. It searches
through all forms in the current text document in a loop and uses the HasByName method to check whether the
corresponding form contains an element with the MyOptions name it is searching for. If this is the case, then the
model array is accessed using the GetGroupByName method (rather than the GetByName method to determine
simple models).
Checkboxes
The model object of a checkbox form provides the following properties:
172 OpenOffice.org 3.2 BASIC Guide · March 2010