< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.TableKit Class Reference

The TableKit class is a user space object. More...

Inheritance diagram for HPS.Publish.TableKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this TableKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.TableKit in_kit)
 Check if the source TableKit is equivalent to this TableKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Publish.TableKit in_kit)
 Copies the source TableKit into this TableKit. More...
 
HPS.Publish.TableKit SetButton (int in_row, int in_column, HPS.Publish.ButtonKit in_button)
 Adds a button to this table at the specified row and column. More...
 
HPS.Publish.TableKit SetHTML (string in_source, HPS.Publish.Source.Type in_type)
 Sets the HTML table source or file. More...
 
HPS.Publish.TableKit SetHTML (string in_source)
 Sets the HTML table source or file. More...
 
HPS.Publish.TableKit SetHTMLStyle (string in_source, HPS.Publish.Source.Type in_type)
 Sets the HTML table style source or file. More...
 
HPS.Publish.TableKit SetHTMLStyle (string in_source)
 Sets the HTML table style source or file. More...
 
HPS.Publish.TableKit SetLink (int in_row, int in_column, HPS.Publish.LinkKit in_link)
 Adds a link to this table at the specified row and column. More...
 
HPS.Publish.TableKit SetText (int in_row, int in_column, HPS.Publish.TextKit in_text)
 Adds text to this table at the specified row and column. More...
 
HPS.Publish.TableKit SetTextField (int in_row, int in_column, HPS.Publish.TextFieldKit in_text_field)
 Adds a text field to this table at the specified row and column. More...
 
void Show (out HPS.Publish.TableKit out_kit)
 Copies this TableKit into the given TableKit. More...
 
bool ShowButton (int in_row, int in_column, out HPS.Publish.ButtonKit out_button)
 Shows the button at the specified row and column. 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 ShowLink (int in_row, int in_column, out HPS.Publish.LinkKit out_link)
 Shows the link at the specified row and column. More...
 
bool ShowText (int in_row, int in_column, out HPS.Publish.TextKit out_text)
 Shows the text at the specified row and column. More...
 
bool ShowTextField (int in_row, int in_column, out HPS.Publish.TextFieldKit out_text_field)
 Shows the link at the specified row and column. More...
 
 TableKit ()
 The default constructor creates an empty TableKit object. More...
 
 TableKit (HPS.Publish.TableKit in_kit)
 The copy constructor creates a new TableKit object that contains the same settings as the source TableKit. More...
 
HPS.Publish.TableKit UnsetButton (int in_row, int in_column)
 Removes the button at the specified row and column. More...
 
HPS.Publish.TableKit UnsetEverything ()
 Removes all data from the table. More...
 
HPS.Publish.TableKit UnsetHTML ()
 Removes the HTML table setting. More...
 
HPS.Publish.TableKit UnsetHTMLStyle ()
 Removes the HTML table style setting. More...
 
HPS.Publish.TableKit UnsetLink (int in_row, int in_column)
 Removes the link at the specified row and column. More...
 
HPS.Publish.TableKit UnsetText (int in_row, int in_column)
 Removes the text at the specified row and column. More...
 
HPS.Publish.TableKit UnsetTextField (int in_row, int in_column)
 Removes the text field at the specified row and column. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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.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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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. Note that to insert tables into a Publish PDF, the TableToPDFPublish add-on must be installed.

Constructor & Destructor Documentation

HPS.Publish.TableKit.TableKit ( )

The default constructor creates an empty TableKit object.

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref> to copy.

Member Function Documentation

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

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.

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

Check if the source TableKit is equivalent to this TableKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.Publish.TableKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Publish.TableKit.Set ( HPS.Publish.TableKit  in_kit)

Copies the source TableKit into this TableKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref> to copy.
HPS.Publish.TableKit HPS.Publish.TableKit.SetButton ( int  in_row,
int  in_column,
HPS.Publish.ButtonKit  in_button 
)

Adds a button to this table at the specified row and column.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga1012ddd4a4d8e0fa1f62b0a51e4618d3">A3DPDFPageInsertButtonInTable</ulink>.

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.
HPS.Publish.TableKit HPS.Publish.TableKit.SetHTML ( string  in_source,
HPS.Publish.Source.Type  in_type 
)

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 <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>.
Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.SetHTML ( string  in_source)

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.
HPS.Publish.TableKit HPS.Publish.TableKit.SetHTMLStyle ( string  in_source,
HPS.Publish.Source.Type  in_type 
)

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.
HPS.Publish.TableKit HPS.Publish.TableKit.SetHTMLStyle ( string  in_source)

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.
HPS.Publish.TableKit HPS.Publish.TableKit.SetLink ( int  in_row,
int  in_column,
HPS.Publish.LinkKit  in_link 
)

Adds a link to this table at the specified row and column.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#ga073798a1d1582e79b31e3b38f1cbf105">A3DPDFPageInsertLinkInTable</ulink>.

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.
HPS.Publish.TableKit HPS.Publish.TableKit.SetText ( int  in_row,
int  in_column,
HPS.Publish.TextKit  in_text 
)

Adds text to this table at the specified row and column.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gad3d5385fd9ad890e578007ee62b0100b">A3DPDFPageInsertTextInTable</ulink>.

Parameters
in_rowRow in which to add the text.
in_columnColumn in which to add the text.
in_text<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> to add at the specified row and column in the table.
Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.SetTextField ( int  in_row,
int  in_column,
HPS.Publish.TextFieldKit  in_text_field 
)

Adds a text field to this table at the specified row and column.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gacc519dd8ddd5c28899eb093d59b8e313">A3DPDFPageInsertTextFieldInTable</ulink>.

Parameters
in_rowRow in which to add the text field.
in_columnColumn in which to add the text field.
in_text_field<ref refid="class_h_p_s_1_1_publish_1_1_text" kindref="compound">Text</ref> field to add at the specified row and column in the table.
Returns
A reference to this TableKit.
void HPS.Publish.TableKit.Show ( out HPS.Publish.TableKit  out_kit)

Copies this TableKit into the given TableKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_table_kit" kindref="compound">TableKit</ref>.
bool HPS.Publish.TableKit.ShowButton ( int  in_row,
int  in_column,
out HPS.Publish.ButtonKit  out_button 
)

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 specifed row and column in the table.
Returns
true if a button was added at the specified row and column, false otherwise.
bool HPS.Publish.TableKit.ShowHTML ( out string  out_source,
out HPS.Publish.Source.Type  out_type 
)

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.
bool HPS.Publish.TableKit.ShowHTMLStyle ( out string  out_source,
out HPS.Publish.Source.Type  out_type 
)

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.
bool HPS.Publish.TableKit.ShowLink ( int  in_row,
int  in_column,
out HPS.Publish.LinkKit  out_link 
)

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 specifed row and column in the table.
Returns
true if a link was added at the specified row and column, false otherwise.
bool HPS.Publish.TableKit.ShowText ( int  in_row,
int  in_column,
out HPS.Publish.TextKit  out_text 
)

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 specifed row and column in the table.
Returns
true if text was added at the specified row and column, false otherwise.
bool HPS.Publish.TableKit.ShowTextField ( int  in_row,
int  in_column,
out HPS.Publish.TextFieldKit  out_text_field 
)

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.
Returns
true if a link was added at the specified row and column, false otherwise.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetButton ( int  in_row,
int  in_column 
)

Removes the button at the specified row and column.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetEverything ( )

Removes all data from the table.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetHTML ( )

Removes the HTML table setting.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetHTMLStyle ( )

Removes the HTML table style setting.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetLink ( int  in_row,
int  in_column 
)

Removes the link at the specified row and column.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetText ( int  in_row,
int  in_column 
)

Removes the text at the specified row and column.

Returns
A reference to this TableKit.
HPS.Publish.TableKit HPS.Publish.TableKit.UnsetTextField ( int  in_row,
int  in_column 
)

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: