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...
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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/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/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.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_font, 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... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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 IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
The default constructor creates an empty ListBoxKit object.
|
inline |
The copy constructor creates a new ListBoxKit object that contains the same settings as the source ListBoxKit.
in_kit | The source ListBoxKit to copy. |
|
inlinevirtual |
Indicates whether this ListBoxKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source ListBoxKit is equivalent to this ListBoxKit.
in_kit | The source ListBoxKit to compare to this ListBoxKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source ListBoxKit into this ListBoxKit.
in_kit | The source ListBoxKit to copy. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a613aa60b08374a6b5ee06b9793505fcf">A3DPDFListBoxData::m_bHasBorder</ulink>.
in_state | Whether the list box has a border. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a8338d5a48d20dfd427356f5815a253f1">A3DPDFListBoxData::m_sBorderColor</ulink>.
in_color | The border color of the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#ad521f05576c362b8529b12fd3b94191b">A3DPDFListBoxData::m_eLineStyleBorder</ulink>.
in_style | The border style for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#aa68a2d58450a36413f7ae50213e3f2cd">A3DPDFListBoxData::m_eThicknessBorder</ulink>.
in_thickness | The border thickness for the list box. |
|
inline |
Sets the contents of the list box. 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.
in_displayed_values | The values displayed in the list box |
in_export_values | The export values associated with the values displayed |
|
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/publish/latest/build/api_ref/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.
in_color | The fill color for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.
in_name | The builtin font for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the list box. |
in_style | The style of font to use for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a6e38b53683e4fb7094eef6944d0c149b">A3DPDFListBoxData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a37ce067341dad28f98be68e13d15f6a2">A3DPDFListBoxData::m_iFontSize</ulink>.
in_size | The font size for the list box. |
|
inline |
Sets whether the list box 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_list_box_data.html#a15f5a5f907498ef4a09c8960ca1fac30">A3DPDFListBoxData::m_bIsLocked</ulink>.
in_state | Whether the list box is locked. |
|
inline |
Sets whether multiple selection is allowed. 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_list_box_data.html#aa64df979f517fb4106ea040dde36cc24">A3DPDFListBoxData::m_bMultipleSelection</ulink>.
in_state | Whether multiple selection is allowed |
|
inline |
Sets the name of the list box. 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_list_box_data.html#a4e87e4e13d58440e1f0b09f56d93da36">A3DPDFListBoxData::m_pcName</ulink>.
in_name | UTF8-encoded name of the list box. |
|
inline |
Sets the printability for the list box. 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_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>.
in_state | The printability for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#abfe4860172f1e7be6d65092435fe7589">A3DPDFListBoxData::m_sTextColor</ulink>.
in_color | The text color for the list box. |
|
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/publish/latest/build/api_ref/struct_a3_d_p_d_f_list_box_data.html#a10bc7f5374f39ccb8a10a9d279fb0503">A3DPDFListBoxData::m_eTextOrientation</ulink>.
in_rotation | The text rotation for the list box. |
|
inline |
Sets the tooltip for the list box. 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_list_box_data.html#aec810bf271dd6d8ee817e8913e96d95f">A3DPDFListBoxData::m_pcTooltip</ulink>.
in_tooltip | UTF8-encoded tooltip text for the list box. |
|
inline |
Sets the visibility for the list box. 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_list_box_data.html#abfce3c7edc84163e4ab3e26c46d3e709">A3DPDFListBoxData::m_eFormField</ulink>.
in_state | The visibility for the list box. |
|
inline |
Copies this ListBoxKit into the given ListBoxKit.
out_kit | The ListBoxKit to populate with the contents of this ListBoxKit. |
|
inline |
Shows the border setting for the list box.
out_state | Whether the list box has a border. |
|
inline |
Shows the border color for the list box.
out_color | The border color of the list box. |
|
inline |
Shows the border style for the list box.
out_style | The border style for the list box. |
|
inline |
Shows the border thickness for the list box.
out_thickness | The border thickness for the list box. |
|
inline |
Shows the content setting for the list box.
out_displayed_values | The values displayed by the list box. |
out_export_values | The export values associated with the displayed values. |
|
inline |
Shows the fill color for the list box.
out_color | The fill color for the list box. |
|
inline |
Shows the font for the list box.
out_type | The type of font for the list box. |
out_font | The built-in font for the list box. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the list box. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the list box. This is only valid if out_type is Text::Font::Type::Explicit. |
|
inline |
Shows the font size for the list box.
out_size | The font size for the list box. |
|
inline |
Shows the lock setting for the list box.
|
inline |
Shows the multiple selection setting for the list box.
out_state | Whether multiple selection is enabled. |
|
inline |
Shows the name for the list box.
out_name | The name of the list box. |
|
inline |
Shows the printability for the list box.
out_state | The printability for the list box. |
|
inline |
Shows the text color for the list box.
out_color | The text color for the list box. |
|
inline |
Shows the text rotation for the list box.
out_rotation | The text rotation for the list box. |
|
inline |
Shows the tooltip for the list box.
out_tooltip | The tooltip text for the list box. |
|
inline |
Shows the visibility for the list box.
out_state | The visibility for the list box. |
|
inline |
Removes the border setting.
|
inline |
Removes the border color setting.
|
inline |
Removes the border style setting.
|
inline |
Removes the border thickness setting.
|
inline |
Removes the content setting.
|
inline |
Removes all data from the list box.
|
inline |
Removes the fill color setting.
|
inline |
Removes the font setting.
|
inline |
Removes the font size setting.
|
inline |
Removes the lock setting.
|
inline |
Removes the multiple selection setting.
|
inline |
Removes the name setting.
|
inline |
Removes the printability setting.
|
inline |
Removes the text color setting.
|
inline |
Removes the text rotation setting.
|
inline |
Removes the tooltip setting.
|
inline |
Removes the visibility setting.