Inheritance diagram for HPS.Publish.TableKit:
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.TableKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.TableKit in_kit)
 
HPS.Publish.TableKit SetButton (int in_row, int in_column, HPS.Publish.ButtonKit in_button)
 
HPS.Publish.TableKit SetHTML (string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.TableKit SetHTML (string in_source)
 
HPS.Publish.TableKit SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.TableKit SetHTMLStyle (string in_source)
 
HPS.Publish.TableKit SetLink (int in_row, int in_column, HPS.Publish.LinkKit in_link)
 
HPS.Publish.TableKit SetText (int in_row, int in_column, HPS.Publish.TextKit in_text)
 
HPS.Publish.TableKit SetTextField (int in_row, int in_column, HPS.Publish.TextFieldKit in_text_field)
 
void Show (out HPS.Publish.TableKit out_kit)
 
bool ShowButton (int in_row, int in_column, out HPS.Publish.ButtonKit out_button)
 
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 ShowLink (int in_row, int in_column, out HPS.Publish.LinkKit out_link)
 
bool ShowText (int in_row, int in_column, out HPS.Publish.TextKit out_text)
 
bool ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field)
 
 TableKit ()
 
 TableKit (HPS.Publish.TableKit in_kit)
 
HPS.Publish.TableKit UnsetButton (int in_row, int in_column)
 
HPS.Publish.TableKit UnsetEverything ()
 
HPS.Publish.TableKit UnsetHTML ()
 
HPS.Publish.TableKit UnsetHTMLStyle ()
 
HPS.Publish.TableKit UnsetLink (int in_row, int in_column)
 
HPS.Publish.TableKit UnsetText (int in_row, int in_column)
 
HPS.Publish.TableKit UnsetTextField (int in_row, int in_column)
 
- 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.TableKit a, HPS.Publish.TableKit b)
 
static bool operator== (HPS.Publish.TableKit a, HPS.Publish.TableKit 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 TableKit class is a user space object. It acts as the container for all data that can be used to specify a table for a Publish PDF.

Warning

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

Constructor & Destructor Documentation

◆ TableKit() [1/2]

HPS.Publish.TableKit.TableKit ( )
inline

The default constructor creates an empty TableKit object.

◆ TableKit() [2/2]

HPS.Publish.TableKit.TableKit ( HPS.Publish.TableKit  in_kit)
inline

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

Parameters
in_kitThe source TableKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.TableKit.Empty ( )
inlinevirtual

Indicates whether this TableKit has any values set on it.

Returns
true if no values are set on this TableKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source TableKit is equivalent to this TableKit.

Parameters
in_kitThe source TableKit to compare to this TableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Publish.TableKit.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.TableKit.Set ( HPS.Publish.TableKit  in_kit)
inline

Copies the source TableKit into this TableKit.

Parameters
in_kitThe source TableKit to copy.

◆ SetButton()

HPS.Publish.TableKit HPS.Publish.TableKit.SetButton ( int  in_row,
int  in_column,
HPS.Publish.ButtonKit  in_button 
)
inline

Adds a button to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertButtonInTable.

Parameters
in_rowRow in which to add the button.
in_columnColumn in which to add the button.
in_buttonButton to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetHTML() [1/2]

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

◆ SetHTML() [2/2]

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

◆ SetHTMLStyle() [1/2]

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

◆ SetHTMLStyle() [2/2]

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

◆ SetLink()

HPS.Publish.TableKit HPS.Publish.TableKit.SetLink ( int  in_row,
int  in_column,
HPS.Publish.LinkKit  in_link 
)
inline

Adds a link to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertLinkInTable.

Parameters
in_rowRow in which to add the link.
in_columnColumn in which to add the link.
in_linkLink to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetText()

HPS.Publish.TableKit HPS.Publish.TableKit.SetText ( int  in_row,
int  in_column,
HPS.Publish.TextKit  in_text 
)
inline

Adds text to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.

Parameters
in_rowRow in which to add the text.
in_columnColumn in which to add the text.
in_textText to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetTextField()

HPS.Publish.TableKit HPS.Publish.TableKit.SetTextField ( int  in_row,
int  in_column,
HPS.Publish.TextFieldKit  in_text_field 
)
inline

Adds a text field to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextFieldInTable.

Parameters
in_rowRow in which to add the text field.
in_columnColumn in which to add the text field.
in_text_fieldText field to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ Show()

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

Copies this TableKit into the given TableKit.

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

◆ ShowButton()

bool HPS.Publish.TableKit.ShowButton ( int  in_row,
int  in_column,
out HPS.Publish.ButtonKit  out_button 
)
inline

Shows the button at the specified row and column.

Parameters
in_rowRow in which to show the button.
in_columnColumn in which to show the button.
out_buttonThe button at the specified row and column in the table.
Returns
true if a button was added at the specified row and column, false otherwise.

◆ ShowHTML()

bool HPS.Publish.TableKit.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.TableKit.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.

◆ ShowLink()

bool HPS.Publish.TableKit.ShowLink ( int  in_row,
int  in_column,
out HPS.Publish.LinkKit  out_link 
)
inline

Shows the link at the specified row and column.

Parameters
in_rowRow in which to show the link.
in_columnColumn in which to show the link.
out_linkThe link at the specified row and column in the table.
Returns
true if a link was added at the specified row and column, false otherwise.

◆ ShowText()

bool HPS.Publish.TableKit.ShowText ( int  in_row,
int  in_column,
out HPS.Publish.TextKit  out_text 
)
inline

Shows the text at the specified row and column.

Parameters
in_rowRow in which to show the text.
in_columnColumn in which to show the text.
out_textThe text at the specified row and column in the table.
Returns
true if text was added at the specified row and column, false otherwise.

◆ ShowTextField()

bool HPS.Publish.TableKit.ShowTextField ( int  in_row,
int  in_column,
out HPS.Publish.TextFieldKit  out_text_field 
)
inline

Shows the link at the specified row and column.

Parameters
in_rowRow in which to show the link.
in_columnColumn in which to show the link.
out_text_fieldThe text field at the specified row and column in the table.
Returns
true if a link was added at the specified row and column, false otherwise.

◆ UnsetButton()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetButton ( int  in_row,
int  in_column 
)
inline

Removes the button at the specified row and column.

Returns
A reference to this TableKit.

◆ UnsetEverything()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetEverything ( )
inline

Removes all data from the table.

Returns
A reference to this TableKit.

◆ UnsetHTML()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetHTML ( )
inline

Removes the HTML table setting.

Returns
A reference to this TableKit.

◆ UnsetHTMLStyle()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetHTMLStyle ( )
inline

Removes the HTML table style setting.

Returns
A reference to this TableKit.

◆ UnsetLink()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetLink ( int  in_row,
int  in_column 
)
inline

Removes the link at the specified row and column.

Returns
A reference to this TableKit.

◆ UnsetText()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetText ( int  in_row,
int  in_column 
)
inline

Removes the text at the specified row and column.

Returns
A reference to this TableKit.

◆ UnsetTextField()

HPS.Publish.TableKit HPS.Publish.TableKit.UnsetTextField ( int  in_row,
int  in_column 
)
inline

Removes the text field at the specified row and column.

Returns
A reference to this TableKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs