describes properties that apply to the whole document of any application. More...

import "Settings.idl";

Inheritance diagram for Settings:

Public Types
typedef sequence< byte >	PrinterSetup
	platform and driver dependent printer setup data.

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

Public Attributes
com::sun::star::i18n::XForbiddenCharacters	ForbiddenCharacters
	gives access to the set of forbidden characters.
short	LinkUpdateMode
	specifies the update mode for links when loading text documents.
string	PrinterName
	printer used by the document.
boolean	IsKernAsianPunctuation
	specifies if kerning is applied to Asian punctuation.
short	CharacterCompressionType
	specifies the compression (character spacing) type used for Asian characters.
boolean	ApplyUserData
	specifies if the user-specific settings saved within a document should be loaded with the document.
boolean	SaveVersionOnClose
	specifies if a new version is created if a document has been modified and you want to close it.
boolean	UpdateFromTemplate
	specifies if the document should be updated when the template it was created from changes.
boolean	FieldAutoUpdate
	specifies if fields in text documents are updated automatically.
string	CurrentDatabaseDataSource
	The name of the globally registered com::sun::star::sdb::DataSource from which the current data is taken.
string	CurrentDatabaseCommand
	a string value, specifying the name of the object displayed currently (or the SQL statement used).
long	CurrentDatabaseCommandType
	determines the interpretation of the property DataTableName.
long	DefaultTabStop
boolean	IsPrintBooklet
	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
	is only effective, if IsPrintBooklet is TRUE.
boolean	IsPrintBookletBack
	is only effective, if IsPrintBooklet is TRUE.
long	PrintQuality
	how printing uses color.
string	ColorTableURL
	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
string	LineEndTableURL
string	HatchTableURL
string	GradientTableURL
string	BitmapTableURL
boolean	AutoCalculate
short	PrinterIndependentLayout
	forbid use of printer metrics for layout
boolean	AddExternalLeading
	layout engine should add value of a Font's "external leading" attribute to the line spacing.
boolean	EmbedFonts
	Whether to embed fonts used by the document (see e.g.
boolean	EmbedSystemFonts
	Whether to embed also system fonts used by the document.
boolean	EmbedOnlyUsedFonts
	Whether to embed only the fonts that are used in the document.
boolean	EmbedLatinScriptFonts
	Whether to embed Latin script fonts.
boolean	EmbedAsianScriptFonts
	Whether to embed Asian script fonts.
boolean	EmbedComplexScriptFonts
	Whether to embed Complex script fonts.

Additional Inherited Members
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()
void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name.
any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property.
void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list.
void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName.
void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list.
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object.
void	acquire ()
	increases the reference counter by one.
void	release ()
	decreases the reference counter by one.

Detailed 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

Member Typedef Documentation

◆ PrinterSetup

sequence< byte > PrinterSetup

property

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.

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

gives access to the properties implemented by this service.

Member Data Documentation

◆ AddExternalLeading

boolean AddExternalLeading

optionalproperty

layout engine should add value of a Font's "external leading" attribute to the line spacing.

◆ ApplyUserData

boolean ApplyUserData

optionalproperty

specifies if the user-specific settings saved within a document should be loaded with the document.

◆ AutoCalculate

boolean AutoCalculate

optionalproperty

◆ BitmapTableURL

string BitmapTableURL

optionalproperty

◆ CharacterCompressionType

short CharacterCompressionType

optionalproperty

specifies the compression (character spacing) type used for Asian characters.

See also: com::sun::star::text::CharacterCompressionType

◆ ColorTableURL

string ColorTableURL

optionalproperty

contains the URL that points to a color table (file extension .soc) that will be used for showing a palette in dialogs using colors.

◆ CurrentDatabaseCommand

string CurrentDatabaseCommand

optionalproperty

a string value, specifying the name of the object displayed currently (or the SQL statement used).

◆ CurrentDatabaseCommandType

long CurrentDatabaseCommandType

optionalproperty

determines the interpretation of the property DataTableName.

See also: com::sun::star::sdb::CommandType

◆ CurrentDatabaseDataSource

string CurrentDatabaseDataSource

optionalproperty

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.

◆ DashTableURL

string DashTableURL

optionalproperty

◆ DefaultTabStop

long DefaultTabStop

optionalproperty

◆ EmbedAsianScriptFonts

boolean EmbedAsianScriptFonts

optionalproperty

Whether to embed Asian script fonts.

Since: LibreOffice 6.2

◆ EmbedComplexScriptFonts

boolean EmbedComplexScriptFonts

optionalproperty

Whether to embed Complex script fonts.

Since: LibreOffice 6.2

◆ EmbedFonts

boolean EmbedFonts

optionalproperty

Whether to embed fonts used by the document (see e.g.

handling of OOXML embedRegular etc.)

Since: LibreOffice 4.0

◆ EmbedLatinScriptFonts

boolean EmbedLatinScriptFonts

optionalproperty

Whether to embed Latin script fonts.

Since: LibreOffice 6.2

◆ EmbedOnlyUsedFonts

boolean EmbedOnlyUsedFonts

optionalproperty

Whether to embed only the fonts that are used in the document.

Since: LibreOffice 6.2

◆ EmbedSystemFonts

boolean EmbedSystemFonts

optionalproperty

Whether to embed also system fonts used by the document.

Does not have any effect if EmbedFonts is false.

Since: LibreOffice 4.0

◆ FieldAutoUpdate

boolean FieldAutoUpdate

optionalproperty

specifies if fields in text documents are updated automatically.

◆ ForbiddenCharacters

com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters

optionalproperty

gives access to the set of forbidden characters.

Returns: the com::sun::star::i18n::XForbiddenCharacters interface to allow retrieval and modification of the forbidden characters set.

◆ GradientTableURL

string GradientTableURL

optionalproperty

◆ HatchTableURL

string HatchTableURL

optionalproperty

◆ IsKernAsianPunctuation

boolean IsKernAsianPunctuation

optionalproperty

specifies if kerning is applied to Asian punctuation.

Applies only if kerning is enabled.

◆ IsPrintBooklet

boolean IsPrintBooklet

optionalproperty

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.

◆ IsPrintBookletBack

boolean IsPrintBookletBack

optionalproperty

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.

◆ IsPrintBookletFront

boolean IsPrintBookletFront

optionalproperty

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.

◆ LineEndTableURL

string LineEndTableURL

optionalproperty

◆ LinkUpdateMode

short LinkUpdateMode

optionalproperty

specifies the update mode for links when loading text documents.

For supported values see the constants group LinkUpdateModes.

◆ PrinterIndependentLayout

short PrinterIndependentLayout

optionalproperty

forbid use of printer metrics for layout

For supported values see the constants group PrinterIndependentLayout.

◆ PrinterName

string PrinterName

property

printer used by the document.

◆ PrintQuality

long PrintQuality

optionalproperty

how printing uses color.

0: Default
1: Grayscale
2: Black & White (with grayscale images)

◆ SaveVersionOnClose

boolean SaveVersionOnClose

optionalproperty

specifies if a new version is created if a document has been modified and you want to close it.

◆ UpdateFromTemplate

boolean UpdateFromTemplate

optionalproperty

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.

The documentation for this service was generated from the following file:

com/sun/star/document/Settings.idl

Public Types

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PrinterSetup

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

Member Data Documentation

◆ AddExternalLeading

◆ ApplyUserData

◆ AutoCalculate

◆ BitmapTableURL

◆ CharacterCompressionType

◆ ColorTableURL

◆ CurrentDatabaseCommand

◆ CurrentDatabaseCommandType

◆ CurrentDatabaseDataSource

◆ DashTableURL

◆ DefaultTabStop

◆ EmbedAsianScriptFonts

◆ EmbedComplexScriptFonts

◆ EmbedFonts

◆ EmbedLatinScriptFonts

◆ EmbedOnlyUsedFonts

◆ EmbedSystemFonts

◆ FieldAutoUpdate

◆ ForbiddenCharacters

◆ GradientTableURL

◆ HatchTableURL

◆ IsKernAsianPunctuation

◆ IsPrintBooklet

◆ IsPrintBookletBack

◆ IsPrintBookletFront

◆ LineEndTableURL

◆ LinkUpdateMode

◆ PrinterIndependentLayout

◆ PrinterName

◆ PrintQuality

◆ SaveVersionOnClose

◆ UpdateFromTemplate