|
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) |
|
| 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 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.
◆ TableKit() [1/2]
HPS.Publish.TableKit.TableKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty TableKit object.
◆ TableKit() [2/2]
The copy constructor creates a new TableKit object that contains the same settings as the source TableKit.
- Parameters
-
◆ 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()
Check if the source TableKit is equivalent to this TableKit.
- Parameters
-
- 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()
◆ SetButton()
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_row | Row in which to add the button. |
in_column | Column in which to add the button. |
in_button | Button to add at the specified row and column in the table. |
- Returns
- A reference to this TableKit.
◆ 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 TableKit.
◆ 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 TableKit.
◆ 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 TableKit.
◆ 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 TableKit.
◆ SetLink()
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_row | Row in which to add the link. |
in_column | Column in which to add the link. |
in_link | Link to add at the specified row and column in the table. |
- Returns
- A reference to this TableKit.
◆ SetText()
Adds text to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.
- Parameters
-
in_row | Row in which to add the text. |
in_column | Column in which to add the text. |
in_text | Text to add at the specified row and column in the table. |
- Returns
- A reference to this TableKit.
◆ SetTextField()
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_row | Row in which to add the text field. |
in_column | Column in which to add the text field. |
in_text_field | Text field to add at the specified row and column in the table. |
- Returns
- A reference to this TableKit.
◆ Show()
◆ ShowButton()
Shows the button at the specified row and column.
- Parameters
-
in_row | Row in which to show the button. |
in_column | Column in which to show the button. |
out_button | The 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()
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.
◆ 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_row | Row in which to show the link. |
in_column | Column in which to show the link. |
out_link | The 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_row | Row in which to show the text. |
in_column | Column in which to show the text. |
out_text | The 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()
Shows the link at the specified row and column.
- Parameters
-
in_row | Row in which to show the link. |
in_column | Column in which to show the link. |
out_text_field | The 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()
Removes the button at the specified row and column.
- Returns
- A reference to this TableKit.
◆ UnsetEverything()
Removes all data from the table.
- Returns
- A reference to this TableKit.
◆ UnsetHTML()
Removes the HTML table setting.
- Returns
- A reference to this TableKit.
◆ UnsetHTMLStyle()
Removes the HTML table style setting.
- Returns
- A reference to this TableKit.
◆ UnsetLink()
Removes the link at the specified row and column.
- Returns
- A reference to this TableKit.
◆ UnsetText()
Removes the text at the specified row and column.
- Returns
- A reference to this TableKit.
◆ UnsetTextField()
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