<html> <head> <title>Service DocumentSettings</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="DocumentSettings-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</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 DocumentSettings</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>describes properties that apply to the whole text document. </dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/Settings.html">Settings</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>describes properties that apply to the whole document of any application. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="PrintSettings.html">PrintSettings</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="PrintPreviewSettings.html">PrintPreviewSettings</a></td> <td class="imsum_right"/></tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</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"><p>gives access to the properties implemented by this service. </p> </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">boolean<br> <a href="#ChartAutoUpdate">ChartAutoUpdate</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if charts in text documents are updated automatically. This has no effect if 'FieldAutoUpdate' is <b>false</b>. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AddParaTableSpacing">AddParaTableSpacing</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if spacing between paragraphs and tables is to be added. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AddParaTableSpacingAtStart">AddParaTableSpacingAtStart</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if top paragraph spacing is applied to paragraphs on the first page of text documents. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AlignTabStopPosition">AlignTabStopPosition</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the alignment of tab stops in text documents. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SaveGlobalDocumentLinks">SaveGlobalDocumentLinks</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if the contents of links in the global document are saved or not. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsLabelDocument">IsLabelDocument</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if the document has been created as a label document. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseFormerLineSpacing">UseFormerLineSpacing</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if the former (till OpenOffice.org 1.1) or the new line spacing formatting is applied. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AddParaSpacingToTableCells">AddParaSpacingToTableCells</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if paragraph and table spacing is added at the bottom of table cells </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseFormerObjectPositioning">UseFormerObjectPositioning</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if the former (till OpenOffice.org 1.1) or the new object positioning is applied. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ConsiderTextWrapOnObjPos">ConsiderTextWrapOnObjPos</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies if the text wrap of floating screen objects are considered in a specified way in the positioning algorithm. </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="Settings" class="membertitle">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/Settings.html">Settings</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>describes properties that apply to the whole document of any application. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="PrintSettings" class="membertitle"><a href="PrintSettings.html">PrintSettings</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="PrintPreviewSettings" class="membertitle"><a href="PrintPreviewSettings.html">PrintPreviewSettings</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>gives access to the properties implemented by this service. </dd> </dl> </td> </tr> </table> </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="ChartAutoUpdate" class="membertitle">ChartAutoUpdate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ChartAutoUpdate</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if charts in text documents are updated automatically. This has no effect if 'FieldAutoUpdate' is <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AddParaTableSpacing" class="membertitle">AddParaTableSpacing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AddParaTableSpacing</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if spacing between paragraphs and tables is to be added. </dd> <dd><p>If between two paragraphs, two tables, or a paragraph and a table, you have defined spacing above and below each object, usually only the larger one of the two spaces is used. If the spacing between hte objects are to be added this property has to be <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AddParaTableSpacingAtStart" class="membertitle">AddParaTableSpacingAtStart</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AddParaTableSpacingAtStart</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if top paragraph spacing is applied to paragraphs on the first page of text documents. </dd> <dd><p>If <b>true</b>, the paragraph or table spacing to the top will also be effective at the beginning of a page or column if the paragraph or table is positioned on the first page of the document. The same applies for a page break.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AlignTabStopPosition" class="membertitle">AlignTabStopPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AlignTabStopPosition</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the alignment of tab stops in text documents. </dd> <dd><p>If <b>true</b> centered and right-aligned paragraphs containing tabs are formatted as a whole in the center or aligned to the right. If <b>false</b>, only the text to the right of the last tab, for example, is aligned to the right, while the text to the left remains where it is.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SaveGlobalDocumentLinks" class="membertitle">SaveGlobalDocumentLinks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SaveGlobalDocumentLinks</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if the contents of links in the global document are saved or not. </dd> <dd><p>This property applies only for master documents.</p> <p><em>Note</em>: This name is a bit misleading, it should be something like <code>SaveLinkedDocumentContent</code>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsLabelDocument" class="membertitle">IsLabelDocument</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsLabelDocument</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if the document has been created as a label document. </dd> <dd><p>This property indicates that the document contains multiple text frames and that the content of one frame is duplicated into the other frames by internally linked text sections.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseFormerLineSpacing" class="membertitle">UseFormerLineSpacing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseFormerLineSpacing</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if the former (till OpenOffice.org 1.1) or the new line spacing formatting is applied. </dd> <dd><p>This property controls how a set line spacing at a paragraph influences the formatting of the text lines and the spacing between paragraphs. If <b>true</b>, the formatting till OpenOffice.org 1.1 is applied. This means, that a proportional line spacing is applied above and below a text line and that the maximum of the line spacing value between two paragraph is added respectively reckoned up with the paragraph spacing (adding or reckoning up is controlled by document option AddParaTableSpacing). If <b>false</b> (default for documents since OpenOffice.org 2.0), a proportional line spacing is only applied below a text line and it's always added to the paragraph spacing between two paragraphs.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AddParaSpacingToTableCells" class="membertitle">AddParaSpacingToTableCells</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AddParaSpacingToTableCells</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if paragraph and table spacing is added at the bottom of table cells </dd> <dd><p>This property controls, if the spacing of the last paragraph respectively table of a table cell is added at the bottom of this table cells If <b>true</b> (default for documents since OpenOffice.org 2.0), the spacing of the last paragraph respectively table of a table cell is added at the bottom of this table cell. If <b>false</b> (typically for documents till OpenOffice.org 1.1), the spacing of the last paragraph respectively table of a table cell isn't added at the bottom of this table cell.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseFormerObjectPositioning" class="membertitle">UseFormerObjectPositioning</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseFormerObjectPositioning</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if the former (till OpenOffice.org 1.1) or the new object positioning is applied. </dd> <dd><p>This property controls how floating screen objects (Writer fly frames and drawing objects are positioned. If <b>true</b>, the object positioning till OpenOffice.org 1.1 is applied. This means, that the top of a paragraph, at which a floating screen object orients its vertical position, includes the lower spacing and the line spacing of the previous paragraph. If <b>false</b> (default for documents since OpenOffice.org 2.0), the top of a paragraph, at which a floating screen object orients its vertical position, doesn't include the lower spacing and the line spacing of the previous paragraph.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ConsiderTextWrapOnObjPos" class="membertitle">ConsiderTextWrapOnObjPos</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ConsiderTextWrapOnObjPos</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies if the text wrap of floating screen objects are considered in a specified way in the positioning algorithm. </dd> <dd><p>This property controls how floating screen objects (Writer fly frames and drawing objects) are positioned. If <b>true</b>, the object positioning algorithm will consider the text wrap style, set at the floating screen object. The attribute <a href="BaseFrameProperties.html">BaseFrameProperties</a>::<a href="BaseFrameProperties.html#WrapInfluenceOnPosition">WrapInfluenceOnPosition</a> specifies how the text wrap is considered. If <b>false</b> (default value), the former object positioning algorithm (known from OpenOffice.org 1.1) is applied.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</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 © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>