<html> <head> <title>Service GenericTextDocument</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="GenericTextDocument-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">text</a> :: </p> </td> </tr> <tr> <td class="title">service GenericTextDocument</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A text document is a model component which contains text structured by paragraphs. </dd> <dd><p>Each paragraph and each portion of text can be fitted with some attributes (technically properties).</p> <p>Its declared as generic text document, because its function is needed by different derived services (TextDocument/WebDocument/GlobalDocument).</p> <p>In addition, all text objects can be searched.</p> </dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>abstract service which specifies a storable and printable document </dd> </dl> </td> </tr> </table> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>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. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextDocument.html">XTextDocument</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is the main interface of a text document.</dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XSearchable.html">XSearchable</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>enables the object to look for specified contents of the object (in particular, for a text range which contains a specific string pattern). </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XRefreshable.html">XRefreshable</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is supported by objects with data that can be refreshed from a data source. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XFootnotesSupplier.html">XFootnotesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XEndnotesSupplier.html">XEndnotesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XReplaceable.html">XReplaceable</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XPagePrintable.html">XPagePrintable</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XReferenceMarksSupplier.html">XReferenceMarksSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XLineNumberingSupplier.html">XLineNumberingSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XChapterNumberingSupplier.html">XChapterNumberingSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextGraphicObjectsSupplier.html">XTextGraphicObjectsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextEmbeddedObjectsSupplier.html">XTextEmbeddedObjectsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextTablesSupplier.html">XTextTablesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/XStyleFamiliesSupplier.html">XStyleFamiliesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XBookmarksSupplier.html">XBookmarksSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentIndexesSupplier.html">XDocumentIndexesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextFieldsSupplier.html">XTextFieldsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextFramesSupplier.html">XTextFramesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XTextSectionsSupplier.html">XTextSectionsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XNumberFormatsSupplier.html">XNumberFormatsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a><br> <a href="#CharLocale">CharLocale</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the identifier of the default locale of the document. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#CharacterCount">CharacterCount</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the count of all characters in the document. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#ParagraphCount">ParagraphCount</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the count of all paragraphs in the document. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#WordCount">WordCount</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the count of all words in the document. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#WordSeparator">WordSeparator</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains a string that consists of characters that mark the separation of words in counting the words in a document. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#IndexAutoMarkFileURL">IndexAutoMarkFileURL</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>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. * * </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#RecordChanges">RecordChanges</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if change recording is active. * * </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#TwoDigitYear">TwoDigitYear</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>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 * * </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="CharLocale" class="membertitle">CharLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <b>CharLocale</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the identifier of the default locale of the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharacterCount" class="membertitle">CharacterCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>CharacterCount</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the count of all characters in the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ParagraphCount" class="membertitle">ParagraphCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>ParagraphCount</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the count of all paragraphs in the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="WordCount" class="membertitle">WordCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>WordCount</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the count of all words in the document.</dd> <dt><b>See also</b></dt> <dd><a href="#WordSeparator">WordSeparator</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="WordSeparator" class="membertitle">WordSeparator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>WordSeparator</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains a string that consists of characters that mark the separation of words in counting the words in a document. </dd> <dd><p> I.e. slash and backslash. Whitespaces (tab stop, space, paragraph break, line break) always separate words.</p></dd> <dt><b>See also</b></dt> <dd><a href="#WordCount">WordCount</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IndexAutoMarkFileURL" class="membertitle">IndexAutoMarkFileURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>IndexAutoMarkFileURL</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>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. * * </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RecordChanges" class="membertitle">RecordChanges</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>RecordChanges</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if change recording is active. * * </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TwoDigitYear" class="membertitle">TwoDigitYear</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>TwoDigitYear</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>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 * * </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
6468
