HPS::Publish::LinkKit

class HPS.Publish.LinkKit : public HPS.SprocketKit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this LinkKit has any values set on it.

Return: true if no values are set on this LinkKit, false otherwise.

bool Equals (HPS.Publish.LinkKit in_kit)

Check if the source LinkKit is equivalent to this LinkKit.

Param in_kit: The source LinkKit to compare to this LinkKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

LinkKit (): The default constructor creates an empty LinkKit object.

LinkKit (HPS.Publish.LinkKit in_kit)

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

Param in_kit: The source LinkKit to copy.

override HPS.Type ObjectType ()

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).

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

void Set (HPS.Publish.LinkKit in_kit)

Copies the source LinkKit into this LinkKit.

Param in_kit: The source LinkKit to copy.

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 A3DPDFLinkData::m_sColor.

Param in_color: The color of the border for the link.
Return: A reference to this 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 A3DPDFLinkData::m_iBorderWidth.

Param in_width: The border width in points for the link.
Return: A reference to this 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 A3DPDFLinkData::m_eHighlightingMode.

Param in_mode: The highlighting mode for the link.
Return: A reference to this 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 A3DPDFLinkData::m_pcJavascriptString.

Param in_source: The JavaScript source or file (depending on the next argument) for the link.
Return: A reference to this 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 A3DPDFLinkData::m_pcJavascriptString.

Param in_source: The JavaScript source or file (depending on the next argument) for the link.
Param in_type: The type of the preceding argument. Defaults to Source.Type.Code.
Return: A reference to this LinkKit.

void Show (out HPS.Publish.LinkKit out_kit)

Copies this LinkKit into the given LinkKit.

Param out_kit: The LinkKit to populate with the contents of this LinkKit.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color setting.

Param out_color: The border color of the link.
Return: true if a border color was specified, false otherwise.

bool ShowBorderWidth (out int out_width)

Shows the border width setting.

Param out_width: The border width of the link.
Return: true if a border width was specified, false otherwise.

bool ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode)

Shows the highlighting mode setting.

Param out_mode: The highlighting mode of the link.
Return: true if a highlighting mode was specified, false otherwise.

bool ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type)

Shows the JavaScript setting.

Param out_source: The JavaScript source or file (depending on the next argument) for the link.
Param out_type: The type of the preceding argument.
Return: true if a JavaScript source or file was specified, false otherwise.

HPS.Publish.LinkKit UnsetBorderColor ()

Removes the border color setting.