C++
C#
VB
JScript
All

Classes ITable


The Table object defines the structure of a table in terms of Axes, as well as a variety of other settings. The Axes objects define the dimensions while CellItems define the contents of the cells.

Remarks

Only the 'Side' and 'Top' axes are currently supported. 'Layer' axes may be added in the future.

Groups

Operations
Method Clear

Clears the table

Method HasCellStatus

Checks to see if the table contains the specified cell status.

Method RefreshFromMetadata

Updates all axes in the table from the metadata if UseMetadataDefinition is True

Read-only Properties
IDL Property Annotations

A collection of Annotation objects that define additional information to be shown outside the main body of the table (for example, headings and footnotes).

IDL Property AvailableLevels

A list of levels that the table can be aggregated at.

IDL Property Axes

A collection of Axis objects that define the structure of the table.

IDL Property Base

The numeric 'Base' value for the table.

IDL Property CellItems

A collection of CellItem objects that define the cell contents for the table.

IDL Property DatePopulated

The date when the table was last populated.

IDL Property DefaultLevel

The default aggregation level for a table containing hierarchical data

IDL Property Filters

A collection of Filter objects that are applied to the case data that the table is based on when the table is populated.

IDL Property IsEmpty

Returns True if the Axes collection is empty for this table, i.e. If the table doesn't have any Top, Side, or Layer axis.

IDL Property IsEmptySide

Returns True if no 'Side' axis exists in the Axes collection of this table.

IDL Property IsEmptyTop

Returns True if no 'Top' axis exists in the Axes collection of this table.

IDL Property IsLevelValid

True if the ITable.Level property is valid

IDL Property IsPopulated

Returns True if the table has been populated (i.e. ITable.CellValues is not 'null').

IDL Property IsStatisticValid

Returns True if the specified statistical test is valid for this table.

IDL Property IsValid

True if the table is valid.

IDL Property IsWeighted

True if a weight variable has been specified for the Weight property

IDL Property Name

The name used to reference the table in the Tables collection.

IDL Property Parent

The parent object

IDL Property Properties

A collection of Property objects that define additional configuration information about the table.

IDL Property Rules

A collection of Rule objects that are applied to the values in the table when it is populated.

IDL Property Statistics

A collection of Statistic objects that define statistical tests to be calculated for the table.

IDL Property Type

The Type of table (either ttAggregated or ttProfile)

Read/Write Properties
IDL Property CellValues

The values of the cells of the table

IDL Property Description

A description or title for the table, e.g. “Table of age by gender”.

IDL Property Level

The level at which to aggregate a table containing hierarchical data

IDL Property OnAfterPopulate

Script that is automatically executed for the table after table population.

IDL Property PopulateError

The error message when populating the table.

IDL Property SortColumn

Controls sorting of rows by specifying the column to sort on and the order in which to sort.

IDL Property SortRow

Controls sorting of columns by specifying the row to sort on and the order in which to sort.

IDL Property Specification

The table specification string that defines the structure of the table.

IDL Property Status

The overall status indication for the table.

IDL Property UseDefaultLevel

Causes the ITable.Level property to be set to the default aggregation level

IDL Property Weight

Sets the name of the weight variable to be used for the table.

Interface ID

The ID of the ITable interface is 5CA48471-4CE3-4750-A3DE-A615BEACFAC1.