|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The RadioButtonKit class is a user space object. It acts as the container for all data that can be used to specify a radio button for a Publish PDF.
◆ RadioButtonKit() [1/2]
HPS.Publish.RadioButtonKit.RadioButtonKit |
( |
| ) |
|
|
inline |
◆ RadioButtonKit() [2/2]
◆ Empty()
override bool HPS.Publish.RadioButtonKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
Creates a RadioButtonKit 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 RadioButtonKit passed to a function.
- Returns
- A RadioButtonKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.RadioButtonKit.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()
◆ 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 A3DPDFRadioButtonData::m_pcExportValue.
- Parameters
-
in_export_value | UTF8-encoded export value of the radio button. |
- Returns
- A reference to this RadioButtonKit.
◆ SetFillColor()
◆ SetFont() [1/3]
◆ SetFont() [2/3]
Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the radio button. |
in_style | The style of font to use for the radio button. |
- Returns
- A reference to this RadioButtonKit.
◆ SetFont() [3/3]
◆ SetFontSize()
◆ SetGrouping()
Sets whether the radio buttons with the same names are grouped, and therefore mutually exclusive. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bRadiosInUnison.
- Parameters
-
in_state | Whether the radio button is part of a group. |
- Returns
- A reference to this RadioButtonKit.
◆ SetLock()
◆ SetName()
◆ SetPrintability()
◆ SetTextColor()
◆ SetTextRotation()
◆ SetTooltip()
◆ SetVisibility()
◆ Show()
◆ ShowBorder()
bool HPS.Publish.RadioButtonKit.ShowBorder |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the border setting for the radio button.
- Parameters
-
out_state | Whether the radio button has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS.Publish.RadioButtonKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color for the radio button.
- Parameters
-
out_color | The border color of the radio button. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
Shows the border style for the radio button.
- Parameters
-
out_style | The border style for the radio button. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
Shows the border thickness for the radio button.
- Parameters
-
out_thickness | The border thickness for the radio button. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowDefaultState()
bool HPS.Publish.RadioButtonKit.ShowDefaultState |
( |
out bool |
out_default_state | ) |
|
|
inline |
Shows the default state for the radio button.
- Parameters
-
out_default_state | The default state for the radio button. |
- Returns
- true if a default state was specified, false otherwise.
◆ ShowExportValue()
bool HPS.Publish.RadioButtonKit.ShowExportValue |
( |
out string |
out_export_value | ) |
|
|
inline |
Shows the export value for the radio button.
- Parameters
-
out_export_value | The export value for the radio button. |
- Returns
- true if an export value was specified, false otherwise.
◆ ShowFillColor()
bool HPS.Publish.RadioButtonKit.ShowFillColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the fill color for the radio button.
- Parameters
-
out_color | The fill color for the radio button. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the radio button.
- Parameters
-
out_type | The type of font for the radio button. |
out_font | The built-in font for the radio button. This is only valid if out_type is Text.Font.Type.BuiltIn. |
out_font_name | The explicit font name for the radio button. This is only valid if out_type is Text.Font.Type.Explicit. |
out_style | The font style for the radio button. 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.RadioButtonKit.ShowFontSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the font size for the radio button.
- Parameters
-
out_size | The font size for the radio button. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowGrouping()
bool HPS.Publish.RadioButtonKit.ShowGrouping |
( |
out bool |
out_grouping | ) |
|
|
inline |
Shows the grouping state for the radio button.
- Parameters
-
out_grouping | The grouping state for the radio button. |
- Returns
- true if a groupings state was specified, false otherwise.
◆ ShowLock()
bool HPS.Publish.RadioButtonKit.ShowLock |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the lock setting for the radio button.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS.Publish.RadioButtonKit.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the name for the radio button.
- Parameters
-
out_name | The name of the radio button. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS.Publish.RadioButtonKit.ShowPrintability |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the printability for the radio button.
- Parameters
-
out_state | The printability for the radio button. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowTextColor()
bool HPS.Publish.RadioButtonKit.ShowTextColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the text color for the radio button.
- Parameters
-
out_color | The text color for the radio button. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
Shows the text rotation for the radio button.
- Parameters
-
out_rotation | The text rotation for the radio button. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS.Publish.RadioButtonKit.ShowTooltip |
( |
out string |
out_tooltip | ) |
|
|
inline |
Shows the tooltip for the radio button.
- Parameters
-
out_tooltip | The tooltip text for the radio button. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS.Publish.RadioButtonKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the visibility for the radio button.
- Parameters
-
out_state | The visibility for the radio button. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
Removes the border setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetDefaultState()
Removes the default state setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetEverything()
Removes all data from the radio button.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetExportValue()
Removes the export value setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetFont()
◆ UnsetFontSize()
Removes the font size setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetGrouping()
Removes the grouping setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetLock()
◆ UnsetName()
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetTooltip()
Removes the tooltip setting.
- Returns
- A reference to this RadioButtonKit.
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this RadioButtonKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs