Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: 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 See also ::com::sun::star::sheet::DocumentSettings See also ::com::sun::star::drawing::DocumentSettings See also ::com::sun::star::presentation::DocumentSettings

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

Properties' Summary
ForbiddenCharacters | [ OPTIONAL ] gives access to the set of forbidden characters.
LinkUpdateMode | [ OPTIONAL ] specifies the update mode for links when loading text documents.
PrinterName | printer used by the document.
PrinterSetup | platform and driver dependent printer setup data.
IsKernAsianPunctuation | [ OPTIONAL ] specifies if kerning is applied to Asian punctuation.
CharacterCompressionType | [ OPTIONAL ] specifies the compression (character spacing) type used for Asian characters.
ApplyUserData | [ OPTIONAL ] specifies if the user-specific settings saved within a document should be loaded with the document.
SaveVersionOnClose | [ OPTIONAL ] specifies if a new version is created if a document has been modified and you want to close it.
UpdateFromTemplate | [ OPTIONAL ] specifies if the document should be updated when the template it was created from changes.
FieldAutoUpdate | [ OPTIONAL ] specifies if fields in text documents are updated automatically.
CurrentDatabaseDataSource | [ OPTIONAL ] The name of the globally registered DataSource from which the current data is taken.
CurrentDatabaseCommand | [ OPTIONAL ] a string value, specifying the name of the object displayed currently (or the SQL statement used).
CurrentDatabaseCommandType | [ OPTIONAL ] determines the interpretation of the property DataTableName.
DefaultTabStop | [ OPTIONAL ]
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.
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.
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.
PrintQuality | [ OPTIONAL ]
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.
DashTableURL | [ OPTIONAL ]
LineEndTableURL | [ OPTIONAL ]
HatchTableURL | [ OPTIONAL ]
GradientTableURL | [ OPTIONAL ]
BitmapTableURL | [ OPTIONAL ]
AutoCalculate | [ OPTIONAL ]
PrinterIndependentLayout | [ OPTIONAL ] forbid use of printer metrics for layout

Properties' Details
ForbiddenCharacters
[ readonly ] ::com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; [ 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; [ 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; [ OPTIONAL ] Description specifies if kerning is applied to Asian punctuation. Applies only if kerning is enabled.
CharacterCompressionType
short CharacterCompressionType; [ OPTIONAL ] Description specifies the compression (character spacing) type used for Asian characters. See also ::com::sun::star::text::CharacterCompressionType
ApplyUserData
boolean ApplyUserData; [ OPTIONAL ] Description specifies if the user-specific settings saved within a document should be loaded with the document.
SaveVersionOnClose
boolean SaveVersionOnClose; [ OPTIONAL ] Description specifies if a new version is created if a document has been modified and you want to close it.
UpdateFromTemplate
boolean UpdateFromTemplate; [ 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; [ OPTIONAL ] Description specifies if fields in text documents are updated automatically.
CurrentDatabaseDataSource
string CurrentDatabaseDataSource; [ OPTIONAL ] Description The name of the globally registered DataSource from which the current data is taken. The data source can e.g. be used for feeding a form letter.
CurrentDatabaseCommand
string CurrentDatabaseCommand; [ OPTIONAL ] Description a string value, specifying the name of the object displayed currently (or the SQL statement used).
CurrentDatabaseCommandType
long CurrentDatabaseCommandType; [ OPTIONAL ] Description determines the interpretation of the property DataTableName. See also ::com::sun::star::sdb::CommandType
DefaultTabStop
long DefaultTabStop; [ OPTIONAL ] Description
IsPrintBooklet
boolean IsPrintBooklet; [ 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; [ 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; [ 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; [ OPTIONAL ] Description
ColorTableURL
string ColorTableURL; [ 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; [ OPTIONAL ] Description
LineEndTableURL
string LineEndTableURL; [ OPTIONAL ] Description
HatchTableURL
string HatchTableURL; [ OPTIONAL ] Description
GradientTableURL
string GradientTableURL; [ OPTIONAL ] Description
BitmapTableURL
string BitmapTableURL; [ OPTIONAL ] Description
AutoCalculate
boolean AutoCalculate; [ OPTIONAL ] Description
PrinterIndependentLayout
short PrinterIndependentLayout; [ OPTIONAL ] Description forbid use of printer metrics for layout For supported values see the constants group PrinterIndependentLayout .

Top of Page

Copyright © 2003 Sun Microsystems, Inc.