Overview

Sample Code

Programming Guide

API Reference

Support

HPS.Publish.DropDownListKit Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 DropDownListKit ()
 The default constructor creates an empty DropDownListKit object. More...
 
 DropDownListKit (HPS.Publish.DropDownListKit in_kit)
 The copy constructor creates a new DropDownListKit object that contains the same settings as the source DropDownListKit. More...
 
override bool Empty ()
 Indicates whether this DropDownListKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.DropDownListKit in_kit)
 Check if the source DropDownListKit is equivalent to this DropDownListKit. More...
 
override int GetHashCode ()
 
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.DropDownListKit in_kit)
 Copies the source DropDownListKit into this DropDownListKit. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a07a4601e1dfc46509cac3521af276fb4">A3DPDFDropDownListData::m_bHasBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a562350ab889cd5c71212a7ec6cd9255c">A3DPDFDropDownListData::m_sBorderColor</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a839621262590f42bd0edcda8bf75b181">A3DPDFDropDownListData::m_eLineStyleBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#abc49c0df74bded60a91307c13a5b5831">A3DPDFDropDownListData::m_eThicknessBorder</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gaeb695657f0a4b0864ed66c346c984a87">A3DPDFPageFieldListAddItem</ulink>. The two arrays need to have the same size. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a4947fa1d4f199544abcffe471873ca4f">A3DPDFDropDownListData::m_bAllowUserToEnterCustomText</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a7062508a25fdd808f13a81d9a183bcc3">A3DPDFDropDownListData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFDropDownListData::m_bHasFillColor</ulink> to true. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a9e3a815ed2eb6be5fa8855b1af62917d">A3DPDFDropDownListData::m_iFontSize</ulink>. More...
 
HPS.Publish.DropDownListKit SetImmediateCommit (bool in_state)
 Sets whether selected values are committed immediately. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a2870499ba84e16ffc484546fd7cacad8">A3DPDFDropDownListData::m_bCommitImmediate</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac7de3f7760af59c1b0c2c26865f594b1">A3DPDFDropDownListData::m_bIsLocked</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a736db78eb989039c4501ecf84e7d21ac">A3DPDFDropDownListData::m_pcName</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a8104c8b8f8f80b76bfcf12142a51a050">A3DPDFDropDownListData::m_eFormField</ulink>. More...
 
HPS.Publish.DropDownListKit SetSpellChecking (bool in_state)
 Sets whether spell checking is enabled. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a84a064d2607797298dcdfbc49d07a1a2">A3DPDFDropDownListData::m_bCheckSpelling</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a7f4b10a1a055edd6172003741d698785">A3DPDFDropDownListData::m_sTextColor</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#afdf939a599e3be7354d3abd91145c25f">A3DPDFDropDownListData::m_eTextOrientation</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ad96fec5ac9a5de55bca5f93dbbfab198">A3DPDFDropDownListData::m_pcTooltip</ulink>. More...
 
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 <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a8104c8b8f8f80b76bfcf12142a51a050">A3DPDFDropDownListData::m_eFormField</ulink>. More...
 
void Show (out HPS.Publish.DropDownListKit out_kit)
 Copies this DropDownListKit into the given DropDownListKit. More...
 
bool ShowBorder (out bool out_state)
 Shows the border setting for the drop down list. More...
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 Shows the border color for the drop down list. More...
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 Shows the border style for the drop down list. More...
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 Shows the border thickness for the drop down list. More...
 
bool ShowContents (out string[] out_displayed_values, out string[] out_export_values)
 Shows the content setting for the drop down list More...
 
bool ShowCustomText (out bool out_state)
 Shows the custom text setting for the drop down list. More...
 
bool ShowFillColor (out HPS.RGBColor out_color)
 Shows the fill color for the drop down list. More...
 
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. More...
 
bool ShowFontSize (out int out_size)
 Shows the font size for the drop down list. More...
 
bool ShowImmediateCommit (out bool out_state)
 Shows the immediate commit setting for the drop down list. More...
 
bool ShowLock (out bool out_state)
 Shows the lock setting for the drop down list. More...
 
bool ShowName (out string out_name)
 Shows the name for the drop down list. More...
 
bool ShowPrintability (out bool out_state)
 Shows the printability for the drop down list. More...
 
bool ShowSpellChecking (out bool out_state)
 Shows the spell checking setting for the drop down list. More...
 
bool ShowTextColor (out HPS.RGBColor out_color)
 Shows the text color for the drop down list. More...
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 Shows the text rotation for the drop down list. More...
 
bool ShowTooltip (out string out_tooltip)
 Shows the tooltip for the drop down list. More...
 
bool ShowVisibility (out bool out_state)
 Shows the visibility for the drop down list. More...
 
HPS.Publish.DropDownListKit UnsetBorder ()
 Removes the border setting. More...
 
HPS.Publish.DropDownListKit UnsetBorderColor ()
 Removes the border color setting. More...
 
HPS.Publish.DropDownListKit UnsetBorderStyle ()
 Removes the border style setting. More...
 
HPS.Publish.DropDownListKit UnsetBorderThickness ()
 Removes the border thickness setting. More...
 
HPS.Publish.DropDownListKit UnsetContents ()
 Removes the content setting. More...
 
HPS.Publish.DropDownListKit UnsetCustomText ()
 Removes the custom text setting. More...
 
HPS.Publish.DropDownListKit UnsetEverything ()
 Removes all data from the drop down list. More...
 
HPS.Publish.DropDownListKit UnsetFillColor ()
 Removes the fill color setting. More...
 
HPS.Publish.DropDownListKit UnsetFont ()
 Removes the font setting. More...
 
HPS.Publish.DropDownListKit UnsetFontSize ()
 Removes the font size setting. More...
 
HPS.Publish.DropDownListKit UnsetImmediateCommit ()
 Removes the immediate commit setting. More...
 
HPS.Publish.DropDownListKit UnsetLock ()
 Removes the lock setting. More...
 
HPS.Publish.DropDownListKit UnsetName ()
 Removes the name setting. More...
 
HPS.Publish.DropDownListKit UnsetPrintability ()
 Removes the printability setting. More...
 
HPS.Publish.DropDownListKit UnsetSpellChecking ()
 Removes the spell checking setting. More...
 
HPS.Publish.DropDownListKit UnsetTextColor ()
 Removes the text color setting. More...
 
HPS.Publish.DropDownListKit UnsetTextRotation ()
 Removes the text rotation setting. More...
 
HPS.Publish.DropDownListKit UnsetTooltip ()
 Removes the tooltip setting. More...
 
HPS.Publish.DropDownListKit UnsetVisibility ()
 Removes the visibility setting. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
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...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. 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...
 

Static Public Member Functions

static 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. More...
 
static bool operator!= (HPS.Publish.DropDownListKit a, HPS.Publish.DropDownListKit b)
 
static bool operator== (HPS.Publish.DropDownListKit a, HPS.Publish.DropDownListKit 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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.Publish.DropDownListKit.DropDownListKit ( )
inline

The default constructor creates an empty DropDownListKit object.

HPS.Publish.DropDownListKit.DropDownListKit ( HPS.Publish.DropDownListKit  in_kit)
inline

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

Parameters
in_kitThe source DropDownListKit to copy.

Member Function Documentation

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

Indicates whether this DropDownListKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source DropDownListKit is equivalent to this DropDownListKit.

Parameters
in_kitThe source DropDownListKit to compare to this DropDownListKit.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.GetDefault ( )
inlinestatic

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.

Returns
A DropDownListKit with the default settings.
override HPS.Type HPS.Publish.DropDownListKit.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.DropDownListKit.Set ( HPS.Publish.DropDownListKit  in_kit)
inline

Copies the source DropDownListKit into this DropDownListKit.

Parameters
in_kitThe source DropDownListKit to copy.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetBorder ( bool  in_state)
inline

Sets whether the drop down list has a border. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a07a4601e1dfc46509cac3521af276fb4">A3DPDFDropDownListData::m_bHasBorder</ulink>.

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

Sets the border color for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a562350ab889cd5c71212a7ec6cd9255c">A3DPDFDropDownListData::m_sBorderColor</ulink>.

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

Sets the border style for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a839621262590f42bd0edcda8bf75b181">A3DPDFDropDownListData::m_eLineStyleBorder</ulink>.

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

Sets the border thickness for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#abc49c0df74bded60a91307c13a5b5831">A3DPDFDropDownListData::m_eThicknessBorder</ulink>.

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

Sets the contents of the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/group__a3d__publish__page__module.html#gaeb695657f0a4b0864ed66c346c984a87">A3DPDFPageFieldListAddItem</ulink>. The two arrays need to have the same size.

Parameters
in_displayed_valuesThe values displayed in the drop down list
in_export_valuesThe export values associated with the values displayed
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetCustomText ( bool  in_state)
inline

Sets whether the user can enter custom text. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a4947fa1d4f199544abcffe471873ca4f">A3DPDFDropDownListData::m_bAllowUserToEnterCustomText</ulink>.

Parameters
in_stateWhether the user can enter custom text.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetFillColor ( HPS.RGBColor  in_color)
inline

Sets the fill color for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a7062508a25fdd808f13a81d9a183bcc3">A3DPDFDropDownListData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFDropDownListData::m_bHasFillColor</ulink> to true.

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

Sets a builtin font for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>.

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

Sets a specific font for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>.

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

Sets a specific font for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac2b8f71e48e6d8b34a05b39dad7197b7">A3DPDFDropDownListData::m_pcFontName</ulink>.

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

Sets the font size for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a9e3a815ed2eb6be5fa8855b1af62917d">A3DPDFDropDownListData::m_iFontSize</ulink>.

Parameters
in_sizeThe font size for the drop down list.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetImmediateCommit ( bool  in_state)
inline

Sets whether selected values are committed immediately. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a2870499ba84e16ffc484546fd7cacad8">A3DPDFDropDownListData::m_bCommitImmediate</ulink>.

Parameters
in_stateWhether selected values are committed immediately.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetLock ( bool  in_state)
inline

Sets whether the drop down list is locked. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ac7de3f7760af59c1b0c2c26865f594b1">A3DPDFDropDownListData::m_bIsLocked</ulink>.

Parameters
in_stateWhether the drop down list is locked.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetName ( string  in_name)
inline

Sets the name of the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a736db78eb989039c4501ecf84e7d21ac">A3DPDFDropDownListData::m_pcName</ulink>.

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

Sets the printability for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a8104c8b8f8f80b76bfcf12142a51a050">A3DPDFDropDownListData::m_eFormField</ulink>.

Parameters
in_stateThe printability for the drop down list.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetSpellChecking ( bool  in_state)
inline

Sets whether spell checking is enabled. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a84a064d2607797298dcdfbc49d07a1a2">A3DPDFDropDownListData::m_bCheckSpelling</ulink>.

Parameters
in_stateWhether spell checking is enabled.
Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.SetTextColor ( HPS.RGBColor  in_color)
inline

Sets the text color for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a7f4b10a1a055edd6172003741d698785">A3DPDFDropDownListData::m_sTextColor</ulink>.

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

Sets the text rotation for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#afdf939a599e3be7354d3abd91145c25f">A3DPDFDropDownListData::m_eTextOrientation</ulink>.

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

Sets the tooltip for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#ad96fec5ac9a5de55bca5f93dbbfab198">A3DPDFDropDownListData::m_pcTooltip</ulink>.

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

Sets the visibility for the drop down list. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f_drop_down_list_data.html#a8104c8b8f8f80b76bfcf12142a51a050">A3DPDFDropDownListData::m_eFormField</ulink>.

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

Copies this DropDownListKit into the given DropDownListKit.

Parameters
out_kitThe DropDownListKit to populate with the contents of this DropDownListKit.
bool HPS.Publish.DropDownListKit.ShowBorder ( out bool  out_state)
inline

Shows the border setting for the drop down list.

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

Shows the border color for the drop down list.

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

Shows the border style for the drop down list.

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

Shows the border thickness for the drop down list.

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

Shows the content setting for the drop down list

Parameters
out_displayed_valuesThe values displayed by the drop down list
out_export_valuesThe export values associated with the displayed values.
Returns
true if a content setting was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowCustomText ( out bool  out_state)
inline

Shows the custom text setting for the drop down list.

Parameters
out_stateWhether the user can enter custom text.
Returns
true if a custom text setting was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowFillColor ( out HPS.RGBColor  out_color)
inline

Shows the fill color for the drop down list.

Parameters
out_colorThe fill color for the drop down list.
Returns
true if a fill color was specified, false otherwise.
bool HPS.Publish.DropDownListKit.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 
)
inline

Shows the font for the drop down list.

Parameters
out_typeThe type of font for the drop down list.
out_fontThe built-in font for the drop down list. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_nameThe explicit font name for the drop down list. This is only valid if out_type is Text::Font::Type::Explicit.
out_styleThe font style for the drop down list. This is only valid if out_type is Text::Font::Type::Explicit.
Returns
true if a font was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowFontSize ( out int  out_size)
inline

Shows the font size for the drop down list.

Parameters
out_sizeThe font size for the drop down list.
Returns
true if a font size was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowImmediateCommit ( out bool  out_state)
inline

Shows the immediate commit setting for the drop down list.

Parameters
out_stateWhether selected values are committed immediately.
Returns
true if an immediate commit setting was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowLock ( out bool  out_state)
inline

Shows the lock setting for the drop down list.

Returns
true if a lock setting was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowName ( out string  out_name)
inline

Shows the name for the drop down list.

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

Shows the printability for the drop down list.

Parameters
out_stateThe printability for the drop down list.
Returns
true if a printability was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowSpellChecking ( out bool  out_state)
inline

Shows the spell checking setting for the drop down list.

Parameters
out_stateWhether spell checking is enabled.
Returns
true if a spell checking setting was specified, false otherwise.
bool HPS.Publish.DropDownListKit.ShowTextColor ( out HPS.RGBColor  out_color)
inline

Shows the text color for the drop down list.

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

Shows the text rotation for the drop down list.

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

Shows the tooltip for the drop down list.

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

Shows the visibility for the drop down list.

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

Removes the border setting.

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

Removes the border color setting.

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

Removes the border style setting.

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

Removes the border thickness setting.

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

Removes the content setting.

Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.UnsetCustomText ( )
inline

Removes the custom text setting.

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

Removes all data from the drop down list.

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

Removes the fill color setting.

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

Removes the font setting.

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

Removes the font size setting.

Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.UnsetImmediateCommit ( )
inline

Removes the immediate commit setting.

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

Removes the lock setting.

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

Removes the name setting.

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

Removes the printability setting.

Returns
A reference to this DropDownListKit.
HPS.Publish.DropDownListKit HPS.Publish.DropDownListKit.UnsetSpellChecking ( )
inline

Removes the spell checking setting.

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

Removes the text color setting.

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

Removes the text rotation setting.

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

Removes the tooltip setting.

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

Removes the visibility setting.

Returns
A reference to this DropDownListKit.

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