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

Public Member Functions

 CheckBoxKit ()
 
 CheckBoxKit (HPS.Publish.CheckBoxKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.CheckBoxKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.CheckBoxKit in_kit)
 
HPS.Publish.CheckBoxKit SetBorder (bool in_state)
 
HPS.Publish.CheckBoxKit SetBorderColor (HPS.RGBColor in_color)
 
HPS.Publish.CheckBoxKit SetBorderStyle (HPS.Publish.Border.Style in_style)
 
HPS.Publish.CheckBoxKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
 
HPS.Publish.CheckBoxKit SetDefaultState (bool in_state)
 
HPS.Publish.CheckBoxKit SetExportValue (string in_export_value)
 
HPS.Publish.CheckBoxKit SetFillColor (HPS.RGBColor in_color)
 
HPS.Publish.CheckBoxKit SetFont (HPS.Publish.Text.Font.Name in_name)
 
HPS.Publish.CheckBoxKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
 
HPS.Publish.CheckBoxKit SetFont (string in_name)
 
HPS.Publish.CheckBoxKit SetFontSize (int in_size)
 
HPS.Publish.CheckBoxKit SetLock (bool in_state)
 
HPS.Publish.CheckBoxKit SetName (string in_name)
 
HPS.Publish.CheckBoxKit SetPrintability (bool in_state)
 
HPS.Publish.CheckBoxKit SetTextColor (HPS.RGBColor in_color)
 
HPS.Publish.CheckBoxKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
 
HPS.Publish.CheckBoxKit SetTooltip (string in_tooltip)
 
HPS.Publish.CheckBoxKit SetVisibility (bool in_state)
 
void Show (out HPS.Publish.CheckBoxKit out_kit)
 
bool ShowBorder (out bool out_state)
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 
bool ShowDefaultState (out bool out_default_state)
 
bool ShowExportValue (out string out_export_value)
 
bool ShowFillColor (out HPS.RGBColor out_color)
 
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)
 
bool ShowFontSize (out int out_size)
 
bool ShowLock (out bool out_state)
 
bool ShowName (out string out_name)
 
bool ShowPrintability (out bool out_state)
 
bool ShowTextColor (out HPS.RGBColor out_color)
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 
bool ShowTooltip (out string out_tooltip)
 
bool ShowVisibility (out bool out_state)
 
HPS.Publish.CheckBoxKit UnsetBorder ()
 
HPS.Publish.CheckBoxKit UnsetBorderColor ()
 
HPS.Publish.CheckBoxKit UnsetBorderStyle ()
 
HPS.Publish.CheckBoxKit UnsetBorderThickness ()
 
HPS.Publish.CheckBoxKit UnsetDefaultState ()
 
HPS.Publish.CheckBoxKit UnsetEverything ()
 
HPS.Publish.CheckBoxKit UnsetExportValue ()
 
HPS.Publish.CheckBoxKit UnsetFillColor ()
 
HPS.Publish.CheckBoxKit UnsetFont ()
 
HPS.Publish.CheckBoxKit UnsetFontSize ()
 
HPS.Publish.CheckBoxKit UnsetLock ()
 
HPS.Publish.CheckBoxKit UnsetName ()
 
HPS.Publish.CheckBoxKit UnsetPrintability ()
 
HPS.Publish.CheckBoxKit UnsetTextColor ()
 
HPS.Publish.CheckBoxKit UnsetTextRotation ()
 
HPS.Publish.CheckBoxKit UnsetTooltip ()
 
HPS.Publish.CheckBoxKit UnsetVisibility ()
 
- 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 ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Publish.CheckBoxKit GetDefault ()
 
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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ CheckBoxKit() [1/2]

HPS.Publish.CheckBoxKit.CheckBoxKit ( )
inline

The default constructor creates an empty CheckBoxKit object.

◆ CheckBoxKit() [2/2]

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

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

Parameters
in_kitThe source CheckBoxKit to copy.

Member Function Documentation

◆ Empty()

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

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.

◆ Equals()

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

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

Parameters
in_kitThe source CheckBoxKit to compare to this CheckBoxKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.Publish.CheckBoxKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.SprocketKit.

◆ Set()

void HPS.Publish.CheckBoxKit.Set ( HPS.Publish.CheckBoxKit  in_kit)
inline

Copies the source CheckBoxKit into this CheckBoxKit.

Parameters
in_kitThe source CheckBoxKit to copy.

◆ SetBorder()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorder ( bool  in_state)
inline

Sets whether the check box has a border. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bHasBorder.

Parameters
in_stateWhether the check box has a border.
Returns
A reference to this CheckBoxKit.

◆ SetBorderColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderColor ( HPS.RGBColor  in_color)
inline

Sets the border color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sBorderColor.

Parameters
in_colorThe border color of the check box.
Returns
A reference to this CheckBoxKit.

◆ SetBorderStyle()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderStyle ( HPS.Publish.Border.Style  in_style)
inline

Sets the border style for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eLineStyleBorder.

Parameters
in_styleThe border style for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetBorderThickness()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetBorderThickness ( HPS.Publish.Border.Thickness  in_thickness)
inline

Sets the border thickness for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eThicknessBorder.

Parameters
in_thicknessThe border thickness for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetDefaultState()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetDefaultState ( bool  in_state)
inline

Sets whether the check box is checked by default. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsCheckedByDefault.

Parameters
in_stateWhether the check box is checked by default.
Returns
A reference to this CheckBoxKit.

◆ SetExportValue()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetExportValue ( string  in_export_value)
inline

Sets the export value used when field data is exported by Acrobat functions. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcExportValue.

Parameters
in_export_valueUTF8-encoded export value of the check box.
Returns
A reference to this CheckBoxKit.

◆ SetFillColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFillColor ( HPS.RGBColor  in_color)
inline

Sets the fill color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sFillColor and implicitly sets A3DPDFCheckBoxData::m_bHasFillColor to true.

Parameters
in_colorThe fill color for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetFont() [1/3]

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFont ( HPS.Publish.Text.Font.Name  in_name)
inline

Sets a builtin font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.

Parameters
in_nameThe builtin font for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetFont() [2/3]

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFont ( string  in_name,
HPS.Publish.Text.Font.Style  in_style 
)
inline

Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.

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.

◆ SetFont() [3/3]

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFont ( string  in_name)
inline

Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.

Parameters
in_nameUTF8-encoded font name for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetFontSize()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetFontSize ( int  in_size)
inline

Sets the font size for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_iFontSize.

Parameters
in_sizeThe font size for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetLock()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetLock ( bool  in_state)
inline

Sets whether the check box is locked. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsLocked.

Parameters
in_stateWhether the check box is locked.
Returns
A reference to this CheckBoxKit.

◆ SetName()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetName ( string  in_name)
inline

Sets the name of the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcName.

Parameters
in_nameUTF8-encoded name of the check box.
Returns
A reference to this CheckBoxKit.

◆ SetPrintability()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetPrintability ( bool  in_state)
inline

Sets the printability for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.

Parameters
in_stateThe printability for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetTextColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTextColor ( HPS.RGBColor  in_color)
inline

Sets the text color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sTextColor.

Parameters
in_colorThe text color for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetTextRotation()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTextRotation ( HPS.Publish.Text.Rotation  in_rotation)
inline

Sets the text rotation for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eTextOrientation.

Parameters
in_rotationThe text rotation for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetTooltip()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetTooltip ( string  in_tooltip)
inline

Sets the tooltip for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcTooltip.

Parameters
in_tooltipUTF8-encoded tooltip text for the check box.
Returns
A reference to this CheckBoxKit.

◆ SetVisibility()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.SetVisibility ( bool  in_state)
inline

Sets the visibility for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.

Parameters
in_stateThe visibility for the check box.
Returns
A reference to this CheckBoxKit.

◆ Show()

void HPS.Publish.CheckBoxKit.Show ( out HPS.Publish.CheckBoxKit  out_kit)
inline

Copies this CheckBoxKit into the given CheckBoxKit.

Parameters
out_kitThe CheckBoxKit to populate with the contents of this CheckBoxKit.

◆ ShowBorder()

bool HPS.Publish.CheckBoxKit.ShowBorder ( out bool  out_state)
inline

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.

◆ ShowBorderColor()

bool HPS.Publish.CheckBoxKit.ShowBorderColor ( out HPS.RGBColor  out_color)
inline

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.

◆ ShowBorderStyle()

