The TableKit class is a user space object. It acts as the container for all data that can be used to specify a table for a Publish PDF. Note that to insert tables into a Publish PDF, the TableToPDFPublish add-on must be installed. More...
Public Member Functions | |
override void | Dispose () |
TableKit () | |
The default constructor creates an empty TableKit object. More... | |
TableKit (HPS.Publish.TableKit in_kit) | |
The copy constructor creates a new TableKit object that contains the same settings as the source TableKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Publish.TableKit in_kit) |
Copies the source TableKit into this TableKit. More... | |
void | Show (out HPS.Publish.TableKit out_kit) |
Copies this TableKit into the given TableKit. More... | |
override bool | Empty () |
Indicates whether this TableKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Publish.TableKit in_kit) |
Check if the source TableKit is equivalent to this TableKit. More... | |
HPS.Publish.TableKit | SetHTML (string in_source, HPS.Publish.Source.Type in_type) |
Sets the HTML table source or file. More... | |
HPS.Publish.TableKit | SetHTML (string in_source) |
Sets the HTML table source or file. More... | |
HPS.Publish.TableKit | SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type) |
Sets the HTML table style source or file. More... | |
HPS.Publish.TableKit | SetHTMLStyle (string in_source) |
Sets the HTML table style source or file. More... | |
HPS.Publish.TableKit | SetLink (int in_row, int in_column, HPS.Publish.LinkKit in_link) |
Adds a link to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga073798a1d1582e79b31e3b38f1cbf105">A3DPDFPageInsertLinkInTable</ulink>. More... | |
HPS.Publish.TableKit | SetText (int in_row, int in_column, HPS.Publish.TextKit in_text) |
Adds text to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gad3d5385fd9ad890e578007ee62b0100b">A3DPDFPageInsertTextInTable</ulink>. More... | |
HPS.Publish.TableKit | SetButton (int in_row, int in_column, HPS.Publish.ButtonKit in_button) |
Adds a button to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1012ddd4a4d8e0fa1f62b0a51e4618d3">A3DPDFPageInsertButtonInTable</ulink>. More... | |
HPS.Publish.TableKit | SetTextField (int in_row, int in_column, HPS.Publish.TextFieldKit in_text_field) |
Adds a text field to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacc519dd8ddd5c28899eb093d59b8e313">A3DPDFPageInsertTextFieldInTable</ulink>. More... | |
HPS.Publish.TableKit | UnsetHTML () |
Removes the HTML table setting. More... | |
HPS.Publish.TableKit | UnsetHTMLStyle () |
Removes the HTML table style setting. More... | |
HPS.Publish.TableKit | UnsetLink (int in_row, int in_column) |
Removes the link at the specified row and column. More... | |
HPS.Publish.TableKit | UnsetText (int in_row, int in_column) |
Removes the text at the specified row and column. More... | |
HPS.Publish.TableKit | UnsetButton (int in_row, int in_column) |
Removes the button at the specified row and column. More... | |
HPS.Publish.TableKit | UnsetTextField (int in_row, int in_column) |
Removes the text field at the specified row and column. More... | |
HPS.Publish.TableKit | UnsetEverything () |
Removes all data from the table. More... | |
bool | ShowHTML (out string out_source, out HPS.Publish.Source.Type out_type) |
Shows the HTML table setting. More... | |
bool | ShowHTMLStyle (out string out_source, out HPS.Publish.Source.Type out_type) |
Shows the HTML table style setting. More... | |
bool | ShowLink (int in_row, int in_column, out HPS.Publish.LinkKit out_link) |
Shows the link at the specified row and column. More... | |
bool | ShowText (int in_row, int in_column, out HPS.Publish.TextKit out_text) |
Shows the text at the specified row and column. More... | |
bool | ShowButton (int in_row, int in_column, out HPS.Publish.ButtonKit out_button) |
Shows the button at the specified row and column. More... | |
bool | ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field) |
Shows the link at the specified row and column. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.Publish.TableKit a, HPS.Publish.TableKit b) |
static bool | operator!= (HPS.Publish.TableKit a, HPS.Publish.TableKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The TableKit class is a user space object. It acts as the container for all data that can be used to specify a table for a Publish PDF. Note that to insert tables into a Publish PDF, the TableToPDFPublish add-on must be installed.
|
inline |
The default constructor creates an empty TableKit object.
|
inline |
|
inlinevirtual |
Indicates whether this TableKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
|
inline |
Adds a button to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga1012ddd4a4d8e0fa1f62b0a51e4618d3">A3DPDFPageInsertButtonInTable</ulink>.
in_row | Row in which to add the button. |
in_column | Column in which to add the button. |
in_button | Button to add at the specified row and column in the table. |
|
inline |
Sets the HTML table source or file.
in_source | UTF8-encoded HTML table source or file (depending on the following argument). |
in_type | The type of the preceding argument. Defaults to Source::Type::Code. |
|
inline |
Sets the HTML table source or file.
in_source | UTF8-encoded HTML table source or file (depending on the following argument). |
|
inline |
Sets the HTML table style source or file.
in_source | UTF8-encoded HTML table style source or file (depending on the following argument). |
in_type | Type of the preceding argument. |
|
inline |
Sets the HTML table style source or file.
in_source | UTF8-encoded HTML table style source or file (depending on the following argument). |
|
inline |
Adds a link to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#ga073798a1d1582e79b31e3b38f1cbf105">A3DPDFPageInsertLinkInTable</ulink>.
in_row | Row in which to add the link. |
in_column | Column in which to add the link. |
in_link | Link to add at the specified row and column in the table. |
|
inline |
Adds text to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gad3d5385fd9ad890e578007ee62b0100b">A3DPDFPageInsertTextInTable</ulink>.
in_row | Row in which to add the text. |
in_column | Column in which to add the text. |
in_text | Text to add at the specified row and column in the table. |
|
inline |
Adds a text field to this table at the specified row and column. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gacc519dd8ddd5c28899eb093d59b8e313">A3DPDFPageInsertTextFieldInTable</ulink>.
in_row | Row in which to add the text field. |
in_column | Column in which to add the text field. |
in_text_field | Text field to add at the specified row and column in the table. |
|
inline |
|
inline |
Shows the button at the specified row and column.
in_row | Row in which to show the button. |
in_column | Column in which to show the button. |
out_button | The button at the specified row and column in the table. |
|
inline |
Shows the HTML table setting.
out_source | The HTML table source or file (depending on the following argument). |
out_type | The type of the preceding argument. |
|
inline |
Shows the HTML table style setting.
out_source | The HTML table style source or file (depending on the following argument). |
out_type | The type of the preceding argument. |
|
inline |
Shows the link at the specified row and column.
in_row | Row in which to show the link. |
in_column | Column in which to show the link. |
out_link | The link at the specified row and column in the table. |
|
inline |
Shows the text at the specified row and column.
in_row | Row in which to show the text. |
in_column | Column in which to show the text. |
out_text | The text at the specified row and column in the table. |
|
inline |
Shows the link at the specified row and column.
in_row | Row in which to show the link. |
in_column | Column in which to show the link. |
out_text_field | The text field at the specified row and column in the table. |
|
inline |
Removes the button at the specified row and column.
|
inline |
Removes all data from the table.
|
inline |
Removes the HTML table setting.
|
inline |
Removes the HTML table style setting.
|
inline |
Removes the link at the specified row and column.
|
inline |
Removes the text at the specified row and column.
|
inline |
Removes the text field at the specified row and column.