HPS.Publish.DropDownListKit

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

The DropDownListKit class is a user space object. It acts as the container for all data that can be used to specify a drop down list for a Publish PDF.

Public Functions

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

DropDownListKit (HPS.Publish.DropDownListKit in_kit)

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

Param in_kit: The source DropDownListKit to copy.

override bool Empty ()

Indicates whether this DropDownListKit has any values set on it.

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

bool Equals (HPS.Publish.DropDownListKit in_kit)

Check if the source DropDownListKit is equivalent to this DropDownListKit.

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

void Set (HPS.Publish.DropDownListKit in_kit)

Copies the source DropDownListKit into this DropDownListKit.

Param in_kit: The source DropDownListKit to copy.

HPS.Publish.DropDownListKit SetBorder (bool in_state)

Sets whether the drop down list has a border. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bHasBorder.

Param in_state: Whether the drop down list has a border.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sBorderColor.

Param in_color: The border color of the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eLineStyleBorder.

Param in_style: The border style for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eThicknessBorder.

Param in_thickness: The border thickness for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetContents (string[] in_displayed_values, string[] in_export_values)

Sets the contents of the drop down list. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. The two arrays need to have the same size.

Param in_displayed_values: The values displayed in the drop down list
Param in_export_values: The export values associated with the values displayed
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetCustomText (bool in_state)

Sets whether the user can enter custom text. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bAllowUserToEnterCustomText.

Param in_state: Whether the user can enter custom text.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFillColor (HPS.RGBColor in_color)

Sets the fill color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sFillColor and implicitly sets A3DPDFDropDownListData::m_bHasFillColor to true.

Param in_color: The fill color for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name: The builtin font for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFont (string in_name)

Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name: UTF8-encoded font name for the drop down list.
Return: A reference to this DropDownListKit.

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

Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.

Param in_name: UTF8-encoded font name for the drop down list.
Param in_style: The style of font to use for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetFontSize (int in_size)

Sets the font size for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_iFontSize.

Param in_size: The font size for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetImmediateCommit (bool in_state)

Sets whether selected values are committed immediately. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCommitImmediate.

Param in_state: Whether selected values are committed immediately.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetLock (bool in_state)

Sets whether the drop down list is locked. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bIsLocked.

Param in_state: Whether the drop down list is locked.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetName (string in_name)

Sets the name of the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcName.

Param in_name: UTF8-encoded name of the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetPrintability (bool in_state)

Sets the printability for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.

Param in_state: The printability for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetSpellChecking (bool in_state)

Sets whether spell checking is enabled. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCheckSpelling.

Param in_state: Whether spell checking is enabled.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sTextColor.

Param in_color: The text color for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eTextOrientation.

Param in_rotation: The text rotation for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetTooltip (string in_tooltip)

Sets the tooltip for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcTooltip.

Param in_tooltip: UTF8-encoded tooltip text for the drop down list.
Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit SetVisibility (bool in_state)

Sets the visibility for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.

Param in_state: The visibility for the drop down list.
Return: A reference to this DropDownListKit.

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

Copies this DropDownListKit into the given DropDownListKit.

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

bool ShowBorder (out bool out_state)

Shows the border setting for the drop down list.

Param out_state: Whether the drop down list 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 drop down list.

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

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

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

bool ShowCustomText (out bool out_state)

Shows the custom text setting for the drop down list.

Param out_state: Whether the user can enter custom text.
Return: true if a custom text setting was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the drop down list.

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

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

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

bool ShowImmediateCommit (out bool out_state)

Shows the immediate commit setting for the drop down list.

Param out_state: Whether selected values are committed immediately.
Return: true if an immediate commit setting was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the drop down list.

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

bool ShowName (out string out_name)

Shows the name for the drop down list.

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

bool ShowPrintability (out bool out_state)

Shows the printability for the drop down list.

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

bool ShowSpellChecking (out bool out_state)

Shows the spell checking setting for the drop down list.

Param out_state: Whether spell checking is enabled.
Return: true if a spell checking setting was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the drop down list.

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

Param out_rotation: The text rotation for the drop down list.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the drop down list.

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

bool ShowVisibility (out bool out_state)

Shows the visibility for the drop down list.

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

HPS.Publish.DropDownListKit UnsetBorder ()

Removes the border setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetContents ()

Removes the content setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetCustomText ()

Removes the custom text setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetEverything ()

Removes all data from the drop down list.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFont ()

Removes the font setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetImmediateCommit ()

Removes the immediate commit setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetLock ()

Removes the lock setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetName ()

Removes the name setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetSpellChecking ()

Removes the spell checking setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this DropDownListKit.

HPS.Publish.DropDownListKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this DropDownListKit.

Public Static Functions

HPS.Publish.DropDownListKit GetDefault ()

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

Return: A DropDownListKit with the default settings.