
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. 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... | |
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... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
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. 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 IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
The default constructor creates an empty LinkKit object.
|
inline |
Member Function Documentation
|
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.
|
inline |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
|
inline |
|
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_color The color of the border for the link.
- Returns
- A reference to this LinkKit.
|
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_width The border width in points for the link.
- Returns
- A reference to this LinkKit.
|
inline |
Sets the highlighting mode for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_eHighlightingMode.
- Parameters
-
in_mode The highlighting mode for the link.
- Returns
- A reference to this LinkKit.
|
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_source The JavaScript source or file (depending on the next argument) for the link. in_type The type of the preceding argument. Defaults to Source.Type.Code.
- Returns
- A reference to this LinkKit.
|
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_source The JavaScript source or file (depending on the next argument) for the link.
- Returns
- A reference to this LinkKit.
|
inline |
|
inline |
Shows the border color setting.
- Parameters
-
out_color The border color of the link.
- Returns
- true if a border color was specified, false otherwise.
|
inline |
Shows the border width setting.
- Parameters
-
out_width The border width of the link.
- Returns
- true if a border width was specified, false otherwise.
|
inline |
Shows the highlighting mode setting.
- Parameters
-
out_mode The highlighting mode of the link.
- Returns
- true if a highlighting mode was specified, false otherwise.
|
inline |
Shows the JavaScript setting.
- Parameters
-
out_source The JavaScript source or file (depending on the next argument) for the link. out_type The type of the preceding argument.
- Returns
- true if a JavaScript source or file was specified, false otherwise.
|
inline |
Removes the border color setting.
- Returns
- A reference to this LinkKit.
|
inline |
Removes the border width setting.
- Returns
- A reference to this LinkKit.
|
inline |
Removes all data from the link.
- Returns
- A reference to this LinkKit.
|
inline |
Removes the highlighting mode setting.
- Returns
- A reference to this LinkKit.
|
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