
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this RadioButtonKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.RadioButtonKit in_kit) |
Check if the source RadioButtonKit is equivalent to this RadioButtonKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
RadioButtonKit () | |
The default constructor creates an empty RadioButtonKit object. More... | |
RadioButtonKit (HPS.Publish.RadioButtonKit in_kit) | |
The copy constructor creates a new RadioButtonKit object that contains the same settings as the source RadioButtonKit. More... | |
void | Set (HPS.Publish.RadioButtonKit in_kit) |
Copies the source RadioButtonKit into this RadioButtonKit. More... | |
HPS.Publish.RadioButtonKit | SetBorder (bool in_state) |
Sets whether the radio button has a border. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bHasBorder. More... | |
HPS.Publish.RadioButtonKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the border color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sBorderColor. More... | |
HPS.Publish.RadioButtonKit | SetBorderStyle (HPS.Publish.Border.Style in_style) |
Sets the border style for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eLineStyleBorder. More... | |
HPS.Publish.RadioButtonKit | SetBorderThickness (HPS.Publish.Border.Thickness in_thickness) |
Sets the border thickness for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eThicknessBorder. More... | |
HPS.Publish.RadioButtonKit | SetDefaultState (bool in_state) |
Sets whether the radio button is checked by default. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsCheckedByDefault. More... | |
HPS.Publish.RadioButtonKit | 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 A3DPDFRadioButtonData::m_pcExportValue. More... | |
HPS.Publish.RadioButtonKit | SetFillColor (HPS.RGBColor in_color) |
Sets the fill color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sFillColor and implicitly sets A3DPDFRadioButtonData::m_bHasFillColor to true. More... | |
HPS.Publish.RadioButtonKit | SetFont (HPS.Publish.Text.Font.Name in_name) |
Sets a builtin font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName. More... | |
HPS.Publish.RadioButtonKit | SetFont (string in_name, HPS.Publish.Text.Font.Style in_style) |
Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName. More... | |
HPS.Publish.RadioButtonKit | SetFont (string in_name) |
Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName. More... | |
HPS.Publish.RadioButtonKit | SetFontSize (int in_size) |
Sets the font size for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_iFontSize. More... | |
HPS.Publish.RadioButtonKit | SetGrouping (bool in_state) |
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. More... | |
HPS.Publish.RadioButtonKit | SetLock (bool in_state) |
Sets whether the radio button is locked. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsLocked. More... | |
HPS.Publish.RadioButtonKit | SetName (string in_name) |
Sets the name of the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcName. More... | |
HPS.Publish.RadioButtonKit | SetPrintability (bool in_state) |
Sets the printability for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField. More... | |
HPS.Publish.RadioButtonKit | SetTextColor (HPS.RGBColor in_color) |
Sets the text color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sTextColor. More... | |
HPS.Publish.RadioButtonKit | SetTextRotation (HPS.Publish.Text.Rotation in_rotation) |
Sets the text rotation for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eTextOrientation. More... | |
HPS.Publish.RadioButtonKit | SetTooltip (string in_tooltip) |
Sets the tooltip for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcTooltip. More... | |
HPS.Publish.RadioButtonKit | SetVisibility (bool in_state) |
Sets the visibility for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField. More... | |
void | Show (out HPS.Publish.RadioButtonKit out_kit) |
Copies this RadioButtonKit into the given RadioButtonKit. More... | |
bool | ShowBorder (out bool out_state) |
Shows the border setting for the radio button. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color for the radio button. More... | |
bool | ShowBorderStyle (out HPS.Publish.Border.Style out_style) |
Shows the border style for the radio button. More... | |
bool | ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness) |
Shows the border thickness for the radio button. More... | |
bool | ShowDefaultState (out bool out_default_state) |
Shows the default state for the radio button. More... | |
bool | ShowExportValue (out string out_export_value) |
Shows the export value for the radio button. More... | |
bool | ShowFillColor (out HPS.RGBColor out_color) |
Shows the fill color for the radio button. 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 radio button. More... | |
bool | ShowFontSize (out int out_size) |
Shows the font size for the radio button. More... | |
bool | ShowGrouping (out bool out_grouping) |
Shows the grouping state for the radio button. More... | |
bool | ShowLock (out bool out_state) |
Shows the lock setting for the radio button. More... | |
bool | ShowName (out string out_name) |
Shows the name for the radio button. More... | |
bool | ShowPrintability (out bool out_state) |
Shows the printability for the radio button. More... | |
bool | ShowTextColor (out HPS.RGBColor out_color) |
Shows the text color for the radio button. More... | |
bool | ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation) |
Shows the text rotation for the radio button. More... | |
bool | ShowTooltip (out string out_tooltip) |
Shows the tooltip for the radio button. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility for the radio button. More... | |
HPS.Publish.RadioButtonKit | UnsetBorder () |
Removes the border setting. More... | |
HPS.Publish.RadioButtonKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.RadioButtonKit | UnsetBorderStyle () |
Removes the border style setting. More... | |
HPS.Publish.RadioButtonKit | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
HPS.Publish.RadioButtonKit | UnsetDefaultState () |
Removes the default state setting. More... | |
HPS.Publish.RadioButtonKit | UnsetEverything () |
Removes all data from the radio button. More... | |
HPS.Publish.RadioButtonKit | UnsetExportValue () |
Removes the export value setting. More... | |
HPS.Publish.RadioButtonKit | UnsetFillColor () |
Removes the fill color setting. More... | |
HPS.Publish.RadioButtonKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.RadioButtonKit | UnsetFontSize () |
Removes the font size setting. More... | |
HPS.Publish.RadioButtonKit | UnsetGrouping () |
Removes the grouping setting. More... | |
HPS.Publish.RadioButtonKit | UnsetLock () |
Removes the lock setting. More... | |
HPS.Publish.RadioButtonKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.RadioButtonKit | UnsetPrintability () |
Removes the printability setting. More... | |
HPS.Publish.RadioButtonKit | UnsetTextColor () |
Removes the text color setting. More... | |
HPS.Publish.RadioButtonKit | UnsetTextRotation () |
Removes the text rotation setting. More... | |
HPS.Publish.RadioButtonKit | UnsetTooltip () |
Removes the tooltip setting. More... | |
HPS.Publish.RadioButtonKit | UnsetVisibility () |
Removes the visibility setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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... | |
virtual 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.RadioButtonKit | 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. More... | |
static bool | operator!= (HPS.Publish.RadioButtonKit a, HPS.Publish.RadioButtonKit b) |
static bool | operator== (HPS.Publish.RadioButtonKit a, HPS.Publish.RadioButtonKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty RadioButtonKit object.
|
inline |
The copy constructor creates a new RadioButtonKit object that contains the same settings as the source RadioButtonKit.
- Parameters
-
in_kit The source RadioButtonKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this RadioButtonKit has any values set on it.
- Returns
- true if no values are set on this RadioButtonKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
- Parameters
-
in_kit The source RadioButtonKit to compare to this RadioButtonKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
inline |
Copies the source RadioButtonKit into this RadioButtonKit.
- Parameters
-
in_kit The source RadioButtonKit to copy.
|
inline |
Sets whether the radio button has a border. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bHasBorder.
- Parameters
-
in_state Whether the radio button has a border.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the border color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sBorderColor.
- Parameters
-
in_color The border color of the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the border style for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eLineStyleBorder.
- Parameters
-
in_style The border style for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the border thickness for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eThicknessBorder.
- Parameters
-
in_thickness The border thickness for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets whether the radio button is checked by default. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsCheckedByDefault.
- Parameters
-
in_state Whether the radio button is checked by default.
- Returns
- A reference to this RadioButtonKit.
|
inline |
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.
|
inline |
Sets the fill color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sFillColor and implicitly sets A3DPDFRadioButtonData::m_bHasFillColor to true.
- Parameters
-
in_color The fill color for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets a builtin font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.
- Parameters
-
in_name The builtin font for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
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.
|
inline |
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.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the font size for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_iFontSize.
- Parameters
-
in_size The font size for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
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.
|
inline |
Sets whether the radio button is locked. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsLocked.
- Parameters
-
in_state Whether the radio button is locked.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the name of the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcName.
- Parameters
-
in_name UTF8-encoded name of the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the printability for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.
- Parameters
-
in_state The printability for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the text color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sTextColor.
- Parameters
-
in_color The text color for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the text rotation for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eTextOrientation.
- Parameters
-
in_rotation The text rotation for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the tooltip for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcTooltip.
- Parameters
-
in_tooltip UTF8-encoded tooltip text for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Sets the visibility for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.
- Parameters
-
in_state The visibility for the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Copies this RadioButtonKit into the given RadioButtonKit.
- Parameters
-
out_kit The RadioButtonKit to populate with the contents of this RadioButtonKit.
|
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.
|
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.
|
inline |
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.
|
inline |
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.
|
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.
|
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.
|
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.
|
inline |
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.
|
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.
|
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.
|
inline |
Shows the lock setting for the radio button.
- Returns
- true if a lock setting was specified, false otherwise.
|
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.
|
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.
|
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.
|
inline |
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.
|
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.
|
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.
|
inline |
Removes the border setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the border color setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the border style setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the border thickness setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the default state setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes all data from the radio button.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the export value setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the fill color setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the font setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the font size setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the grouping setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the lock setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the name setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the printability setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the text color setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the text rotation setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
Removes the tooltip setting.
- Returns
- A reference to this RadioButtonKit.
|
inline |
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