|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ DataTableKit() [1/2]
HPS.Publish.DataTableKit.DataTableKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty DataTableKit object.
◆ DataTableKit() [2/2]
The copy constructor creates a new DataTableKit object that contains the same settings as the source DataTableKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.DataTableKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
Check if the source DataTableKit is equivalent to this DataTableKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A DataTableKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.DataTableKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
◆ SetColumns()
Sets the number of columns for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbCols.
- Parameters
-
in_value | The number of columns of theData Table. |
- Returns
- A reference to this DataTableKit.
◆ SetRows()
Sets the number of rows for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData.m_iNbRows.
- Parameters
-
in_value | The number of rows of theData Table. |
- Returns
- A reference to this DataTableKit.
◆ Show()
◆ ShowColumns()
bool HPS.Publish.DataTableKit.ShowColumns |
( |
out uint |
out_number | ) |
|
|
inline |
Shows the number of columns of the DataTable.
- Parameters
-
out_number | The number of columns of the DataTable. |
- Returns
- true if a number of columns was specified, false otherwise.
◆ ShowRows()
bool HPS.Publish.DataTableKit.ShowRows |
( |
out uint |
out_number | ) |
|
|
inline |
Shows the number of rows of the DataTable.
- Parameters
-
out_number | The number of rows of the DataTable. |
- Returns
- true if a number of rows was specified, false otherwise.
◆ UnsetColumns()
Removes the columns setting.
- Returns
- A reference to this DataTableKit.
◆ UnsetData()
Removes the Data setting.
- Returns
- A reference to this DataTableKit.
◆ UnsetRows()
Removes the rows setting.
- Returns
- A reference to this DataTableKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs