service TextSection in module com::sun::star::text::

(Global Index)

Syntax

service TextSection;

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.

Included Services

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

Description

is an object which can be anchored in a text, like instances of TextFrame or TextFields .


Exported Interfaces

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

Description

provide special data of a TextSection .


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

Description

specifies the name of the object.


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

Description

provides information about and access to the properties from an implementation.


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

Description

makes it possible to query information about the state of one or more properties.


Property Summary

Condition This property contains a conditional expression.

IsVisible If this property is false , the text section is hidden.

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

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

LinkRegion specifies the source of a file link in the document that is specified in TextSection::FileLink .

DDECommandType specifies the type of the command string for a DDE operation.

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

DDECommandElement specifies the source element of the command string for a DDE operation.

BackGraphicURL contains the URL for the background graphic.

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

BackGraphicLocation determines the position of the background graphic.

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

FootnoteIsRestartNumbering determins whether the footnotes numbering restarts within the section. This is only valid if FootnoteIsRestartNumbering is set.

FootnoteRestartNumberingAt determins at which number the footnote numbering inside of the section starts. This is only valid if FootnoteIsRestartNumbering is set.

FootnoteIsOwnNumbering determins whether the footnotes within the section use an own numbering format. This is only valid if FootnoteIsRestartNumbering is set.

FootnoteNumberingType determins the numbering type of the footnote numbering as a value of NumberingType . This is only valid if FootnoteIsOwnNumbering is set.

FootnoteNumberingPrefix determins the prefix that is display before the footnote number. This is only valid if FootnoteIsOwnNumbering is set.

FootnoteNumberingSuffix determins the suffix that is display after of the footnote number. This is only valid if FootnoteIsOwnNumbering is set.

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

EndnoteIsRestartNumbering determins whether the endnotes numbering restarts within the section. This is only valid if EndnoteIsRestartNumbering is set.

EndnoteRestartNumberingAt determins at which number the endnote numbering inside of the section starts. This is only valid if EndnoteIsRestartNumbering is set.

EndnoteIsOwnNumbering determins whether the endnotes within the section use an own numbering format. This is only valid if EndnoteIsRestartNumbering is set.

EndnoteNumberingType determins the numbering type of the endnote numbering as a value of NumberingType . This is only valid if EndoteIsOwnNumbering is set.

EndnoteNumberingPrefix determins the prefix that is display before the endnote number. This is only valid if EndnoteIsOwnNumbering is set.

EndnoteNumberingSuffix determins the suffix that is display after the endnote number. This is only valid if EndnoteIsOwnNumbering is set.

IsAutomaticUpdate determins if a DDE link is updated automatically.

TextColumns allows columns to be set into the text section

Property Details



Condition

Syntax

string Condition;

Description

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.


IsVisible

Syntax

boolean IsVisible;

Description

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


IsProtected

Syntax

boolean IsProtected;

Description

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


FileLink

Syntax

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

Description

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


LinkRegion

Syntax

string LinkRegion;

Description

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.


DDECommandType

Syntax

string DDECommandType;

Description

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.


DDECommandFile

Syntax

string DDECommandFile;

Description

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


DDECommandElement

Syntax

string DDECommandElement;

Description

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.


BackGraphicURL

Syntax

string BackGraphicURL;

Description

contains the URL for the background graphic.


BackGraphicFilter

Syntax

string BackGraphicFilter;

Description

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


BackGraphicLocation

Syntax

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

Description

determines the position of the background graphic.

See also

GraphicLocation

FootnoteIsCollectAtTextEnd

Syntax

boolean FootnoteIsCollectAtTextEnd;

Description

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


FootnoteIsRestartNumbering

Syntax

boolean FootnoteIsRestartNumbering;

Description

determins whether the footnotes numbering restarts within the section. This is only valid if FootnoteIsRestartNumbering is set.


FootnoteRestartNumberingAt

Syntax

short FootnoteRestartNumberingAt;

Description

determins at which number the footnote numbering inside of the section starts. This is only valid if FootnoteIsRestartNumbering is set.


FootnoteIsOwnNumbering

Syntax

boolean FootnoteIsOwnNumbering;

Description

determins whether the footnotes within the section use an own numbering format. This is only valid if FootnoteIsRestartNumbering is set.


FootnoteNumberingType

Syntax

short FootnoteNumberingType;

Description

determins the numbering type of the footnote numbering as a value of NumberingType . This is only valid if FootnoteIsOwnNumbering is set.


FootnoteNumberingPrefix

Syntax

string FootnoteNumberingPrefix;

Description

determins the prefix that is display before the footnote number. This is only valid if FootnoteIsOwnNumbering is set.


FootnoteNumberingSuffix

Syntax

string FootnoteNumberingSuffix;

Description

determins the suffix that is display after of the footnote number. This is only valid if FootnoteIsOwnNumbering is set.


EndnoteIsCollectAtTextEnd

Syntax

boolean EndnoteIsCollectAtTextEnd;

Description

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


EndnoteIsRestartNumbering

Syntax

boolean EndnoteIsRestartNumbering;

Description

determins whether the endnotes numbering restarts within the section. This is only valid if EndnoteIsRestartNumbering is set.


EndnoteRestartNumberingAt

Syntax

short EndnoteRestartNumberingAt;

Description

determins at which number the endnote numbering inside of the section starts. This is only valid if EndnoteIsRestartNumbering is set.


EndnoteIsOwnNumbering

Syntax

boolean EndnoteIsOwnNumbering;

Description

determins whether the endnotes within the section use an own numbering format. This is only valid if EndnoteIsRestartNumbering is set.


EndnoteNumberingType

Syntax

short EndnoteNumberingType;

Description

determins the numbering type of the endnote numbering as a value of NumberingType . This is only valid if EndoteIsOwnNumbering is set.


EndnoteNumberingPrefix

Syntax

string EndnoteNumberingPrefix;

Description

determins the prefix that is display before the endnote number. This is only valid if EndnoteIsOwnNumbering is set.


EndnoteNumberingSuffix

Syntax

string EndnoteNumberingSuffix;

Description

determins the suffix that is display after the endnote number. This is only valid if EndnoteIsOwnNumbering is set.


IsAutomaticUpdate

Syntax

boolean IsAutomaticUpdate;

Description

determins if a DDE link is updated automatically.


TextColumns

Syntax

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

Description

allows columns to be set into the text section

Top of Page