HPS::Publish::ButtonKit

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

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.

Public Functions

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

ButtonKit (HPS.Publish.ButtonKit in_kit)

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

Param in_kit: The source ButtonKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this ButtonKit has any values set on it.

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

bool Equals (HPS.Publish.ButtonKit in_kit)

Check if the source ButtonKit is equivalent to this ButtonKit.

Param in_kit: The source ButtonKit to compare to this ButtonKit.
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.ButtonKit in_kit)

Copies the source ButtonKit into this ButtonKit.

Param in_kit: The source ButtonKit to copy.

HPS.Publish.ButtonKit SetBorder (bool in_state)

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

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

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

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

Param in_thickness: The border thickness for the button.
Return: A reference to this 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 A3DPDFButtonData::m_sFillColor and implicitly sets A3DPDFButtonData::m_bHasFillColor to true.

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

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

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

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

Param in_size: The font size for the button.
Return: A reference to this 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 A3DPDFButtonData::m_eHighlightingMode.

Param in_mode: The highlighting mode for the button.
Return: A reference to this 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 A3DPDFButtonData::m_pImage.

Param in_image: The icon image for the button.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetLabel (string in_label)

Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel.

Param in_label: UTF8-encoded label for the button.
Return: A reference to this 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 A3DPDFButtonData::m_eLayoutTextIcon.

Param in_position: The label position for the button.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetLock (bool in_state)

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

Param in_state: Whether the button is locked.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetName (string in_name)

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

Param in_name: UTF8-encoded name of the button.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetPrintability (bool in_state)

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

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

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

Param in_rotation: The text rotation for the button.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetTooltip (string in_tooltip)

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

Param in_tooltip: UTF8-encoded tooltip text for the button.
Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit SetVisibility (bool in_state)

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

Param in_state: The visibility for the button.
Return: A reference to this ButtonKit.

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

Copies this ButtonKit into the given ButtonKit.

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

bool ShowBorder (out bool out_state)

Shows the border setting for the button.

Param out_state: Whether the 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 button.

Param out_color: The border color of the 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 button.

Param out_style: The border style for the 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 button.

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

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the button.

Param out_color: The fill color for the 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 button.

Param out_type: The type of font for the button.
Param out_font: The built-in font for the button. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the button. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the 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 button.

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

bool ShowHighlighting (out HPS.Publish.Highlighting.Mode out_mode)

Shows the highlighting mode for the button.

Param out_mode: The highlighting mode for the button.
Return: true if a highlighting mode was specified, false otherwise.

bool ShowIconImage (out HPS.Publish.ImageKit out_image)

Shows the icon image for the button.

Param out_image: The icon image for the button.
Return: true if an icon image was specified, false otherwise.

bool ShowLabel (out string out_label)

Shows the label for the button.

Param out_label: The label for the button.
Return: true if a label was specified, false otherwise.

bool ShowLabelPosition (out HPS.Publish.Label.Position out_position)

Shows the label position for the button.

Param out_position: The label position for the button.
Return: true if a label position was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the button.

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

bool ShowName (out string out_name)

Shows the name for the button.

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

bool ShowPrintability (out bool out_state)

Shows the printability for the button.

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

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the button.

Param out_color: The text color for the 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 button.

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

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the button.

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

bool ShowVisibility (out bool out_state)

Shows the visibility for the button.

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

HPS.Publish.ButtonKit UnsetBorder ()

Removes the border setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetEverything ()

Removes all data from the button.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFont ()

Removes the font setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetHighlighting ()

Removes the highlighting mode setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetIconImage ()

Removes the icon image setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLabel ()

Removes the label setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLabelPosition ()

Removes the label position setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetLock ()

Removes the lock setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetName ()

Removes the name setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this ButtonKit.

HPS.Publish.ButtonKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this ButtonKit.

Public Static Functions

HPS.Publish.ButtonKit GetDefault ()

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.

Return: A ButtonKit with the default settings.

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

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