< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.CheckBoxKit Class Reference

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

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

Public Member Functions

 CheckBoxKit ()
 The default constructor creates an empty CheckBoxKit object. More...
 
 CheckBoxKit (HPS.Publish.CheckBoxKit in_kit)
 The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this CheckBoxKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.CheckBoxKit in_kit)
 Check if the source CheckBoxKit is equivalent to this CheckBoxKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Publish.CheckBoxKit in_kit)
 Copies the source CheckBoxKit into this CheckBoxKit. More...
 
HPS.Publish.CheckBoxKit SetBorder (bool in_state)
 Sets whether the check box has a border. More...
 
HPS.Publish.CheckBoxKit SetBorderColor (HPS.RGBColor in_color)
 Sets the border color for the check box. More...
 
HPS.Publish.CheckBoxKit SetBorderStyle (HPS.Publish.Border.Style in_style)
 Sets the border style for the check box. More...
 
HPS.Publish.CheckBoxKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
 Sets the border thickness for the check box. More...
 
HPS.Publish.CheckBoxKit SetDefaultState (bool in_state)
 Sets whether the check box is checked by default. More...
 
HPS.Publish.CheckBoxKit SetExportValue (string in_export_value)
 Sets the export value used when field data is exported by Acrobat functions. More...
 
HPS.Publish.CheckBoxKit SetFillColor (HPS.RGBColor in_color)
 Sets the fill color for the check box. More...
 
HPS.Publish.CheckBoxKit SetFont (HPS.Publish.Text.Font.Name in_name)
 Sets a builtin font for the check box. More...
 
HPS.Publish.CheckBoxKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
 Sets a specific font for the check box. More...
 
HPS.Publish.CheckBoxKit SetFont (string in_name)
 Sets a specific font for the check box. More...
 
HPS.Publish.CheckBoxKit SetFontSize (int in_size)
 Sets the font size for the check box. More...
 
HPS.Publish.CheckBoxKit SetLock (bool in_state)
 Sets whether the check box is locked. More...
 
HPS.Publish.CheckBoxKit SetName (string in_name)
 Sets the name of the check box. More...
 
HPS.Publish.CheckBoxKit SetPrintability (bool in_state)
 Sets the printability for the check box. More...
 
HPS.Publish.CheckBoxKit SetTextColor (HPS.RGBColor in_color)
 Sets the text color for the check box. More...
 
HPS.Publish.CheckBoxKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
 Sets the text rotation for the check box. More...
 
HPS.Publish.CheckBoxKit SetTooltip (string in_tooltip)
 Sets the tooltip for the check box. More...
 
HPS.Publish.CheckBoxKit SetVisibility (bool in_state)
 Sets the visibility for the check box. More...
 
void Show (out HPS.Publish.CheckBoxKit out_kit)
 Copies this CheckBoxKit into the given CheckBoxKit. More...
 
bool ShowBorder (out bool out_state)
 Shows the border setting for the check box. More...
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 Shows the border color for the check box. More...
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 Shows the border style for the check box. More...
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 Shows the border thickness for the check box. More...
 
bool ShowDefaultState (out bool out_default_state)
 Shows the default state for the check box. More...
 
bool ShowExportValue (out string out_export_value)
 Shows the export value for the check box. More...
 
bool ShowFillColor (out HPS.RGBColor out_color)
 Shows the fill color for the check box. 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 check box. More...
 
bool ShowFontSize (out int out_size)
 Shows the font size for the check box. More...
 
bool ShowLock (out bool out_state)
 Shows the lock setting for the check box. More...
 
bool ShowName (out string out_name)
 Shows the name for the check box. More...
 
bool ShowPrintability (out bool out_state)
 Shows the printability for the check box. More...
 
bool ShowTextColor (out HPS.RGBColor out_color)
 Shows the text color for the check box. More...
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 Shows the text rotation for the check box. More...
 
bool ShowTooltip (out string out_tooltip)
 Shows the tooltip for the check box. More...
 
bool ShowVisibility (out bool out_state)
 Shows the visibility for the check box. More...
 
HPS.Publish.CheckBoxKit UnsetBorder ()
 Removes the border setting. More...
 
HPS.Publish.CheckBoxKit UnsetBorderColor ()
 Removes the border color setting. More...
 
HPS.Publish.CheckBoxKit UnsetBorderStyle ()
 Removes the border style setting. More...
 
HPS.Publish.CheckBoxKit UnsetBorderThickness ()
 Removes the border thickness setting. More...
 
HPS.Publish.CheckBoxKit UnsetDefaultState ()
 Removes the default state setting. More...
 
HPS.Publish.CheckBoxKit UnsetEverything ()
 Removes all data from the check box. More...
 
HPS.Publish.CheckBoxKit UnsetExportValue ()
 Removes the export value setting. More...
 
HPS.Publish.CheckBoxKit UnsetFillColor ()
 Removes the fill color setting. More...
 
HPS.Publish.CheckBoxKit UnsetFont ()
 Removes the font setting. More...
 
HPS.Publish.CheckBoxKit UnsetFontSize ()
 Removes the font size setting. More...
 
HPS.Publish.CheckBoxKit UnsetLock ()
 Removes the lock setting. More...
 
HPS.Publish.CheckBoxKit UnsetName ()
 Removes the name setting. More...
 
HPS.Publish.CheckBoxKit UnsetPrintability ()
 Removes the printability setting. More...
 
HPS.Publish.CheckBoxKit UnsetTextColor ()
 Removes the text color setting. More...
 
HPS.Publish.CheckBoxKit UnsetTextRotation ()
 Removes the text rotation setting. More...
 
HPS.Publish.CheckBoxKit UnsetTooltip ()
 Removes the tooltip setting. More...
 
HPS.Publish.CheckBoxKit 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.CheckBoxKit GetDefault ()
 Creates a CheckBoxKit which contains the default settings. More...
 
static bool operator!= (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b)
 
static bool operator== (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit 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 CheckBoxKit class is a user space object.

It acts as the container for all data that can be used to specify a check box for a Publish PDF.

Constructor & Destructor Documentation

HPS.Publish.CheckBoxKit.CheckBoxKit ( )

The default constructor creates an empty CheckBoxKit object.

HPS.Publish.CheckBoxKit.CheckBoxKit ( HPS.Publish.CheckBoxKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_check_box_kit" kindref="compound">CheckBoxKit</ref> to copy.

Member Function Documentation

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

Indicates whether this CheckBoxKit has any values set on it.

Returns
true if no values are set on this CheckBoxKit, false otherwise.

Reimplemented from HPS.Object.

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

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

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

Creates a CheckBoxKit 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 CheckBoxKit passed to a function.

Returns
A CheckBoxKit with the default settings.
override HPS.Type HPS.Publish.CheckBoxKit.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.CheckBoxKit.Set ( HPS.Publish.CheckBoxKit  in_kit)

Copies the source CheckBoxKit into this CheckBoxKit.

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

Sets whether the check box 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_check_box_data.html#a8f59c630e0f26f15d6bab9660499b36e">A3DPDFCheckBoxData::m_bHasBorder</ulink>.

Parameters
in_stateWhether the check box has a border.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderColor ( HPS.RGBColor  in_color)

Sets the border color for the check box.

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_check_box_data.html#ab11458bd156a91bc2ac7eae2f265147b">A3DPDFCheckBoxData::m_sBorderColor</ulink>.

Parameters
in_colorThe border color of the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderStyle ( HPS.Publish.Border.Style  in_style)

Sets the border style for the check box.

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_check_box_data.html#ae9d37141615cba0ab402366fa7a90f8a">A3DPDFCheckBoxData::m_eLineStyleBorder</ulink>.

Parameters
in_styleThe border style for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderThickness ( HPS.Publish.Border.Thickness  in_thickness)

Sets the border thickness for the check box.

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_check_box_data.html#ad8dc5ab66d688a364e9c3212a15f9b89">A3DPDFCheckBoxData::m_eThicknessBorder</ulink>.

Parameters
in_thicknessThe border thickness for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetDefaultState ( bool  in_state)

Sets whether the check box is checked by default.

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_check_box_data.html#a2f3a43f0dcd4ad80bb3ba35b40f7201b">A3DPDFCheckBoxData::m_bIsCheckedByDefault</ulink>.

Parameters
in_stateWhether the check box is checked by default.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetExportValue ( string  in_export_value)

Sets the export value used when field data is exported by Acrobat functions.

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_check_box_data.html#a36f565103f4e88c33a1f65d3c10b268b">A3DPDFCheckBoxData::m_pcExportValue</ulink>.

Parameters
in_export_valueUTF8-encoded export value of the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFillColor ( HPS.RGBColor  in_color)

Sets the fill color for the check box.

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_check_box_data.html#ae3fef1552b3a1735132d4638698030c7">A3DPDFCheckBoxData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFCheckBoxData::m_bHasFillColor</ulink> to true.

Parameters
in_colorThe fill color for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFont ( HPS.Publish.Text.Font.Name  in_name)

Sets a builtin font for the check box.

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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.

Parameters
in_nameThe builtin font for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFont ( string  in_name,
HPS.Publish.Text.Font.Style  in_style 
)

Sets a specific font for the check box.

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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.

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

Sets a specific font for the check box.

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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.

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

Sets the font size for the check box.

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_check_box_data.html#aa53034d802575ab762f72f5aa0451e45">A3DPDFCheckBoxData::m_iFontSize</ulink>.

Parameters
in_sizeThe font size for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetLock ( bool  in_state)

Sets whether the check box 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_check_box_data.html#a97d7fa4d8f4bc1d6b40efe78bba5ba85">A3DPDFCheckBoxData::m_bIsLocked</ulink>.

Parameters
in_stateWhether the check box is locked.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetName ( string  in_name)

Sets the name of the check box.

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_check_box_data.html#a70f813f3a8e5ed1b545ceb7216ea7c7f">A3DPDFCheckBoxData::m_pcName</ulink>.

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

Sets the printability for the check box.

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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>.

Parameters
in_stateThe printability for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTextColor ( HPS.RGBColor  in_color)

Sets the text color for the check box.

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_check_box_data.html#a6137dcadfaec886dd2e98bed49d20169">A3DPDFCheckBoxData::m_sTextColor</ulink>.

Parameters
in_colorThe text color for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTextRotation ( HPS.Publish.Text.Rotation  in_rotation)

Sets the text rotation for the check box.

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_check_box_data.html#a717710765f5bd52fc4a71c0fc461ea7f">A3DPDFCheckBoxData::m_eTextOrientation</ulink>.

Parameters
in_rotationThe text rotation for the check box.
Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTooltip ( string  in_tooltip)

Sets the tooltip for the check box.

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_check_box_data.html#a29554afd13838d44df6cc14a99f1fd6f">A3DPDFCheckBoxData::m_pcTooltip</ulink>.

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

Sets the visibility for the check box.

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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>.

Parameters
in_stateThe visibility for the check box.
Returns
A reference to this CheckBoxKit.
void HPS.Publish.CheckBoxKit.Show ( out HPS.Publish.CheckBoxKit  out_kit)

Copies this CheckBoxKit into the given CheckBoxKit.

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

Shows the border setting for the check box.

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

Shows the border color for the check box.

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

Shows the border style for the check box.

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

Shows the border thickness for the check box.

Parameters
out_thicknessThe border thickness for the check box.
Returns
true if a border thickness was specified, false otherwise.
bool HPS.Publish.CheckBoxKit.ShowDefaultState ( out bool  out_default_state)

Shows the default state for the check box.

Parameters
out_default_stateThe default state for the check box.
Returns
true if a default state was specified, false otherwise.
bool HPS.Publish.CheckBoxKit.ShowExportValue ( out string  out_export_value)

Shows the export value for the check box.

Parameters
out_export_valueThe export value for the check box.
Returns
true if an export value was specified, false otherwise.
bool HPS.Publish.CheckBoxKit.ShowFillColor ( out HPS.RGBColor  out_color)

Shows the fill color for the check box.

Parameters
out_colorThe fill color for the check box.
Returns
true if a fill color was specified, false otherwise.
bool HPS.Publish.CheckBoxKit.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 check box.

Parameters
out_typeThe type of font for the check box.
out_font_nameThe explicit font name for the check box. 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 check box. 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.CheckBoxKit.ShowFontSize ( out int  out_size)

Shows the font size for the check box.

Parameters
out_sizeThe font size for the check box.
Returns
true if a font size was specified, false otherwise.
bool HPS.Publish.CheckBoxKit.ShowLock ( out bool  out_state)

Shows the lock setting for the check box.

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

Shows the name for the check box.

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

Shows the printability for the check box.

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

Shows the text color for the check box.

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

Shows the text rotation for the check box.

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

Shows the tooltip for the check box.

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

Shows the visibility for the check box.

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

Removes the border setting.

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

Removes the border color setting.

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

Removes the border style setting.

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

Removes the border thickness setting.

Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetDefaultState ( )

Removes the default state setting.

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

Removes all data from the check box.

Returns
A reference to this CheckBoxKit.
HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetExportValue ( )

Removes the export value setting.

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

Removes the fill color setting.

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

Removes the font setting.

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

Removes the font size setting.

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

Removes the lock setting.

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

Removes the name setting.

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

Removes the printability setting.

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

Removes the text color setting.

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

Removes the text rotation setting.

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

Removes the tooltip setting.

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

Removes the visibility setting.

Returns
A reference to this CheckBoxKit.

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