:: com :: sun :: star :: sheet ::

service SpreadsheetDocumentSettings
[ DEPRECATED ]
Description
contributes properties to control the configuration which is global for all views of a spreadsheet document.
See also
SpreadsheetDocument

Exported Interfaces
::com::sun::star::beans::XPropertySet
Description
provides access to the properties.
Properties' Summary
IsIterationEnabled enables iterated calculation of circular references.
IterationCount specifies how many iterations are carried out.
IterationEpsilon specifies the point at which a change in results will stop the iteration.
StandardDecimals specifies the number of decimals in the default number format.
NullDate specifies the date that is represented by the value zero.
DefaultTabStop specifies the width of default tabulators.
IgnoreCase specifies whether upper and lower cases are treated as equal when comparing cells.
CalcAsShown specifies whether calculations are performed with the rounded values displayed in cells (set to true ) instead of the internal values (set to false ).
MatchWholeCell specifies whether filter criteria must match entire cell contents.
SpellOnline enables online spell checking.
LookUpLabels specifies whether column or row labels are looked up from anywhere on the sheet.
RegularExpressions specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.
ForbiddenCharacters [ OPTIONAL ]
contains the interface XForbiddenCharacters.
HasDrawPages [ OPTIONAL ]
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.
CharLocale [ OPTIONAL ]
contains the standard document language for Western text.
CharLocaleAsian [ OPTIONAL ]
contains the standard document language for Asian text.
CharLocaleComplex [ OPTIONAL ]
contains the standard document language for Complex text.
Properties' Details
IsIterationEnabled
boolean IsIterationEnabled;
Description
enables iterated calculation of circular references.
IterationCount
long IterationCount;
Description
specifies how many iterations are carried out.

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

IterationEpsilon
double IterationEpsilon;
Description
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 .

StandardDecimals
short StandardDecimals;
Description
specifies the number of decimals in the default number format.
NullDate
::com::sun::star::util::Date NullDate;
Description
specifies the date that is represented by the value zero.
DefaultTabStop
short DefaultTabStop;
Description
specifies the width of default tabulators.
IgnoreCase
boolean IgnoreCase;
Description
specifies whether upper and lower cases are treated as equal when comparing cells.
CalcAsShown
boolean CalcAsShown;
Description
specifies whether calculations are performed with the rounded values displayed in cells (set to true ) instead of the internal values (set to false ).
MatchWholeCell
boolean MatchWholeCell;
Description
specifies whether filter criteria must match entire cell contents.
SpellOnline
boolean SpellOnline;
Description
enables online spell checking.
LookUpLabels
boolean LookUpLabels;
Description
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
LabelRanges
RegularExpressions
boolean RegularExpressions;
Description
specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.
ForbiddenCharacters
[ readonly ] ::com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
[ OPTIONAL ]
Description
contains the interface XForbiddenCharacters.
HasDrawPages
[ readonly ] boolean HasDrawPages;
[ OPTIONAL ]
Description
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.
CharLocale
::com::sun::star::lang::Locale CharLocale;
[ OPTIONAL ]
Description
contains the standard document language for Western text.
CharLocaleAsian
::com::sun::star::lang::Locale CharLocaleAsian;
[ OPTIONAL ]
Description
contains the standard document language for Asian text.
CharLocaleComplex
::com::sun::star::lang::Locale CharLocaleComplex;
[ OPTIONAL ]
Description
contains the standard document language for Complex text.

 
Top of Page