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. The TableToPDF Publish add-on must be installed in order to use this class. More...

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TableKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.TableKit in_kit) |
Check if the source TableKit is equivalent to this TableKit. More... | |
override int | GetHashCode () |
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... | |
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 A3DPDFPageInsertButtonInTable. 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 A3DPDFPageInsertLinkInTable. 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 A3DPDFPageInsertTextInTable. 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 A3DPDFPageInsertTextFieldInTable. More... | |
void | Show (out HPS.Publish.TableKit out_kit) |
Copies this TableKit into the given TableKit. 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 | 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 | ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field) |
Shows the link at the specified row and column. More... | |
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... | |
HPS.Publish.TableKit | UnsetButton (int in_row, int in_column) |
Removes the button at the specified row and column. More... | |
HPS.Publish.TableKit | UnsetEverything () |
Removes all data from the table. 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 | UnsetTextField (int in_row, int in_column) |
Removes the text field at the specified row and column. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
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... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual 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... | |
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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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. The TableToPDF Publish add-on must be installed in order to use this class.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty TableKit object.
|
inline |
Member Function Documentation
|
inlinevirtual |
Indicates whether this TableKit has any values set on it.
- Returns
- true if no values are set on this TableKit, false otherwise.
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.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
|
inline |
|
inline |
Adds a button to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertButtonInTable.
- Parameters
-
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.
- Returns
- A reference to this TableKit.
|
inline |
Sets the HTML table source or file.
- Parameters
-
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.
- Returns
- A reference to this TableKit.
|
inline |
Sets the HTML table source or file.
- Parameters
-
in_source UTF8-encoded HTML table source or file (depending on the following argument).
- Returns
- A reference to this TableKit.
|
inline |
Sets the HTML table style source or file.
- Parameters
-
in_source UTF8-encoded HTML table style source or file (depending on the following argument). in_type Type of the preceding argument.
- Returns
- A reference to this TableKit.
|
inline |
Sets the HTML table style source or file.
- Parameters
-
in_source UTF8-encoded HTML table style source or file (depending on the following argument).
- Returns
- A reference to this TableKit.
|
inline |
Adds a link to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertLinkInTable.
- Parameters
-
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.
- Returns
- A reference to this TableKit.
|
inline |
Adds text to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.
- Parameters
-
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.
- Returns
- A reference to this TableKit.
|
inline |
Adds a text field to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextFieldInTable.
- Parameters
-
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.
- Returns
- A reference to this TableKit.
|
inline |
|
inline |
Shows the button at the specified row and column.
- Parameters
-
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.
- Returns
- true if a button was added at the specified row and column, false otherwise.
|
inline |
Shows the HTML table setting.
- Parameters
-
out_source The HTML table source or file (depending on the following argument). out_type The type of the preceding argument.
- Returns
- true if an HTML table was specified, false otherwise.
|
inline |
Shows the HTML table style setting.
- Parameters
-
out_source The HTML table style source or file (depending on the following argument). out_type The type of the preceding argument.
- Returns
- true if an HTML table style was specified, false otherwise.
|
inline |
Shows the link at the specified row and column.
- Parameters
-
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.
- Returns
- true if a link was added at the specified row and column, false otherwise.
|
inline |
Shows the text at the specified row and column.
- Parameters
-
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.
- Returns
- true if text was added at the specified row and column, false otherwise.
|
inline |
Shows the link at the specified row and column.
- Parameters
-
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.
- Returns
- true if a link was added at the specified row and column, false otherwise.
|
inline |
Removes the button at the specified row and column.
- Returns
- A reference to this TableKit.
|
inline |
Removes all data from the table.
- Returns
- A reference to this TableKit.
|
inline |
Removes the HTML table setting.
- Returns
- A reference to this TableKit.
|
inline |
Removes the HTML table style setting.
- Returns
- A reference to this TableKit.
|
inline |
Removes the link at the specified row and column.
- Returns
- A reference to this TableKit.
|
inline |
Removes the text at the specified row and column.
- Returns
- A reference to this TableKit.
|
inline |
Removes the text field at the specified row and column.
- Returns
- A reference to this TableKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs