This service specifies a content control with properties in a TextDocument. More...

import"ContentControl.idl";

Inheritance diagram for ContentControl:

Exported Interfaces
interface	com::sun::star::text::XTextContent
	Provides a way to insert the content control using insertTextContent(). More...

Public Attributes
boolean	ShowingPlaceHolder
	Current content is placeholder text. More...

boolean	Checkbox
	Display the content control as a checkbox. More...

boolean	Checked
	If Checkbox is true, is the checkbox checked? More...

string	CheckedState
	If Checkbox is true, the value of a checked checkbox. More...

string	UncheckedState
	If Checkbox is true, the value of an unchecked checkbox. More...

sequence< sequence< com::sun::star::beans::PropertyValue > >	ListItems
	List items of a dropdown: DisplayText + Value pairs with string values for each item. More...

boolean	Picture
	Display the content control as a picture. More...

boolean	Date
	Display the content control as a date. More...

string	DateFormat
	If Date is true, the date format in a syntax accepted by the NumberFormatter. More...

string	DateLanguage
	If Date is true, the date's BCP 47 language tag. More...

string	CurrentDate
	Date in YYYY-MM-DDT00:00:00Z format. More...

boolean	PlainText
	Plain text, i.e. More...

string	PlaceholderDocPart
	The placeholder's doc part: just remembered. More...

string	DataBindingPrefixMappings
	The data bindings's prefix mappings: just remembered. More...

string	DataBindingXpath
	The data bindings's XPath: just remembered. More...

string	DataBindingStoreItemID
	The data bindings's store item ID: just remembered. More...

string	Color
	The color: just remembered. More...

string	Appearance
	The appearance: just remembered. More...

boolean	ComboBox
	Combo box that allows free-form text as well, i.e. More...

boolean	DropDown
	Drop-down that does not allow free-form text, i.e. More...

string	Alias
	The alias: kind of a human-readable title / description, show up on the UI. More...

string	Tag
	The tag: similar to Alias, but is meant to be machine-readable. More...

string	DateString
	The formatted date string, based on DateFormat, DateLanguage and CurrentDate. More...

long	Id
	A unique numeric id, used by macros to identify a specific control. More...

unsigned long	TabIndex
	Describes the order in which keyboard navigation moves between controls. More...

string	Lock
	Describes whether the control itself and/or its data can be modified or deleted by the user. More...

string	MultiLine
	Indicates if the control accepts soft breaks. More...

Additional Inherited Members
Public Member Functions inherited from XTextContent
void	attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
	is called when this object gets embedded in a text. More...

com::sun::star::text::XTextRange	getAnchor ()

Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...

void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...

void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Detailed Description

This service specifies a content control with properties in a TextDocument.

A content control wraps one or more text portions and controls the behavior of that content.

Since: LibreOffice 7.4

Exported Interfaces

◆ com::sun::star::text::XTextContent

interface com::sun::star::text::XTextContent

Provides a way to insert the content control using insertTextContent().

Member Data Documentation

◆ Alias

string Alias

optionalproperty

The alias: kind of a human-readable title / description, show up on the UI.

-also used by VBA to group controls into a smaller, indexed collection

Since: LibreOffice 7.5

◆ Appearance

string Appearance

optionalproperty

The appearance: just remembered.

Since: LibreOffice 7.6

◆ Checkbox

boolean Checkbox

optionalproperty

Display the content control as a checkbox.

◆ Checked

boolean Checked

optionalproperty

If Checkbox is true, is the checkbox checked?

◆ CheckedState

string CheckedState

optionalproperty

If Checkbox is true, the value of a checked checkbox.

◆ Color

string Color

optionalproperty

The color: just remembered.

◆ ComboBox

boolean ComboBox

optionalproperty

Combo box that allows free-form text as well, i.e.

not dropdown.

Since: LibreOffice 7.5

◆ CurrentDate

string CurrentDate

optionalproperty

Date in YYYY-MM-DDT00:00:00Z format.

◆ DataBindingPrefixMappings

string DataBindingPrefixMappings

optionalproperty

The data bindings's prefix mappings: just remembered.

◆ DataBindingStoreItemID

string DataBindingStoreItemID

optionalproperty

The data bindings's store item ID: just remembered.

◆ DataBindingXpath

string DataBindingXpath

optionalproperty

The data bindings's XPath: just remembered.

◆ Date

boolean Date

optionalproperty

Display the content control as a date.

If true, a date picker is provided on the UI.

◆ DateFormat

string DateFormat

optionalproperty

If Date is true, the date format in a syntax accepted by the NumberFormatter.

◆ DateLanguage

string DateLanguage

optionalproperty

If Date is true, the date's BCP 47 language tag.

◆ DateString

string DateString

optionalpropertyreadonly

The formatted date string, based on DateFormat, DateLanguage and CurrentDate.

Since: LibreOffice 7.5

◆ DropDown

boolean DropDown

optionalproperty

Drop-down that does not allow free-form text, i.e.

not combo box.

Since: LibreOffice 7.5

◆ Id

long Id

optionalproperty

A unique numeric id, used by macros to identify a specific control.

Since: LibreOffice 7.5

◆ ListItems

sequence< sequence< com::sun::star::beans::PropertyValue > > ListItems

optionalproperty

List items of a dropdown: DisplayText + Value pairs with string values for each item.

◆ Lock

string Lock

optionalproperty

Describes whether the control itself and/or its data can be modified or deleted by the user.

Since: LibreOffice 7.6

◆ MultiLine

string MultiLine

optionalproperty

Indicates if the control accepts soft breaks.

Since: LibreOffice 24.2

◆ Picture

boolean Picture

optionalproperty

Display the content control as a picture.

◆ PlaceholderDocPart

string PlaceholderDocPart

optionalproperty

The placeholder's doc part: just remembered.

◆ PlainText

boolean PlainText

optionalproperty

Plain text, i.e.

not rich text.

◆ ShowingPlaceHolder

boolean ShowingPlaceHolder

optionalproperty

Current content is placeholder text.

◆ TabIndex

unsigned long TabIndex

optionalproperty

Describes the order in which keyboard navigation moves between controls.

Since: LibreOffice 7.6

◆ Tag

string Tag

optionalproperty

The tag: similar to Alias, but is meant to be machine-readable.

-also used by VBA to group controls into a smaller, indexed collection

Since: LibreOffice 7.5

◆ UncheckedState

string UncheckedState

optionalproperty

If Checkbox is true, the value of an unchecked checkbox.

The documentation for this service was generated from the following file:

com/sun/star/text/ContentControl.idl

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::text::XTextContent

Member Data Documentation

◆ Alias

◆ Appearance

◆ Checkbox

◆ Checked

◆ CheckedState

◆ Color

◆ ComboBox

◆ CurrentDate

◆ DataBindingPrefixMappings

◆ DataBindingStoreItemID

◆ DataBindingXpath

◆ Date

◆ DateFormat

◆ DateLanguage

◆ DateString

◆ DropDown

◆ Id

◆ ListItems

◆ Lock

◆ MultiLine

◆ Picture

◆ PlaceholderDocPart

◆ PlainText

◆ ShowingPlaceHolder

◆ TabIndex

◆ Tag

◆ UncheckedState