contributes properties to control the configuration which is global for all views of a spreadsheet document. More...

import"SpreadsheetDocumentSettings.idl";

Inheritance diagram for SpreadsheetDocumentSettings:

Exported Interfaces
interface	com::sun::star::beans::XPropertySet
	published service PropertySet More...

Public Attributes
boolean	IsIterationEnabled
	enables iterated calculation of circular references. More...

long	IterationCount
	specifies how many iterations are carried out. More...

double	IterationEpsilon
	specifies the point at which a change in results will stop the iteration. More...

short	StandardDecimals
	specifies the number of decimals in the default number format. More...

com::sun::star::util::Date	NullDate
	specifies the date that is represented by the value zero. More...

short	DefaultTabStop
	specifies the width of default tabulators. More...

boolean	IgnoreCase
	specifies whether upper and lower cases are treated as equal when comparing cells. More...

boolean	CalcAsShown
	specifies whether calculations are performed with the rounded values displayed in cells (set to `TRUE`) instead of the internal values (set to `FALSE`). More...

boolean	MatchWholeCell
	specifies whether filter criteria must match entire cell contents. More...

boolean	SpellOnline
	enables online spell checking. More...

boolean	LookUpLabels
	specifies whether column or row labels are looked up from anywhere on the sheet. More...

boolean	RegularExpressions
	specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents. More...

com::sun::star::i18n::XForbiddenCharacters	ForbiddenCharacters
	contains the interface XForbiddenCharacters. More...

boolean	HasDrawPages
	If this property is set the document has DrawPages. More...

com::sun::star::lang::Locale	CharLocale
	contains the standard document language for Western text. More...

com::sun::star::lang::Locale	CharLocaleAsian
	contains the standard document language for Asian text. More...

com::sun::star::lang::Locale	CharLocaleComplex
	contains the standard document language for Complex text. More...

boolean	IsLoaded
	specifies whether the document data are already loaded. More...

boolean	IsUndoEnabled
	specifies whether the undo command is enabled. More...

boolean	IsAdjustHeightEnabled
	specifies whether the automatic adjustment of the row height is enabled. More...

boolean	IsExecuteLinkEnabled
	specifies whether the automatic execution of links is enabled. More...

com::sun::star::awt::XDevice	ReferenceDevice
	contains the reference device used for formatting the document. More...

boolean	RecordChanges
	specifies whether changes record is enabled. More...

boolean	IsRecordChangesProtected
	specifies whether changes record is protected. More...

boolean	Wildcards
	specifies whether wildcards in formulas are enabled, e.g., for functions which look up spreadsheet contents. More...

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. More...

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. More...

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. More...

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. More...

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. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Detailed Description

contributes properties to control the configuration which is global for all views of a spreadsheet document.

Deprecated:

See also: com::sun::star::sheet::SpreadsheetDocument

Exported Interfaces

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

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

published service PropertySet

provides access to the properties.

Member Data Documentation

◆ CalcAsShown

boolean CalcAsShown

property

specifies whether calculations are performed with the rounded values displayed in cells (set to TRUE) instead of the internal values (set to FALSE).

◆ CharLocale

com::sun::star::lang::Locale CharLocale

optionalproperty

contains the standard document language for Western text.

◆ CharLocaleAsian

com::sun::star::lang::Locale CharLocaleAsian

optionalproperty

contains the standard document language for Asian text.

◆ CharLocaleComplex

com::sun::star::lang::Locale CharLocaleComplex

optionalproperty

contains the standard document language for Complex text.

◆ DefaultTabStop

short DefaultTabStop

property

specifies the width of default tabulators.

◆ ForbiddenCharacters

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

optionalpropertyreadonly

contains the interface XForbiddenCharacters.

◆ HasDrawPages

boolean HasDrawPages

optionalpropertyreadonly

If this property is set the document has DrawPages.

Use this property to find out, whether the document has DrawPages or not, because the getDrawPage method on the XDrawPageSupplier and the getDrawPages method on the XDrawPagesSupplier always creates the DrawPages if there are none; and this is very slow and needs more memory.

◆ IgnoreCase

boolean IgnoreCase

property

