English:

The Free and Open Productivity Suite
Help us Help the World

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

deprecated service SpreadsheetDocumentSettings
Usage Restrictions
deprecated
Description
contributes properties to control the configuration which is global for all views of a spreadsheet document.
See also
SpreadsheetDocument

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet

provides access to the properties.

Properties' Summary
boolean
IsIterationEnabled
enables iterated calculation of circular references.  
long
IterationCount
specifies how many iterations are carried out.  
double
IterationEpsilon
specifies the point at which a change in results will stop the iteration.  
short
StandardDecimals
specifies the number of decimals in the default number format.  
::com::sun::star::util::Date
NullDate
specifies the date that is represented by the value zero.  
short
DefaultTabStop
specifies the width of default tabulators.  
boolean
IgnoreCase
specifies whether upper and lower cases are treated as equal when comparing cells.  
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).  
boolean
MatchWholeCell
specifies whether filter criteria must match entire cell contents.  
boolean
SpellOnline
enables online spell checking.  
boolean
LookUpLabels
specifies whether column or row labels are looked up from anywhere on the sheet.  
boolean
RegularExpressions
specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents.  
[ readonly ] ::com::sun::star::i18n::XForbiddenCharacters
ForbiddenCharacters
[ OPTIONAL ]
contains the interface XForbiddenCharacters.  
[ readonly ] boolean
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.  
::com::sun::star::lang::Locale
CharLocale
[ OPTIONAL ]
contains the standard document language for Western text.  
::com::sun::star::lang::Locale
CharLocaleAsian
[ OPTIONAL ]
contains the standard document language for Asian text.  
::com::sun::star::lang::Locale
CharLocaleComplex
[ OPTIONAL ]
contains the standard document language for Complex text.  
boolean
IsLoaded
[ OPTIONAL ]
specifies whether the document data are already loaded.  
boolean
IsUndoEnabled
[ OPTIONAL ]
specifies whether the undo command is enabled.  
boolean
IsAdjustHeightEnabled
[ OPTIONAL ]
specifies whether the automatic adjustment of the row height is enabled.  
boolean
IsExecuteLinkEnabled
[ OPTIONAL ]
specifies whether the automatic execution of links is enabled.  
[ readonly ] ::com::sun::star::awt::XDevice
ReferenceDevice
[ OPTIONAL ]
contains the reference device used for formatting the document.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description
provides access to the properties.
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;
Usage Restrictions
optional
Description
contains the interface XForbiddenCharacters.
HasDrawPages
[ readonly ] boolean HasDrawPages;
Usage Restrictions
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;
Usage Restrictions
optional
Description
contains the standard document language for Western text.
CharLocaleAsian
::com::sun::star::lang::Locale CharLocaleAsian;
Usage Restrictions
optional
Description
contains the standard document language for Asian text.
CharLocaleComplex
::com::sun::star::lang::Locale CharLocaleComplex;
Usage Restrictions
optional
Description
contains the standard document language for Complex text.
IsLoaded
boolean IsLoaded;
Usage Restrictions
optional
Description
specifies whether the document data are already loaded.
Since
OOo 3.0
IsUndoEnabled
boolean IsUndoEnabled;
Usage Restrictions
optional
Description
specifies whether the undo command is enabled.
Since
OOo 3.0
IsAdjustHeightEnabled
boolean IsAdjustHeightEnabled;
Usage Restrictions
optional
Description
specifies whether the automatic adjustment of the row height is enabled.
Since
OOo 3.0
IsExecuteLinkEnabled
boolean IsExecuteLinkEnabled;
Usage Restrictions
optional
Description
specifies whether the automatic execution of links is enabled.
Since
OOo 3.0
ReferenceDevice
[ readonly ] ::com::sun::star::awt::XDevice ReferenceDevice;
Usage Restrictions
optional
Description
contains the reference device used for formatting the document.
Since
OOo 3.0

 
Top of Page

Logo ApacheCon Europe 2014

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.