|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The LinkKit class is a user space object. It acts as the container for all data that can be used to specify a link for a Publish PDF.
◆ LinkKit() [1/2]
HPS.Publish.LinkKit.LinkKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty LinkKit object.
◆ LinkKit() [2/2]
The copy constructor creates a new LinkKit object that contains the same settings as the source LinkKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.LinkKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this LinkKit has any values set on it.
- Returns
- true if no values are set on this LinkKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source LinkKit is equivalent to this LinkKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.Publish.LinkKit.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()
◆ SetBorderColor()
Sets the color of the border for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor.
- Parameters
-
in_color | The color of the border for the link. |
- Returns
- A reference to this LinkKit.
◆ SetBorderWidth()
Sets the border width in points for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_iBorderWidth.
- Parameters
-
in_width | The border width in points for the link. |
- Returns
- A reference to this LinkKit.
◆ SetHighlighting()
Sets the highlighting mode for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_eHighlightingMode.
- Parameters
-
in_mode | The highlighting mode for the link. |
- Returns
- A reference to this LinkKit.
◆ SetJavaScript() [1/2]
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.
- Parameters
-
in_source | The JavaScript source or file (depending on the next argument) for the link. |
in_type | The type of the preceding argument. Defaults to Source.Type.Code. |
- Returns
- A reference to this LinkKit.
◆ SetJavaScript() [2/2]
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.
- Parameters
-
in_source | The JavaScript source or file (depending on the next argument) for the link. |
- Returns
- A reference to this LinkKit.
◆ Show()
◆ ShowBorderColor()
bool HPS.Publish.LinkKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color setting.
- Parameters
-
out_color | The border color of the link. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderWidth()
bool HPS.Publish.LinkKit.ShowBorderWidth |
( |
out int |
out_width | ) |
|
|
inline |
Shows the border width setting.
- Parameters
-
out_width | The border width of the link. |
- Returns
- true if a border width was specified, false otherwise.
◆ ShowHighlighting()
Shows the highlighting mode setting.
- Parameters
-
out_mode | The highlighting mode of the link. |
- Returns
- true if a highlighting mode was specified, false otherwise.
◆ ShowJavaScript()
Shows the JavaScript setting.
- Parameters
-
out_source | The JavaScript source or file (depending on the next argument) for the link. |
out_type | The type of the preceding argument. |
- Returns
- true if a JavaScript source or file was specified, false otherwise.
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this LinkKit.
◆ UnsetBorderWidth()
Removes the border width setting.
- Returns
- A reference to this LinkKit.
◆ UnsetEverything()
Removes all data from the link.
- Returns
- A reference to this LinkKit.
◆ UnsetHighlighting()
Removes the highlighting mode setting.
- Returns
- A reference to this LinkKit.
◆ UnsetJavaScript()
Removes the JavaScript setting.
- Returns
- A reference to this LinkKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs