RadioButtonFormField Class |
A RadioButtonFormField represents a parent field of other IFormElement objects
that are either RadioButtonFormField objects or RadioButtonWidgetAnnotations. Making a set of radio buttons
that are wired up correctly can be a tricky process. RadioButtonWidgetAnnotations typically are not used
without a parent RadioButtonFormField. It is typically easier to use the MakeRadioSet(GlobalResources, PdfGeneratedPage, String, String, String, String, PdfBounds)
method to make a set of radio buttons.
Inheritance HierarchySystemObject
Atalasoft.PdfDoc.Generating.FormsBaseFormField
Atalasoft.PdfDoc.Generating.FormsBaseButtonFormField
Atalasoft.PdfDoc.Generating.FormsRadioButtonFormField
Atalasoft.PdfDoc.Generating.FormsBaseFormField
Atalasoft.PdfDoc.Generating.FormsBaseButtonFormField
Atalasoft.PdfDoc.Generating.FormsRadioButtonFormField
Namespace: Atalasoft.PdfDoc.Generating.Forms
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe RadioButtonFormField type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RadioButtonFormField |
Initializes a new instance of the RadioButtonFormField class.
|
Properties| Name | Description | |
|---|---|---|
 | AdditionalActions |
Gets the additional actions that may be used by annotations that are children of this field.
(Inherited from BaseFormField.) |
| ChildFields |
Gets the child fields for this field.
(Inherited from BaseFormField.) |
| DefaultTextAppearance |
Gets or sets the default text appearance that is shared by children of this field.
(Inherited from BaseFormField.) |
| DefaultValue |
Gets or sets the default string value.
|
| EnforceReadyOnlyWithException |
Gets or sets a value indicating whether to enforce ready only with the IsFieldReadOnly propery with an exception.
(Inherited from BaseFormField.) |
| FieldAlternateDescription |
Gets or sets the field alternate description for display in the user interface.
(Inherited from BaseFormField.) |
| FieldFullName |
Gets the fully qualified name of the field. This value is only correct if
ParentField has been set. When the parent chain is properly
set up, this will return ParentField.FieldFullName + '.' + FieldName
(Inherited from BaseFormField.) |
| FieldName |
Gets or sets the name of the field.
(Inherited from BaseFormField.) |
| FieldNameForExport |
Gets or sets the field name for export.
(Inherited from BaseFormField.) |
| IsFieldNoExport |
Gets or sets a value indicating whether this field should not be export.
(Inherited from BaseFormField.) |
| IsFieldReadOnly |
Gets or sets a value indicating whether this field is read only.
(Inherited from BaseFormField.) |
| IsFieldRequired |
Gets or sets a value indicating whether this field is required.
(Inherited from BaseFormField.) |
| ParentField |
Gets or sets the parent field.
(Inherited from BaseFormField.) |
| Value |
Gets or sets the string value.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImplementMe |
Built for inheritance.
(Overrides BaseButtonFormFieldImplementMe.) |
 | MakeRadioSet(String, String, String, RadioButtonWidgetAnnotation) |
Makes a radio set from the collection of RadioButtonWidgetAnnotation objects.
Note that it is the client's responsibility to ensure that the radio buttons are put into the Annotations collection of
a page in the document.
|
| MakeRadioSet(PdfGeneratedPage, String, String, String, RadioButtonWidgetAnnotation) |
Makes the radio set from the set of radio buttons installing them in the supplied page (if any).
|
 | MakeRadioSet(GlobalResources, PdfGeneratedPage, String, String, String, String, PdfBounds) |
Makes a set of radio button fields with a single parent field. If currentValue or defaultValue are null, the code will
substitute the standard radio button cleared value.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ThrowIfReadOnlyT |
If EnforceReadyOnlyWithException is true and IsFieldReadOnly is true,
throw an InvalidOperationException, otherwise return value.
(Inherited from BaseFormField.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also