The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service Spreadsheet
Usage Restrictions
not published
Description
represents a complete spreadsheet in a spreadsheet document.

This service extents the service SheetCellRange. A spreadsheet is nothing else than a cell range with extended functionality.

See also
SpreadsheetDocument
Developers Guide
Spreadsheets - Spreadsheet Services - Overview

Included Services - Summary
SheetCellRange

provides functionality for cell range handling.

Scenario
(referenced entity's summary:)
represents a scenario in a spreadsheet document.
Exported Interfaces - Summary
XSpreadsheet

provides methods to create a cell cursor.

::com::sun::star::container::XNamed

provides accessing the spreadsheet name.

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

provides methods to protect and unprotect the sheet contents.

XDataPilotTablesSupplier

provides access to the collection of DataPilot tables.

XScenariosSupplier

provides access to the collection of scenarios.

XSheetAnnotationsSupplier

provides access to the collection of annotations.

::com::sun::star::drawing::XDrawPageSupplier

provides access to the draw page of this spreadsheet.

::com::sun::star::table::XTableChartsSupplier

provides access to the collection of chart objects.

XCellRangeMovement

provides methods to move cell ranges inside the spreadsheet or to other spreadsheets in this document.

XPrintAreas

provides access to the print area settings of this sheet.

XSheetPageBreak

provides access to the page breaks of this sheet.

XSheetOutline

provides access to row and column outline settings.

XSheetAuditing

provides access to the auditing (detective) functionality.

XSheetLinkable

provides methods for a linked sheet.

XExternalSheetName

provides a method to set an external name at the sheet. (details)

Properties' Summary
boolean
IsVisible
specifies if the sheet is visible.  
string
PageStyle
specifies the page style of the sheet.  
short
TableLayout
[ OPTIONAL ]
specifies the direction of the columns in the spreadsheet.  
boolean
AutomaticPrintArea
[ OPTIONAL ]
specifies whether the sheet has an automatic print area.  
::com::sun::star::util::Color
TabColor
[ OPTIONAL ]
specifies the color of the sheet tab, if any.  
Included Services - Details
SheetCellRange
Description
provides functionality for cell range handling.
Scenario
(referenced entity's summary:)
represents a scenario in a spreadsheet document.
Exported Interfaces - Details
XSpreadsheet
Description
provides methods to create a cell cursor.
::com::sun::star::container::XNamed
Description
provides accessing the spreadsheet name.
::com::sun::star::util::XProtectable
Description
provides methods to protect and unprotect the sheet contents.
XDataPilotTablesSupplier
Description
provides access to the collection of DataPilot tables.
XScenariosSupplier
Description
provides access to the collection of scenarios.
XSheetAnnotationsSupplier
Description
provides access to the collection of annotations.
::com::sun::star::drawing::XDrawPageSupplier
Description
provides access to the draw page of this spreadsheet.
::com::sun::star::table::XTableChartsSupplier
Description
provides access to the collection of chart objects.
XCellRangeMovement
Description
provides methods to move cell ranges inside the spreadsheet or to other spreadsheets in this document.
XPrintAreas
Description
provides access to the print area settings of this sheet.
XSheetPageBreak
Description
provides access to the page breaks of this sheet.
XSheetOutline
Description
provides access to row and column outline settings.
XSheetAuditing
Description
provides access to the auditing (detective) functionality.
XSheetLinkable
Description
provides methods for a linked sheet.
XExternalSheetName
Usage Restrictions
optional
Description
provides a method to set an external name at the sheet.
Since
OOo 3.0
Properties' Details
IsVisible
boolean IsVisible;
Description
specifies if the sheet is visible.
PageStyle
string PageStyle;
Description
specifies the page style of the sheet.
TableLayout
short TableLayout;
Usage Restrictions
optional
Description
specifies the direction of the columns in the spreadsheet.

Possible values are com::sun::star::text::WritingMode2::LR_TB to order the columns from left to right, and com::sun::star::text::WritingMode2::RL_TB to order the columns from right to left.

See also
::com::sun::star::text::WritingMode2
AutomaticPrintArea
boolean AutomaticPrintArea;
Usage Restrictions
optional
Description
specifies whether the sheet has an automatic print area.

The automatic print area is used to print a sheet without explicit print areas, also if other sheets have print areas.

If the property is true, and there are print areas on other sheets, the used area of this sheet is also printed.

If the property is false, and there are print areas on other sheets, only these specified print areas are printed.

If there are no print areas on the other sheets it does not matter whether property is true or false.

This property can only be true, if there are no print areas given on this sheet. If the property is set to true the print areas of this sheet will be removed.

See also
XPrintAreas
TabColor
::com::sun::star::util::Color TabColor;
Usage Restrictions
optional
Description
specifies the color of the sheet tab, if any.

 
Top of Page

Apache Software Foundation

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.