|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ CheckBoxKit() [1/2]
HPS.Publish.CheckBoxKit.CheckBoxKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty CheckBoxKit object.
◆ CheckBoxKit() [2/2]
The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.CheckBoxKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this CheckBoxKit has any values set on it.
- Returns
- true if no values are set on this CheckBoxKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A CheckBoxKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.CheckBoxKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
◆ SetBorder()
Sets whether the check box has a border. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bHasBorder.
- Parameters
-
in_state | Whether the check box has a border. |
- Returns
- A reference to this CheckBoxKit.
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetDefaultState()
◆ SetExportValue()
Sets the export value used when field data is exported by Acrobat functions. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcExportValue.
- Parameters
-
in_export_value | UTF8-encoded export value of the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFillColor()
◆ SetFont() [1/3]
Sets a builtin font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
- Parameters
-
in_name | The builtin font for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFont() [2/3]
Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the check box. |
in_style | The style of font to use for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFont() [3/3]
Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFontSize()
Sets the font size for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_iFontSize.
- Parameters
-
in_size | The font size for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetLock()
Sets whether the check box is locked. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsLocked.
- Parameters
-
in_state | Whether the check box is locked. |
- Returns
- A reference to this CheckBoxKit.
◆ SetName()
Sets the name of the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcName.
- Parameters
-
in_name | UTF8-encoded name of the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetPrintability()
Sets the printability for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.
- Parameters
-
in_state | The printability for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetTextColor()
Sets the text color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sTextColor.
- Parameters
-
in_color | The text color for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetTextRotation()
◆ SetTooltip()
Sets the tooltip for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcTooltip.
- Parameters
-
in_tooltip | UTF8-encoded tooltip text for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetVisibility()
Sets the visibility for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.
- Parameters
-
in_state | The visibility for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ Show()
◆ ShowBorder()
bool HPS.Publish.CheckBoxKit.ShowBorder |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the border setting for the check box.
- Parameters
-
out_state | Whether the check box has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS.Publish.CheckBoxKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color for the check box.
- Parameters
-
out_color | The border color of the check box. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
Shows the border style for the check box.
- Parameters
-
out_style | The border style for the check box. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
Shows the border thickness for the check box.
- Parameters
-
out_thickness | The border thickness for the check box. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowDefaultState()
bool HPS.Publish.CheckBoxKit.ShowDefaultState |
( |
out bool |
out_default_state | ) |
|
|
inline |
Shows the default state for the check box.
- Parameters
-
out_default_state | The default state for the check box. |
- Returns
- true if a default state was specified, false otherwise.
◆ ShowExportValue()
bool HPS.Publish.CheckBoxKit.ShowExportValue |
( |
out string |
out_export_value | ) |
|
|
inline |
Shows the export value for the check box.
- Parameters
-
out_export_value | The export value for the check box. |
- Returns
- true if an export value was specified, false otherwise.
◆ ShowFillColor()
bool HPS.Publish.CheckBoxKit.ShowFillColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the fill color for the check box.
- Parameters
-
out_color | The fill color for the check box. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the check box.
- Parameters
-
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. |
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
bool HPS.Publish.CheckBoxKit.ShowFontSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the font size for the check box.
- Parameters
-
out_size | The font size for the check box. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowLock()
bool HPS.Publish.CheckBoxKit.ShowLock |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the lock setting for the check box.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS.Publish.CheckBoxKit.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the name for the check box.
- Parameters
-
out_name | The name of the check box. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS.Publish.CheckBoxKit.ShowPrintability |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the printability for the check box.
- Parameters
-
out_state | The printability for the check box. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowTextColor()
bool HPS.Publish.CheckBoxKit.ShowTextColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the text color for the check box.
- Parameters
-
out_color | The text color for the check box. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
Shows the text rotation for the check box.
- Parameters
-
out_rotation | The text rotation for the check box. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS.Publish.CheckBoxKit.ShowTooltip |
( |
out string |
out_tooltip | ) |
|
|
inline |
Shows the tooltip for the check box.
- Parameters
-
out_tooltip | The tooltip text for the check box. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS.Publish.CheckBoxKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the visibility for the check box.
- Parameters
-
out_state | The visibility for the check box. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
Removes the border setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetDefaultState()
Removes the default state setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetEverything()
Removes all data from the check box.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetExportValue()
Removes the export value setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFontSize()
Removes the font size setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetLock()
Removes the lock setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetName()
Removes the name setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTooltip()
Removes the tooltip setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this CheckBoxKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs