<html> <head> <title>Interface XConsolidationDescriptor</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="XConsolidationDescriptor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Other_Table_Operations#Data_Consolidation" 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="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">deprecated </td> <td width="50%" class="title">interface XConsolidationDescriptor</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>provides access to the settings of a consolidation descriptor. </dd> <dt><b>See also</b></dt> <dd><a href="ConsolidationDescriptor.html">ConsolidationDescriptor</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/Other_Table_Operations#Data_Consolidation">Spreadsheets - Other Table Operations - Data Consolidation</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getFunction">getFunction</a></td> <td class="imsum_right">returns the function by which the ranges are consolidated. </td> </tr> <tr> <td class="imsum_left"><a href="#setFunction">setFunction</a></td> <td class="imsum_right">sets the function by which the ranges are consolidated. </td> </tr> <tr> <td class="imsum_left"><a href="#getSources">getSources</a></td> <td class="imsum_right">returns the cell ranges which are consolidated. </td> </tr> <tr> <td class="imsum_left"><a href="#setSources">setSources</a></td> <td class="imsum_right">sets the cell ranges which are consolidated. </td> </tr> <tr> <td class="imsum_left"><a href="#getStartOutputPosition">getStartOutputPosition</a></td> <td class="imsum_right">returns the position of the top left cell of the cell range where the consolidated data are copied. </td> </tr> <tr> <td class="imsum_left"><a href="#setStartOutputPosition">setStartOutputPosition</a></td> <td class="imsum_right">sets the position of the top left cell of the cell range where the consolidated data are copied. </td> </tr> <tr> <td class="imsum_left"><a href="#getUseColumnHeaders">getUseColumnHeaders</a></td> <td class="imsum_right">returns, whether column headers from the cell ranges are used to find matching data or not. </td> </tr> <tr> <td class="imsum_left"><a href="#setUseColumnHeaders">setUseColumnHeaders</a></td> <td class="imsum_right">specifies if column headers from the cell ranges are used to find matching data. </td> </tr> <tr> <td class="imsum_left"><a href="#getUseRowHeaders">getUseRowHeaders</a></td> <td class="imsum_right">returns, whether row headers from the cell ranges are used to find matching data or not. </td> </tr> <tr> <td class="imsum_left"><a href="#setUseRowHeaders">setUseRowHeaders</a></td> <td class="imsum_right">specifies if row headers from the cell ranges are used to find matching data. </td> </tr> <tr> <td class="imsum_left"><a href="#getInsertLinks">getInsertLinks</a></td> <td class="imsum_right">returns, whether links to the original data are inserted in the output area or not. </td> </tr> <tr> <td class="imsum_left"><a href="#setInsertLinks">setInsertLinks</a></td> <td class="imsum_right">specifies if links to the original data are inserted in the output area. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getFunction" class="membertitle">getFunction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="GeneralFunction.html">GeneralFunction</a></td> </tr> <tr> <td valign="top"><b>getFunction</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the function by which the ranges are consolidated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setFunction" class="membertitle">setFunction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setFunction</b>(</td> <td valign="top">[in] <a href="GeneralFunction.html">GeneralFunction</a></td> <td valign="bottom"> nFunction );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the function by which the ranges are consolidated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSources" class="membertitle">getSources</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a> ></td> </tr> <tr> <td valign="top"><b>getSources</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the cell ranges which are consolidated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setSources" class="membertitle">setSources</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setSources</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a> ></td> <td valign="bottom"> aSources );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the cell ranges which are consolidated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStartOutputPosition" class="membertitle">getStartOutputPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a></td> </tr> <tr> <td valign="top"><b>getStartOutputPosition</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the position of the top left cell of the cell range where the consolidated data are copied. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setStartOutputPosition" class="membertitle">setStartOutputPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStartOutputPosition</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a></td> <td valign="bottom"> aStartOutputPosition );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the position of the top left cell of the cell range where the consolidated data are copied. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUseColumnHeaders" class="membertitle">getUseColumnHeaders</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getUseColumnHeaders</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns, whether column headers from the cell ranges are used to find matching data or not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setUseColumnHeaders" class="membertitle">setUseColumnHeaders</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setUseColumnHeaders</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bUseColumnHeaders );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies if column headers from the cell ranges are used to find matching data. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUseRowHeaders" class="membertitle">getUseRowHeaders</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getUseRowHeaders</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns, whether row headers from the cell ranges are used to find matching data or not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setUseRowHeaders" class="membertitle">setUseRowHeaders</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setUseRowHeaders</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bUseRowHeaders );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies if row headers from the cell ranges are used to find matching data. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getInsertLinks" class="membertitle">getInsertLinks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getInsertLinks</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns, whether links to the original data are inserted in the output area or not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setInsertLinks" class="membertitle">setInsertLinks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setInsertLinks</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bInsertLinks );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies if links to the original data are inserted in the output area. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 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>