
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 (if the object is derived, this does not give the true type of the derived object). 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... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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.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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
- Warning
The TableToPDF Publish add-on must be installed in order to use this class.
Constructor & Destructor Documentation
◆ SlideTableKit() [1/2]
|
inline |
The default constructor creates an empty SlideTableKit object.
◆ SlideTableKit() [2/2]
|
inline |
The copy constructor creates a new SlideTableKit object that contains the same settings as the source SlideTableKit.
- Parameters
-
in_kit The source SlideTableKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this SlideTableKit has any values set on it.
- Returns
- true if no values are set on this SlideTableKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source SlideTableKit is equivalent to this SlideTableKit.
- Parameters
-
in_kit The source SlideTableKit to compare to this SlideTableKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
|
inline |
Copies the source SlideTableKit into this SlideTableKit.
- Parameters
-
in_kit The source SlideTableKit to copy.
◆ SetButtons()
|
inline |
Sets the button names for the slide table.
- Parameters
-
in_previous_button_name UTF8-encoded name for the previous button. in_next_button_name UTF8-encoded name for the next button.
- Returns
- A reference to this SlideTableKit.
◆ SetHeader()
|
inline |
Sets whether this slide table has a header.
- Parameters
-
in_state Whether this slide table has a header.
- Returns
- A reference to this SlideTableKit.
◆ SetHTML() [1/2]
|
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 SlideTableKit.
◆ SetHTML() [2/2]
|
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 SlideTableKit.
◆ SetHTMLStyle() [1/2]
|
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 SlideTableKit.
◆ SetHTMLStyle() [2/2]
|
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 SlideTableKit.
◆ SetText()
|
inline |
Sets the text strings for the slide table.
- Parameters
-
in_rows Number of rows. in_columns Number of columns. in_text Text strings for the slide table. This array should be of size in_rows * in_columns.
- Returns
- A reference to this SlideTableKit.
◆ Show()
|
inline |
Copies this SlideTableKit into the given SlideTableKit.
- Parameters
-
out_kit The SlideTableKit to populate with the contents of this SlideTableKit.
◆ ShowButtons()
|
inline |
Shows the buttons setting.
- Parameters
-
out_previous_button_name Name for the previous button. out_next_button_name Name for the next button.
- Returns
- true if button names were specified, false otherwise.
◆ ShowHeader()
|
inline |
Shows the header setting.
- Parameters
-
out_state Whether this slide table has a header.
- Returns
- true if a header setting was specified, false otherwise.
◆ ShowHTML()
|
inline |
◆ ShowHTMLStyle()
|
inline |
◆ ShowText()
|
inline |
Shows the text strings setting.
- Parameters
-
out_rows Number of rows. out_columns Number of columns. out_text Text strings for the slide table.
- Returns
- true if text strings were specified, false otherwise.
◆ UnsetButtons()
|
inline |
Removes the buttons setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetEverything()
|
inline |
Removes all data from the table.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHeader()
|
inline |
Removes the header setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHTML()
|
inline |
Removes the HTML table setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHTMLStyle()
|
inline |
Removes the HTML table style setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetText()
|
inline |
Removes the text strings setting.
- Returns
- A reference to this SlideTableKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs