Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: text ::
service DocumentSettings
Description describes properties that apply to the whole text document.

Included Services - Summary
::com::sun::star::document::Settings | (referenced entity's summary:) describes properties that apply to the whole document of any application.
PrintSettings |

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet | gives access to the properties implemented by this service.

Properties' Summary
boolean ChartAutoUpdate | [ OPTIONAL ] specifies if charts in text documents are updated automatically. This has no effect if "FieldAutoUpdate" is false.
boolean AddParaTableSpacing | [ OPTIONAL ] specifies if spacing between paragraphs and tables is to be added.
boolean AddParaTableSpacingAtStart | [ OPTIONAL ] specifies if top paragraph spacing is applied to paragraphs on the first page of text documents.
boolean AlignTabStopPosition | [ OPTIONAL ] specifies the alignment of tab stops in text documents.
boolean SaveGlobalDocumentLinks | [ OPTIONAL ] specifies if the contents of links in the global document are saved or not.
boolean IsLabelDocument | [ OPTIONAL ] specifies if the document has been created as a label document.
boolean UseFormerLineSpacing | [ OPTIONAL ] specifies if the former (till OpenOffice.org 1.1) or the new line spacing formatting is applied.
boolean AddParaSpacingToTableCells | [ OPTIONAL ] specifies if paragraph and table spacing is added at the bottom of table cells
boolean UseFormerObjectPositioning | [ OPTIONAL ] specifies if the former (till OpenOffice.org 1.1) or the new object positioning is applied.
boolean ConsiderTextWrapOnObjPos | [ OPTIONAL ] specifies if the text wrap of floating screen objects are considered in a specified way in the positioning algorithm.
boolean MathBaselineAlignment | [ OPTIONAL ] specifies if Math objects should automatically vertically aligned to match the baseline of the surrounding text.

Included Services - Details
::com::sun::star::document::Settings
(referenced entity's summary:) describes properties that apply to the whole document of any application.
PrintSettings
Usage Restrictions optional

Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description gives access to the properties implemented by this service.

Properties' Details
ChartAutoUpdate
boolean ChartAutoUpdate; Usage Restrictions optional Description specifies if charts in text documents are updated automatically. This has no effect if "FieldAutoUpdate" is false.
AddParaTableSpacing
boolean AddParaTableSpacing; Usage Restrictions optional Description specifies if spacing between paragraphs and tables is to be added. 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 the objects are to be added this property has to be true.
AddParaTableSpacingAtStart
boolean AddParaTableSpacingAtStart; Usage Restrictions optional Description specifies if top paragraph spacing is applied to paragraphs on the first page of text documents. If true, 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.
AlignTabStopPosition
boolean AlignTabStopPosition; Usage Restrictions optional Description specifies the alignment of tab stops in text documents. If true centered and right-aligned paragraphs containing tabs are formatted as a whole in the center or aligned to the right. If false, 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.
SaveGlobalDocumentLinks
boolean SaveGlobalDocumentLinks; Usage Restrictions optional Description specifies if the contents of links in the global document are saved or not. This property applies only for master documents. Note: This name is a bit misleading, it should be something like `SaveLinkedDocumentContent`.
IsLabelDocument
boolean IsLabelDocument; Usage Restrictions optional Description specifies if the document has been created as a label document. 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.
UseFormerLineSpacing
boolean UseFormerLineSpacing; Usage Restrictions optional Description specifies if the former (till OpenOffice.org 1.1) or the new line spacing formatting is applied. This property controls how a set line spacing at a paragraph influences the formatting of the text lines and the spacing between paragraphs. If true, 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 false (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. Since OOo 2.0
AddParaSpacingToTableCells
boolean AddParaSpacingToTableCells; Usage Restrictions optional Description specifies if paragraph and table spacing is added at the bottom of table cells 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 true (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 false (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. Since OOo 2.0
UseFormerObjectPositioning
boolean UseFormerObjectPositioning; Usage Restrictions optional Description specifies if the former (till OpenOffice.org 1.1) or the new object positioning is applied. This property controls how floating screen objects (Writer fly frames and drawing objects are positioned. If true, 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 false (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. Since OOo 2.0
ConsiderTextWrapOnObjPos
boolean ConsiderTextWrapOnObjPos; Usage Restrictions optional Description specifies if the text wrap of floating screen objects are considered in a specified way in the positioning algorithm. This property controls how floating screen objects (Writer fly frames and drawing objects) are positioned. If true, the object positioning algorithm will consider the text wrap style, set at the floating screen object. The attribute BaseFrameProperties::WrapInfluenceOnPosition specifies how the text wrap is considered. If false (default value), the former object positioning algorithm (known from OpenOffice.org 1.1) is applied. Since OOo 2.0
MathBaselineAlignment
boolean MathBaselineAlignment; Usage Restrictions optional Description specifies if Math objects should automatically vertically aligned to match the baseline of the surrounding text. If activated formula object that are anchored 'As Character' will be vertically aligned to have their baseline match with the one from the text. Since OOo 3.4

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.