The ButtonKit class is a user space object. It acts as the container for all data that can be used to specify a button for a Publish PDF. More...

Public Member Functions | |
ButtonKit () | |
The default constructor creates an empty ButtonKit object. More... | |
ButtonKit (HPS.Publish.ButtonKit in_kit) | |
The copy constructor creates a new ButtonKit object that contains the same settings as the source ButtonKit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ButtonKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.ButtonKit in_kit) |
Check if the source ButtonKit is equivalent to this ButtonKit. More... | |
override int | GetHashCode () |
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.ButtonKit in_kit) |
Copies the source ButtonKit into this ButtonKit. More... | |
HPS.Publish.ButtonKit | SetBorder (bool in_state) |
Sets whether the button has a border. This corresponds to the value that will be passed to A3DPDFButtonData::m_bHasBorder. More... | |
HPS.Publish.ButtonKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor. More... | |
HPS.Publish.ButtonKit | SetBorderStyle (HPS.Publish.Border.Style in_style) |
Sets the border style for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLineStyleBorder. More... | |
HPS.Publish.ButtonKit | SetBorderThickness (HPS.Publish.Border.Thickness in_thickness) |
Sets the border thickness for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eThicknessBorder. More... | |
HPS.Publish.ButtonKit | SetFillColor (HPS.RGBColor in_color) |
Sets the fill color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sFillColor and implicitly sets A3DPDFButtonData::m_bHasFillColor to true. More... | |
HPS.Publish.ButtonKit | SetFont (HPS.Publish.Text.Font.Name in_name) |
Sets a builtin font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName. More... | |
HPS.Publish.ButtonKit | SetFont (string in_name, HPS.Publish.Text.Font.Style in_style) |
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName. More... | |
HPS.Publish.ButtonKit | SetFont (string in_name) |
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName. More... | |
HPS.Publish.ButtonKit | SetFontSize (int in_size) |
Sets the font size for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_iFontSize. More... | |
HPS.Publish.ButtonKit | SetHighlighting (HPS.Publish.Highlighting.Mode in_mode) |
Sets the highlighting mode for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eHighlightingMode. More... | |
HPS.Publish.ButtonKit | SetIconImage (HPS.Publish.ImageKit in_image) |
Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage. More... | |
HPS.Publish.ButtonKit | SetLabel (string in_label) |
Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel. More... | |
HPS.Publish.ButtonKit | SetLabelPosition (HPS.Publish.Label.Position in_position) |
Sets the label position for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLayoutTextIcon. More... | |
HPS.Publish.ButtonKit | SetLock (bool in_state) |
Sets whether the button is locked. This corresponds to the value that will be passed to A3DPDFButtonData::m_bIsLocked. More... | |
HPS.Publish.ButtonKit | SetName (string in_name) |
Sets the name of the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcName. More... | |
HPS.Publish.ButtonKit | SetPrintability (bool in_state) |
Sets the printability for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField. More... | |
HPS.Publish.ButtonKit | SetTextColor (HPS.RGBColor in_color) |
Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor. More... | |
HPS.Publish.ButtonKit | SetTextRotation (HPS.Publish.Text.Rotation in_rotation) |
Sets the text rotation for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eTextOrientation. More... | |
HPS.Publish.ButtonKit | SetTooltip (string in_tooltip) |
Sets the tooltip for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcTooltip. More... | |
HPS.Publish.ButtonKit | SetVisibility (bool in_state) |
Sets the visibility for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField. More... | |
void | Show (out HPS.Publish.ButtonKit out_kit) |
Copies this ButtonKit into the given ButtonKit. More... | |
bool | ShowBorder (out bool out_state) |
Shows the border setting for the button. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color for the button. More... | |
bool | ShowBorderStyle (out HPS.Publish.Border.Style out_style) |
Shows the border style for the button. More... | |
bool | ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness) |
Shows the border thickness for the button. More... | |
bool | ShowFillColor (out HPS.RGBColor out_color) |
Shows the fill color for the button. More... | |
bool | ShowFont (out HPS.Publish.Text.Font.Type out_type, out HPS.Publish.Text.Font.Name out_font, out string out_font_name, out HPS.Publish.Text.Font.Style out_style) |
Shows the font for the button. More... | |
bool | ShowFontSize (out int out_size) |
Shows the font size for the button. More... | |
bool | ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode) |
Shows the highlighting mode for the button. More... | |
bool | ShowIconImage (out HPS.Publish.ImageKit out_image) |
Shows the icon image for the button. More... | |
bool | ShowLabel (out string out_label) |
Shows the label for the button. More... | |
bool | ShowLabelPosition (out HPS.Publish.Label.Position out_position) |
Shows the label position for the button. More... | |
bool | ShowLock (out bool out_state) |
Shows the lock setting for the button. More... | |
bool | ShowName (out string out_name) |
Shows the name for the button. More... | |
bool | ShowPrintability (out bool out_state) |
Shows the printability for the button. More... | |
bool | ShowTextColor (out HPS.RGBColor out_color) |
Shows the text color for the button. More... | |
bool | ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation) |
Shows the text rotation for the button. More... | |
bool | ShowTooltip (out string out_tooltip) |
Shows the tooltip for the button. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility for the button. More... | |
HPS.Publish.ButtonKit | UnsetBorder () |
Removes the border setting. More... | |
HPS.Publish.ButtonKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.ButtonKit | UnsetBorderStyle () |
Removes the border style setting. More... | |
HPS.Publish.ButtonKit | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
HPS.Publish.ButtonKit | UnsetEverything () |
Removes all data from the button. More... | |
HPS.Publish.ButtonKit | UnsetFillColor () |
Removes the fill color setting. More... | |
HPS.Publish.ButtonKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.ButtonKit | UnsetFontSize () |
Removes the font size setting. More... | |
HPS.Publish.ButtonKit | UnsetHighlighting () |
Removes the highlighting mode setting. More... | |
HPS.Publish.ButtonKit | UnsetIconImage () |
Removes the icon image setting. More... | |
HPS.Publish.ButtonKit | UnsetLabel () |
Removes the label setting. More... | |
HPS.Publish.ButtonKit | UnsetLabelPosition () |
Removes the label position setting. More... | |
HPS.Publish.ButtonKit | UnsetLock () |
Removes the lock setting. More... | |
HPS.Publish.ButtonKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.ButtonKit | UnsetPrintability () |
Removes the printability setting. More... | |
HPS.Publish.ButtonKit | UnsetTextColor () |
Removes the text color setting. More... | |
HPS.Publish.ButtonKit | UnsetTextRotation () |
Removes the text rotation setting. More... | |
HPS.Publish.ButtonKit | UnsetTooltip () |
Removes the tooltip setting. More... | |
HPS.Publish.ButtonKit | UnsetVisibility () |
Removes the visibility 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. 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... | |
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 HPS.Publish.ButtonKit | GetDefault () |
Creates a ButtonKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a button unless a setting is overridden by the ButtonKit passed to a function. More... | |
static bool | operator!= (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit b) |
static bool | operator== (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ButtonKit class is a user space object. It acts as the container for all data that can be used to specify a button for a Publish PDF.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ButtonKit object.
|
inline |
Member Function Documentation
|
inlinevirtual |
Indicates whether this ButtonKit has any values set on it.
- Returns
- true if no values are set on this ButtonKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
inlinestatic |
Creates a ButtonKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a button unless a setting is overridden by the ButtonKit passed to a function.
- Returns
- A ButtonKit with the default settings.
|
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.Object.
|
inline |
|
inline |
Sets whether the button has a border. This corresponds to the value that will be passed to A3DPDFButtonData::m_bHasBorder.
- Parameters
-
in_state Whether the button has a border.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.
- Parameters
-
in_color The border color of the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the border style for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLineStyleBorder.
- Parameters
-
in_style The border style for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the border thickness for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eThicknessBorder.
- Parameters
-
in_thickness The border thickness for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the fill color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sFillColor and implicitly sets A3DPDFButtonData::m_bHasFillColor to true.
- Parameters
-
in_color The fill color for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets a builtin font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name The builtin font for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name UTF8-encoded font name for the button. in_style The style of font to use for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name UTF8-encoded font name for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the font size for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_iFontSize.
- Parameters
-
in_size The font size for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the highlighting mode for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eHighlightingMode.
- Parameters
-
in_mode The highlighting mode for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.
- Parameters
-
in_image The icon image for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel.
- Parameters
-
in_label UTF8-encoded label for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the label position for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLayoutTextIcon.
- Parameters
-
in_position The label position for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets whether the button is locked. This corresponds to the value that will be passed to A3DPDFButtonData::m_bIsLocked.
- Parameters
-
in_state Whether the button is locked.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the name of the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcName.
- Parameters
-
in_name UTF8-encoded name of the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the printability for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state The printability for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.
- Parameters
-
in_color The text color for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the text rotation for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eTextOrientation.
- Parameters
-
in_rotation The text rotation for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the tooltip for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcTooltip.
- Parameters
-
in_tooltip UTF8-encoded tooltip text for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Sets the visibility for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state The visibility for the button.
- Returns
- A reference to this ButtonKit.
|
inline |
|
inline |
Shows the border setting for the button.
- Parameters
-
out_state Whether the button has a border.
- Returns
- true if a border setting was specified, false otherwise.
|
inline |
Shows the border color for the button.
- Parameters
-
out_color The border color of the button.
- Returns
- true if a border color was specified, false otherwise.
|
inline |
Shows the border style for the button.
- Parameters
-
out_style The border style for the button.
- Returns
- true if a border style was specified, false otherwise.
|
inline |
Shows the border thickness for the button.
- Parameters
-
out_thickness The border thickness for the button.
- Returns
- true if a border thickness was specified, false otherwise.
|
inline |
Shows the fill color for the button.
- Parameters
-
out_color The fill color for the button.
- Returns
- true if a fill color was specified, false otherwise.
|
inline |
Shows the font for the button.
- Parameters
-
out_type The type of font for the button. out_font The built-in font for the button. This is only valid if out_type is Text.Font.Type.BuiltIn. out_font_name The explicit font name for the button. This is only valid if out_type is Text.Font.Type.Explicit. out_style The font style for the button. This is only valid if out_type is Text.Font.Type.Explicit.
- Returns
- true if a font was specified, false otherwise.
|
inline |
Shows the font size for the button.
- Parameters
-
out_size The font size for the button.
- Returns
- true if a font size was specified, false otherwise.
|
inline |
Shows the highlighting mode for the button.
- Parameters
-
out_mode The highlighting mode for the button.
- Returns
- true if a highlighting mode was specified, false otherwise.
|
inline |
Shows the icon image for the button.
- Parameters
-
out_image The icon image for the button.
- Returns
- true if an icon image was specified, false otherwise.
|
inline |
Shows the label for the button.
- Parameters
-
out_label The label for the button.
- Returns
- true if a label was specified, false otherwise.
|
inline |
Shows the label position for the button.
- Parameters
-
out_position The label position for the button.
- Returns
- true if a label position was specified, false otherwise.
|
inline |
Shows the lock setting for the button.
- Returns
- true if a lock setting was specified, false otherwise.
|
inline |
Shows the name for the button.
- Parameters
-
out_name The name of the button.
- Returns
- true if a name was specified, false otherwise.
|
inline |
Shows the printability for the button.
- Parameters
-
out_state The printability for the button.
- Returns
- true if a printability was specified, false otherwise.
|
inline |
Shows the text color for the button.
- Parameters
-
out_color The text color for the button.
- Returns
- true if a text color was specified, false otherwise.
|
inline |
Shows the text rotation for the button.
- Parameters
-
out_rotation The text rotation for the button.r
- Returns
- true if a rotation was specified, false otherwise.
|
inline |
Shows the tooltip for the button.
- Parameters
-
out_tooltip The tooltip text for the button.
- Returns
- true if a tooltip was specified, false otherwise.
|
inline |
Shows the visibility for the button.
- Parameters
-
out_state The visibility for the button.
- Returns
- true if a visibility was specified, false otherwise.
|
inline |
Removes the border setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the border color setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the border style setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the border thickness setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes all data from the button.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the fill color setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the font setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the font size setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the highlighting mode setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the icon image setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the label setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the label position setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the lock setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the name setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the printability setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the text color setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the text rotation setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the tooltip setting.
- Returns
- A reference to this ButtonKit.
|
inline |
Removes the visibility setting.
- Returns
- A reference to this ButtonKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs