LibreOffice LibreOffice 6.2 SDK API Reference

Variables
com::sun::star::form::FormComponentType Constant Group Referencepublished

These constants specify the class types used to identify a component. More...

## Variables
const short | CONTROL = 1
| This generic identifier is for controls which cannot be identified by another specific identifier. More...
const short | COMMANDBUTTON = 2
| specifies a control that is used to begin, interrupt, or end a process. More...
const short | RADIOBUTTON = 3
| specifies a control that acts like a radio button. More...
const short | IMAGEBUTTON = 4
| specifies a control that displays an image that responds to mouse clicks. More...
const short | CHECKBOX = 5
| specifies a control that is used to check or uncheck to turn an option on or off. More...
const short | LISTBOX = 6
| specifies a control that displays a list from which the user can select one or more items. More...
const short | COMBOBOX = 7
| specifies a control that is used when a list box combined with a static text control or an edit control is needed. More...
const short | GROUPBOX = 8
| specifies a control that displays a frame around a group of controls with or without a caption. More...
const short | TEXTFIELD = 9
| specifies a control that is a text component that allows for the editing of a single line of text. More...
const short | FIXEDTEXT = 10
| specifies a control to display a fixed text, usually used to label other controls. More...
const short | GRIDCONTROL = 11
| is a table like control to display database data. More...
const short | FILECONTROL = 12
| specifies an control which can be used to enter text, extended by an (user-startable) file dialog to browse for files. More...
const short | HIDDENCONTROL = 13
| specifies a control that should not be visible. More...
const short | IMAGECONTROL = 14
| specifies a control to display an image. More...
const short | DATEFIELD = 15
| specifies a control to display and edit a date value. More...
const short | TIMEFIELD = 16
| specifies a control to display and edit a time value. More...
const short | NUMERICFIELD = 17
| specifies a field to display and edit a numeric value. More...
const short | CURRENCYFIELD = 18
| specifies a field to display and edit a currency value. More...
const short | PATTERNFIELD = 19
| specifies a control to display and edit a string according to a pattern. More...
const short | SCROLLBAR = 20
| specifies a control to display and edit, in the form of a scrollbar, a value from a continuous value range More...
const short | SPINBUTTON = 21
| specifies a control to edit, in the form of a spin field, a value from a continuous range of values More...
const short | NAVIGATIONBAR = 22
| specifies a control which provides controller functionality for the com::sun::star::form::component::DataForm it belongs to, such as functionality to navigate or filter this form. More...

## Detailed Description

These constants specify the class types used to identify a component.

## Variable Documentation

## ◆ CHECKBOX

const short CHECKBOX = 5

specifies a control that is used to check or uncheck to turn an option on or off.

## ◆ COMBOBOX

const short COMBOBOX = 7

specifies a control that is used when a list box combined with a static text control or an edit control is needed.

## ◆ COMMANDBUTTON

const short COMMANDBUTTON = 2

specifies a control that is used to begin, interrupt, or end a process.

## ◆ CONTROL

const short CONTROL = 1

This generic identifier is for controls which cannot be identified by another specific identifier.

## ◆ CURRENCYFIELD

const short CURRENCYFIELD = 18

specifies a field to display and edit a currency value.

## ◆ DATEFIELD

const short DATEFIELD = 15

specifies a control to display and edit a date value.

## ◆ FILECONTROL

const short FILECONTROL = 12

specifies an control which can be used to enter text, extended by an (user-startable) file dialog to browse for files.

## ◆ FIXEDTEXT

const short FIXEDTEXT = 10

specifies a control to display a fixed text, usually used to label other controls.

## ◆ GRIDCONTROL

const short GRIDCONTROL = 11

is a table like control to display database data.

## ◆ GROUPBOX

const short GROUPBOX = 8

specifies a control that displays a frame around a group of controls with or without a caption.

## ◆ HIDDENCONTROL

const short HIDDENCONTROL = 13

specifies a control that should not be visible.

## ◆ IMAGEBUTTON

const short IMAGEBUTTON = 4

specifies a control that displays an image that responds to mouse clicks.

## ◆ IMAGECONTROL

const short IMAGECONTROL = 14

specifies a control to display an image.

## ◆ LISTBOX

const short LISTBOX = 6

specifies a control that displays a list from which the user can select one or more items.

## ◆ NAVIGATIONBAR

const short NAVIGATIONBAR = 22

specifies a control which provides controller functionality for the com::sun::star::form::component::DataForm it belongs to, such as functionality to navigate or filter this form.

## ◆ NUMERICFIELD

const short NUMERICFIELD = 17

specifies a field to display and edit a numeric value.

## ◆ PATTERNFIELD

const short PATTERNFIELD = 19

specifies a control to display and edit a string according to a pattern.

## ◆ RADIOBUTTON

const short RADIOBUTTON = 3

specifies a control that acts like a radio button.

Grouped together, such radio buttons present a set of two or more mutually exclusive choices to the user.

## ◆ SCROLLBAR

const short SCROLLBAR = 20

specifies a control to display and edit, in the form of a scrollbar, a value from a continuous value range

## ◆ SPINBUTTON

const short SPINBUTTON = 21

specifies a control to edit, in the form of a spin field, a value from a continuous range of values

## ◆ TEXTFIELD

const short TEXTFIELD = 9

specifies a control that is a text component that allows for the editing of a single line of text.

## ◆ TIMEFIELD

const short TIMEFIELD = 16

specifies a control to display and edit a time value.