|
LibreOffice
LibreOffice 5.3 SDK API Reference
|
A TextSection is a range of complete paragraphs within a text. More...
import"TextSection.idl";
Included Services | |
| service | com::sun::star::text::TextContent |
| service | com::sun::star::xml::UserDefinedAttributesSupplier |
Exported Interfaces | |
| interface | com::sun::star::text::XTextSection |
| interface | com::sun::star::container::XNamed |
| interface | com::sun::star::beans::XPropertySet |
| interface | com::sun::star::beans::XPropertyState |
Exported Interfaces inherited from TextContent | |
| interface | com::sun::star::text::XTextContent |
| This interface is used for the attachment of this text content to the surrounding text. More... | |
Public Attributes | |
| string | Condition |
| This property contains a conditional expression. More... | |
| boolean | IsVisible |
If this property is FALSE, the text section is hidden. More... | |
| boolean | IsProtected |
If this property is TRUE, the text section is protected and cannot be modified from the user interface. More... | |
| com::sun::star::text::SectionFileLink | FileLink |
| If this property is set, then the content of the section is read from the specified document. More... | |
| string | LinkRegion |
| specifies the source of a file link in the document that is specified in TextSection::FileLink. More... | |
| string | DDECommandType |
| specifies the type of the command string for a DDE operation. More... | |
| string | DDECommandFile |
| specifies the source file name of the command string for a DDE operation. More... | |
| string | DDECommandElement |
| specifies the source element of the command string for a DDE operation. More... | |
| string | BackGraphicURL |
| contains the URL for the background graphic. More... | |
| string | BackGraphicFilter |
| contains the name of the file filter for the background graphic. More... | |
| com::sun::star::style::GraphicLocation | BackGraphicLocation |
| determines the position of the background graphic. More... | |
| boolean | FootnoteIsCollectAtTextEnd |
| determines whether footnotes inside the section are displayed at the end of the section text. More... | |
| boolean | FootnoteIsRestartNumbering |
| determines whether the footnotes numbering restarts within the section. More... | |
| short | FootnoteRestartNumberingAt |
| determines at which number the footnote numbering inside of the section starts. More... | |
| boolean | FootnoteIsOwnNumbering |
| determines whether the footnotes within the section use an own numbering format. More... | |
| short | FootnoteNumberingType |
| determines the numbering type of the footnote numbering as a value of com::sun::star::style::NumberingType. More... | |
| string | FootnoteNumberingPrefix |
| determines the prefix that is display before the footnote number. More... | |
| string | FootnoteNumberingSuffix |
| determines the suffix that is display after of the footnote number. More... | |
| boolean | EndnoteIsCollectAtTextEnd |
| determines whether endnotes inside the section are displayed at the end of the section text. More... | |
| boolean | EndnoteIsRestartNumbering |
| determines whether the endnotes numbering restarts within the section. More... | |
| short | EndnoteRestartNumberingAt |
| determines at which number the endnote numbering inside of the section starts. More... | |
| boolean | EndnoteIsOwnNumbering |
| determines whether the endnotes within the section use an own numbering format. More... | |
| short | EndnoteNumberingType |
| determines the numbering type of the endnote numbering as a value of com::sun::star::style::NumberingType. More... | |
| string | EndnoteNumberingPrefix |
| determines the prefix that is display before the endnote number. More... | |
| string | EndnoteNumberingSuffix |
| determines the suffix that is display after the endnote number. More... | |
| boolean | IsAutomaticUpdate |
| determines if a DDE link is updated automatically. More... | |
| com::sun::star::text::XTextColumns | TextColumns |
| allows columns to be set into the text section More... | |
| long | SectionLeftMargin |
| determines the left margin of the section More... | |
| long | SectionRightMargin |
| determines the left margin of the section More... | |
Public Attributes inherited from TextContent | |
| com::sun::star::text::TextContentAnchorType | AnchorType |
| specifies how the text content is attached to its surrounding Text. More... | |
| sequence< com::sun::star::text::TextContentAnchorType > | AnchorTypes |
| contains the anchor type of the text content. More... | |
| com::sun::star::text::WrapTextMode | TextWrap |
| specifies if the text content is a shape and how the text is wrapped around the shape. 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... | |
Public Member Functions inherited from XTextSection | |
| com::sun::star::text::XTextSection | getParentSection () |
| If the object is a child section, then this method returns the parent text section. More... | |
| sequence< com::sun::star::text::XTextSection > | getChildSections () |
Public Member Functions inherited from XNamed | |
| string | getName () |
| void | setName ([in] string aName) |
| sets the programmatic name of the object. More... | |
Public Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More... | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More... | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More... | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More... | |
Public Member Functions inherited from XPropertyState | |
| com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| sequence< com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| Sets the property to default value. More... | |
| any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
Protected Member Functions inherited from XTextSection | |
| com::sun::star::text::XTextSection | getParentSection () |
| If the object is a child section, then this method returns the parent text section. More... | |
| sequence< com::sun::star::text::XTextSection > | getChildSections () |
Protected Member Functions inherited from XNamed | |
| string | getName () |
| void | setName ([in] string aName) |
| sets the programmatic name of the object. More... | |
Protected Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More... | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More... | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More... | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More... | |
Protected Member Functions inherited from XPropertyState | |
| com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| sequence< com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| Sets the property to default value. More... | |
| any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
Protected Attributes inherited from UserDefinedAttributesSupplier | |
| ::com::sun::star::container::XNameContainer | UserDefinedAttributes |
| This container holds the AttributeData elements that represent uninterpreted XML attributes. More... | |
A TextSection is a range of complete paragraphs within a text.
The content of the section may be the content of a link into another document, a link from the same document, or the result of a DDE operation.
TextSection instances can be linked from and to other texts.
|
optional |
| interface com::sun::star::beans::XPropertySet |
| interface com::sun::star::beans::XPropertyState |
| interface com::sun::star::container::XNamed |
| interface com::sun::star::text::XTextSection |
|
property |
contains the name of the file filter for the background graphic.
|
property |
determines the position of the background graphic.
|
property |
contains the URL for the background graphic.
|
property |
This property contains a conditional expression.
If the result of the conditional expression is TRUE and the property TextSection::IsVisible is FALSE, then the section is hidden.
|
property |
specifies the source element of the command string for a DDE operation.
The element can be i.e. a name of a cell in a sheet or a bookmark.
|
property |
specifies the source file name of the command string for a DDE operation.
|
property |
specifies the type of the command string for a DDE operation.
The type can be the name of the application that provides a DDE source.
|
property |
determines whether endnotes inside the section are displayed at the end of the section text.
|
property |
determines whether the endnotes within the section use an own numbering format.
This is only valid if EndnoteIsRestartNumbering is set.
|
property |
determines whether the endnotes numbering restarts within the section.
This is only valid if EndnoteIsRestartNumbering is set.
|
property |
determines the prefix that is display before the endnote number.
This is only valid if EndnoteIsOwnNumbering is set.
|
property |
determines the suffix that is display after the endnote number.
This is only valid if EndnoteIsOwnNumbering is set.
|
property |
determines the numbering type of the endnote numbering as a value of com::sun::star::style::NumberingType.
This is only valid if EndoteIsOwnNumbering is set.
|
property |
determines at which number the endnote numbering inside of the section starts.
This is only valid if EndnoteIsRestartNumbering is set.
|
property |
If this property is set, then the content of the section is read from the specified document.
|
property |
determines whether footnotes inside the section are displayed at the end of the section text.
|
property |
determines whether the footnotes within the section use an own numbering format.
This is only valid if FootnoteIsRestartNumbering is set.
|
property |
determines whether the footnotes numbering restarts within the section.
This is only valid if FootnoteIsRestartNumbering is set.
|
property |
determines the prefix that is display before the footnote number.
This is only valid if FootnoteIsOwnNumbering is set.
|
property |
determines the suffix that is display after of the footnote number.
This is only valid if FootnoteIsOwnNumbering is set.
|
property |
determines the numbering type of the footnote numbering as a value of com::sun::star::style::NumberingType.
This is only valid if FootnoteIsOwnNumbering is set.
|
property |
determines at which number the footnote numbering inside of the section starts.
This is only valid if FootnoteIsRestartNumbering is set.
|
property |
determines if a DDE link is updated automatically.
|
property |
If this property is TRUE, the text section is protected and cannot be modified from the user interface.
|
property |
If this property is FALSE, the text section is hidden.
|
property |
specifies the source of a file link in the document that is specified in TextSection::FileLink.
The source may be a text section or a bookmark. If TextSection::FileLink is empty, then the current document is searched for the source. If this property is empty and TextSection::FileLink is set, then the complete document content is linked into this section.
|
optionalproperty |
determines the left margin of the section
|
optionalproperty |
determines the left margin of the section
allows columns to be set into the text section
1.8.13