Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

service Settings
Description
describes properties that apply to the whole document of any application.

For application specific settings, please refer to the individual services.

See also
::com::sun::star::text::DocumentSettings, ::com::sun::star::sheet::DocumentSettings, ::com::sun::star::drawing::DocumentSettings, ::com::sun::star::presentation::DocumentSettings

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet

gives access to the properties implemented by this service.

Properties' Summary
::com::sun::star::i18n::XForbiddenCharacters
ForbiddenCharacters
[ OPTIONAL ]
gives access to the set of forbidden characters.  
short
LinkUpdateMode
[ OPTIONAL ]
specifies the update mode for links when loading text documents.  
string
PrinterName
printer used by the document.  
sequence< byte >
PrinterSetup
platform and driver dependent printer setup data.  
boolean
IsKernAsianPunctuation
[ OPTIONAL ]
specifies if kerning is applied to Asian punctuation.  
short
CharacterCompressionType
[ OPTIONAL ]
specifies the compression (character spacing) type used for Asian characters.  
boolean
ApplyUserData
[ OPTIONAL ]
specifies if the user-specific settings saved within a document should be loaded with the document.  
boolean
SaveVersionOnClose
[ OPTIONAL ]
specifies if a new version is created if a document has been modified and you want to close it.  
boolean
UpdateFromTemplate
[ OPTIONAL ]
specifies if the document should be updated when the template it was created from changes.  
boolean
FieldAutoUpdate
[ OPTIONAL ]
specifies if fields in text documents are updated automatically.  
string
CurrentDatabaseDataSource
[ OPTIONAL ]
The name of the globally registered ::com::sun::star::sdb::DataSource from which the current data is taken.  
string
CurrentDatabaseCommand
[ OPTIONAL ]
a string value, specifying the name of the object displayed currently (or the SQL statement used).  
long
CurrentDatabaseCommandType
[ OPTIONAL ]
determines the interpretation of the property DataTableName.  
long
DefaultTabStop
[ OPTIONAL ]
 
boolean
IsPrintBooklet
[ OPTIONAL ]
determines if the document will be printed as a booklet (brochure), i.e., two document pages are put together on one physical page, such that you can fold the print result and get a booklet.  
boolean
IsPrintBookletFront
[ OPTIONAL ]
is only effective, if IsPrintBooklet is true. If this property is also true, only the fronts of the pages of your booklet are printed.  
boolean
IsPrintBookletBack
[ OPTIONAL ]
is only effective, if IsPrintBooklet is true. If this property is also true, only the backs of the pages of your booklet are printed.  
long
PrintQuality
[ OPTIONAL ]
 
string
ColorTableURL
[ OPTIONAL ]
contains the URL that points to a color table (file extension .soc) that will be used for showing a palette in dialogs using colors.  
string
DashTableURL
[ OPTIONAL ]
 
string
LineEndTableURL
[ OPTIONAL ]
 
string
HatchTableURL
[ OPTIONAL ]
 
string
GradientTableURL
[ OPTIONAL ]
 
string
BitmapTableURL
[ OPTIONAL ]
 
boolean
AutoCalculate
[ OPTIONAL ]
 
short
PrinterIndependentLayout
[ OPTIONAL ]
forbid use of printer metrics for layout  
boolean
AddExternalLeading
[ OPTIONAL ]
layout engine should add value of a Font's 'external leading' * attribute to the line spacing.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description
gives access to the properties implemented by this service.
Properties' Details
ForbiddenCharacters
::com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
Usage Restrictions
optional
Description
gives access to the set of forbidden characters.
Returns
the ::com::sun::star::i18n::XForbiddenCharacters interface to allow retreival and modification of the forbidden characters set.
LinkUpdateMode
short LinkUpdateMode;
Usage Restrictions
optional
Description
specifies the update mode for links when loading text documents.

For supported values see the constants group LinkUpdateModes.

PrinterName
string PrinterName;
Description
printer used by the document.
PrinterSetup
sequence< byte > PrinterSetup;
Description
platform and driver dependent printer setup data.

This property serves to capture the current printer setup settings, such as paper tray, printer options, etc. The data can typically be interpreted only by the system that generated it. The PrinterSetup property may be used to save and restore the user's printer settings.

IsKernAsianPunctuation
boolean IsKernAsianPunctuation;
Usage Restrictions
optional
Description
specifies if kerning is applied to Asian punctuation.

Applies only if kerning is enabled.

CharacterCompressionType
short CharacterCompressionType;
Usage Restrictions
optional
Description
specifies the compression (character spacing) type used for Asian characters.
See also
::com::sun::star::text::CharacterCompressionType
ApplyUserData
boolean ApplyUserData;
Usage Restrictions
optional
Description
specifies if the user-specific settings saved within a document should be loaded with the document.
SaveVersionOnClose
boolean SaveVersionOnClose;
Usage Restrictions
optional
Description
specifies if a new version is created if a document has been modified and you want to close it.
UpdateFromTemplate
boolean UpdateFromTemplate;
Usage Restrictions
optional
Description
specifies if the document should be updated when the template it was created from changes.

Applies only for documents that were created from a template.

FieldAutoUpdate
boolean FieldAutoUpdate;
Usage Restrictions
optional
Description
specifies if fields in text documents are updated automatically.
CurrentDatabaseDataSource
string CurrentDatabaseDataSource;
Usage Restrictions
optional
Description
The name of the globally registered ::com::sun::star::sdb::DataSource from which the current data is taken.

The data source can e.g. be used for feeding a form letter.

CurrentDatabaseCommand
string CurrentDatabaseCommand;
Usage Restrictions
optional
Description
a string value, specifying the name of the object displayed currently (or the SQL statement used).
CurrentDatabaseCommandType
long CurrentDatabaseCommandType;
Usage Restrictions
optional
Description
determines the interpretation of the property DataTableName.
See also
::com::sun::star::sdb::CommandType
DefaultTabStop
long DefaultTabStop;
Usage Restrictions
optional
IsPrintBooklet
boolean IsPrintBooklet;
Usage Restrictions
optional
Description
determines if the document will be printed as a booklet (brochure), i.e., two document pages are put together on one physical page, such that you can fold the print result and get a booklet.

Note, that you have to print in duplex mode, if both, IsPrintBookletFront and IsPrintBookletBack are set to true.

IsPrintBookletFront
boolean IsPrintBookletFront;
Usage Restrictions
optional
Description
is only effective, if IsPrintBooklet is true. If this property is also true, only the fronts of the pages of your booklet are printed.

This is especially useful, if your printer does not supply duplex printing.

IsPrintBookletBack
boolean IsPrintBookletBack;
Usage Restrictions
optional
Description
is only effective, if IsPrintBooklet is true. If this property is also true, only the backs of the pages of your booklet are printed.

This is especially useful, if your printer does not supply duplex printing.

PrintQuality
long PrintQuality;
Usage Restrictions
optional
ColorTableURL
string ColorTableURL;
Usage Restrictions
optional
Description
contains the URL that points to a color table (file extension .soc) that will be used for showing a palette in dialogs using colors.
DashTableURL
string DashTableURL;
Usage Restrictions
optional
LineEndTableURL
string LineEndTableURL;
Usage Restrictions
optional
HatchTableURL
string HatchTableURL;
Usage Restrictions
optional
GradientTableURL
string GradientTableURL;
Usage Restrictions
optional
BitmapTableURL
string BitmapTableURL;
Usage Restrictions
optional
AutoCalculate
boolean AutoCalculate;
Usage Restrictions
optional
PrinterIndependentLayout
short PrinterIndependentLayout;
Usage Restrictions
optional
Description
forbid use of printer metrics for layout

For supported values see the constants group PrinterIndependentLayout.

AddExternalLeading
boolean AddExternalLeading;
Usage Restrictions
optional
Description
layout engine should add value of a Font's 'external leading' * attribute to the line spacing.

 
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.