Service SpreadsheetDocument

Overview

Module

Use

Devguide

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

service SpreadsheetDocument

Description: represents a model component which consists of some settings and one or more spreadsheets.

Developers Guide: Spreadsheets - Working With Spreadsheet Documents - Document Structure - Spreadsheet Document; Spreadsheets - Spreadsheet Documents

Included Services - Summary
::com::sun::star::document::OfficeDocument	common service for all types of documents.
SpreadsheetDocumentSettings	contributes spreadsheet document specific properties. (details)

Exported Interfaces - Summary
::com::sun::star::lang::XMultiServiceFactory	provides methods to create instances of several spreadsheet services.
::com::sun::star::frame::XModel	provides common methods for a document model. (details)
::com::sun::star::document::XActionLockable	provides methods to control the automatic update of cell contents.
::com::sun::star::document::XLinkTargetSupplier	provides access to the collection of link targets available in the document.
::com::sun::star::util::XProtectable	provides methods to protect and unprotect the document.
XSpreadsheetDocument	provides access to the collection of spreadsheets.
XCalculatable	controls the recalculation settings of the document.
XDocumentAuditing	provides a method to refresh all auditing arrows.
XConsolidatable	provides methods to perform a data consolidation.
XGoalSeek	provides a method to perform a goal seek.
::com::sun::star::drawing::XDrawPagesSupplier	provides access to the collection of draw pages of this document.
::com::sun::star::style::XStyleFamiliesSupplier	provides access to the collection of style families. (details)
::com::sun::star::util::XNumberFormatsSupplier	provides access to the collection of number formats contained in the document.

Properties' Summary
[ readonly ] XNamedRanges NamedRanges	contains the collection of named ranges in the document.
[ readonly ] XDatabaseRanges DatabaseRanges	contains the collection of database ranges in the document.
[ readonly ] XLabelRanges ColumnLabelRanges	contains the collection of column label ranges in the document.
[ readonly ] XLabelRanges RowLabelRanges	contains the collection of row label ranges in the document.
[ readonly ] ::com::sun::star::container::XNameAccess SheetLinks	contains the collection of sheet links in the document.
[ readonly ] XAreaLinks AreaLinks	contains the collection of area links in the document.
[ readonly ] ::com::sun::star::container::XNameAccess DDELinks	contains the collection of DDE links in the document.
[ readonly ] XExternalDocLinks ExternalDocLinks	[ OPTIONAL ] contains the collection of external document links in the document.

Included Services - Details

::com::sun::star::document::OfficeDocument

Description common service for all types of documents.

SpreadsheetDocumentSettings

Usage Restrictions deprecated optional Description contributes spreadsheet document specific properties.

Exported Interfaces - Details

::com::sun::star::lang::XMultiServiceFactory

Description provides methods to create instances of several spreadsheet services.

::com::sun::star::frame::XModel

Description provides common methods for a document model. This interface is derived from ::com::sun::star::lang::XComponent.

::com::sun::star::document::XActionLockable

Description provides methods to control the automatic update of cell contents.

::com::sun::star::document::XLinkTargetSupplier

Description provides access to the collection of link targets available in the document.

::com::sun::star::util::XProtectable

Description provides methods to protect and unprotect the document.

XSpreadsheetDocument

Description provides access to the collection of spreadsheets.

XCalculatable

Description controls the recalculation settings of the document.

XDocumentAuditing

Description provides a method to refresh all auditing arrows.

XConsolidatable

Description provides methods to perform a data consolidation.

XGoalSeek

Description provides a method to perform a goal seek.

::com::sun::star::drawing::XDrawPagesSupplier

Description provides access to the collection of draw pages of this document.

::com::sun::star::style::XStyleFamiliesSupplier

Description provides access to the collection of style families. A spreadsheet document contains 2 families of styles: "PageStyles" and "CellStyles".

::com::sun::star::util::XNumberFormatsSupplier

Description provides access to the collection of number formats contained in the document.

Properties' Details

NamedRanges

[ readonly ] XNamedRanges NamedRanges; Description contains the collection of named ranges in the document.

DatabaseRanges

[ readonly ] XDatabaseRanges DatabaseRanges; Description contains the collection of database ranges in the document.

ColumnLabelRanges

[ readonly ] XLabelRanges ColumnLabelRanges; Description contains the collection of column label ranges in the document.

RowLabelRanges

[ readonly ] XLabelRanges RowLabelRanges; Description contains the collection of row label ranges in the document.

SheetLinks

[ readonly ] ::com::sun::star::container::XNameAccess SheetLinks; Description contains the collection of sheet links in the document.

AreaLinks

[ readonly ] XAreaLinks AreaLinks; Description contains the collection of area links in the document.

DDELinks

[ readonly ] ::com::sun::star::container::XNameAccess DDELinks; Description contains the collection of DDE links in the document.

ExternalDocLinks

[ readonly ] XExternalDocLinks ExternalDocLinks; Usage Restrictions optional Description contains the collection of external document links in the document. Since OOo 3.1

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous