|
override void | Dispose () |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Publish.SlideTableKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.Publish.SlideTableKit in_kit) |
|
HPS.Publish.SlideTableKit | SetButtons (string in_previous_button_name, string in_next_button_name) |
|
HPS.Publish.SlideTableKit | SetHeader (bool in_state) |
|
HPS.Publish.SlideTableKit | SetHTML (string in_source, HPS.Publish.Source.Type in_type) |
|
HPS.Publish.SlideTableKit | SetHTML (string in_source) |
|
HPS.Publish.SlideTableKit | SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type) |
|
HPS.Publish.SlideTableKit | SetHTMLStyle (string in_source) |
|
HPS.Publish.SlideTableKit | SetText (ulong in_rows, ulong in_columns, HPS.Publish.TextFieldKit[] in_text) |
|
void | Show (out HPS.Publish.SlideTableKit out_kit) |
|
bool | ShowButtons (out string out_previous_button_name, out string out_next_button_name) |
|
bool | ShowHeader (out bool out_state) |
|
bool | ShowHTML (out string out_source, out HPS.Publish.Source.Type out_type) |
|
bool | ShowHTMLStyle (out string out_source, out HPS.Publish.Source.Type out_type) |
|
bool | ShowText (out ulong out_rows, out ulong out_columns, out HPS.Publish.TextFieldKit[] out_text) |
|
| SlideTableKit () |
|
| SlideTableKit (HPS.Publish.SlideTableKit in_kit) |
|
HPS.Publish.SlideTableKit | UnsetButtons () |
|
HPS.Publish.SlideTableKit | UnsetEverything () |
|
HPS.Publish.SlideTableKit | UnsetHeader () |
|
HPS.Publish.SlideTableKit | UnsetHTML () |
|
HPS.Publish.SlideTableKit | UnsetHTMLStyle () |
|
HPS.Publish.SlideTableKit | UnsetText () |
|
| SprocketKit (HPS.SprocketKit in_that) |
|
| Sprocket (HPS.Sprocket in_that) |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
virtual HPS.Type | Type () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ SlideTableKit() [1/2]
HPS.Publish.SlideTableKit.SlideTableKit |
( |
| ) |
|
|
inline |
◆ SlideTableKit() [2/2]
◆ Empty()
override bool HPS.Publish.SlideTableKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
Check if the source SlideTableKit is equivalent to this SlideTableKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.Publish.SlideTableKit.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()
◆ SetButtons()
HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetButtons |
( |
string |
in_previous_button_name, |
|
|
string |
in_next_button_name |
|
) |
| |
|
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()
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]
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]
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]
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]
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()
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()
◆ ShowButtons()
bool HPS.Publish.SlideTableKit.ShowButtons |
( |
out string |
out_previous_button_name, |
|
|
out string |
out_next_button_name |
|
) |
| |
|
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()
bool HPS.Publish.SlideTableKit.ShowHeader |
( |
out bool |
out_state | ) |
|
|
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()
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.
◆ ShowHTMLStyle()
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.
◆ ShowText()
bool HPS.Publish.SlideTableKit.ShowText |
( |
out ulong |
out_rows, |
|
|
out ulong |
out_columns, |
|
|
out HPS.Publish.TextFieldKit [] |
out_text |
|
) |
| |
|
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()
Removes the buttons setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetEverything()
Removes all data from the table.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHeader()
Removes the header setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHTML()
◆ UnsetHTMLStyle()
◆ UnsetText()
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