< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.ButtonKit Class Reference

The ButtonKit class is a user space object. More...

Inheritance diagram for HPS.Publish.ButtonKit:
HPS.Sprocket HPS.Object

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. 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. More...
 
HPS.Publish.ButtonKit SetBorderColor (HPS.RGBColor in_color)
 Sets the border color for the button. More...
 
HPS.Publish.ButtonKit SetBorderStyle (HPS.Publish.Border.Style in_style)
 Sets the border style for the button. More...
 
HPS.Publish.ButtonKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
 Sets the border thickness for the button. More...
 
HPS.Publish.ButtonKit SetFillColor (HPS.RGBColor in_color)
 Sets the fill color for the button. More...
 
HPS.Publish.ButtonKit SetFont (HPS.Publish.Text.Font.Name in_name)
 Sets a builtin font for the button. More...
 
HPS.Publish.ButtonKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
 Sets a specific font for the button. More...
 
HPS.Publish.ButtonKit SetFont (string in_name)
 Sets a specific font for the button. More...
 
HPS.Publish.ButtonKit SetFontSize (int in_size)
 Sets the font size for the button. More...
 
HPS.Publish.ButtonKit SetHighlighting (HPS.Publish.Highlighting.Mode in_mode)
 Sets the highlighting mode for the button. More...
 
HPS.Publish.ButtonKit SetIconImage (HPS.Publish.ImageKit in_image)
 Sets the icon image for the button. More...
 
HPS.Publish.ButtonKit SetLabel (string in_label)
 Sets the label for the button. More...
 
HPS.Publish.ButtonKit SetLabelPosition (HPS.Publish.Label.Position in_position)
 Sets the label position for the button. More...
 
HPS.Publish.ButtonKit SetLock (bool in_state)
 Sets whether the button is locked. More...
 
HPS.Publish.ButtonKit SetName (string in_name)
 Sets the name of the button. More...
 
HPS.Publish.ButtonKit SetPrintability (bool in_state)
 Sets the printability for the button. More...
 
HPS.Publish.ButtonKit SetTextColor (HPS.RGBColor in_color)
 Sets the text color for the button. More...
 
HPS.Publish.ButtonKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
 Sets the text rotation for the button. More...
 
HPS.Publish.ButtonKit SetTooltip (string in_tooltip)
 Sets the tooltip for the button. More...
 
HPS.Publish.ButtonKit SetVisibility (bool in_state)
 Sets the visibility for the button. 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_name, 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...
 
- 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. More...
 

Static Public Member Functions

static HPS.Publish.ButtonKit GetDefault ()
 Creates a ButtonKit which contains the default settings. More...
 
static bool operator!= (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit b)
 
static bool operator== (HPS.Publish.ButtonKit a, HPS.Publish.ButtonKit 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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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

HPS.Publish.ButtonKit.ButtonKit ( )

The default constructor creates an empty ButtonKit object.

HPS.Publish.ButtonKit.ButtonKit ( HPS.Publish.ButtonKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref> to copy.

Member Function Documentation

override bool HPS.Publish.ButtonKit.Empty ( )
virtual

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.

bool HPS.Publish.ButtonKit.Equals ( HPS.Publish.ButtonKit  in_kit)

Check if the source ButtonKit is equivalent to this ButtonKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.ButtonKit HPS.Publish.ButtonKit.GetDefault ( )
static

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.
override HPS.Type HPS.Publish.ButtonKit.ObjectType ( )
virtual

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.

void HPS.Publish.ButtonKit.Set ( HPS.Publish.ButtonKit  in_kit)

Copies the source ButtonKit into this ButtonKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref> to copy.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetBorder ( bool  in_state)

Sets whether the button has a border.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#ad4c7a9512340cf47280a54ea224d40d2">A3DPDFButtonData::m_bHasBorder</ulink>.

Parameters
in_stateWhether the button has a border.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a436165abe7c60728449388fa267c6826">A3DPDFButtonData::m_sBorderColor</ulink>.

Parameters
in_colorThe border color of the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a1a8a17081af8162147029abf458f6262">A3DPDFButtonData::m_eLineStyleBorder</ulink>.

Parameters
in_styleThe border style for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a28d3d317552251ee79e0353339381d1d">A3DPDFButtonData::m_eThicknessBorder</ulink>.

Parameters
in_thicknessThe border thickness for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a29030fda42fac379b85c88976ce17524">A3DPDFButtonData::m_sFillColor</ulink> and implicitly sets <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#ad98c822b7d53b1ca4200325882ab5b0b">A3DPDFButtonData::m_bHasFillColor</ulink> to true.

Parameters
in_colorThe fill color for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#aae9e31522c1c3eb0a0f2ad59d3425586">A3DPDFButtonData::m_pcFontName</ulink>.

Parameters
in_nameThe builtin font for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#aae9e31522c1c3eb0a0f2ad59d3425586">A3DPDFButtonData::m_pcFontName</ulink>.

Parameters
in_nameUTF8-encoded font name for the button.
in_styleThe style of font to use for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetFont ( string  in_name)

Sets a specific font for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#aae9e31522c1c3eb0a0f2ad59d3425586">A3DPDFButtonData::m_pcFontName</ulink>.

Parameters
in_nameUTF8-encoded font name for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetFontSize ( int  in_size)

Sets the font size for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a4af94fc49eef5d2db53caac85b6d2044">A3DPDFButtonData::m_iFontSize</ulink>.

Parameters
in_sizeThe font size for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a9cda56ca95ddb8c35a6cbe143c337409">A3DPDFButtonData::m_eHighlightingMode</ulink>.

Parameters
in_modeThe highlighting mode for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a60e42630bd048b7d45b6537ce3c47227">A3DPDFButtonData::m_pImage</ulink>.

Parameters
in_imageThe icon image for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetLabel ( string  in_label)

Sets the label for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#af73e13a1e51846375d5c63a7c488a7ba">A3DPDFButtonData::m_pcLabel</ulink>.

Parameters
in_labelUTF8-encoded label for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a1a5e4feedae6a2af08b3525f55b39ae2">A3DPDFButtonData::m_eLayoutTextIcon</ulink>.

Parameters
in_positionThe label position for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetLock ( bool  in_state)

Sets whether the button is locked.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#ae1776f49140f614ff443339008f3481c">A3DPDFButtonData::m_bIsLocked</ulink>.

Parameters
in_stateWhether the button is locked.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetName ( string  in_name)

Sets the name of the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a472a84d194be5e85a890b7cfcb98a6ad">A3DPDFButtonData::m_pcName</ulink>.

Parameters
in_nameUTF8-encoded name of the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetPrintability ( bool  in_state)

Sets the printability for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a7ac1ac94a00ed6e7af90d2740e8c21eb">A3DPDFButtonData::m_eFormField</ulink>.

Parameters
in_stateThe printability for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a49df6a4cddc535bb82910055c6048e79">A3DPDFButtonData::m_sTextColor</ulink>.

Parameters
in_colorThe text color for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#ac054240b48718fdc938cfbc6731dd741">A3DPDFButtonData::m_eTextOrientation</ulink>.

Parameters
in_rotationThe text rotation for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetTooltip ( string  in_tooltip)

Sets the tooltip for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a022cdbd273b1ae114cd10d98a8f93d64">A3DPDFButtonData::m_pcTooltip</ulink>.

Parameters
in_tooltipUTF8-encoded tooltip text for the button.
Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.SetVisibility ( bool  in_state)

Sets the visibility for the button.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_button_data.html#a7ac1ac94a00ed6e7af90d2740e8c21eb">A3DPDFButtonData::m_eFormField</ulink>.

Parameters
in_stateThe visibility for the button.
Returns
A reference to this ButtonKit.
void HPS.Publish.ButtonKit.Show ( out HPS.Publish.ButtonKit  out_kit)

Copies this ButtonKit into the given ButtonKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_button_kit" kindref="compound">ButtonKit</ref>.
bool HPS.Publish.ButtonKit.ShowBorder ( out bool  out_state)

Shows the border setting for the button.

Parameters
out_stateWhether the button has a border.
Returns
true if a border setting was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowBorderColor ( out HPS.RGBColor  out_color)

Shows the border color for the button.

Parameters
out_colorThe border color of the button.
Returns
true if a border color was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowBorderStyle ( out HPS.Publish.Border.Style  out_style)

Shows the border style for the button.

Parameters
out_styleThe border style for the button.
Returns
true if a border style was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowBorderThickness ( out HPS.Publish.Border.Thickness  out_thickness)

Shows the border thickness for the button.

Parameters
out_thicknessThe border thickness for the button.
Returns
true if a border thickness was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowFillColor ( out HPS.RGBColor  out_color)

Shows the fill color for the button.

Parameters
out_colorThe fill color for the button.
Returns
true if a fill color was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowFont ( out HPS.Publish.Text.Font.Type  out_type,
out HPS.Publish.Text.Font.Name  out_name,
out string  out_font_name,
out HPS.Publish.Text.Font.Style  out_style 
)

Shows the font for the button.

Parameters
out_typeThe type of font for the button.
out_font_nameThe explicit font name for the button. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>.
out_styleThe font style for the button. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>.
Returns
true if a font was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowFontSize ( out int  out_size)

Shows the font size for the button.

Parameters
out_sizeThe font size for the button.
Returns
true if a font size was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowHighlighting ( out HPS.Publish.Highlighting.Mode  out_mode)

Shows the highlighting mode for the button.

Parameters
out_modeThe highlighting mode for the button.
Returns
true if a highlighting mode was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowIconImage ( out HPS.Publish.ImageKit  out_image)

Shows the icon image for the button.

Parameters
out_imageThe icon image for the button.
Returns
true if an icon image was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowLabel ( out string  out_label)

Shows the label for the button.

Parameters
out_labelThe label for the button.
Returns
true if a label was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowLabelPosition ( out HPS.Publish.Label.Position  out_position)

Shows the label position for the button.

Parameters
out_positionThe label position for the button.
Returns
true if a label position was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowLock ( out bool  out_state)

Shows the lock setting for the button.

Returns
true if a lock setting was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowName ( out string  out_name)

Shows the name for the button.

Parameters
out_nameThe name of the button.
Returns
true if a name was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowPrintability ( out bool  out_state)

Shows the printability for the button.

Parameters
out_stateThe printability for the button.
Returns
true if a printability was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowTextColor ( out HPS.RGBColor  out_color)

Shows the text color for the button.

Parameters
out_colorThe text color for the button.
Returns
true if a text color was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowTextRotation ( out HPS.Publish.Text.Rotation  out_rotation)

Shows the text rotation for the button.

Parameters
out_rotationThe text rotation for the button.r
Returns
true if a rotation was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowTooltip ( out string  out_tooltip)

Shows the tooltip for the button.

Parameters
out_tooltipThe tooltip text for the button.
Returns
true if a tooltip was specified, false otherwise.
bool HPS.Publish.ButtonKit.ShowVisibility ( out bool  out_state)

Shows the visibility for the button.

Parameters
out_stateThe visibility for the button.
Returns
true if a visibility was specified, false otherwise.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetBorder ( )

Removes the border setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetBorderColor ( )

Removes the border color setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetBorderStyle ( )

Removes the border style setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetBorderThickness ( )

Removes the border thickness setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetEverything ( )

Removes all data from the button.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetFillColor ( )

Removes the fill color setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetFont ( )

Removes the font setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetFontSize ( )

Removes the font size setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetHighlighting ( )

Removes the highlighting mode setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetIconImage ( )

Removes the icon image setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetLabel ( )

Removes the label setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetLabelPosition ( )

Removes the label position setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetLock ( )

Removes the lock setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetName ( )

Removes the name setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetPrintability ( )

Removes the printability setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetTextColor ( )

Removes the text color setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetTextRotation ( )

Removes the text rotation setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetTooltip ( )

Removes the tooltip setting.

Returns
A reference to this ButtonKit.
HPS.Publish.ButtonKit HPS.Publish.ButtonKit.UnsetVisibility ( )

Removes the visibility setting.

Returns
A reference to this ButtonKit.

The documentation for this class was generated from the following file: