Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sheet ::
interface XConsolidationDescriptor
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XConsolidationDescriptor
[ DEPRECATED ] Description provides access to the settings of a consolidation descriptor. See also ConsolidationDescriptor Developers Guide 8.3.11 Spreadsheet Documents - Working with Spreadsheet Documents - Other Table Operations - Data Consolidation

Methods' Summary
getFunction | returns the function by which the ranges are consolidated.
setFunction | sets the function by which the ranges are consolidated.
getSources | returns the cell ranges which are consolidated.
setSources | sets the cell ranges which are consolidated.
getStartOutputPosition | returns the position of the top left cell of the cell range where the consolidated data are copied.
setStartOutputPosition | sets the position of the top left cell of the cell range where the consolidated data are copied.
getUseColumnHeaders | returns, whether column headers from the cell ranges are used to find matching data or not.
setUseColumnHeaders | specifies if column headers from the cell ranges are used to find matching data.
getUseRowHeaders | returns, whether row headers from the cell ranges are used to find matching data or not.
setUseRowHeaders | specifies if row headers from the cell ranges are used to find matching data.
getInsertLinks | returns, whether links to the original data are inserted in the output area or not.
setInsertLinks | specifies if links to the original data are inserted in the output area.

Methods' Details
getFunction
GeneralFunction getFunction(); |  |
Description returns the function by which the ranges are consolidated.
setFunction
void setFunction( | [in] GeneralFunction | nFunction );
Description sets the function by which the ranges are consolidated.
getSources
sequence< ::com::sun::star::table::CellRangeAddress > getSources(); |  |
Description returns the cell ranges which are consolidated.
setSources
void setSources( | [in] sequence< ::com::sun::star::table::CellRangeAddress > | aSources );
Description sets the cell ranges which are consolidated.
getStartOutputPosition
::com::sun::star::table::CellAddress getStartOutputPosition(); |  |
Description returns the position of the top left cell of the cell range where the consolidated data are copied.
setStartOutputPosition
void setStartOutputPosition( | [in] ::com::sun::star::table::CellAddress | aStartOutputPosition );
Description sets the position of the top left cell of the cell range where the consolidated data are copied.
getUseColumnHeaders
boolean getUseColumnHeaders(); |  |
Description returns, whether column headers from the cell ranges are used to find matching data or not.
setUseColumnHeaders
void setUseColumnHeaders( | [in] boolean | bUseColumnHeaders );
Description specifies if column headers from the cell ranges are used to find matching data.
getUseRowHeaders
boolean getUseRowHeaders(); |  |
Description returns, whether row headers from the cell ranges are used to find matching data or not.
setUseRowHeaders
void setUseRowHeaders( | [in] boolean | bUseRowHeaders );
Description specifies if row headers from the cell ranges are used to find matching data.
getInsertLinks
boolean getInsertLinks(); |  |
Description returns, whether links to the original data are inserted in the output area or not.
setInsertLinks
void setInsertLinks( | [in] boolean | bInsertLinks );
Description specifies if links to the original data are inserted in the output area.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.