HPS.Publish.DataTableKit

class HPS.Publish.DataTableKit : public HPS.SprocketKit

The DataTableKit class is a user space object. It acts as the container for all data that can be used to specify a Data Table for a Publish PDF.

Public Functions

DataTableKit ()

The default constructor creates an empty DataTableKit object.

DataTableKit (HPS.Publish.DataTableKit in_kit)

The copy constructor creates a new DataTableKit object that contains the same settings as the source DataTableKit.

Param in_kit

The source DataTableKit to copy.

override bool Empty ()

Indicates whether this DataTableKit has any values set on it.

Return

true if no values are set on this DataTableKit, false otherwise.

bool Equals (HPS.Publish.DataTableKit in_kit)

Check if the source DataTableKit is equivalent to this DataTableKit.

Param in_kit

The source DataTableKit to compare to this DataTableKit.

Return

true if the objects are equivalent, false otherwise.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.DataTableKit in_kit)

Copies the source DataTableKit into this DataTableKit.

Param in_kit

The source DataTableKit to copy.

HPS.Publish.DataTableKit SetColumns (uint in_value)

Sets the number of columns for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbCols.

Param in_value

The number of columns of theData Table.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit SetRows (uint in_value)

Sets the number of rows for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbRows.

Param in_value

The number of rows of theData Table.

Return

A reference to this DataTableKit.

void Show (out HPS.Publish.DataTableKit out_kit)

Copies this DataTableKit into the given DataTableKit.

Param out_kit

The DataTableKit to populate with the contents of this DataTableKit.

bool ShowColumns (out uint out_number)

Shows the number of columns of the DataTable.

Param out_number

The number of columns of the DataTable.

Return

true if a number of columns was specified, false otherwise.

bool ShowRows (out uint out_number)

Shows the number of rows of the DataTable.

Param out_number

The number of rows of the DataTable.

Return

true if a number of rows was specified, false otherwise.

HPS.Publish.DataTableKit UnsetColumns ()

Removes the columns setting.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit UnsetData ()

Removes the Data setting.

Return

A reference to this DataTableKit.

HPS.Publish.DataTableKit UnsetRows ()

Removes the rows setting.

Return

A reference to this DataTableKit.

Public Static Functions

HPS.Publish.DataTableKit GetDefault ()

Creates a DataTableKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a text field unless a setting is overridden by the DataTableKit passed to a function.

Return

A DataTableKit with the default settings.