REFERENCE MANUAL
The LinkKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this LinkKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.LinkKit in_kit) |
Check if the source LinkKit is equivalent to this LinkKit. More... | |
override int | GetHashCode () |
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. More... | |
void | Set (HPS.Publish.LinkKit in_kit) |
Copies the source LinkKit into this LinkKit. More... | |
HPS.Publish.LinkKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the color of the border for the link. More... | |
HPS.Publish.LinkKit | SetBorderWidth (int in_width) |
Sets the border width in points for the link. More... | |
HPS.Publish.LinkKit | SetHighlighting (HPS.Publish.Highlighting.Mode in_mode) |
Sets the highlighting mode for the link. More... | |
HPS.Publish.LinkKit | SetJavaScript (string in_source, HPS.Publish.Source.Type in_type) |
Sets the JavaScript source or file for the link. More... | |
HPS.Publish.LinkKit | SetJavaScript (string in_source) |
Sets the JavaScript source or file for the link. More... | |
void | Show (out HPS.Publish.LinkKit out_kit) |
Copies this LinkKit into the given LinkKit. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color 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 | ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type) |
Shows the JavaScript setting. More... | |
HPS.Publish.LinkKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.LinkKit | UnsetBorderWidth () |
Removes the border width setting. More... | |
HPS.Publish.LinkKit | UnsetEverything () |
Removes all data from the link. More... | |
HPS.Publish.LinkKit | UnsetHighlighting () |
Removes the highlighting mode setting. More... | |
HPS.Publish.LinkKit | UnsetJavaScript () |
Removes the JavaScript setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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.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 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.Publish.LinkKit.LinkKit | ( | ) |
The default constructor creates an empty LinkKit object.
HPS.Publish.LinkKit.LinkKit | ( | HPS.Publish.LinkKit | in_kit | ) |
|
virtual |
Indicates whether this LinkKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.LinkKit.Equals | ( | HPS.Publish.LinkKit | in_kit | ) |
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>. |
|
virtual |
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.
void HPS.Publish.LinkKit.Set | ( | HPS.Publish.LinkKit | in_kit | ) |
HPS.Publish.LinkKit 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>.
in_color | The color of the border for the link. |
HPS.Publish.LinkKit 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>.
in_width | The border width in points for the link. |
HPS.Publish.LinkKit 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>.
in_mode | The highlighting mode for the link. |
HPS.Publish.LinkKit 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>.
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>. |
HPS.Publish.LinkKit 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>.
in_source | The JavaScript source or file (depending on the next argument) for the link. |
void HPS.Publish.LinkKit.Show | ( | out HPS.Publish.LinkKit | out_kit | ) |
bool HPS.Publish.LinkKit.ShowBorderColor | ( | out HPS.RGBColor | out_color | ) |
Shows the border color setting.
out_color | The border color of the link. |
bool HPS.Publish.LinkKit.ShowBorderWidth | ( | out int | out_width | ) |
Shows the border width setting.
out_width | The border width of the link. |
bool HPS.Publish.LinkKit.ShowHighlighting | ( | out HPS.Publish.Highlighting.Mode | out_mode | ) |
Shows the highlighting mode setting.
out_mode | The highlighting mode of the link. |
bool HPS.Publish.LinkKit.ShowJavaScript | ( | out string | out_source, |
out HPS.Publish.Source.Type | out_type | ||
) |
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. |
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderColor | ( | ) |
Removes the border color setting.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderWidth | ( | ) |
Removes the border width setting.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetEverything | ( | ) |
Removes all data from the link.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetHighlighting | ( | ) |
Removes the highlighting mode setting.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetJavaScript | ( | ) |
Removes the JavaScript setting.