A TextSection is a range of complete paragraphs within a text. More...

import"TextSection.idl";

Inheritance diagram for TextSection:

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

com::sun::star::graphic::XGraphic	BackGraphic
	contains the graphic of the background. More...

Public Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType	AnchorType
	specifies how the text content is attached to its surrounding Text. 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 Types inherited from TextContent
typedef sequence< com::sun::star::text::TextContentAnchorType >	AnchorTypes
	contains the anchor type of the text content. More...

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

Detailed Description

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.

Developers Guide: Text Documents - Text Sections

Exported Interfaces

◆ com::sun::star::text::TextContent

service com::sun::star::text::TextContent

◆ com::sun::star::xml::UserDefinedAttributesSupplier

service com::sun::star::xml::UserDefinedAttributesSupplier

optional

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

◆ com::sun::star::beans::XPropertyState

interface com::sun::star::beans::XPropertyState

◆ com::sun::star::container::XNamed

interface com::sun::star::container::XNamed

◆ com::sun::star::text::XTextSection

interface com::sun::star::text::XTextSection

Member Data Documentation

◆ BackGraphic

com::sun::star::graphic::XGraphic BackGraphic

optionalproperty

contains the graphic of the background.

Since: LibreOffice 6.1

◆ BackGraphicFilter

string BackGraphicFilter

property

contains the name of the file filter for the background graphic.

◆ BackGraphicLocation

com::sun::star::style::GraphicLocation BackGraphicLocation

property

determines the position of the background graphic.

See also: GraphicLocation

◆ BackGraphicURL

string BackGraphicURL

property

contains the URL for the background graphic.

Deprecated:: as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

◆ Condition

string Condition

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.

◆ DDECommandElement

string DDECommandElement

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.

◆ DDECommandFile

string DDECommandFile

property

specifies the source file name of the command string for a DDE operation.

◆ DDECommandType

string DDECommandType

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.

◆ EndnoteIsCollectAtTextEnd

boolean EndnoteIsCollectAtTextEnd

property

determines whether endnotes inside the section are displayed at the end of the section text.

◆ EndnoteIsOwnNumbering

boolean EndnoteIsOwnNumbering

property

determines whether the endnotes within the section use an own numbering format.

This is only valid if EndnoteIsRestartNumbering is set.

◆ EndnoteIsRestartNumbering

boolean EndnoteIsRestartNumbering

property

determines whether the endnotes numbering restarts within the section.

This is only valid if EndnoteIsRestartNumbering is set.

◆ EndnoteNumberingPrefix

string EndnoteNumberingPrefix

property

determines the prefix that is display before the endnote number.

This is only valid if EndnoteIsOwnNumbering is set.

◆ EndnoteNumberingSuffix

string EndnoteNumberingSuffix

property

determines the suffix that is display after the endnote number.

This is only valid if EndnoteIsOwnNumbering is set.

◆ EndnoteNumberingType

short EndnoteNumberingType

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.

◆ EndnoteRestartNumberingAt

short EndnoteRestartNumberingAt

property

determines at which number the endnote numbering inside of the section starts.

This is only valid if EndnoteIsRestartNumbering is set.

◆ FileLink

com::sun::star::text::SectionFileLink FileLink

property

If this property is set, then the content of the section is read from the specified document.

◆ FootnoteIsCollectAtTextEnd

boolean FootnoteIsCollectAtTextEnd

property

determines whether footnotes inside the section are displayed at the end of the section text.

◆ FootnoteIsOwnNumbering

boolean FootnoteIsOwnNumbering

property

determines whether the footnotes within the section use an own numbering format.

This is only valid if FootnoteIsRestartNumbering is set.

◆ FootnoteIsRestartNumbering

boolean FootnoteIsRestartNumbering

property

determines whether the footnotes numbering restarts within the section.

This is only valid if FootnoteIsRestartNumbering is set.

◆ FootnoteNumberingPrefix

string FootnoteNumberingPrefix

property

determines the prefix that is display before the footnote number.

This is only valid if FootnoteIsOwnNumbering is set.

◆ FootnoteNumberingSuffix

string FootnoteNumberingSuffix

property

determines the suffix that is display after of the footnote number.

This is only valid if FootnoteIsOwnNumbering is set.

◆ FootnoteNumberingType

short FootnoteNumberingType

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.

◆ FootnoteRestartNumberingAt

short FootnoteRestartNumberingAt

property

determines at which number the footnote numbering inside of the section starts.

This is only valid if FootnoteIsRestartNumbering is set.

◆ IsAutomaticUpdate

boolean IsAutomaticUpdate

property

determines if a DDE link is updated automatically.

◆ IsProtected

boolean IsProtected

property

If this property is TRUE, the text section is protected and cannot be modified from the user interface.

◆ IsVisible

boolean IsVisible

property

If this property is FALSE, the text section is hidden.

◆ LinkRegion

string LinkRegion

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.

◆ SectionLeftMargin

long SectionLeftMargin

optionalproperty

determines the left margin of the section

◆ SectionRightMargin

long SectionRightMargin

optionalproperty

determines the left margin of the section

◆ TextColumns

com::sun::star::text::XTextColumns TextColumns

property

allows columns to be set into the text section

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

com/sun/star/text/TextSection.idl

Included Services

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ com::sun::star::text::TextContent

◆ com::sun::star::xml::UserDefinedAttributesSupplier

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

◆ com::sun::star::beans::XPropertyState

◆ com::sun::star::container::XNamed

◆ com::sun::star::text::XTextSection

Member Data Documentation

◆ BackGraphic

◆ BackGraphicFilter

◆ BackGraphicLocation

◆ BackGraphicURL

◆ Condition

◆ DDECommandElement

◆ DDECommandFile

◆ DDECommandType

◆ EndnoteIsCollectAtTextEnd

◆ EndnoteIsOwnNumbering

◆ EndnoteIsRestartNumbering

◆ EndnoteNumberingPrefix

◆ EndnoteNumberingSuffix

◆ EndnoteNumberingType

◆ EndnoteRestartNumberingAt

◆ FileLink

◆ FootnoteIsCollectAtTextEnd

◆ FootnoteIsOwnNumbering

◆ FootnoteIsRestartNumbering

◆ FootnoteNumberingPrefix

◆ FootnoteNumberingSuffix

◆ FootnoteNumberingType

◆ FootnoteRestartNumberingAt

◆ IsAutomaticUpdate

◆ IsProtected

◆ IsVisible

◆ LinkRegion

◆ SectionLeftMargin

◆ SectionRightMargin

◆ TextColumns