HPS::Publish::ListBoxKit
- class HPS.Publish.ListBoxKit : public HPS.SprocketKit
The ListBoxKit class is a user space object. It acts as the container for all data that can be used to specify a list box for a Publish PDF.
Public Functions
- override void Dispose ()
- override bool Empty ()
Indicates whether this ListBoxKit has any values set on it.
- Return
true if no values are set on this ListBoxKit, false otherwise.
- bool Equals (HPS.Publish.ListBoxKit in_kit)
Check if the source ListBoxKit is equivalent to this ListBoxKit.
- Param in_kit
The source ListBoxKit to compare to this ListBoxKit.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- override int GetHashCode ()
- ListBoxKit ()
The default constructor creates an empty ListBoxKit object.
- ListBoxKit (HPS.Publish.ListBoxKit in_kit)
The copy constructor creates a new ListBoxKit object that contains the same settings as the source ListBoxKit.
- Param in_kit
The source ListBoxKit to copy.
- 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.ListBoxKit in_kit)
Copies the source ListBoxKit into this ListBoxKit.
- Param in_kit
The source ListBoxKit to copy.
- HPS.Publish.ListBoxKit SetBorder (bool in_state)
Sets whether the list box has a border. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bHasBorder.
- Param in_state
Whether the list box has a border.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetBorderColor (HPS.RGBColor in_color)
Sets the border color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sBorderColor.
- Param in_color
The border color of the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetBorderStyle (HPS.Publish.Border.Style in_style)
Sets the border style for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eLineStyleBorder.
- Param in_style
The border style for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
Sets the border thickness for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eThicknessBorder.
- Param in_thickness
The border thickness for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetContents (string[] in_displayed_values, string[] in_export_values)
Sets the contents of the list box. 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 list box
- Param in_export_values
The export values associated with the values displayed
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetFillColor (HPS.RGBColor in_color)
Sets the fill color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sFillColor and implicitly sets A3DPDFListBoxData::m_bHasFillColor to true.
- Param in_color
The fill color for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetFont (HPS.Publish.Text.Font.Name in_name)
Sets a builtin font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.
- Param in_name
The builtin font for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetFont (string in_name)
Sets a specific font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.
- Param in_name
UTF8-encoded font name for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
Sets a specific font for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcFontName.
- Param in_name
UTF8-encoded font name for the list box.
- Param in_style
The style of font to use for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetFontSize (int in_size)
Sets the font size for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_iFontSize.
- Param in_size
The font size for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetLock (bool in_state)
Sets whether the list box is locked. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bIsLocked.
- Param in_state
Whether the list box is locked.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetMultipleSelection (bool in_state)
Sets whether multiple selection is allowed. This corresponds to the value that will be passed to A3DPDFListBoxData::m_bMultipleSelection.
- Param in_state
Whether multiple selection is allowed
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetName (string in_name)
Sets the name of the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcName.
- Param in_name
UTF8-encoded name of the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetPrintability (bool in_state)
Sets the printability for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eFormField.
- Param in_state
The printability for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetTextColor (HPS.RGBColor in_color)
Sets the text color for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_sTextColor.
- Param in_color
The text color for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
Sets the text rotation for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eTextOrientation.
- Param in_rotation
The text rotation for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetTooltip (string in_tooltip)
Sets the tooltip for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_pcTooltip.
- Param in_tooltip
UTF8-encoded tooltip text for the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit SetVisibility (bool in_state)
Sets the visibility for the list box. This corresponds to the value that will be passed to A3DPDFListBoxData::m_eFormField.
- Param in_state
The visibility for the list box.
- Return
A reference to this ListBoxKit.
- void Show (out HPS.Publish.ListBoxKit out_kit)
Copies this ListBoxKit into the given ListBoxKit.
- Param out_kit
The ListBoxKit to populate with the contents of this ListBoxKit.
- bool ShowBorder (out bool out_state)
Shows the border setting for the list box.
- Param out_state
Whether the list 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 list box.
- Param out_color
The border color of the list 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 list box.
- Param out_style
The border style for the list 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 list box.
- Param out_thickness
The border thickness for the list box.
- Return
true if a border thickness was specified, false otherwise.
- bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)
- bool ShowFillColor (out HPS.RGBColor out_color)
Shows the fill color for the list box.
- Param out_color
The fill color for the list 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 list box.
- Param out_type
The type of font for the list box.
- Param out_font
The built-in font for the list box. This is only valid if out_type is Text.Font.Type.BuiltIn.
- Param out_font_name
The explicit font name for the list box. This is only valid if out_type is Text.Font.Type.Explicit.
- Param out_style
The font style for the list 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 list box.
- Param out_size
The font size for the list box.
- Return
true if a font size was specified, false otherwise.
- bool ShowLock (out bool out_state)
Shows the lock setting for the list box.
- Return
true if a lock setting was specified, false otherwise.
- bool ShowMultipleSelection (out bool out_state)
Shows the multiple selection setting for the list box.
- Param out_state
Whether multiple selection is enabled.
- Return
true if a multiple selection setting was specified, false otherwise.
- bool ShowName (out string out_name)
Shows the name for the list box.
- Param out_name
The name of the list box.
- Return
true if a name was specified, false otherwise.
- bool ShowPrintability (out bool out_state)
Shows the printability for the list box.
- Param out_state
The printability for the list box.
- Return
true if a printability was specified, false otherwise.
- bool ShowTextColor (out HPS.RGBColor out_color)
Shows the text color for the list box.
- Param out_color
The text color for the list 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 list box.
- Param out_rotation
The text rotation for the list box.
- Return
true if a rotation was specified, false otherwise.
- bool ShowTooltip (out string out_tooltip)
Shows the tooltip for the list box.
- Param out_tooltip
The tooltip text for the list box.
- Return
true if a tooltip was specified, false otherwise.
- bool ShowVisibility (out bool out_state)
Shows the visibility for the list box.
- Param out_state
The visibility for the list box.
- Return
true if a visibility was specified, false otherwise.
- HPS.Publish.ListBoxKit UnsetBorder ()
Removes the border setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetBorderColor ()
Removes the border color setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetBorderStyle ()
Removes the border style setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetBorderThickness ()
Removes the border thickness setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetContents ()
Removes the content setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetEverything ()
Removes all data from the list box.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetFillColor ()
Removes the fill color setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetFont ()
Removes the font setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetFontSize ()
Removes the font size setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetLock ()
Removes the lock setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetMultipleSelection ()
Removes the multiple selection setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetName ()
Removes the name setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetPrintability ()
Removes the printability setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetTextColor ()
Removes the text color setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetTextRotation ()
Removes the text rotation setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetTooltip ()
Removes the tooltip setting.
- Return
A reference to this ListBoxKit.
- HPS.Publish.ListBoxKit UnsetVisibility ()
Removes the visibility setting.
- Return
A reference to this ListBoxKit.
Public Static Functions
- HPS.Publish.ListBoxKit GetDefault ()
Creates a ListBoxKit 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 ListBoxKit passed to a function.
- Return
A ListBoxKit with the default settings.
- bool operator!= (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)
- bool operator== (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)