Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service SpreadsheetDocumentSettings

Description
keep the configuration which is global for all views of a spreadsheet document.


Exported Interfaces

com::sun::star::beans::XPropertySet
Description
provides information about and access to the properties from an implementation.

Properties' Summary

IsIterationEnabled enables iterated calculation of circular references.
IterationCount specifies how many iterations are carried out if iteration is enabled.
IterationEpsilon if iteration is enabled, this property 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 if upper and lower cases are treated as equal when comparing cells.
CalcAsShown if this property is set, calculations are performed with the rounded values displayed in cells instead of the internal values.
MatchWholeCell if this property is set, filter criteria must match entire cell contents.
SpellOnline enables online spell checking.
LookUpLabels if this property is set, column or row labels are looked up from anywhere on the sheet.
RegularExpressions if this property is set, regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.
ForbiddenCharacters This property gives the XForbiddenCharacters.
HasDrawPages 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.

Properties' Details

IsIterationEnabled
 
boolean IsIterationEnabled;
Description
enables iterated calculation of circular references.
IterationCount
 
long IterationCount;
Description
specifies how many iterations are carried out if iteration is enabled.
IterationEpsilon
 
double IterationEpsilon;
Description
if iteration is enabled, this 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.

only applied when iteration is enabled by 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 if upper and lower cases are treated as equal when comparing cells.
CalcAsShown
 
boolean CalcAsShown;
Description
if this property is set, calculations are performed with the rounded values displayed in cells instead of the internal values.
MatchWholeCell
 
boolean MatchWholeCell;
Description
if this property is set, filter criteria must match entire cell contents.
SpellOnline
 
boolean SpellOnline;
Description
enables online spell checking.
LookUpLabels
 
boolean LookUpLabels;
Description
if this property is set, column or row labels are looked up from anywhere on the sheet.
RegularExpressions
 
boolean RegularExpressions;
Description
if this property is set, regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.
ForbiddenCharacters
 
[ readonly ] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
Description
This property gives the XForbiddenCharacters.
HasDrawPages
 
[ readonly ] boolean HasDrawPages;
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.

Top of Page