HPS.Publish.TableKit

class HPS.Publish.TableKit : public HPS.SprocketKit 

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.

Warning

Public Functions

override bool Empty ()

Indicates whether this TableKit has any values set on it.

Return: true if no values are set on this TableKit, false otherwise.

bool Equals (HPS.Publish.TableKit in_kit)

Check if the source TableKit is equivalent to this TableKit.

Param in_kit: The source TableKit to compare to this TableKit.
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.TableKit in_kit)

Copies the source TableKit into this TableKit.

Param in_kit: The source TableKit to copy.

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.

Param in_row: Row in which to add the button.
Param in_column: Column in which to add the button.
Param in_button: Button to add at the specified row and column in the table.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTML (string in_source)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTML (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table source or file.

Param in_source: UTF8-encoded HTML table source or file (depending on the following argument).
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTMLStyle (string in_source)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Return: A reference to this TableKit.

HPS.Publish.TableKit SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type)

Sets the HTML table style source or file.

Param in_source: UTF8-encoded HTML table style source or file (depending on the following argument).
Param in_type: Type of the preceding argument.
Return: A reference to this TableKit.

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.

Param in_row: Row in which to add the link.
Param in_column: Column in which to add the link.
Param in_link: Link to add at the specified row and column in the table.
Return: A reference to this TableKit.

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.

Param in_row: Row in which to add the text.
Param in_column: Column in which to add the text.
Param in_text: Text to add at the specified row and column in the table.
Return: A reference to this TableKit.

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.

Param in_row: Row in which to add the text field.
Param in_column: Column in which to add the text field.
Param in_text_field: Text field to add at the specified row and column in the table.
Return: A reference to this TableKit.

void Show (out HPS.Publish.TableKit out_kit)

Copies this TableKit into the given TableKit.

Param out_kit: The TableKit to populate with the contents of this TableKit.

bool ShowButton (int in_row, int in_column, out HPS.Publish.ButtonKit out_button)

Shows the button at the specified row and column.

Param in_row: Row in which to show the button.
Param in_column: Column in which to show the button.
Param out_button: The button at the specified row and column in the table.
Return: true if a button was added at the specified row and column, false otherwise.

bool ShowHTML (out string out_source, out HPS.Publish.Source.Type out_type)

Shows the HTML table setting.

Param out_source: The HTML table source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table was specified, false otherwise.

bool ShowHTMLStyle (out string out_source, out HPS.Publish.Source.Type out_type)

Shows the HTML table style setting.

Param out_source: The HTML table style source or file (depending on the following argument).
Param out_type: The type of the preceding argument.
Return: true if an HTML table style was specified, false otherwise.

bool ShowLink (int in_row, int in_column, out HPS.Publish.LinkKit out_link)

Shows the link at the specified row and column.

Param in_row: Row in which to show the link.
Param in_column: Column in which to show the link.
Param out_link: The link at the specified row and column in the table.
Return: true if a link was added at the specified row and column, false otherwise.

bool ShowText (int in_row, int in_column, out HPS.Publish.TextKit out_text)

Shows the text at the specified row and column.

Param in_row: Row in which to show the text.
Param in_column: Column in which to show the text.
Param out_text: The text at the specified row and column in the table.
Return: true if text was added at the specified row and column, false otherwise.

bool ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field)

Shows the link at the specified row and column.

Param in_row: Row in which to show the link.
Param in_column: Column in which to show the link.
Param out_text_field: The text field at the specified row and column in the table.
Return: true if a link was added at the specified row and column, false otherwise.