The CheckBoxKit class is a user space object. It acts as the container for all data that can be used to specify a check box for a Publish PDF. More...
Public Member Functions | |
override void | Dispose () |
CheckBoxKit () | |
The default constructor creates an empty CheckBoxKit object. More... | |
CheckBoxKit (HPS.Publish.CheckBoxKit in_kit) | |
The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit. 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.CheckBoxKit in_kit) |
Copies the source CheckBoxKit into this CheckBoxKit. More... | |
void | Show (out HPS.Publish.CheckBoxKit out_kit) |
Copies this CheckBoxKit into the given CheckBoxKit. More... | |
override bool | Empty () |
Indicates whether this CheckBoxKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Publish.CheckBoxKit in_kit) |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit. More... | |
HPS.Publish.CheckBoxKit | SetName (string in_name) |
Sets the name of the check 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_check_box_data.html#a70f813f3a8e5ed1b545ceb7216ea7c7f">A3DPDFCheckBoxData::m_pcName</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetFont (HPS.Publish.Text.Font.Name in_name) |
Sets a builtin font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetFont (string in_name, HPS.Publish.Text.Font.Style in_style) |
Sets a specific font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetFont (string in_name) |
Sets a specific font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetFontSize (int in_size) |
Sets the font size for the check 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_check_box_data.html#aa53034d802575ab762f72f5aa0451e45">A3DPDFCheckBoxData::m_iFontSize</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetTextColor (HPS.RGBColor in_color) |
Sets the text color for the check 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_check_box_data.html#a6137dcadfaec886dd2e98bed49d20169">A3DPDFCheckBoxData::m_sTextColor</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetTooltip (string in_tooltip) |
Sets the tooltip for the check 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_check_box_data.html#a29554afd13838d44df6cc14a99f1fd6f">A3DPDFCheckBoxData::m_pcTooltip</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetVisibility (bool in_state) |
Sets the visibility for the check 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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetPrintability (bool in_state) |
Sets the printability for the check 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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetTextRotation (HPS.Publish.Text.Rotation in_rotation) |
Sets the text rotation for the check 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_check_box_data.html#a717710765f5bd52fc4a71c0fc461ea7f">A3DPDFCheckBoxData::m_eTextOrientation</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetLock (bool in_state) |
Sets whether the check 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_check_box_data.html#a97d7fa4d8f4bc1d6b40efe78bba5ba85">A3DPDFCheckBoxData::m_bIsLocked</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetBorder (bool in_state) |
Sets whether the check 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_check_box_data.html#a8f59c630e0f26f15d6bab9660499b36e">A3DPDFCheckBoxData::m_bHasBorder</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the border color for the check 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_check_box_data.html#ab11458bd156a91bc2ac7eae2f265147b">A3DPDFCheckBoxData::m_sBorderColor</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetBorderThickness (HPS.Publish.Border.Thickness in_thickness) |
Sets the border thickness for the check 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_check_box_data.html#ad8dc5ab66d688a364e9c3212a15f9b89">A3DPDFCheckBoxData::m_eThicknessBorder</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetBorderStyle (HPS.Publish.Border.Style in_style) |
Sets the border style for the check 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_check_box_data.html#ae9d37141615cba0ab402366fa7a90f8a">A3DPDFCheckBoxData::m_eLineStyleBorder</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetFillColor (HPS.RGBColor in_color) |
Sets the fill color for the check 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_check_box_data.html#ae3fef1552b3a1735132d4638698030c7">A3DPDFCheckBoxData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFCheckBoxData::m_bHasFillColor</ulink> to true. More... | |
HPS.Publish.CheckBoxKit | SetExportValue (string in_export_value) |
Sets the export value used when field data is exported by Acrobat functions. 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_check_box_data.html#a36f565103f4e88c33a1f65d3c10b268b">A3DPDFCheckBoxData::m_pcExportValue</ulink>. More... | |
HPS.Publish.CheckBoxKit | SetDefaultState (bool in_state) |
Sets whether the check box is checked by default. 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_check_box_data.html#a2f3a43f0dcd4ad80bb3ba35b40f7201b">A3DPDFCheckBoxData::m_bIsCheckedByDefault</ulink>. More... | |
HPS.Publish.CheckBoxKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.CheckBoxKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.CheckBoxKit | UnsetFontSize () |
Removes the font size setting. More... | |
HPS.Publish.CheckBoxKit | UnsetTextColor () |
Removes the text color setting. More... | |
HPS.Publish.CheckBoxKit | UnsetTooltip () |
Removes the tooltip setting. More... | |
HPS.Publish.CheckBoxKit | UnsetVisibility () |
Removes the visibility setting. More... | |
HPS.Publish.CheckBoxKit | UnsetPrintability () |
Removes the printability setting. More... | |
HPS.Publish.CheckBoxKit | UnsetTextRotation () |
Removes the text rotation setting. More... | |
HPS.Publish.CheckBoxKit | UnsetLock () |
Removes the lock setting. More... | |
HPS.Publish.CheckBoxKit | UnsetBorder () |
Removes the border setting. More... | |
HPS.Publish.CheckBoxKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.CheckBoxKit | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
HPS.Publish.CheckBoxKit | UnsetBorderStyle () |
Removes the border style setting. More... | |
HPS.Publish.CheckBoxKit | UnsetFillColor () |
Removes the fill color setting. More... | |
HPS.Publish.CheckBoxKit | UnsetExportValue () |
Removes the export value setting. More... | |
HPS.Publish.CheckBoxKit | UnsetDefaultState () |
Removes the default state setting. More... | |
HPS.Publish.CheckBoxKit | UnsetEverything () |
Removes all data from the check box. More... | |
bool | ShowName (out string out_name) |
Shows the name for the check 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 check box. More... | |
bool | ShowFontSize (out int out_size) |
Shows the font size for the check box. More... | |
bool | ShowTextColor (out HPS.RGBColor out_color) |
Shows the text color for the check box. More... | |
bool | ShowTooltip (out string out_tooltip) |
Shows the tooltip for the check box. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility for the check box. More... | |
bool | ShowPrintability (out bool out_state) |
Shows the printability for the check box. More... | |
bool | ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation) |
Shows the text rotation for the check box. More... | |
bool | ShowLock (out bool out_state) |
Shows the lock setting for the check box. More... | |
bool | ShowBorder (out bool out_state) |
Shows the border setting for the check box. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color for the check box. More... | |
bool | ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness) |
Shows the border thickness for the check box. More... | |
bool | ShowBorderStyle (out HPS.Publish.Border.Style out_style) |
Shows the border style for the check box. More... | |
bool | ShowFillColor (out HPS.RGBColor out_color) |
Shows the fill color for the check box. More... | |
bool | ShowExportValue (out string out_export_value) |
Shows the export value for the check box. More... | |
bool | ShowDefaultState (out bool out_default_state) |
Shows the default state for the check 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.CheckBoxKit | GetDefault () |
Creates a CheckBoxKit 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 CheckBoxKit passed to a function. More... | |
static bool | operator== (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit b) |
static bool | operator!= (HPS.Publish.CheckBoxKit a, HPS.Publish.CheckBoxKit 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 CheckBoxKit class is a user space object. It acts as the container for all data that can be used to specify a check box for a Publish PDF.
|
inline |
The default constructor creates an empty CheckBoxKit object.
|
inline |
The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit.
in_kit | The source CheckBoxKit to copy. |
|
inlinevirtual |
Indicates whether this CheckBoxKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
in_kit | The source CheckBoxKit to compare to this CheckBoxKit. |
|
inlinestatic |
Creates a CheckBoxKit 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 CheckBoxKit 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 CheckBoxKit into this CheckBoxKit.
in_kit | The source CheckBoxKit to copy. |
|
inline |
Sets whether the check 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_check_box_data.html#a8f59c630e0f26f15d6bab9660499b36e">A3DPDFCheckBoxData::m_bHasBorder</ulink>.
in_state | Whether the check box has a border. |
|
inline |
Sets the border color for the check 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_check_box_data.html#ab11458bd156a91bc2ac7eae2f265147b">A3DPDFCheckBoxData::m_sBorderColor</ulink>.
in_color | The border color of the check box. |
|
inline |
Sets the border style for the check 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_check_box_data.html#ae9d37141615cba0ab402366fa7a90f8a">A3DPDFCheckBoxData::m_eLineStyleBorder</ulink>.
in_style | The border style for the check box. |
|
inline |
Sets the border thickness for the check 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_check_box_data.html#ad8dc5ab66d688a364e9c3212a15f9b89">A3DPDFCheckBoxData::m_eThicknessBorder</ulink>.
in_thickness | The border thickness for the check box. |
|
inline |
Sets whether the check box is checked by default. 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_check_box_data.html#a2f3a43f0dcd4ad80bb3ba35b40f7201b">A3DPDFCheckBoxData::m_bIsCheckedByDefault</ulink>.
in_state | Whether the check box is checked by default. |
|
inline |
Sets the export value used when field data is exported by Acrobat functions. 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_check_box_data.html#a36f565103f4e88c33a1f65d3c10b268b">A3DPDFCheckBoxData::m_pcExportValue</ulink>.
in_export_value | UTF8-encoded export value of the check box. |
|
inline |
Sets the fill color for the check 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_check_box_data.html#ae3fef1552b3a1735132d4638698030c7">A3DPDFCheckBoxData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFCheckBoxData::m_bHasFillColor</ulink> to true.
in_color | The fill color for the check box. |
|
inline |
Sets a builtin font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.
in_name | The builtin font for the check box. |
|
inline |
Sets a specific font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the check box. |
in_style | The style of font to use for the check box. |
|
inline |
Sets a specific font for the check 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_check_box_data.html#acf5d507f8d53e88edb732b77f55fbc7f">A3DPDFCheckBoxData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the check box. |
|
inline |
Sets the font size for the check 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_check_box_data.html#aa53034d802575ab762f72f5aa0451e45">A3DPDFCheckBoxData::m_iFontSize</ulink>.
in_size | The font size for the check box. |
|
inline |
Sets whether the check 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_check_box_data.html#a97d7fa4d8f4bc1d6b40efe78bba5ba85">A3DPDFCheckBoxData::m_bIsLocked</ulink>.
in_state | Whether the check box is locked. |
|
inline |
Sets the name of the check 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_check_box_data.html#a70f813f3a8e5ed1b545ceb7216ea7c7f">A3DPDFCheckBoxData::m_pcName</ulink>.
in_name | UTF8-encoded name of the check box. |
|
inline |
Sets the printability for the check 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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>.
in_state | The printability for the check box. |
|
inline |
Sets the text color for the check 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_check_box_data.html#a6137dcadfaec886dd2e98bed49d20169">A3DPDFCheckBoxData::m_sTextColor</ulink>.
in_color | The text color for the check box. |
|
inline |
Sets the text rotation for the check 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_check_box_data.html#a717710765f5bd52fc4a71c0fc461ea7f">A3DPDFCheckBoxData::m_eTextOrientation</ulink>.
in_rotation | The text rotation for the check box. |
|
inline |
Sets the tooltip for the check 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_check_box_data.html#a29554afd13838d44df6cc14a99f1fd6f">A3DPDFCheckBoxData::m_pcTooltip</ulink>.
in_tooltip | UTF8-encoded tooltip text for the check box. |
|
inline |
Sets the visibility for the check 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_check_box_data.html#a8fc22870b1df024c392dd14848bf1077">A3DPDFCheckBoxData::m_eFormField</ulink>.
in_state | The visibility for the check box. |
|
inline |
Copies this CheckBoxKit into the given CheckBoxKit.
out_kit | The CheckBoxKit to populate with the contents of this CheckBoxKit. |
|
inline |
Shows the border setting for the check box.
out_state | Whether the check box has a border. |
|
inline |
Shows the border color for the check box.
out_color | The border color of the check box. |
|
inline |
Shows the border style for the check box.
out_style | The border style for the check box. |
|
inline |
Shows the border thickness for the check box.
out_thickness | The border thickness for the check box. |
|
inline |
Shows the default state for the check box.
out_default_state | The default state for the check box. |
|
inline |
Shows the export value for the check box.
out_export_value | The export value for the check box. |
|
inline |
Shows the fill color for the check box.
out_color | The fill color for the check box. |
|
inline |
Shows the font for the check box.
out_type | The type of font for the check box. |
out_font | The built-in font for the check box. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the check box. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the check box. This is only valid if out_type is Text::Font::Type::Explicit. |
|
inline |
Shows the font size for the check box.
out_size | The font size for the check box. |
|
inline |
Shows the lock setting for the check box.
|
inline |
Shows the name for the check box.
out_name | The name of the check box. |
|
inline |
Shows the printability for the check box.
out_state | The printability for the check box. |
|
inline |
Shows the text color for the check box.
out_color | The text color for the check box. |
|
inline |
Shows the text rotation for the check box.
out_rotation | The text rotation for the check box. |
|
inline |
Shows the tooltip for the check box.
out_tooltip | The tooltip text for the check box. |
|
inline |
Shows the visibility for the check box.
out_state | The visibility for the check 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 default state setting.
|
inline |
Removes all data from the check box.
|
inline |
Removes the export value setting.
|
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 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.