Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: 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 ]
XBookmarksSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1
XDocumentIndexesSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1
XTextFieldsSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1
XTextFramesSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1
XTextSectionsSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1
::com::sun::star::util::XNumberFormatsSupplier | [ OPTIONAL ] Since version OpenOffice.org 1.1.1

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.
IndexAutoMarkFileURL | [ OPTIONAL ] specifies the concordance file taken into account when * creating an index. * * When no concordance file should be used the string is empty. * Used for text documents only. * *
RecordChanges | [ OPTIONAL ] specifies if change recording is active. * *
TwoDigitYear | [ OPTIONAL ] specifies the first 4 digit year to be used when years * are given in 2 digits. * * Example: if set to 1930 * Oct-12-29 will be interpreted as Oct-12-2029 * Oct-12-30 will be interpreted as Oct-12-1930 * Oct-12-02 will be interpreted as Oct-12-2002 * *

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
IndexAutoMarkFileURL
string IndexAutoMarkFileURL; [ OPTIONAL ] Description specifies the concordance file taken into account when * creating an index. * * When no concordance file should be used the string is empty. * Used for text documents only. * * Since version OpenOffice.org 1.1.1
RecordChanges
boolean RecordChanges; [ OPTIONAL ] Description specifies if change recording is active. * * Since version OpenOffice.org 1.1.1
TwoDigitYear
short TwoDigitYear; [ OPTIONAL ] Description specifies the first 4 digit year to be used when years * are given in 2 digits. * * Example: if set to 1930 * Oct-12-29 will be interpreted as Oct-12-2029 * Oct-12-30 will be interpreted as Oct-12-1930 * Oct-12-02 will be interpreted as Oct-12-2002 * * Since version OpenOffice.org 1.1.1

Top of Page

Copyright © 2003 Sun Microsystems, Inc.