Constants' Group PropertyControlType

Overview

Module

Use

Devguide

Index

Constants

Constants' Details

:: com :: sun :: star :: inspection ::

constants group PropertyControlType

Description: describes pre-defined possible control types to be used to display and enter property values within a ObjectInspector.; The type of a control determines its visual appearance, its behaviour, and - important for property handlers using a control - the expected type when reading and writing the control's value.
Since: OOo 2.0.3
See also: XPropertyControl, XPropertyControlFactory, XPropertyControl::ValueType

Constants
ListBox	denotes a control which allows the user to choose from a list of possible property values
ComboBox	denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value.
TextField	denotes a control which allows the user to enter property values consisting of a single line of text
MultiLineTextField	denotes a control which allows the user to enter pure text, including line breaks
CharacterField	denotes a control which allows the user to enter a single character
StringListField	denotes a control which allows the user to enter a list of single-line strings
ColorListBox	denotes a control which allows the user to choose from a list of colors.
NumericField	denotes a control which allows the user to enter a numerical value
DateField	denotes a control which allows the user to enter a date value
TimeField	denotes a control which allows the user to enter a time value
DateTimeField	denotes a control which allows the user to enter a combined date/time value
HyperlinkField	denotes a control which displays a string in a hyperlink-like appearance
Unknown	denotes a non-standard property control, which is usually provided by an XPropertyHandler

Constants' Details

ListBox

const short ListBox = 1; Description denotes a control which allows the user to choose from a list of possible property values Controls of type ListBox exchange their values as `string`. Additionally, those controls support the XStringListControl interface.

ComboBox

const short ComboBox = 2; Description denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value. Controls of type ComboBox exchange their values as `string`. Additionally, those controls support the XStringListControl interface.

TextField

const short TextField = 3; Description denotes a control which allows the user to enter property values consisting of a single line of text Controls of type TextField exchange their values as `string`.

MultiLineTextField

const short MultiLineTextField = 4; Description denotes a control which allows the user to enter pure text, including line breaks Controls of type MultiLineTextField exchange their values as `string`.

CharacterField

const short CharacterField = 5; Description denotes a control which allows the user to enter a single character Controls of type CharacterField exchange their values as `short`, being a single UTF-16 character.

StringListField

const short StringListField = 6; Description denotes a control which allows the user to enter a list of single-line strings Controls of type StringListField exchange their values as `sequence< string >.`

ColorListBox

const short ColorListBox = 7; Description denotes a control which allows the user to choose from a list of colors. Controls of type ColorListBox usually exchange their values as ::com::sun::star::util::Color. Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as `string`. That is, if you write a string into XPropertyControl::Value, and if this string has previously been added to the list using the XStringListControl interface, this string is selected. Vice versa, if the user selects one of those non-color strings in the list, then reading XPropertyControl::Value will retrieve you this stting.

NumericField

const short NumericField = 8; Description denotes a control which allows the user to enter a numerical value Controls of type NumericField exchange their values as `double`. Additionally, those controls support the XNumericControl interface.

DateField

const short DateField = 9; Description denotes a control which allows the user to enter a date value Controls of type DateField exchange their values as ::com::sun::star::util::Date.

TimeField

const short TimeField = 10; Description denotes a control which allows the user to enter a time value Controls of type TimeField exchange their values as ::com::sun::star::util::Time.

DateTimeField

const short DateTimeField = 11; Description denotes a control which allows the user to enter a combined date/time value Controls of type DateTimeField exchange their values as ::com::sun::star::util::DateTime.

HyperlinkField

const short HyperlinkField = 12; Description denotes a control which displays a string in a hyperlink-like appearance Controls of type HyperlinkField exchange their values as `string`. Additionally, those controls support the XHyperlinkControl interface.

Unknown

const short Unknown = 13; Description denotes a non-standard property control, which is usually provided by an XPropertyHandler

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous