Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Publish.ListBoxKit Class Reference

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

Inheritance diagram for HPS.Publish.ListBoxKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
 ListBoxKit ()
 The default constructor creates an empty ListBoxKit object. More...
 
 ListBoxKit (HPS.Publish.ListBoxKit in_kit)
 The copy constructor creates a new ListBoxKit object that contains the same settings as the source ListBoxKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Publish.ListBoxKit in_kit)
 Copies the source ListBoxKit into this ListBoxKit. More...
 
void Show (out HPS.Publish.ListBoxKit out_kit)
 Copies this ListBoxKit into the given ListBoxKit. More...
 
override bool Empty ()
 Indicates whether this ListBoxKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Publish.ListBoxKit in_kit)
 Check if the source ListBoxKit is equivalent to this ListBoxKit. More...
 
HPS.Publish.ListBoxKit SetName (string in_name)
 Sets the name of the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a4e87e4e13d58440e1f0b09f56d93da36">A3DPDFListBoxData::m_pcName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a37ce067341dad28f98be68e13d15f6a2">A3DPDFListBoxData::m_iFontSize</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfe4860172f1e7be6d65092435fe7589">A3DPDFListBoxData::m_sTextColor</ulink>. More...
 
HPS.Publish.ListBoxKit SetTooltip (string in_tooltip)
 Sets the tooltip for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aec810bf271dd6d8ee817e8913e96d95f">A3DPDFListBoxData::m_pcTooltip</ulink>. More...
 
HPS.Publish.ListBoxKit SetVisibility (bool in_state)
 Sets the visibility for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>. More...
 
HPS.Publish.ListBoxKit SetPrintability (bool in_state)
 Sets the printability for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a10bc7f5374f39ccb8a10a9d279fb0503">A3DPDFListBoxData::m_eTextOrientation</ulink>. More...
 
HPS.Publish.ListBoxKit SetLock (bool in_state)
 Sets whether the list box is locked. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a15f5a5f907498ef4a09c8960ca1fac30">A3DPDFListBoxData::m_bIsLocked</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a613aa60b08374a6b5ee06b9793505fcf">A3DPDFListBoxData::m_bHasBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a8338d5a48d20dfd427356f5815a253f1">A3DPDFListBoxData::m_sBorderColor</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aa68a2d58450a36413f7ae50213e3f2cd">A3DPDFListBoxData::m_eThicknessBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#ad521f05576c362b8529b12fd3b94191b">A3DPDFListBoxData::m_eLineStyleBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a1c8e058380d2c95426c7362c3104bf36">A3DPDFListBoxData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFListBoxData::m_bHasFillColor</ulink> to true. More...
 
HPS.Publish.ListBoxKit SetMultipleSelection (bool in_state)
 Sets whether multiple selection is allowed. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aa64df979f517fb4106ea040dde36cc24">A3DPDFListBoxData::m_bMultipleSelection</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gaeb695657f0a4b0864ed66c346c984a87">A3DPDFPageFieldListAddItem</ulink>. More...
 
HPS.Publish.ListBoxKit UnsetName ()
 Removes the name setting. More...
 
HPS.Publish.ListBoxKit UnsetFont ()
 Removes the font setting. More...
 
HPS.Publish.ListBoxKit UnsetFontSize ()
 Removes the font size setting. More...
 
HPS.Publish.ListBoxKit UnsetTextColor ()
 Removes the text color setting. More...
 
HPS.Publish.ListBoxKit UnsetTooltip ()
 Removes the tooltip setting. More...
 
HPS.Publish.ListBoxKit UnsetVisibility ()
 Removes the visibility setting. More...
 
HPS.Publish.ListBoxKit UnsetPrintability ()
 Removes the printability setting. More...
 
HPS.Publish.ListBoxKit UnsetTextRotation ()
 Removes the text rotation setting. More...
 
HPS.Publish.ListBoxKit UnsetLock ()
 Removes the lock setting. More...
 
HPS.Publish.ListBoxKit UnsetBorder ()
 Removes the border setting. More...
 
HPS.Publish.ListBoxKit UnsetBorderColor ()
 Removes the border color setting. More...
 
HPS.Publish.ListBoxKit UnsetBorderThickness ()
 Removes the border thickness setting. More...
 
HPS.Publish.ListBoxKit UnsetBorderStyle ()
 Removes the border style setting. More...
 
HPS.Publish.ListBoxKit UnsetFillColor ()
 Removes the fill color setting. More...
 
HPS.Publish.ListBoxKit UnsetMultipleSelection ()
 Removes the multiple selection setting. More...
 
HPS.Publish.ListBoxKit UnsetContents ()
 Removes the content setting. More...
 
HPS.Publish.ListBoxKit UnsetEverything ()
 Removes all data from the list box. More...
 
bool ShowName (out string out_name)
 Shows the name for the list box. More...
 
bool ShowFont (out HPS.Publish.Text.Font.Type out_type, out HPS.Publish.Text.Font.Name out_name, out string out_font_name, out HPS.Publish.Text.Font.Style out_style)
 Shows the font for the list box. More...
 
bool ShowFontSize (out int out_size)
 Shows the font size for the list box. More...
 
bool ShowTextColor (out HPS.RGBColor out_color)
 Shows the text color for the list box. More...
 
bool ShowTooltip (out string out_tooltip)
 Shows the tooltip for the list box. More...
 
bool ShowVisibility (out bool out_state)
 Shows the visibility for the list box. More...
 
bool ShowPrintability (out bool out_state)
 Shows the printability for the list box. More...
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 Shows the text rotation for the list box. More...
 
bool ShowLock (out bool out_state)
 Shows the lock setting for the list box. More...
 
bool ShowBorder (out bool out_state)
 Shows the border setting for the list box. More...
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 Shows the border color for the list box. More...
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 Shows the border thickness for the list box. More...
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 Shows the border style for the list box. More...
 
bool ShowFillColor (out HPS.RGBColor out_color)
 Shows the fill color for the list box. More...
 
bool ShowMultipleSelection (out bool out_state)
 Shows the multiple selection setting for the list box. More...
 
bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)
 Shows the content setting for the list box. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static 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. More...
 
static bool operator== (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)
 
static bool operator!= (HPS.Publish.ListBoxKit a, HPS.Publish.ListBoxKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.Publish.ListBoxKit.ListBoxKit ( )
inline

The default constructor creates an empty ListBoxKit object.

HPS.Publish.ListBoxKit.ListBoxKit ( HPS.Publish.ListBoxKit  in_kit)
inline

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref> to copy.

Member Function Documentation

override bool HPS.Publish.ListBoxKit.Empty ( )
inlinevirtual

Indicates whether this ListBoxKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.Publish.ListBoxKit.Equals ( HPS.Publish.ListBoxKit  in_kit)
inline

Check if the source ListBoxKit is equivalent to this ListBoxKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.GetDefault ( )
inlinestatic

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.

Returns
A ListBoxKit with the default settings.
override HPS.Type HPS.Publish.ListBoxKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.Publish.ListBoxKit.Set ( HPS.Publish.ListBoxKit  in_kit)
inline

Copies the source ListBoxKit into this ListBoxKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref> to copy.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorder ( bool  in_state)
inline

Sets whether the list box has a border. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a613aa60b08374a6b5ee06b9793505fcf">A3DPDFListBoxData::m_bHasBorder</ulink>.

Parameters
in_stateWhether the list box has a border.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderColor ( HPS.RGBColor  in_color)
inline

Sets the border color for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a8338d5a48d20dfd427356f5815a253f1">A3DPDFListBoxData::m_sBorderColor</ulink>.

Parameters
in_colorThe border color of the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderStyle ( HPS.Publish.Border.Style  in_style)
inline

Sets the border style for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#ad521f05576c362b8529b12fd3b94191b">A3DPDFListBoxData::m_eLineStyleBorder</ulink>.

Parameters
in_styleThe border style for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetBorderThickness ( HPS.Publish.Border.Thickness  in_thickness)
inline

Sets the border thickness for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aa68a2d58450a36413f7ae50213e3f2cd">A3DPDFListBoxData::m_eThicknessBorder</ulink>.

Parameters
in_thicknessThe border thickness for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetContents ( string[]  in_displayed_values,
string[]  in_export_values 
)
inline

Sets the contents of the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__page__module.html#gaeb695657f0a4b0864ed66c346c984a87">A3DPDFPageFieldListAddItem</ulink>.

Parameters
in_countThe size of the arrays passed in.
in_displayed_valuesThe values displayed in the list box
in_export_valuesThe export values associated with the values displayed
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFillColor ( HPS.RGBColor  in_color)
inline

Sets the fill color for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a1c8e058380d2c95426c7362c3104bf36">A3DPDFListBoxData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFListBoxData::m_bHasFillColor</ulink> to true.

Parameters
in_colorThe fill color for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( HPS.Publish.Text.Font.Name  in_name)
inline

Sets a builtin font for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.

Parameters
in_nameThe builtin font for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( string  in_name,
HPS.Publish.Text.Font.Style  in_style 
)
inline

Sets a specific font for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.

Parameters
in_nameUTF8-encoded font name for the list box.
in_styleThe style of font to use for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFont ( string  in_name)
inline

Sets a specific font for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.

Parameters
in_nameUTF8-encoded font name for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetFontSize ( int  in_size)
inline

Sets the font size for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a37ce067341dad28f98be68e13d15f6a2">A3DPDFListBoxData::m_iFontSize</ulink>.

Parameters
in_sizeThe font size for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetLock ( bool  in_state)
inline

Sets whether the list box is locked. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a15f5a5f907498ef4a09c8960ca1fac30">A3DPDFListBoxData::m_bIsLocked</ulink>.

Parameters
in_stateWhether the list box is locked.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetMultipleSelection ( bool  in_state)
inline

Sets whether multiple selection is allowed. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aa64df979f517fb4106ea040dde36cc24">A3DPDFListBoxData::m_bMultipleSelection</ulink>.

Parameters
in_stateWhether multiple selection is allowed
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetName ( string  in_name)
inline

Sets the name of the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a4e87e4e13d58440e1f0b09f56d93da36">A3DPDFListBoxData::m_pcName</ulink>.

Parameters
in_nameUTF8-encoded name of the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetPrintability ( bool  in_state)
inline

Sets the printability for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>.

Parameters
in_stateThe printability for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTextColor ( HPS.RGBColor  in_color)
inline

Sets the text color for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfe4860172f1e7be6d65092435fe7589">A3DPDFListBoxData::m_sTextColor</ulink>.

Parameters
in_colorThe text color for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTextRotation ( HPS.Publish.Text.Rotation  in_rotation)
inline

Sets the text rotation for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#a10bc7f5374f39ccb8a10a9d279fb0503">A3DPDFListBoxData::m_eTextOrientation</ulink>.

Parameters
in_rotationThe text rotation for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetTooltip ( string  in_tooltip)
inline

Sets the tooltip for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#aec810bf271dd6d8ee817e8913e96d95f">A3DPDFListBoxData::m_pcTooltip</ulink>.

Parameters
in_tooltipUTF8-encoded tooltip text for the list box.
Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.SetVisibility ( bool  in_state)
inline

Sets the visibility for the list box. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>.

Parameters
in_stateThe visibility for the list box.
Returns
A reference to this ListBoxKit.
void HPS.Publish.ListBoxKit.Show ( out HPS.Publish.ListBoxKit  out_kit)
inline

Copies this ListBoxKit into the given ListBoxKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_list_box_kit" kindref="compound">ListBoxKit</ref>.
bool HPS.Publish.ListBoxKit.ShowBorder ( out bool  out_state)
inline

Shows the border setting for the list box.

Parameters
out_stateWhether the list box has a border.
Returns
true if a border setting was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowBorderColor ( out HPS.RGBColor  out_color)
inline

Shows the border color for the list box.

Parameters
out_colorThe border color of the list box.
Returns
true if a border color was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowBorderStyle ( out HPS.Publish.Border.Style  out_style)
inline

Shows the border style for the list box.

Parameters
out_styleThe border style for the list box.
Returns
true if a border style was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowBorderThickness ( out HPS.Publish.Border.Thickness  out_thickness)
inline

Shows the border thickness for the list box.

Parameters
out_thicknessThe border thickness for the list box.
Returns
true if a border thickness was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowContents ( out string[]  out_displayed_values,
out string[]  out_export_values 
)
inline

Shows the content setting for the list box.

Parameters
out_displayed_valuesThe values displayed by the list box.
out_export_valuesThe export values associated with the displayed values.
Returns
true if a content setting was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowFillColor ( out HPS.RGBColor  out_color)
inline

Shows the fill color for the list box.

Parameters
out_colorThe fill color for the list box.
Returns
true if a fill color was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowFont ( out HPS.Publish.Text.Font.Type  out_type,
out HPS.Publish.Text.Font.Name  out_name,
out string  out_font_name,
out HPS.Publish.Text.Font.Style  out_style 
)
inline

Shows the font for the list box.

Parameters
out_typeThe type of font for the list box.
out_font_nameThe explicit font name for the list box. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>.
out_styleThe font style for the list box. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>.
Returns
true if a font was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowFontSize ( out int  out_size)
inline

Shows the font size for the list box.

Parameters
out_sizeThe font size for the list box.
Returns
true if a font size was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowLock ( out bool  out_state)
inline

Shows the lock setting for the list box.

Returns
true if a lock setting was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowMultipleSelection ( out bool  out_state)
inline

Shows the multiple selection setting for the list box.

Parameters
out_stateWhether multiple selection is enabled.
Returns
true if a multiple selection setting was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowName ( out string  out_name)
inline

Shows the name for the list box.

Parameters
out_nameThe name of the list box.
Returns
true if a name was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowPrintability ( out bool  out_state)
inline

Shows the printability for the list box.

Parameters
out_stateThe printability for the list box.
Returns
true if a printability was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowTextColor ( out HPS.RGBColor  out_color)
inline

Shows the text color for the list box.

Parameters
out_colorThe text color for the list box.
Returns
true if a text color was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowTextRotation ( out HPS.Publish.Text.Rotation  out_rotation)
inline

Shows the text rotation for the list box.

Parameters
out_rotationThe text rotation for the list box.
Returns
true if a rotation was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowTooltip ( out string  out_tooltip)
inline

Shows the tooltip for the list box.

Parameters
out_tooltipThe tooltip text for the list box.
Returns
true if a tooltip was specified, false otherwise.
bool HPS.Publish.ListBoxKit.ShowVisibility ( out bool  out_state)
inline

Shows the visibility for the list box.

Parameters
out_stateThe visibility for the list box.
Returns
true if a visibility was specified, false otherwise.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorder ( )
inline

Removes the border setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderStyle ( )
inline

Removes the border style setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetBorderThickness ( )
inline

Removes the border thickness setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetContents ( )
inline

Removes the content setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetEverything ( )
inline

Removes all data from the list box.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFillColor ( )
inline

Removes the fill color setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFont ( )
inline

Removes the font setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetFontSize ( )
inline

Removes the font size setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetLock ( )
inline

Removes the lock setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetMultipleSelection ( )
inline

Removes the multiple selection setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetName ( )
inline

Removes the name setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetPrintability ( )
inline

Removes the printability setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTextColor ( )
inline

Removes the text color setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTextRotation ( )
inline

Removes the text rotation setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetTooltip ( )
inline

Removes the tooltip setting.

Returns
A reference to this ListBoxKit.
HPS.Publish.ListBoxKit HPS.Publish.ListBoxKit.UnsetVisibility ( )
inline

Removes the visibility setting.

Returns
A reference to this ListBoxKit.

The documentation for this class was generated from the following file: