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

service TextDocument
Description
A text document is a model component which contains text structured by paragraphs.

Each paragraph and each portion of text can be fitted with some attributes (technically properties).

In addition, all text objects can be searched.

Developers Guide
7.1 Text Documents - Overview
7.3.2 Text Documents - Working with Text Documents - Formatting
7.4.2 Text Documents - Overall Document Features - Settings - Document Properties

Included Services
::com::sun::star::document::OfficeDocument
abstract service which specifies a storable and printable document
Exported Interfaces
XTextDocument
is the main interface of a text document.
::com::sun::star::util::XSearchable
enables the object to look for specified contents of the object (in particular, for a text range which contains a specific string pattern).
::com::sun::star::util::XRefreshable
is supported by objects with data that can be refreshed from a data source.
XFootnotesSupplier
[ OPTIONAL ]
XEndnotesSupplier
[ OPTIONAL ]
::com::sun::star::util::XReplaceable
[ OPTIONAL ]
XPagePrintable
[ OPTIONAL ]
XReferenceMarksSupplier
[ OPTIONAL ]
XLineNumberingSupplier
[ OPTIONAL ]
XChapterNumberingSupplier
[ OPTIONAL ]
::com::sun::star::beans::XPropertySet
[ OPTIONAL ]
XTextGraphicObjectsSupplier
[ OPTIONAL ]
XTextEmbeddedObjectsSupplier
[ OPTIONAL ]
XTextTablesSupplier
[ OPTIONAL ]
::com::sun::star::style::XStyleFamiliesSupplier
[ OPTIONAL ]
::com::sun::star::util::XNumberFormatsSupplier
supplies the collection of ::com::sun::star::util::NumberFormat s (for example, in a document) and the settings belonging to these formats.
Properties' Summary
CharLocale [ OPTIONAL ]
contains the identifier of the default locale of the document.
CharacterCount [ OPTIONAL ]
contains the count of all characters in the document.
ParagraphCount [ OPTIONAL ]
contains the count of all paragraphs in the document.
WordCount [ OPTIONAL ]
contains the count of all words in the document.
WordSeparator [ OPTIONAL ]
contains a string that consists of characters that mark the separation of words in counting the words in a document.
Properties' Details
CharLocale
::com::sun::star::lang::Locale CharLocale;
[ OPTIONAL ]
Description
contains the identifier of the default locale of the document.
CharacterCount
[ readonly ] long CharacterCount;
[ OPTIONAL ]
Description
contains the count of all characters in the document.
ParagraphCount
[ readonly ] long ParagraphCount;
[ OPTIONAL ]
Description
contains the count of all paragraphs in the document.
WordCount
[ readonly ] long WordCount;
[ OPTIONAL ]
Description
contains the count of all words in the document.
See also
WordSeparator
WordSeparator
string WordSeparator;
[ OPTIONAL ]
Description
contains a string that consists of characters that mark the separation of words in counting the words in a document.

I.e. slash and backslash. Whitespaces (tab stop, space, paragraph break, line break) always separate words.

See also
WordCount

 
Top of Page