Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 5987

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Service Spreadsheet</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="Spreadsheet-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Services_-_Overview" class="navimain">Devguide</a></td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">service Spreadsheet</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>represents a complete spreadsheet in a spreadsheet document.

 </dd>
<dd><p>This service extents the service SheetCellRange. A spreadsheet is
 nothing else than a cell range with extended functionality.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="SpreadsheetDocument.html">SpreadsheetDocument</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Services_-_Overview">Spreadsheets - Spreadsheet Services - Overview</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="SheetCellRange.html">SheetCellRange</a></td>
<td class="imsum_right"><p>provides functionality for cell range handling.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="Scenario.html">Scenario</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>represents a scenario in a spreadsheet document.

 </dd>
</dl>
</td>
</tr>
</table>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSpreadsheet.html">XSpreadsheet</a></td>
<td class="imsum_right"><p>provides methods to create a cell cursor.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></td>
<td class="imsum_right"><p>provides accessing the spreadsheet name.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XProtectable.html">XProtectable</a></td>
<td class="imsum_right"><p>provides methods to protect and unprotect the sheet contents.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDataPilotTablesSupplier.html">XDataPilotTablesSupplier</a></td>
<td class="imsum_right"><p>provides access to the collection of DataPilot tables.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XScenariosSupplier.html">XScenariosSupplier</a></td>
<td class="imsum_right"><p>provides access to the collection of scenarios.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSheetAnnotationsSupplier.html">XSheetAnnotationsSupplier</a></td>
<td class="imsum_right"><p>provides access to the collection of annotations.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XDrawPageSupplier.html">XDrawPageSupplier</a></td>
<td class="imsum_right"><p>provides access to the draw page of this spreadsheet.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XTableChartsSupplier.html">XTableChartsSupplier</a></td>
<td class="imsum_right"><p>provides access to the collection of chart objects.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XCellRangeMovement.html">XCellRangeMovement</a></td>
<td class="imsum_right"><p>provides methods to move cell ranges inside the spreadsheet or to
 other spreadsheets in this document.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XPrintAreas.html">XPrintAreas</a></td>
<td class="imsum_right"><p>provides access to the print area settings of this sheet.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSheetPageBreak.html">XSheetPageBreak</a></td>
<td class="imsum_right"><p>provides access to the page breaks of this sheet.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSheetOutline.html">XSheetOutline</a></td>
<td class="imsum_right"><p>provides access to row and column outline settings.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSheetAuditing.html">XSheetAuditing</a></td>
<td class="imsum_right"><p>provides access to the auditing (detective) functionality.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XSheetLinkable.html">XSheetLinkable</a></td>
<td class="imsum_right"><p>provides methods for a linked sheet.
 </p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XExternalSheetName.html">XExternalSheetName</a></td>
<td class="imsum_right"><p>provides a method to set an external name at the sheet.

 (<a href="#XExternalSheetName">details</a>)</p>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#IsVisible">IsVisible</a></td>
<td class="imsum_right">specifies if the sheet is visible.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#PageStyle">PageStyle</a></td>
<td class="imsum_right">specifies the page style of the sheet.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#TableLayout">TableLayout</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies the direction of the columns in the spreadsheet.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutomaticPrintArea">AutomaticPrintArea</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies whether the sheet has an automatic print area.

 &nbsp;</td>
</tr>
</table>
<a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="SheetCellRange" class="membertitle"><a href="SheetCellRange.html">SheetCellRange</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides functionality for cell range handling.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="Scenario" class="membertitle"><a href="Scenario.html">Scenario</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt>(referenced entity's summary:)</dt>
<dd>represents a scenario in a spreadsheet document.

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSpreadsheet" class="membertitle"><a href="XSpreadsheet.html">XSpreadsheet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides methods to create a cell cursor.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XNamed" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides accessing the spreadsheet name.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XProtectable" class="membertitle">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XProtectable.html">XProtectable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides methods to protect and unprotect the sheet contents.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XDataPilotTablesSupplier" class="membertitle"><a href="XDataPilotTablesSupplier.html">XDataPilotTablesSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the collection of DataPilot tables.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XScenariosSupplier" class="membertitle"><a href="XScenariosSupplier.html">XScenariosSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the collection of scenarios.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSheetAnnotationsSupplier" class="membertitle"><a href="XSheetAnnotationsSupplier.html">XSheetAnnotationsSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the collection of annotations.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XDrawPageSupplier" class="membertitle">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XDrawPageSupplier.html">XDrawPageSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the draw page of this spreadsheet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XTableChartsSupplier" class="membertitle">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XTableChartsSupplier.html">XTableChartsSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the collection of chart objects.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XCellRangeMovement" class="membertitle"><a href="XCellRangeMovement.html">XCellRangeMovement</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides methods to move cell ranges inside the spreadsheet or to
 other spreadsheets in this document.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XPrintAreas" class="membertitle"><a href="XPrintAreas.html">XPrintAreas</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the print area settings of this sheet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSheetPageBreak" class="membertitle"><a href="XSheetPageBreak.html">XSheetPageBreak</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the page breaks of this sheet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSheetOutline" class="membertitle"><a href="XSheetOutline.html">XSheetOutline</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to row and column outline settings.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSheetAuditing" class="membertitle"><a href="XSheetAuditing.html">XSheetAuditing</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the auditing (detective) functionality.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XSheetLinkable" class="membertitle"><a href="XSheetLinkable.html">XSheetLinkable</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides methods for a linked sheet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XExternalSheetName" class="membertitle"><a href="XExternalSheetName.html">XExternalSheetName</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>provides a method to set an external name at the sheet.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="IsVisible" class="membertitle">IsVisible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>IsVisible</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies if the sheet is visible.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="PageStyle" class="membertitle">PageStyle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>PageStyle</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the page style of the sheet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TableLayout" class="membertitle">TableLayout</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>TableLayout</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies the direction of the columns in the spreadsheet.

 </dd>
<dd><p>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.</p>

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/WritingMode2.html">WritingMode2</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutomaticPrintArea" class="membertitle">AutomaticPrintArea</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutomaticPrintArea</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies whether the sheet has an automatic print area.

 </dd>
<dd><p> The automatic print area is used to print a sheet without
 explicit print areas, also if other sheets have print areas.</p>

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

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

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

 <p> 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.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XPrintAreas.html">XPrintAreas</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>