English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service GenericTextDocument
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).

Its declared as generic text document, because its function is needed by different derived services (TextDocument/WebDocument/GlobalDocument).

In addition, all text objects can be searched.


Included Services - Summary
::com::sun::star::document::OfficeDocument
(referenced entity's summary:)
abstract service which specifies a storable and printable document
Exported Interfaces - Summary
::com::sun::star::lang::XMultiServiceFactory

provides methods to create instances of several text document services. A text document provides several services which need the context of a text document and these text document dependent services are created at the text document directly and not over the global service manager.

XTextDocument
(referenced entity's summary:)
is the main interface of a text document.
::com::sun::star::util::XSearchable
(referenced entity's summary:)
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
(referenced entity's summary:)
is supported by objects with data that can be refreshed from a data source.
XFootnotesSupplier
XEndnotesSupplier
::com::sun::star::util::XReplaceable
XPagePrintable
XReferenceMarksSupplier
XLineNumberingSupplier
XChapterNumberingSupplier
::com::sun::star::beans::XPropertySet
XTextGraphicObjectsSupplier
XTextEmbeddedObjectsSupplier
XTextTablesSupplier
::com::sun::star::style::XStyleFamiliesSupplier
XBookmarksSupplier
XDocumentIndexesSupplier
XTextFieldsSupplier
XTextFramesSupplier
XTextSectionsSupplier
::com::sun::star::util::XNumberFormatsSupplier
Properties' Summary
::com::sun::star::lang::Locale
CharLocale
[ OPTIONAL ]
contains the identifier of the default locale of the document.  
[ readonly ] long
CharacterCount
[ OPTIONAL ]
contains the count of all characters in the document.  
[ readonly ] long
ParagraphCount
[ OPTIONAL ]
contains the count of all paragraphs in the document.  
[ readonly ] long
WordCount
[ OPTIONAL ]
contains the count of all words in the document. 
string
WordSeparator
[ OPTIONAL ]
contains a string that consists of characters that mark the separation of words in counting the words in a document.  
string
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. * *  
boolean
RecordChanges
[ OPTIONAL ]
specifies if change recording is active. * *  
short
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 * *  
Included Services - Details
::com::sun::star::document::OfficeDocument
(referenced entity's summary:)
abstract service which specifies a storable and printable document
Exported Interfaces - Details
::com::sun::star::lang::XMultiServiceFactory
Description
provides methods to create instances of several text document services. A text document provides several services which need the context of a text document and these text document dependent services are created at the text document directly and not over the global service manager.
XTextDocument
(referenced entity's summary:)
is the main interface of a text document.
::com::sun::star::util::XSearchable
(referenced entity's summary:)
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
(referenced entity's summary:)
is supported by objects with data that can be refreshed from a data source.
XFootnotesSupplier
Usage Restrictions
optional
XEndnotesSupplier
Usage Restrictions
optional
::com::sun::star::util::XReplaceable
Usage Restrictions
optional
XPagePrintable
Usage Restrictions
optional
XReferenceMarksSupplier
Usage Restrictions
optional
XLineNumberingSupplier
Usage Restrictions
optional
XChapterNumberingSupplier
Usage Restrictions
optional
::com::sun::star::beans::XPropertySet
Usage Restrictions
optional
XTextGraphicObjectsSupplier
Usage Restrictions
optional
XTextEmbeddedObjectsSupplier
Usage Restrictions
optional
XTextTablesSupplier
Usage Restrictions
optional
::com::sun::star::style::XStyleFamiliesSupplier
Usage Restrictions
optional
XBookmarksSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
XDocumentIndexesSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
XTextFieldsSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
XTextFramesSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
XTextSectionsSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
::com::sun::star::util::XNumberFormatsSupplier
Usage Restrictions
optional
Since
OOo 1.1.2
Properties' Details
CharLocale
::com::sun::star::lang::Locale CharLocale;
Usage Restrictions
optional
Description
contains the identifier of the default locale of the document.
CharacterCount
[ readonly ] long CharacterCount;
Usage Restrictions
optional
Description
contains the count of all characters in the document.
ParagraphCount
[ readonly ] long ParagraphCount;
Usage Restrictions
optional
Description
contains the count of all paragraphs in the document.
WordCount
[ readonly ] long WordCount;
Usage Restrictions
optional
Description
contains the count of all words in the document.
See also
WordSeparator
WordSeparator
string WordSeparator;
Usage Restrictions
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;
Usage Restrictions
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
OOo 1.1.2
RecordChanges
boolean RecordChanges;
Usage Restrictions
optional
Description
specifies if change recording is active. * *
Since
OOo 1.1.2
TwoDigitYear
short TwoDigitYear;
Usage Restrictions
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
OOo 1.1.2

 
Top of Page

Logo ApacheCon Europe 2014

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.