Properties' Summary |
string
Condition |
This property contains a conditional expression.
|
boolean
IsVisible |
If this property is false, the text section is hidden.
|
boolean
IsProtected |
If this property is true, the text section is protected
and cannot be modified from the user interface.
|
SectionFileLink
FileLink |
If this property is set, then the content of the section is read
from the specified document.
|
string
LinkRegion |
specifies the source of a file link in the document that is
specified in TextSection::FileLink.
|
string
DDECommandType |
specifies the type of the command string for a DDE operation.
|
string
DDECommandFile |
specifies the source file name of the command string for a DDE operation.
|
string
DDECommandElement |
specifies the source element of the command string for a DDE operation.
|
string
BackGraphicURL |
contains the URL for the background graphic.
|
string
BackGraphicFilter |
contains the name of the file filter for the background graphic.
|
::com::sun::star::style::GraphicLocation
BackGraphicLocation |
determines the position of the background graphic.
|
boolean
FootnoteIsCollectAtTextEnd |
determines whether footnotes inside the section are displayed at the end of the
section text.
|
boolean
FootnoteIsRestartNumbering |
determines whether the footnotes numbering restarts within the section.
This is only valid if FootnoteIsRestartNumbering is set.
|
short
FootnoteRestartNumberingAt |
determines at which number the footnote numbering inside of the section starts.
This is only valid if FootnoteIsRestartNumbering is set.
|
boolean
FootnoteIsOwnNumbering |
determines whether the footnotes within the section use an own numbering format.
This is only valid if FootnoteIsRestartNumbering is set.
|
short
FootnoteNumberingType |
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.
|
string
FootnoteNumberingPrefix |
determines the prefix that is display before the footnote number.
This is only valid if FootnoteIsOwnNumbering is set.
|
string
FootnoteNumberingSuffix |
determines the suffix that is display after of the footnote number.
This is only valid if FootnoteIsOwnNumbering is set.
|
boolean
EndnoteIsCollectAtTextEnd |
determines whether endnotes inside the section are displayed at the end of the
section text.
|
boolean
EndnoteIsRestartNumbering |
determines whether the endnotes numbering restarts within the section.
This is only valid if EndnoteIsRestartNumbering is set.
|
short
EndnoteRestartNumberingAt |
determines at which number the endnote numbering inside of the section starts.
This is only valid if EndnoteIsRestartNumbering is set.
|
boolean
EndnoteIsOwnNumbering |
determines whether the endnotes within the section use an own numbering format.
This is only valid if EndnoteIsRestartNumbering is set.
|
short
EndnoteNumberingType |
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.
|
string
EndnoteNumberingPrefix |
determines the prefix that is display before the endnote number.
This is only valid if EndnoteIsOwnNumbering is set.
|
string
EndnoteNumberingSuffix |
determines the suffix that is display after the endnote number.
This is only valid if EndnoteIsOwnNumbering is set.
|
boolean
IsAutomaticUpdate |
determines if a DDE link is updated automatically.
|
XTextColumns
TextColumns |
allows columns to be set into the text section
|
long
SectionLeftMargin |
[ OPTIONAL ]
determines the left margin of the section
|
long
SectionRightMargin |
[ OPTIONAL ]
determines the left margin of the section
|
Properties' Details |
Condition
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
boolean IsVisible;
- Description
- If this property is false, the text section is hidden.
|
|
IsProtected
boolean IsProtected;
- Description
- If this property is true, the text section is protected
and cannot be modified from the user interface.
|
|
FileLink
SectionFileLink FileLink;
- Description
- If this property is set, then the content of the section is read
from the specified document.
|
|
LinkRegion
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
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
string DDECommandFile;
- Description
- specifies the source file name of the command string for a DDE operation.
|
|
DDECommandElement
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
string BackGraphicURL;
- Description
- contains the URL for the background graphic.
|
|
BackGraphicFilter
string BackGraphicFilter;
- Description
- contains the name of the file filter for the background graphic.
|
|
BackGraphicLocation
|
FootnoteIsCollectAtTextEnd
boolean FootnoteIsCollectAtTextEnd;
- Description
- determines whether footnotes inside the section are displayed at the end of the
section text.
|
|
FootnoteIsRestartNumbering
boolean FootnoteIsRestartNumbering;
- Description
- determines whether the footnotes numbering restarts within the section.
This is only valid if
FootnoteIsRestartNumbering is set.
|
|
FootnoteRestartNumberingAt
short FootnoteRestartNumberingAt;
- Description
- determines at which number the footnote numbering inside of the section starts.
This is only valid if
FootnoteIsRestartNumbering is set.
|
|
FootnoteIsOwnNumbering
boolean FootnoteIsOwnNumbering;
- Description
- determines whether the footnotes within the section use an own numbering format.
This is only valid if
FootnoteIsRestartNumbering is set.
|
|
FootnoteNumberingType
short FootnoteNumberingType;
- Description
- 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.
|
|
FootnoteNumberingPrefix
string FootnoteNumberingPrefix;
- Description
- determines the prefix that is display before the footnote number.
This is only valid if
FootnoteIsOwnNumbering is set.
|
|
FootnoteNumberingSuffix
string FootnoteNumberingSuffix;
- Description
- determines the suffix that is display after of the footnote number.
This is only valid if
FootnoteIsOwnNumbering is set.
|
|
EndnoteIsCollectAtTextEnd
boolean EndnoteIsCollectAtTextEnd;
- Description
- determines whether endnotes inside the section are displayed at the end of the
section text.
|
|
EndnoteIsRestartNumbering
boolean EndnoteIsRestartNumbering;
- Description
- determines whether the endnotes numbering restarts within the section.
This is only valid if
EndnoteIsRestartNumbering is set.
|
|
EndnoteRestartNumberingAt
short EndnoteRestartNumberingAt;
- Description
- determines at which number the endnote numbering inside of the section starts.
This is only valid if
EndnoteIsRestartNumbering is set.
|
|
EndnoteIsOwnNumbering
boolean EndnoteIsOwnNumbering;
- Description
- determines whether the endnotes within the section use an own numbering format.
This is only valid if
EndnoteIsRestartNumbering is set.
|
|
EndnoteNumberingType
short EndnoteNumberingType;
- Description
- 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.
|
|
EndnoteNumberingPrefix
string EndnoteNumberingPrefix;
- Description
- determines the prefix that is display before the endnote number.
This is only valid if
EndnoteIsOwnNumbering is set.
|
|
EndnoteNumberingSuffix
string EndnoteNumberingSuffix;
- Description
- determines the suffix that is display after the endnote number.
This is only valid if
EndnoteIsOwnNumbering is set.
|
|
IsAutomaticUpdate
boolean IsAutomaticUpdate;
- Description
- determines if a DDE link is updated automatically.
|
|
TextColumns
XTextColumns TextColumns;
- Description
- allows columns to be set into the text section
|
|
SectionLeftMargin
long SectionLeftMargin;
- Usage Restrictions
- optional
- Description
- determines the left margin of the section
|
|
SectionRightMargin
long SectionRightMargin;
- Usage Restrictions
- optional
- Description
- determines the left margin of the section
|
|
Copyright © 2024, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.