HPS.Publish.RadioButtonKit

class HPS.Publish.RadioButtonKit : public HPS.SprocketKit

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

Public Functions

override bool Empty ()

Indicates whether this RadioButtonKit has any values set on it.

Return

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

bool Equals (HPS.Publish.RadioButtonKit in_kit)

Check if the source RadioButtonKit is equivalent to this RadioButtonKit.

Param in_kit

The source RadioButtonKit to compare to this RadioButtonKit.

Return

true if the objects are equivalent, false otherwise.

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.

RadioButtonKit ()

The default constructor creates an empty RadioButtonKit object.

RadioButtonKit (HPS.Publish.RadioButtonKit in_kit)

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

Param in_kit

The source RadioButtonKit to copy.

void Set (HPS.Publish.RadioButtonKit in_kit)

Copies the source RadioButtonKit into this RadioButtonKit.

Param in_kit

The source RadioButtonKit to copy.

HPS.Publish.RadioButtonKit SetBorder (bool in_state)

Sets whether the radio button has a border. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bHasBorder.

Param in_state

Whether the radio button has a border.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sBorderColor.

Param in_color

The border color of the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eLineStyleBorder.

Param in_style

The border style for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eThicknessBorder.

Param in_thickness

The border thickness for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetDefaultState (bool in_state)

Sets whether the radio button is checked by default. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsCheckedByDefault.

Param in_state

Whether the radio button is checked by default.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit 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 A3DPDFRadioButtonData::m_pcExportValue.

Param in_export_value

UTF8-encoded export value of the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFillColor (HPS.RGBColor in_color)

Sets the fill color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sFillColor and implicitly sets A3DPDFRadioButtonData::m_bHasFillColor to true.

Param in_color

The fill color for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.

Param in_name

The builtin font for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFont (string in_name)

Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.

Param in_name

UTF8-encoded font name for the radio button.

Return

A reference to this RadioButtonKit.

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

Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.

Param in_name

UTF8-encoded font name for the radio button.

Param in_style

The style of font to use for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetFontSize (int in_size)

Sets the font size for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_iFontSize.

Param in_size

The font size for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetGrouping (bool in_state)

Sets whether the radio buttons with the same names are grouped, and therefore mutually exclusive. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bRadiosInUnison.

Param in_state

Whether the radio button is part of a group.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetLock (bool in_state)

Sets whether the radio button is locked. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsLocked.

Param in_state

Whether the radio button is locked.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetName (string in_name)

Sets the name of the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcName.

Param in_name

UTF8-encoded name of the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetPrintability (bool in_state)

Sets the printability for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.

Param in_state

The printability for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sTextColor.

Param in_color

The text color for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eTextOrientation.

Param in_rotation

The text rotation for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetTooltip (string in_tooltip)

Sets the tooltip for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcTooltip.

Param in_tooltip

UTF8-encoded tooltip text for the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit SetVisibility (bool in_state)

Sets the visibility for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.

Param in_state

The visibility for the radio button.

Return

A reference to this RadioButtonKit.

void Show (out HPS.Publish.RadioButtonKit out_kit)

Copies this RadioButtonKit into the given RadioButtonKit.

Param out_kit

The RadioButtonKit to populate with the contents of this RadioButtonKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the radio button.

Param out_state

Whether the radio button 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 radio button.

Param out_color

The border color of the radio button.

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 radio button.

Param out_style

The border style for the radio button.

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 radio button.

Param out_thickness

The border thickness for the radio button.

Return

true if a border thickness was specified, false otherwise.

bool ShowDefaultState (out bool out_default_state)

Shows the default state for the radio button.

Param out_default_state

The default state for the radio button.

Return

true if a default state was specified, false otherwise.

bool ShowExportValue (out string out_export_value)

Shows the export value for the radio button.

Param out_export_value

The export value for the radio button.

Return

true if an export value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the radio button.

Param out_color

The fill color for the radio button.

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 radio button.

Param out_type

The type of font for the radio button.

Param out_font

The built-in font for the radio button. This is only valid if out_type is Text.Font.Type.BuiltIn.

Param out_font_name

The explicit font name for the radio button. This is only valid if out_type is Text.Font.Type.Explicit.

Param out_style

The font style for the radio button. 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 radio button.

Param out_size

The font size for the radio button.

Return

true if a font size was specified, false otherwise.

bool ShowGrouping (out bool out_grouping)

Shows the grouping state for the radio button.

Param out_grouping

The grouping state for the radio button.

Return

true if a groupings state was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the radio button.

Return

true if a lock setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the radio button.

Param out_name

The name of the radio button.

Return

true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the radio button.

Param out_state

The printability for the radio button.

Return

true if a printability was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the radio button.

Param out_color

The text color for the radio button.

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 radio button.

Param out_rotation

The text rotation for the radio button.

Return

true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the radio button.

Param out_tooltip

The tooltip text for the radio button.

Return

true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the radio button.

Param out_state

The visibility for the radio button.

Return

true if a visibility was specified, false otherwise.

HPS.Publish.RadioButtonKit UnsetBorder ()

Removes the border setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderColor ()

Removes the border color setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderStyle ()

Removes the border style setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetBorderThickness ()

Removes the border thickness setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetDefaultState ()

Removes the default state setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetEverything ()

Removes all data from the radio button.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetExportValue ()

Removes the export value setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFillColor ()

Removes the fill color setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFont ()

Removes the font setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetFontSize ()

Removes the font size setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetGrouping ()

Removes the grouping setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetLock ()

Removes the lock setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetName ()

Removes the name setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetPrintability ()

Removes the printability setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTextColor ()

Removes the text color setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTextRotation ()

Removes the text rotation setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetTooltip ()

Removes the tooltip setting.

Return

A reference to this RadioButtonKit.

HPS.Publish.RadioButtonKit UnsetVisibility ()

Removes the visibility setting.

Return

A reference to this RadioButtonKit.

Public Static Functions

HPS.Publish.RadioButtonKit GetDefault ()

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

Return

A RadioButtonKit with the default settings.