Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XSheetOutline
Description
provides methods to access the outlines of a sheet.
Developers Guide
Spreadsheets - Sheet Outline

Methods' Summary
group creates an outline group.  
ungroup removes outline groups.  
autoOutline creates outline groups from formula references in a range.  
clearOutline removes all outline groups from the sheet.  
hideDetail collapses an outline group.  
showDetail reopens an outline group.  
showLevel shows all outlined groups below a specific level.  
Methods' Details
group
void
group( [in] ::com::sun::star::table::CellRangeAddress  aRange,
[in] ::com::sun::star::table::TableOrientation  nOrientation );

Description
creates an outline group.
Parameter aRange
contains the range of rows or columns, depending on the parameter nOrientation.
Parameter nOrientation
the orientation of the new outline (columns or rows).
ungroup
void
ungroup( [in] ::com::sun::star::table::CellRangeAddress  aRange,
[in] ::com::sun::star::table::TableOrientation  nOrientation );

Description
removes outline groups.

In the specified range, all outline groups on the innermost level are removed.

Parameter aRange
contains the range of rows or columns, depending on the parameter nOrientation.
Parameter nOrientation
the orientation of the outlines to remove (columns or rows).
autoOutline
void
autoOutline( [in] ::com::sun::star::table::CellRangeAddress  aRange );

Description
creates outline groups from formula references in a range.
Parameter aRange
the cell range for which outlines are generated.
clearOutline
void
clearOutline();

Description
removes all outline groups from the sheet.
hideDetail
void
hideDetail( [in] ::com::sun::star::table::CellRangeAddress  aRange );

Description
collapses an outline group.
Parameter aRange
the cell range for which the outlines are collapsed.
showDetail
void
showDetail( [in] ::com::sun::star::table::CellRangeAddress  aRange );

Description
reopens an outline group.
Parameter aRange
the cell range for which the outlines are reopened.
showLevel
void
showLevel( [in] short  nLevel,
[in] ::com::sun::star::table::TableOrientation  nOrientation );

Description
shows all outlined groups below a specific level.
Parameter nLevel
all outline levels from 1 to this value will be opened and the higher levels will be closed.
Parameter nOrientation
the orientation of the outlines (columns or rows).
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.