Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 5612

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Service DatabaseRange</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="DatabaseRange-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Database_Operations" 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">Included Services</td>
<td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</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">service DatabaseRange</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>represents a database range in a spreadsheet document.

 </dd>
<dd><p>A database range is a name for a cell range that also stores filtering,
 sorting, subtotal and data import settings and options.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="DatabaseRanges.html">DatabaseRanges</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/Database_Operations">Spreadsheets - Database Operations</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDatabaseRange.html">XDatabaseRange</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>provides access to the settings and options of a database range.

 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XCellRangeReferrer.html">XCellRangeReferrer</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>allows direct access to the cells in a named range or to the cells
 which are visible in a view, without the need to get the document
 object first.

 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>provides information about and access to the 
 properties from an implementation. 
 
 </dd>
</dl>
</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"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>specifies the name of the object.
 
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XRefreshable.html">XRefreshable</a></td>
<td class="imsum_right"><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
</dl>
</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="#MoveCells">MoveCells</a></td>
<td class="imsum_right">if this property is set, columns or rows are inserted or deleted
 when the size of the range is changed by an update operation.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#KeepFormats">KeepFormats</a></td>
<td class="imsum_right">if this property is set, cell formats are extended
 when the size of the range is changed by an update operation.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#StripData">StripData</a></td>
<td class="imsum_right">if this property is set, the cell contents within the database
 range are left out when the document is saved.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoFilter">AutoFilter</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies whether the AutoFilter is enabled or not.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#UseFilterCriteriaSource">UseFilterCriteriaSource</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies whether the filter criteria should be taken from a CellRange.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a><br>
<a href="#FilterCriteriaSource">FilterCriteriaSource</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies the range where the filter can find the filter criterias.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#RefreshPeriod">RefreshPeriod</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies the time between two refresh actions in seconds.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#FromSelection">FromSelection</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies whether the imported data is only a selection of the database.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">[ readonly ] long<br>
<a href="#TokenIndex">TokenIndex</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>returns the index used to refer to this range in token arrays.

 &nbsp;</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="MoveCells" class="membertitle">MoveCells</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>MoveCells</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if this property is set, columns or rows are inserted or deleted
 when the size of the range is changed by an update operation.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="KeepFormats" class="membertitle">KeepFormats</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>KeepFormats</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if this property is set, cell formats are extended
 when the size of the range is changed by an update operation.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="StripData" class="membertitle">StripData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>StripData</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if this property is set, the cell contents within the database
 range are left out when the document is saved.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoFilter" class="membertitle">AutoFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoFilter</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies whether the AutoFilter is enabled or not.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="UseFilterCriteriaSource" class="membertitle">UseFilterCriteriaSource</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>UseFilterCriteriaSource</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies whether the filter criteria should be taken from a CellRange.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FilterCriteriaSource" class="membertitle">FilterCriteriaSource</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a> <b>FilterCriteriaSource</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies the range where the filter can find the filter criterias.
 </dd>
<dd><p>This is only used if <a href="SheetFilterDescriptor.html">SheetFilterDescriptor</a>::<a href="SheetFilterDescriptor.html#UseFilterCriteriaSource">UseFilterCriteriaSource</a> is <b>true</b>.</p>

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="RefreshPeriod" class="membertitle">RefreshPeriod</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>RefreshPeriod</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies the time between two refresh actions in seconds.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FromSelection" class="membertitle">FromSelection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>FromSelection</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies whether the imported data is only a selection of the database.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TokenIndex" class="membertitle">TokenIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] long <b>TokenIndex</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>returns the index used to refer to this range in token arrays.

 </dd>
<dd><p>A token describing a database range shall contain the op-code
 OPCODE_DB_AREA and this index as data part.</p>

 </dd>
<dt><b/></dt>
<dd/><dt><b>See also</b></dt>
<dd><a href="FormulaToken.html">FormulaToken</a>, <a href="FormulaMapGroupSpecialOffset.html">FormulaMapGroupSpecialOffset</a>::<a href="FormulaMapGroupSpecialOffset.html#DB_AREA">DB_AREA</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; 2008 Sun Microsystems, Inc.</p>

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

</html>