bool HPS.Publish.CheckBoxKit.ShowBorderStyle ( out HPS.Publish.Border.Style  out_style)
inline

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.

◆ ShowBorderThickness()

bool HPS.Publish.CheckBoxKit.ShowBorderThickness ( out HPS.Publish.Border.Thickness  out_thickness)
inline

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.

◆ ShowDefaultState()

bool HPS.Publish.CheckBoxKit.ShowDefaultState ( out bool  out_default_state)
inline

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.

◆ ShowExportValue()

bool HPS.Publish.CheckBoxKit.ShowExportValue ( out string  out_export_value)
inline

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.

◆ ShowFillColor()

bool HPS.Publish.CheckBoxKit.ShowFillColor ( out HPS.RGBColor  out_color)
inline

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.

◆ ShowFont()

bool HPS.Publish.CheckBoxKit.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 
)
inline

Shows the font for the check box.

Parameters
out_typeThe type of font for the check box.
out_fontThe built-in font for the check box. This is only valid if out_type is Text.Font.Type.BuiltIn.
out_font_nameThe explicit font name for the check box. This is only valid if out_type is Text.Font.Type.Explicit.
out_styleThe font style for the check box. This is only valid if out_type is Text.Font.Type.Explicit.
Returns
true if a font was specified, false otherwise.

◆ ShowFontSize()

bool HPS.Publish.CheckBoxKit.ShowFontSize ( out int  out_size)
inline

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.

◆ ShowLock()

bool HPS.Publish.CheckBoxKit.ShowLock ( out bool  out_state)
inline

Shows the lock setting for the check box.

Returns
true if a lock setting was specified, false otherwise.

◆ ShowName()

bool HPS.Publish.CheckBoxKit.ShowName ( out string  out_name)
inline

Shows the name for the check box.

Parameters
out_nameThe name of the check box.
Returns
true if a name was specified, false otherwise.

◆ ShowPrintability()

bool HPS.Publish.CheckBoxKit.ShowPrintability ( out bool  out_state)
inline

Shows the printability for the check box.

Parameters
out_stateThe printability for the check box.
Returns
true if a printability was specified, false otherwise.

◆ ShowTextColor()

bool HPS.Publish.CheckBoxKit.ShowTextColor ( out HPS.RGBColor  out_color)
inline

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.

◆ ShowTextRotation()

bool HPS.Publish.CheckBoxKit.ShowTextRotation ( out HPS.Publish.Text.Rotation  out_rotation)
inline

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.

◆ ShowTooltip()

bool HPS.Publish.CheckBoxKit.ShowTooltip ( out string  out_tooltip)
inline

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.

◆ ShowVisibility()

bool HPS.Publish.CheckBoxKit.ShowVisibility ( out bool  out_state)
inline

Shows the visibility for the check box.

Parameters
out_stateThe visibility for the check box.
Returns
true if a visibility was specified, false otherwise.

◆ UnsetBorder()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetBorder ( )
inline

Removes the border setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetBorderColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetBorderStyle()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetBorderStyle ( )
inline

Removes the border style setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetBorderThickness()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetBorderThickness ( )
inline

Removes the border thickness setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetDefaultState()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetDefaultState ( )
inline

Removes the default state setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetEverything()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetEverything ( )
inline

Removes all data from the check box.

Returns
A reference to this CheckBoxKit.

◆ UnsetExportValue()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetExportValue ( )
inline

Removes the export value setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetFillColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetFillColor ( )
inline

Removes the fill color setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetFont()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetFont ( )
inline

Removes the font setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetFontSize()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetFontSize ( )
inline

Removes the font size setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetLock()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetLock ( )
inline

Removes the lock setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetName()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetName ( )
inline

Removes the name setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetPrintability()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetPrintability ( )
inline

Removes the printability setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetTextColor()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetTextColor ( )
inline

Removes the text color setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetTextRotation()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetTextRotation ( )
inline

Removes the text rotation setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetTooltip()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetTooltip ( )
inline

Removes the tooltip setting.

Returns
A reference to this CheckBoxKit.

◆ UnsetVisibility()

HPS.Publish.CheckBoxKit HPS.Publish.CheckBoxKit.UnsetVisibility ( )
inline

Removes the visibility setting.

Returns
A reference to this CheckBoxKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs