AlterOffice
AlterOffice 3.4 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Exported Interfaces | Public Attributes | List of all members
ContentControl Service Reference

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

import "ContentControl.idl";

Inheritance diagram for ContentControl:
XTextContent XComponent XInterface

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...
 
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...
 

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.

Exported Interfaces

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

Member Data Documentation

string Alias
optionalproperty

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

boolean Checkbox
optionalproperty

Display the content control as a checkbox.

boolean Checked
optionalproperty

If Checkbox is true, is the checkbox checked?

string CheckedState
optionalproperty

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

string Color
optionalproperty

The color: just remembered.

boolean ComboBox
optionalproperty

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

not dropdown.

string CurrentDate
optionalproperty

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

string DataBindingPrefixMappings
optionalproperty

The data bindings's prefix mappings: just remembered.

string DataBindingStoreItemID
optionalproperty

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

string DataBindingXpath
optionalproperty

The data bindings's XPath: just remembered.

boolean Date
optionalproperty

Display the content control as a date.

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

string DateFormat
optionalproperty

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

string DateLanguage
optionalproperty

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

string DateString
optionalpropertyreadonly

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

boolean DropDown
optionalproperty

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

not combo box.

long Id
optionalproperty

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

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

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

boolean Picture
optionalproperty

Display the content control as a picture.

string PlaceholderDocPart
optionalproperty

The placeholder's doc part: just remembered.

boolean PlainText
optionalproperty

Plain text, i.e.

not rich text.

boolean ShowingPlaceHolder
optionalproperty

Current content is placeholder text.

string Tag
optionalproperty

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

string UncheckedState
optionalproperty

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


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