Inheritance diagram for HPS.Publish.DataTableKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

 DataTableKit ()
 
 DataTableKit (HPS.Publish.DataTableKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.DataTableKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.DataTableKit in_kit)
 
HPS.Publish.DataTableKit SetColumns (uint in_value)
 
HPS.Publish.DataTableKit SetData (string[][] in_value)
 
HPS.Publish.DataTableKit SetRows (uint in_value)
 
void Show (out HPS.Publish.DataTableKit out_kit)
 
bool ShowColumns (out uint out_number)
 
bool ShowData (out string[][] out_data)
 
bool ShowRows (out uint out_number)
 
HPS.Publish.DataTableKit UnsetColumns ()
 
HPS.Publish.DataTableKit UnsetData ()
 
HPS.Publish.DataTableKit UnsetRows ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Publish.DataTableKit GetDefault ()
 
static bool operator!= (HPS.Publish.DataTableKit a, HPS.Publish.DataTableKit b)
 
static bool operator== (HPS.Publish.DataTableKit a, HPS.Publish.DataTableKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ DataTableKit() [1/2]

HPS.Publish.DataTableKit.DataTableKit ( )
inline

The default constructor creates an empty DataTableKit object.

◆ DataTableKit() [2/2]

HPS.Publish.DataTableKit.DataTableKit ( HPS.Publish.DataTableKit  in_kit)
inline

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

Parameters
in_kitThe source DataTableKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.DataTableKit.Empty ( )
inlinevirtual

Indicates whether this DataTableKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.Publish.DataTableKit.Equals ( HPS.Publish.DataTableKit  in_kit)
inline

Check if the source DataTableKit is equivalent to this DataTableKit.

Parameters
in_kitThe source DataTableKit to compare to this DataTableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.DataTableKit HPS.Publish.DataTableKit.GetDefault ( )
inlinestatic

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()

void HPS.Publish.DataTableKit.Set ( HPS.Publish.DataTableKit  in_kit)
inline

Copies the source DataTableKit into this DataTableKit.

Parameters
in_kitThe source DataTableKit to copy.

◆ SetColumns()

HPS.Publish.DataTableKit HPS.Publish.DataTableKit.SetColumns ( uint  in_value)
inline

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

Parameters
in_valueThe number of columns of theData Table.
Returns
A reference to this DataTableKit.

◆ SetRows()

HPS.Publish.DataTableKit HPS.Publish.DataTableKit.SetRows ( uint  in_value)
inline

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

Parameters
in_valueThe number of rows of theData Table.
Returns
A reference to this DataTableKit.

◆ Show()

void HPS.Publish.DataTableKit.Show ( out HPS.Publish.DataTableKit  out_kit)
inline

Copies this DataTableKit into the given DataTableKit.

Parameters
out_kitThe DataTableKit to populate with the contents of this DataTableKit.

◆ ShowColumns()

bool HPS.Publish.DataTableKit.ShowColumns ( out uint  out_number)
inline

Shows the number of columns of the DataTable.

Parameters
out_numberThe 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_numberThe number of rows of the DataTable.
Returns
true if a number of rows was specified, false otherwise.

◆ UnsetColumns()

HPS.Publish.DataTableKit HPS.Publish.DataTableKit.UnsetColumns ( )
inline

Removes the columns setting.

Returns
A reference to this DataTableKit.

◆ UnsetData()

HPS.Publish.DataTableKit HPS.Publish.DataTableKit.UnsetData ( )
inline

Removes the Data setting.

Returns
A reference to this DataTableKit.

◆ UnsetRows()

HPS.Publish.DataTableKit HPS.Publish.DataTableKit.UnsetRows ( )
inline

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