specifies whether upper and lower cases are treated as equal when comparing cells.

◆ IsAdjustHeightEnabled

boolean IsAdjustHeightEnabled

optionalproperty

specifies whether the automatic adjustment of the row height is enabled.

This boolean is actually a counter internally, of the number of times something has locked the height, so setting it to false will only perform one unlock operation, and might leave it still locked

Since: OOo 3.0

◆ IsExecuteLinkEnabled

boolean IsExecuteLinkEnabled

optionalproperty

specifies whether the automatic execution of links is enabled.

Since: OOo 3.0

◆ IsIterationEnabled

boolean IsIterationEnabled

property

enables iterated calculation of circular references.

◆ IsLoaded

boolean IsLoaded

optionalproperty

specifies whether the document data are already loaded.

Since: OOo 3.0

◆ IsRecordChangesProtected

boolean IsRecordChangesProtected

optionalpropertyreadonly

specifies whether changes record is protected.

Since: LibreOffice 5.0

◆ IsUndoEnabled

boolean IsUndoEnabled

optionalproperty

specifies whether the undo command is enabled.

Since: OOo 3.0

◆ IterationCount

long IterationCount

property

specifies how many iterations are carried out.

This setting is only used, if iteration is enabled using SpreadsheetDocumentSettings::IsIterationEnabled.

◆ IterationEpsilon

double IterationEpsilon

property

specifies the point at which a change in results will stop the iteration.

More exactly it specifies a difference in the change of the result between two iterations. If the result difference is less than or equal to this epsilon-value, the iteration is stopped.

This setting is only used, if iteration is enabled using SpreadsheetDocumentSettings::IsIterationEnabled.

◆ LookUpLabels

boolean LookUpLabels

property

specifies whether column or row labels are looked up from anywhere on the sheet.

Explicitly defined label ranges are used even if this property is set to FALSE.

See also: com::sun::star::sheet::LabelRanges

◆ MatchWholeCell

boolean MatchWholeCell

property

specifies whether filter criteria must match entire cell contents.

◆ NullDate

com::sun::star::util::Date NullDate

property

specifies the date that is represented by the value zero.

◆ RecordChanges

boolean RecordChanges

optionalproperty

specifies whether changes record is enabled.

No modification applied if the record changes protection is activated information given by SpreadsheetDocumentSettings::IsRecordChangesProtected

Since: LibreOffice 5.0

◆ ReferenceDevice

com::sun::star::awt::XDevice ReferenceDevice

optionalpropertyreadonly

contains the reference device used for formatting the document.

Since: OOo 3.0

◆ RegularExpressions

boolean RegularExpressions

property

specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.

RegularExpressions and Wildcards are mutually exclusive, only one can have the value TRUE. If both are set to TRUE via API calls then the last one set takes precedence.

◆ SpellOnline

boolean SpellOnline

property

enables online spell checking.

◆ StandardDecimals

short StandardDecimals

property

specifies the number of decimals in the default number format.

◆ Wildcards

boolean Wildcards

optionalproperty

specifies whether wildcards in formulas are enabled, e.g., for functions which look up spreadsheet contents.

Wildcards and RegularExpressions are mutually exclusive, only one can have the value TRUE. If both are set to TRUE via API calls then the last one set takes precedence.

Since: LibreOffice 5.2

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

com/sun/star/sheet/SpreadsheetDocumentSettings.idl

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

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

Member Data Documentation

◆ CalcAsShown

◆ CharLocale

◆ CharLocaleAsian

◆ CharLocaleComplex

◆ DefaultTabStop

◆ ForbiddenCharacters

◆ HasDrawPages

◆ IgnoreCase

◆ IsAdjustHeightEnabled

◆ IsExecuteLinkEnabled

◆ IsIterationEnabled

◆ IsLoaded

◆ IsRecordChangesProtected

◆ IsUndoEnabled

◆ IterationCount

◆ IterationEpsilon

◆ LookUpLabels

◆ MatchWholeCell

◆ NullDate

◆ RecordChanges

◆ ReferenceDevice

◆ RegularExpressions

◆ SpellOnline

◆ StandardDecimals

◆ Wildcards