Inheritance diagram for HPS.Publish.LinkKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.LinkKit in_kit)
 
override int GetHashCode ()
 
 LinkKit ()
 
 LinkKit (HPS.Publish.LinkKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.LinkKit in_kit)
 
HPS.Publish.LinkKit SetBorderColor (HPS.RGBColor in_color)
 
HPS.Publish.LinkKit SetBorderWidth (int in_width)
 
HPS.Publish.LinkKit SetHighlighting (HPS.Publish.Highlighting.Mode in_mode)
 
HPS.Publish.LinkKit SetJavaScript (string in_source, HPS.Publish.Source.Type in_type)
 
HPS.Publish.LinkKit SetJavaScript (string in_source)
 
void Show (out HPS.Publish.LinkKit out_kit)
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 
bool ShowBorderWidth (out int out_width)
 
bool ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode)
 
bool ShowJavaScript (out string out_source, out HPS.Publish.Source.Type out_type)
 
HPS.Publish.LinkKit UnsetBorderColor ()
 
HPS.Publish.LinkKit UnsetBorderWidth ()
 
HPS.Publish.LinkKit UnsetEverything ()
 
HPS.Publish.LinkKit UnsetHighlighting ()
 
HPS.Publish.LinkKit UnsetJavaScript ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ LinkKit() [1/2]

HPS.Publish.LinkKit.LinkKit ( )
inline

The default constructor creates an empty LinkKit object.

◆ LinkKit() [2/2]

HPS.Publish.LinkKit.LinkKit ( HPS.Publish.LinkKit  in_kit)
inline

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

Parameters
in_kitThe source LinkKit to copy.

Member Function Documentation

◆ 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()

bool HPS.Publish.LinkKit.Equals ( HPS.Publish.LinkKit  in_kit)
inline

Check if the source LinkKit is equivalent to this LinkKit.

Parameters
in_kitThe source LinkKit to compare to this LinkKit.
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()

void HPS.Publish.LinkKit.Set ( HPS.Publish.LinkKit  in_kit)
inline

Copies the source LinkKit into this LinkKit.

Parameters
in_kitThe source LinkKit to copy.

◆ SetBorderColor()

HPS.Publish.LinkKit HPS.Publish.LinkKit.SetBorderColor ( HPS.RGBColor  in_color)
inline

Sets the color of the border for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor.

Parameters
in_colorThe color of the border for the link.
Returns
A reference to this LinkKit.

◆ SetBorderWidth()

HPS.Publish.LinkKit HPS.Publish.LinkKit.SetBorderWidth ( int  in_width)
inline

Sets the border width in points for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_iBorderWidth.

Parameters
in_widthThe border width in points for the link.
Returns
A reference to this LinkKit.

◆ SetHighlighting()

HPS.Publish.LinkKit HPS.Publish.LinkKit.SetHighlighting ( HPS.Publish.Highlighting.Mode  in_mode)
inline

Sets the highlighting mode for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_eHighlightingMode.

Parameters
in_modeThe highlighting mode for the link.
Returns
A reference to this LinkKit.

◆ SetJavaScript() [1/2]

HPS.Publish.LinkKit HPS.Publish.LinkKit.SetJavaScript ( string  in_source,
HPS.Publish.Source.Type  in_type 
)
inline

Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the link.
in_typeThe type of the preceding argument. Defaults to Source.Type.Code.
Returns
A reference to this LinkKit.

◆ SetJavaScript() [2/2]

HPS.Publish.LinkKit HPS.Publish.LinkKit.SetJavaScript ( string  in_source)
inline

Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the link.
Returns
A reference to this LinkKit.

◆ Show()

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

Copies this LinkKit into the given LinkKit.

Parameters
out_kitThe LinkKit to populate with the contents of this LinkKit.

◆ ShowBorderColor()

bool HPS.Publish.LinkKit.ShowBorderColor ( out HPS.RGBColor  out_color)
inline

Shows the border color setting.

Parameters
out_colorThe 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_widthThe border width of the link.
Returns
true if a border width was specified, false otherwise.

◆ ShowHighlighting()

bool HPS.Publish.LinkKit.ShowHighlighting ( out HPS.Publish.Highlighting.Mode  out_mode)
inline

Shows the highlighting mode setting.

Parameters
out_modeThe highlighting mode of the link.
Returns
true if a highlighting mode was specified, false otherwise.

◆ ShowJavaScript()

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

Shows the JavaScript setting.

Parameters
out_sourceThe JavaScript source or file (depending on the next argument) for the link.
out_typeThe type of the preceding argument.
Returns
true if a JavaScript source or file was specified, false otherwise.

◆ UnsetBorderColor()

HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this LinkKit.

◆ UnsetBorderWidth()

HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderWidth ( )
inline

Removes the border width setting.

Returns
A reference to this LinkKit.

◆ UnsetEverything()

HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetEverything ( )
inline

Removes all data from the link.

Returns
A reference to this LinkKit.

◆ UnsetHighlighting()

HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetHighlighting ( )
inline

Removes the highlighting mode setting.

Returns
A reference to this LinkKit.

◆ UnsetJavaScript()

HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetJavaScript ( )
inline

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