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. More...
Public Member Functions | |
override void | Dispose () |
LinkKit () | |
The default constructor creates an empty LinkKit object. More... | |
LinkKit (HPS.Publish.LinkKit in_kit) | |
The copy constructor creates a new LinkKit object that contains the same settings as the source LinkKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Publish.LinkKit in_kit) |
Copies the source LinkKit into this LinkKit. More... | |
void | Show (out HPS.Publish.LinkKit out_kit) |
Copies this LinkKit into the given LinkKit. More... | |
override bool | Empty () |
Indicates whether this LinkKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Publish.LinkKit in_kit) |
Check if the source LinkKit is equivalent to this LinkKit. More... | |
HPS.Publish.LinkKit | SetJavaScript (string in_source, HPS.Publish.Source.Type in_type) |
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a30ccc5b6802182423393fb898d422a99">A3DPDFLinkData::m_pcJavascriptString</ulink>. More... | |
HPS.Publish.LinkKit | SetJavaScript (string in_source) |
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a30ccc5b6802182423393fb898d422a99">A3DPDFLinkData::m_pcJavascriptString</ulink>. More... | |
HPS.Publish.LinkKit | SetBorderWidth (int in_width) |
Sets the border width in points for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a9379305ecf8db0edd6465a554945847f">A3DPDFLinkData::m_iBorderWidth</ulink>. More... | |
HPS.Publish.LinkKit | SetHighlighting (HPS.Publish.Highlighting.Mode in_mode) |
Sets the highlighting mode for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a4d44cce7dcae5ac7780d543ee0194276">A3DPDFLinkData::m_eHighlightingMode</ulink>. More... | |
HPS.Publish.LinkKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the color of the border for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a2c07d8af3446367af217e9f65f0bfcc2">A3DPDFLinkData::m_sColor</ulink>. More... | |
HPS.Publish.LinkKit | UnsetJavaScript () |
Removes the JavaScript setting. More... | |
HPS.Publish.LinkKit | UnsetBorderWidth () |
Removes the border width setting. More... | |
HPS.Publish.LinkKit | UnsetHighlighting () |
Removes the highlighting mode setting. More... | |
HPS.Publish.LinkKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.LinkKit | UnsetEverything () |
Removes all data from the link. More... | |
bool | ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type) |
Shows the JavaScript setting. More... | |
bool | ShowBorderWidth (out int out_width) |
Shows the border width setting. More... | |
bool | ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode) |
Shows the highlighting mode setting. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
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... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.Publish.LinkKit a, HPS.Publish.LinkKit b) |
static bool | operator!= (HPS.Publish.LinkKit a, HPS.Publish.LinkKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
The default constructor creates an empty LinkKit object.
|
inline |
|
inlinevirtual |
Indicates whether this LinkKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source LinkKit is equivalent to this LinkKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_link_kit" kindref="compound">LinkKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_link_kit" kindref="compound">LinkKit</ref>. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
|
inline |
Sets the color of the border for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a2c07d8af3446367af217e9f65f0bfcc2">A3DPDFLinkData::m_sColor</ulink>.
in_color | The color of the border for the link. |
|
inline |
Sets the border width in points for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a9379305ecf8db0edd6465a554945847f">A3DPDFLinkData::m_iBorderWidth</ulink>.
in_width | The border width in points for the link. |
|
inline |
Sets the highlighting mode for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a4d44cce7dcae5ac7780d543ee0194276">A3DPDFLinkData::m_eHighlightingMode</ulink>.
in_mode | The highlighting mode for the link. |
|
inline |
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a30ccc5b6802182423393fb898d422a99">A3DPDFLinkData::m_pcJavascriptString</ulink>.
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 <ref refid="class_h_p_s_1_1_publish_1_1_source_1a5e72b242e24c67a4d9d777bce395bb92aca0dbad92a874b2f69b549293387925e" kindref="member">Source::Type::Code</ref>. |
|
inline |
Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_link_data.html#a30ccc5b6802182423393fb898d422a99">A3DPDFLinkData::m_pcJavascriptString</ulink>.
in_source | The JavaScript source or file (depending on the next argument) for the link. |
|
inline |
|
inline |
Shows the border color setting.
out_color | The border color of the link. |
|
inline |
Shows the border width setting.
out_width | The border width of the link. |
|
inline |
Shows the highlighting mode setting.
out_mode | The highlighting mode of the link. |
|
inline |
Shows the JavaScript setting.
out_source | The JavaScript source or file (depending on the next argument) for the link. |
out_type | The type of the preceding argument. |
|
inline |
Removes the border color setting.
|
inline |
Removes the border width setting.
|
inline |
Removes all data from the link.
|
inline |
Removes the highlighting mode setting.
|
inline |
Removes the JavaScript setting.