Inheritance diagram for HPS.Publish.SlideTableKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

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 ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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]

HPS.Publish.SlideTableKit.SlideTableKit ( )
inline

The default constructor creates an empty SlideTableKit object.

◆ SlideTableKit() [2/2]

HPS.Publish.SlideTableKit.SlideTableKit ( HPS.Publish.SlideTableKit  in_kit)
inline

The copy constructor creates a new SlideTableKit object that contains the same settings as the source SlideTableKit.

Parameters
in_kitThe source SlideTableKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.SlideTableKit.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()

bool HPS.Publish.SlideTableKit.Equals ( HPS.Publish.SlideTableKit  in_kit)
inline

Check if the source SlideTableKit is equivalent to this SlideTableKit.

Parameters
in_kitThe source SlideTableKit to compare to this SlideTableKit.
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()

void HPS.Publish.SlideTableKit.Set ( HPS.Publish.SlideTableKit  in_kit)
inline

Copies the source SlideTableKit into this SlideTableKit.

Parameters
in_kitThe source SlideTableKit to copy.

◆ 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_nameUTF8-encoded name for the previous button.
in_next_button_nameUTF8-encoded name for the next button.
Returns
A reference to this SlideTableKit.

◆ SetHeader()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHeader ( bool  in_state)
inline

Sets whether this slide table has a header.

Parameters
in_stateWhether this slide table has a header.
Returns
A reference to this SlideTableKit.

◆ SetHTML() [1/2]

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

Sets the HTML table source or file.

Parameters
in_sourceUTF8-encoded HTML table source or file (depending on the following argument).
in_typeThe type of the preceding argument. Defaults to Source.Type.Code.
Returns
A reference to this SlideTableKit.

◆ SetHTML() [2/2]

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTML ( string  in_source)
inline

Sets the HTML table source or file.

Parameters
in_sourceUTF8-encoded HTML table source or file (depending on the following argument).
Returns
A reference to this SlideTableKit.

◆ SetHTMLStyle() [1/2]

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

Sets the HTML table style source or file.

Parameters
in_sourceUTF8-encoded HTML table style source or file (depending on the following argument).
in_typeType of the preceding argument.
Returns
A reference to this SlideTableKit.

◆ SetHTMLStyle() [2/2]

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.SetHTMLStyle ( string  in_source)
inline

Sets the HTML table style source or file.

Parameters
in_sourceUTF8-encoded HTML table style source or file (depending on the following argument).
Returns
A reference to this SlideTableKit.

◆ SetText()

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

Sets the text strings for the slide table.

Parameters
in_rowsNumber of rows.
in_columnsNumber of columns.
in_textText strings for the slide table. This array should be of size in_rows * in_columns.
Returns
A reference to this SlideTableKit.

◆ Show()

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

Copies this SlideTableKit into the given SlideTableKit.

Parameters
out_kitThe SlideTableKit to populate with the contents of this SlideTableKit.

◆ 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_nameName for the previous button.
out_next_button_nameName 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_stateWhether this slide table has a header.
Returns
true if a header setting was specified, false otherwise.

◆ ShowHTML()

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

Shows the HTML table setting.

Parameters
out_sourceThe HTML table source or file (depending on the following argument).
out_typeThe type of the preceding argument.
Returns
true if an HTML table was specified, false otherwise.

◆ ShowHTMLStyle()

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

Shows the HTML table style setting.

Parameters
out_sourceThe HTML table style source or file (depending on the following argument).
out_typeThe 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_rowsNumber of rows.
out_columnsNumber of columns.
out_textText strings for the slide table.
Returns
true if text strings were specified, false otherwise.

◆ UnsetButtons()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetButtons ( )
inline

Removes the buttons setting.

Returns
A reference to this SlideTableKit.

◆ UnsetEverything()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetEverything ( )
inline

Removes all data from the table.

Returns
A reference to this SlideTableKit.

◆ UnsetHeader()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHeader ( )
inline

Removes the header setting.

Returns
A reference to this SlideTableKit.

◆ UnsetHTML()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHTML ( )
inline

Removes the HTML table setting.

Returns
A reference to this SlideTableKit.

◆ UnsetHTMLStyle()

HPS.Publish.SlideTableKit HPS.Publish.SlideTableKit.UnsetHTMLStyle ( )
inline

Removes the HTML table style setting.

Returns
A reference to this SlideTableKit.

◆ UnsetText()

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