控制元素表单详述
From Apache OpenOffice Wiki
表单中可用的控制元素与对话框中可用的控制元素类似。其选择范围包括简单文本字段、列表框和组合框以及各种按钮。
下面列出了控制元素表单一些最重要的属性。所有属性都是关联模型对象的组成部分。
除了标准控制元素以外,还可以在表单中使用表格控制元素,以便能够完整地加入数据库表格。数据库表单一章中介绍了该内容。
按钮
表单按钮的模型对象提供了以下属性:
- BackgroundColor (long)
- 背景颜色
- DefaultButton (Boolean)
- 该按钮用作默认值。在这种情况下,它还会在没有焦点的情况下响应输入按钮
- Enabled (Boolean)
- 可以激活控制元素
- Tabstop (Boolean)
- 可通过 Tab 按钮访问控制元素
- TabIndex (Long)
- 控制元素在激活序列中的位置
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- Tag (String)
- 包含附加信息的字符串,可以将其保存在按钮中,以通过程序控制方式进行访问
- TargetURL (String)
- URL 类型的按钮的目标 URL
- TargetFrame (String)
- 激活按钮(URL 类型的按钮)时,将在其中打开 TargetURL 的窗口(或框)的名称
- Label (String)
- 按钮标签
- TextColor (Long)
- 控制元素的文本颜色
- HelpText (String)
- 将鼠标光标置于控制元素上方时自动显示的帮助文本
- HelpURL (String)
- 相应控制元素的联机帮助的 URL
- ButtonType (Enum)
- 与按钮关联的操作(来自 com.sun.star.form.FormButtonType 的默认值)
通过使用 ButtonType 属性,可以定义在按下按钮时自动执行的操作。关联的 com.sun.star.form.FormButtonType 常量组提供了以下值:
- PUSH
- 标准按钮
- SUBMIT
- 结束表单输入(特别适用于 HTML 表单)
- RESET
- 将表单内的所有值重置为原始值
- URL
- 调用 TargetURL 中定义的 URL(在通过 TargetFrame 指定的窗口中打开)
表单中不支持对话框中提供的确定和取消按钮类型。
选项按钮
可通过选项按钮的模型对象使用它的以下属性:
- Enabled (Boolean)
- 可以激活控制元素
- Tabstop (Boolean)
- 可通过 Tab 键访问控制元素
- TabIndex (Long)
- 控制元素在激活序列中的位置
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- Tag (String)
- 包含附加信息的字符串,可以将其保存在按钮中,以通过程序控制方式进行访问
- Label (String)
- 按钮标签
- Printable (Boolean)
- 可以打印控制元素
- State (Short)
- 如果值为 1,则激活该选项,否则停用该选项
- RefValue (String)
- 用于保存附加信息的字符串(例如,用于管理数据记录 ID)
- TextColor (Long)
- 控制元素的文本颜色
- HelpText (String)
- 将鼠标光标置于控制元素上方时自动显示的帮助文本
- HelpURL (String)
- 相应控制元素的联机帮助的 URL
通过选项按钮的分组机制可以区分对话框的控制元素和表单的控制元素。在对话框中,并排出现的控制元素自动合并为一组;而表单中的分组是按名称进行的。为此,每个组的所有选项按钮必须具有相同的名称。Apache OpenOffice 将分组的控制元素合并为一个数组,以便按相同方式访问 Apache OpenOffice Basic 程序的各个按钮。
以下示例说明了如何确定控制元素组的模型。
Dim Doc As Object Dim Forms As Object Dim Form As Object Dim Ctl As Object Dim I as Integer Doc = StarDesktop.CurrentComponent 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
该代码与前面用于确定简单控制元素模型的代码类似。它通过循环在当前文本文档中搜索所有表单,并使用 HasByName 方法检查相应表单是否包含正在搜索的名为 MyOptions 的元素。如果包含该元素,则使用 GetGroupByName 方法(而不是用于确定简单模型的 GetByName 方法)访问模型数组。
复选框
复选框表单的模型对象提供了以下属性:
- Enabled (Boolean)
- 可以激活控制元素
- Tabstop (Boolean)
- 可通过 Tab 键访问控制元素
- TabIndex (Long)
- 控制元素在激活序列中的位置
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- Tag (String)
- 包含附加信息的字符串,可以将其保存在按钮中,以通过程序控制方式进行访问
- Label (String)
- 按钮标签
- Printable (Boolean)
- 可以打印控制元素
- State (Short)
- 如果值为 1,则激活该选项,否则停用该选项
- RefValue (String)
- 用于保存附加信息的字符串(例如,用于管理数据记录 ID)
- TextColor (Long)
- 控制元素的文本颜色
- HelpText (String)
- 将鼠标光标置于控制元素上方时自动显示的帮助文本
- HelpURL (String)
- 相应控制元素的联机帮助的 URL
文本字段
文本字段表单的模型对象提供了以下属性:
- Align (short)
- 文本方向(0:左对齐,1:居中,2:右对齐)
- BackgroundColor (long)
- 控制元素的背景颜色
- Border (short)
- 边框类型(0:无边框,1:三维边框,2:简单边框)
- EchoChar (String)
- 密码字段的回显字符
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- HardLineBreaks (Boolean)
- 在控制元素文本中永久插入自动换行符
- HScroll (Boolean)
- 文本具有水平滚动条
- MaxTextLen (Short)
- 最大文本长度;如果指定值 0,则无长度限制
- MultiLine (Boolean)
- 允许条目占据多行
- Printable (Boolean)
- 可以打印控制元素
- ReadOnly (Boolean)
- 控制元素的内容为只读
- Enabled (Boolean)
- 可以激活控制元素
- Tabstop (Boolean)
- 可通过 Tab 键访问控制元素
- TabIndex (Long)
- 控制元素在激活序列中的位置
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- Text (String)
- 控制元素的文本
- TextColor (Long)
- 控制元素的文本颜色
- VScroll (Boolean)
- 文本具有垂直滚动条
- HelpText (String)
- 将鼠标光标置于控制元素上方时自动显示的帮助文本
- HelpURL (String)
- 相应控制元素的联机帮助的 URL
列表框
列表框表单的模型对象提供了以下属性:
- BackgroundColor (long)
- 控制元素的背景颜色
- Border (short)
- 边框类型(0:无边框,1:三维边框,2:简单边框)
- FontDescriptor (struct)
- 包含要使用的字体详细信息的结构(与 com.sun.star.awt.FontDescriptor 结构一致)
- LineCount (Short)
- 控制元素的行数
- MultiSelection (Boolean)
- 允许进行条目多重选择
- SelectedItems (Array of Strings)
- 突出显示条目的列表
- StringItemList (Array of Strings)
- 所有条目的列表
- ValueItemList (Array of Variant)
- 包含每个条目的附加信息的列表(例如,用于管理数据记录 ID)
- Printable (Boolean)
- 可以打印控制元素
- ReadOnly (Boolean)
- 控制元素的内容为只读
- Enabled (Boolean)
- 可以激活控制元素
- Tabstop (Boolean)
- 可通过 Tab 键访问控制元素
- TabIndex (Long)
- 控制元素在激活序列中的位置
- FontName (String)
- 字体类型的名称
- FontHeight (Single)
- 以点数 (pt) 为单位的字符高度
- Tag (String)
- 包含附加信息的字符串,可以将其保存在按钮中,以通过程序控制方式进行访问
- TextColor (Long)
- 控制元素的文本颜色
- HelpText (String)
- 将鼠标光标置于控制元素上方时自动显示的帮助文本
- HelpURL (String)
- 相应控制元素的联机帮助的 URL
此外,还通过列表框的视图对象提供了以下方法:
- addItem (Item, Pos)
- 将 Item 中指定的字符串插入到列表中的 Pos 位置
- addItems (ItemArray, Pos)
- 将字符串的 ItemArray 数据字段中列出的条目插入到列表中的 Pos 位置
- removeItems (Pos, Count)
- 从 Pos 位置开始删除 Count 个条目
- selectItem (Item, SelectMode)
- 根据 SelectMode 变量,启用或禁用字符串 Item 中指定元素的突出显示
- makeVisible (Pos)
- 滚动列表字段,以便显示通过 Pos 指定的条目
Content on this page is licensed under the Public Documentation License (PDL). |