REFERENCE MANUAL
The SlideTableKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this SlideTableKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.SlideTableKit in_kit) |
Check if the source SlideTableKit is equivalent to this SlideTableKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Publish.SlideTableKit in_kit) |
Copies the source SlideTableKit into this SlideTableKit. More... | |
HPS.Publish.SlideTableKit | SetButtons (string in_previous_button_name, string in_next_button_name) |
Sets the button names for the slide table. More... | |
HPS.Publish.SlideTableKit | SetHeader (bool in_state) |
Sets whether this slide table has a header. More... | |
HPS.Publish.SlideTableKit | SetHTML (string in_source, HPS.Publish.Source.Type in_type) |
Sets the HTML table source or file. More... | |
HPS.Publish.SlideTableKit | SetHTML (string in_source) |
Sets the HTML table source or file. More... | |
HPS.Publish.SlideTableKit | SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type) |
Sets the HTML table style source or file. More... | |
HPS.Publish.SlideTableKit | SetHTMLStyle (string in_source) |
Sets the HTML table style source or file. More... | |
HPS.Publish.SlideTableKit | SetText (ulong in_rows, ulong in_columns, HPS.Publish.TextFieldKit[] in_text) |
Sets the text strings for the slide table. More... | |
void | Show (out HPS.Publish.SlideTableKit out_kit) |
Copies this SlideTableKit into the given SlideTableKit. More... | |
bool | ShowButtons (out string out_previous_button_name, out string out_next_button_name) |
Shows the buttons setting. More... | |
bool | ShowHeader (out bool out_state) |
Shows the header setting. 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 | ShowText (out ulong out_rows, out ulong out_columns, out HPS.Publish.TextFieldKit[] out_text) |
Shows the text strings setting. More... | |
SlideTableKit () | |
The default constructor creates an empty SlideTableKit object. More... | |
SlideTableKit (HPS.Publish.SlideTableKit in_kit) | |
The copy constructor creates a new SlideTableKit object that contains the same settings as the source SlideTableKit. More... | |
HPS.Publish.SlideTableKit | UnsetButtons () |
Removes the buttons setting. More... | |
HPS.Publish.SlideTableKit | UnsetEverything () |
Removes all data from the table. More... | |
HPS.Publish.SlideTableKit | UnsetHeader () |
Removes the header setting. More... | |
HPS.Publish.SlideTableKit | UnsetHTML () |
Removes the HTML table setting. More... | |
HPS.Publish.SlideTableKit | UnsetHTMLStyle () |
Removes the HTML table style setting. More... | |
HPS.Publish.SlideTableKit | UnsetText () |
Removes the text strings setting. More... | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Publish.SlideTableKit a, HPS.Publish.SlideTableKit b) |
static bool | operator== (HPS.Publish.SlideTableKit a, HPS.Publish.SlideTableKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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. Note that to insert tables into a Publish PDF, the TableToPDFPublish add-on must be installed.
HPS.Publish.SlideTableKit.SlideTableKit | ( | ) |
The default constructor creates an empty SlideTableKit object.
HPS.Publish.SlideTableKit.SlideTableKit | ( | HPS.Publish.SlideTableKit | in_kit | ) |
The copy constructor creates a new SlideTableKit object that contains the same settings as the source SlideTableKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref> to copy. |
|
virtual |
Indicates whether this SlideTableKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.SlideTableKit.Equals | ( | HPS.Publish.SlideTableKit | in_kit | ) |
Check if the source SlideTableKit is equivalent to this SlideTableKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref>. |
|
virtual |
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.
void HPS.Publish.SlideTableKit.Set | ( | HPS.Publish.SlideTableKit | in_kit | ) |
Copies the source SlideTableKit into this SlideTableKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref> to copy. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetButtons | ( | string | in_previous_button_name, |
string | in_next_button_name | ||
) |
Sets the button names for the slide table.
in_previous_button_name | UTF8-encoded name for the previous button. |
in_next_button_name | UTF8-encoded name for the next button. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHeader | ( | bool | in_state | ) |
Sets whether this slide table has a header.
in_state | Whether this slide table has a header. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTML | ( | string | in_source, |
HPS.Publish.Source.Type | in_type | ||
) |
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 <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTML | ( | string | in_source | ) |
Sets the HTML table source or file.
in_source | UTF8-encoded HTML table source or file (depending on the following argument). |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTMLStyle | ( | string | in_source, |
HPS.Publish.Source.Type | in_type | ||
) |
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. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTMLStyle | ( | string | in_source | ) |
Sets the HTML table style source or file.
in_source | UTF8-encoded HTML table style source or file (depending on the following argument). |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetText | ( | ulong | in_rows, |
ulong | in_columns, | ||
HPS.Publish.TextFieldKit[] | in_text | ||
) |
Sets the text strings for the slide table.
in_rows | Number of rows. |
in_columns | Number of columns. |
in_text | <ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> strings for the slide table. This array should be of size in_rows * in_columns. |
void HPS.Publish.SlideTableKit.Show | ( | out HPS.Publish.SlideTableKit | out_kit | ) |
Copies this SlideTableKit into the given SlideTableKit.
out_kit | The <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_slide_table_kit" kindref="compound">SlideTableKit</ref>. |
bool HPS.Publish.SlideTableKit.ShowButtons | ( | out string | out_previous_button_name, |
out string | out_next_button_name | ||
) |
Shows the buttons setting.
out_previous_button_name | Name for the previous button. |
out_next_button_name | Name for the next button. |
bool HPS.Publish.SlideTableKit.ShowHeader | ( | out bool | out_state | ) |
Shows the header setting.
out_state | Whether this slide table has a header. |
bool HPS.Publish.SlideTableKit.ShowHTML | ( | out string | out_source, |
out HPS.Publish.Source.Type | out_type | ||
) |
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. |
bool HPS.Publish.SlideTableKit.ShowHTMLStyle | ( | out string | out_source, |
out HPS.Publish.Source.Type | out_type | ||
) |
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. |
bool HPS.Publish.SlideTableKit.ShowText | ( | out ulong | out_rows, |
out ulong | out_columns, | ||
out HPS.Publish.TextFieldKit[] | out_text | ||
) |
Shows the text strings setting.
out_rows | Number of rows. |
out_columns | Number of columns. |
out_text | <ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> strings for the slide table. |
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetButtons | ( | ) |
Removes the buttons setting.
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetEverything | ( | ) |
Removes all data from the table.
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHeader | ( | ) |
Removes the header setting.
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHTML | ( | ) |
Removes the HTML table setting.
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHTMLStyle | ( | ) |
Removes the HTML table style setting.
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetText | ( | ) |
Removes the text strings setting.