API Search || Global Search

More...

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

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 ()
 
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. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor. 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 A3DPDFLinkData::m_iBorderWidth. 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 A3DPDFLinkData::m_eHighlightingMode. 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 A3DPDFLinkData::m_pcJavascriptString. 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 A3DPDFLinkData::m_pcJavascriptString. 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...
 
- 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 ()
 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...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual 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...
 

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

HPS.Publish.LinkKit.LinkKit ( )
inline

The default constructor creates an empty LinkKit object.

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

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.

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this LinkKit.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetBorderWidth ( )
inline

Removes the border width setting.

Returns
A reference to this LinkKit.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetEverything ( )
inline

Removes all data from the link.

Returns
A reference to this LinkKit.
HPS.Publish.LinkKit HPS.Publish.LinkKit.UnsetHighlighting ( )
inline

Removes the highlighting mode setting.

Returns
A reference to this LinkKit.
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