LibreOffice
LibreOffice 7.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
DocumentSettings Service Referencepublished

describes properties that apply to the whole spreadsheet document. More...

import"DocumentSettings.idl";

Inheritance diagram for DocumentSettings:
Settings XPropertySet XPropertySet XInterface XInterface

Included Services

service com::sun::star::document::Settings
 

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 provides access to the properties. More...
 
- Exported Interfaces inherited from Settings
interface com::sun::star::beans::XPropertySet
 gives access to the properties implemented by this service. More...
 

Public Attributes

boolean ShowZeroValues
 enables display of zero-values. More...
 
boolean ShowNotes
 controls whether a marker is shown for notes in cells. More...
 
boolean ShowGrid
 enables the display of the cell grid. More...
 
com::sun::star::util::Color GridColor
 specifies the color in which the cell grid is displayed. More...
 
boolean ShowPageBreaks
 enables display of page breaks. More...
 
boolean HasColumnRowHeaders
 enables the column and row headers of the view. More...
 
boolean HasSheetTabs
 enables the sheet tabs of the view. More...
 
boolean IsOutlineSymbolsSet
 enables the display of outline symbols. More...
 
boolean IsSnapToRaster
 enables the restriction of object movement and resizing of drawing objects to the raster. More...
 
boolean RasterIsVisible
 enables the display of the drawing object raster. More...
 
long RasterResolutionX
 specifies the distance between horizontal grid elements in 1/100 mm. More...
 
long RasterResolutionY
 specifies the distance between vertical grid elements in 1/100 mm. More...
 
long RasterSubdivisionX
 specifies the number of subdivisions between two horizontal grid elements. More...
 
long RasterSubdivisionY
 specifies the number of subdivisions between two vertical grid elements. More...
 
boolean IsRasterAxisSynchronized
 enables the synchronization of horizontal and vertical grid settings in the user interface. More...
 
boolean IsDocumentShared
 enables the document sharing feature (Tools->Share Spreadsheet) More...
 
- Public Attributes inherited from Settings
com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters
 gives access to the set of forbidden characters. More...
 
short LinkUpdateMode
 specifies the update mode for links when loading text documents. More...
 
string PrinterName
 printer used by the document. More...
 
boolean IsKernAsianPunctuation
 specifies if kerning is applied to Asian punctuation. More...
 
short CharacterCompressionType
 specifies the compression (character spacing) type used for Asian characters. More...
 
boolean ApplyUserData
 specifies if the user-specific settings saved within a document should be loaded with the document. More...
 
boolean SaveVersionOnClose
 specifies if a new version is created if a document has been modified and you want to close it. More...
 
boolean UpdateFromTemplate
 specifies if the document should be updated when the template it was created from changes. More...
 
boolean FieldAutoUpdate
 specifies if fields in text documents are updated automatically. More...
 
string CurrentDatabaseDataSource
 The name of the globally registered com::sun::star::sdb::DataSource from which the current data is taken. More...
 
string CurrentDatabaseCommand
 a string value, specifying the name of the object displayed currently (or the SQL statement used). More...
 
long CurrentDatabaseCommandType
 determines the interpretation of the property DataTableName. More...
 
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. More...
 
boolean IsPrintBookletFront
 is only effective, if IsPrintBooklet is TRUE. More...
 
boolean IsPrintBookletBack
 is only effective, if IsPrintBooklet is TRUE. More...
 
long PrintQuality
 how printing uses color. More...
 
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. More...
 
string DashTableURL
 
string LineEndTableURL
 
string HatchTableURL
 
string GradientTableURL
 
string BitmapTableURL
 
boolean AutoCalculate
 
short PrinterIndependentLayout
 forbid use of printer metrics for layout More...
 
boolean AddExternalLeading
 layout engine should add value of a Font's "external leading" attribute to the line spacing. More...
 
boolean EmbedFonts
 Whether to embed fonts used by the document (see e.g. More...
 
boolean EmbedSystemFonts
 Whether to embed also system fonts used by the document. More...
 
boolean EmbedOnlyUsedFonts
 Whether to embed only the fonts that are used in the document. More...
 
boolean EmbedLatinScriptFonts
 Whether to embed Latin script fonts. More...
 
boolean EmbedAsianScriptFonts
 Whether to embed Asian script fonts. More...
 
boolean EmbedComplexScriptFonts
 Whether to embed Complex script fonts. More...
 

Additional Inherited Members

- Public Types inherited from Settings
typedef sequence< byte > PrinterSetup
 platform and driver dependent printer setup data. More...
 
- 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

describes properties that apply to the whole spreadsheet document.

For settings that affect view properties, these settings apply to subsequently created views and are saved with the document, while SpreadsheetViewSettings can be used to alter a specific view that is already open.

Exported Interfaces

◆ com::sun::star::document::Settings

Exported Interfaces

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

provides access to the properties.

Member Data Documentation

◆ GridColor

com::sun::star::util::Color GridColor
optionalproperty

specifies the color in which the cell grid is displayed.

◆ HasColumnRowHeaders

boolean HasColumnRowHeaders
optionalproperty

enables the column and row headers of the view.

◆ HasSheetTabs

boolean HasSheetTabs
optionalproperty

enables the sheet tabs of the view.

◆ IsDocumentShared

boolean IsDocumentShared
optionalproperty

enables the document sharing feature (Tools->Share Spreadsheet)

◆ IsOutlineSymbolsSet

boolean IsOutlineSymbolsSet
optionalproperty

enables the display of outline symbols.

◆ IsRasterAxisSynchronized

boolean IsRasterAxisSynchronized
optionalproperty

enables the synchronization of horizontal and vertical grid settings in the user interface.

◆ IsSnapToRaster

boolean IsSnapToRaster
optionalproperty

enables the restriction of object movement and resizing of drawing objects to the raster.

◆ RasterIsVisible

boolean RasterIsVisible
optionalproperty

enables the display of the drawing object raster.

◆ RasterResolutionX

long RasterResolutionX
optionalproperty

specifies the distance between horizontal grid elements in 1/100 mm.

◆ RasterResolutionY

long RasterResolutionY
optionalproperty

specifies the distance between vertical grid elements in 1/100 mm.

◆ RasterSubdivisionX

long RasterSubdivisionX
optionalproperty

specifies the number of subdivisions between two horizontal grid elements.

◆ RasterSubdivisionY

long RasterSubdivisionY
optionalproperty

specifies the number of subdivisions between two vertical grid elements.

◆ ShowGrid

boolean ShowGrid
optionalproperty

enables the display of the cell grid.

◆ ShowNotes

boolean ShowNotes
optionalproperty

controls whether a marker is shown for notes in cells.

◆ ShowPageBreaks

boolean ShowPageBreaks
optionalproperty

enables display of page breaks.

◆ ShowZeroValues

boolean ShowZeroValues
optionalproperty

enables display of zero-values.


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