HPS::Publish::SlideTableKit

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

The SlideTableKit class is a user space object. It acts as the container for all data that can be used to specify a slide table for a Publish

PDF.

The TableToPDF

Publish add-on must be installed in order to use this class.

Warning

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this SlideTableKit has any values set on it.

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

bool Equals (HPS.Publish.SlideTableKit in_kit)

Check if the source SlideTableKit is equivalent to this SlideTableKit.

Param in_kit: The source SlideTableKit to compare to this SlideTableKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.SlideTableKit in_kit)

Copies the source SlideTableKit into this SlideTableKit.

Param in_kit: The source SlideTableKit to copy.

HPS.Publish.SlideTableKit SetButtons (string in_previous_button_name, string in_next_button_name)

Sets the button names for the slide table.

Param in_previous_button_name: UTF8-encoded name for the previous button.
Param in_next_button_name: UTF8-encoded name for the next button.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit SetHeader (bool in_state)

Sets whether this slide table has a header.

Param in_state: Whether this slide table has a header.
Return: A reference to this SlideTableKit.

HPS.Publish.SlideTableKit 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 SlideTableKit.

HPS.Publish.SlideTableKit 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 SlideTableKit.

HPS.Publish.SlideTableKit 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 SlideTableKit.

HPS.Publish.SlideTableKit 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 SlideTableKit.

HPS.Publish.SlideTableKit SetText (ulong in_rows, ulong in_columns, HPS.Publish.TextFieldKit[] in_text)

Sets the text strings for the slide table.

Param in_rows: Number of rows.
Param in_columns: Number of columns.
Param in_text: Text strings for the slide table. This array should be of size in_rows * in_columns.
Return: A reference to this SlideTableKit.

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

Copies this SlideTableKit into the given SlideTableKit.

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

bool ShowButtons (out string out_previous_button_name, out string out_next_button_name)

Shows the buttons setting.

Param out_previous_button_name: Name for the previous button.
Param out_next_button_name: Name for the next button.
Return: true if button names were specified, false otherwise.

bool ShowHeader (out bool out_state)

Shows the header setting.

Param out_state: Whether this slide table has a header.
Return: true if a header setting was specified, 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.