HPS::Publish::CheckBoxKit

class HPS.Publish.CheckBoxKit : public HPS.SprocketKit 

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.

Public Functions

CheckBoxKit (): The default constructor creates an empty CheckBoxKit object.

CheckBoxKit (HPS.Publish.CheckBoxKit in_kit)

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

Param in_kit: The source CheckBoxKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this CheckBoxKit has any values set on it.

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

bool Equals (HPS.Publish.CheckBoxKit in_kit)

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

Param in_kit: The source CheckBoxKit to compare to this CheckBoxKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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).

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

void Set (HPS.Publish.CheckBoxKit in_kit)

Copies the source CheckBoxKit into this CheckBoxKit.

Param in_kit: The source CheckBoxKit to copy.

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 A3DPDFCheckBoxData::m_bHasBorder.

Param in_state: Whether the check box has a border.
Return: A reference to this 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 A3DPDFCheckBoxData::m_sBorderColor.

Param in_color: The border color of the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_eLineStyleBorder.

Param in_style: The border style for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_eThicknessBorder.

Param in_thickness: The border thickness for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_bIsCheckedByDefault.

Param in_state: Whether the check box is checked by default.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcExportValue.

Param in_export_value: UTF8-encoded export value of the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_sFillColor and implicitly sets A3DPDFCheckBoxData::m_bHasFillColor to true.

Param in_color: The fill color for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcFontName.

Param in_name: The builtin font for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcFontName.

Param in_name: UTF8-encoded font name for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcFontName.

Param in_name: UTF8-encoded font name for the check box.
Param in_style: The style of font to use for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_iFontSize.

Param in_size: The font size for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_bIsLocked.

Param in_state: Whether the check box is locked.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcName.

Param in_name: UTF8-encoded name of the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_eFormField.

Param in_state: The printability for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_sTextColor.

Param in_color: The text color for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_eTextOrientation.

Param in_rotation: The text rotation for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_pcTooltip.

Param in_tooltip: UTF8-encoded tooltip text for the check box.
Return: A reference to this 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 A3DPDFCheckBoxData::m_eFormField.

Param in_state: The visibility for the check box.
Return: A reference to this CheckBoxKit.

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

Copies this CheckBoxKit into the given CheckBoxKit.

Param out_kit: The CheckBoxKit to populate with the contents of this CheckBoxKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the check box.

Param out_state: Whether the check box has a border.
Return: true if a border setting was specified, false otherwise.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color for the check box.

Param out_color: The border color of the check box.
Return: true if a border color was specified, false otherwise.

bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)

Shows the border style for the check box.

Param out_style: The border style for the check box.
Return: true if a border style was specified, false otherwise.

bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)

Shows the border thickness for the check box.

Param out_thickness: The border thickness for the check box.
Return: true if a border thickness was specified, false otherwise.

bool ShowDefaultState (out bool out_default_state)

Shows the default state for the check box.

Param out_default_state: The default state for the check box.
Return: true if a default state was specified, false otherwise.

bool ShowExportValue (out string out_export_value)

Shows the export value for the check box.

Param out_export_value: The export value for the check box.
Return: true if an export value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the check box.

Param out_color: The fill color for the check box.
Return: true if a fill color was specified, false otherwise.

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 check box.

Param out_type: The type of font for the check box.
Param out_font: The built-in font for the check box. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the check box. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the check box. This is only valid if out_type is Text.Font.Type.Explicit.
Return: true if a font was specified, false otherwise.

bool ShowFontSize (out int out_size)

Shows the font size for the check box.

Param out_size: The font size for the check box.
Return: true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the check box.

Return: true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the check box.

Param out_name: The name of the check box.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the check box.

Param out_state: The printability for the check box.
Return: true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the check box.

Param out_color: The text color for the check box.
Return: true if a text color was specified, false otherwise.

bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)

Shows the text rotation for the check box.

Param out_rotation: The text rotation for the check box.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the check box.

Param out_tooltip: The tooltip text for the check box.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the check box.

Param out_state: The visibility for the check box.
Return: true if a visibility was specified, false otherwise.

HPS.Publish.CheckBoxKit UnsetBorder ()

Removes the border setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetDefaultState ()

Removes the default state setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetEverything ()

Removes all data from the check box.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetExportValue ()

Removes the export value setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFont ()

Removes the font setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetLock ()

Removes the lock setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetName ()

Removes the name setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this CheckBoxKit.

HPS.Publish.CheckBoxKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this CheckBoxKit.

Public Static Functions

HPS.Publish.CheckBoxKit GetDefault ()

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.

Return: A CheckBoxKit with the default settings.

bool operator!= (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b)

bool operator== (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b)