ChoiceField
Overview
ChoiceField is a class in Aspose.PDF FOSS for .NET.
Inherits from: Field.
ChoiceField provides methods such as AddOption, DeleteOption, and GetEnumerator to manage options in combo boxes and list boxes.
This class declares 33 methods for ChoiceField objects in .NET programs.
Available methods include: Accept, AddOption, BaseParagraph, ChangeAfterResize, ChoiceField, Clone, CopyTo, DeleteOption, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, and 11 additional methods.
Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags, and 83 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
IsCombo | bool | Read | Gets the is combo. |
IsEditable | bool | Read | Gets the is editable. |
IsMultiSelect | bool | Read | Gets the is multi select. |
IsSorted | bool | Read | Gets the is sorted. |
MultiSelect | bool | Read/Write | Get/set MultiSelect (/Ff bit 22 — 0-based 21). |
CommitImmediately | bool | Read/Write | Get/set CommitOnSelChange (/Ff bit 27 — 0-based 26). |
SelectedItems | int[] | Read/Write | Selected-option indices, 1-based like Index, Options and Selected — SelectedItems = [1, 3] selects the first and third options and reads back as [1, 3]. |
SelectedValues | IReadOnlyList<string> | Read/Write | The currently selected values. |
SelectedIndices | IReadOnlyList<int> | Read | The 0-based indices of selected values within the Options list. |
Options | OptionCollection | Read | The collection of choice options. |
Selected | int | Read/Write | 1-based index of the currently selected option, or -1 when no option is selected or the selection cannot be matched against the option list. |
Value | string? | Read/Write | The field value (/V). |
Type | FieldType | Read | The field type. |
FullName | string? | Read | The fully qualified field name. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Read/Write | Text-specific horizontal alignment override applied to the field’s widget appearance. |
PageIndex | int | Read | 1-based index of the page that owns this field’s widget. |
PartialName | string? | Read/Write | The partial field name (/T). |
NormalAppearance | XForm? | Read | The field’s “Normal” appearance (the /AP /N entry). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Read | The field widget’s appearance streams (the /AP entry), keyed by appearance name. |
OnActivated | Annotations.PdfAction? | Read/Write | The action triggered when this field is activated (/A entry). |
Count | int | Read | Number of kids in this field’s /Kids array — either child fields (hierarchy nodes) or widget annotations (a terminal field with multiple visual widgets, such as a grouped checkbox/radio). |
Fields | Field[] | Read | Field-typed child kids of this field as a snapshot array — convenience accessor mirroring Fields on the form. |
DefaultValue | string? | Read | The default value (/DV). |
AlternateName | string? | Read/Write | The alternate field name / tooltip (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Read/Write | The widget annotation flags (/F entry), e.g. |
TabOrder | int | Read/Write | Tab order index for this field. |
IsReadOnly | bool | Read | Whether the field is read-only. |
ReadOnly | bool | Read/Write | Whether the field is read-only (settable alias for API compatibility). |
IsRequired | bool | Read | Whether the field is required. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | Read | Appearance characteristics (border / background colors, widget rotation). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Read/Write | Default appearance (font, size, colour) of the field — the field-level counterpart of WidgetAnnotation. |
Rect | Rectangle? | Read/Write | The field rectangle. |
Color | Color | Read/Write | The field color (stored in /DA default appearance string as RGB). |
AnnotationIndex | int | Read/Write | 1-based tab position of this field’s widget within its page’s /Annots array — the array order is the page tab order. |
FitIntoRectangle | bool | Read/Write | Global flag: when true, a field’s value is auto-resized to fit its widget rectangle. |
IsSynchronized | bool | Read | Whether the collection is thread-safe. |
SyncRoot | object | Read | Synchronization root; returns this instance. |
MaxFontSize | double | Read/Write | Maximum font size used by the field’s appearance auto-fit. |
MinFontSize | double | Read/Write | Minimum font size used by the field’s appearance auto-fit. |
MappingName | string? | Read/Write | Mapping name used by external scripts to identify the field. |
IsGroup | bool | Read | Whether this field is a container/group of child fields. |
IsSharedField | bool | Read/Write | Whether this field belongs to a shared-fields group. |
AnnotationType | AnnotationType | Read | Always Widget. |
Border | Border? | Read/Write | Border width, style and dash pattern resolved from the widget’s BS dictionary (form fields carry their border there, not in /Border). |
Actions | AnnotationActionCollection | Read | Action slots for the widget’s /AA tree. |
Exportable | bool | Read/Write | Whether the widget’s value should be exported on form submit. |
Highlighting | HighlightingMode | Read/Write | Visual highlighting mode used when the user clicks the widget (/H entry). |
Parent | Forms.Field? | Read | Parent Field when this widget is the visual child of an AcroForm field. |
Required | bool | Read/Write | Whether the widget must be filled before submit (/Ff bit 2). |
HighlightMode | string | Read | The highlight mode (/H entry). |
DefaultAppearanceString | string? | Read | The default appearance string (/DA entry). |
FieldValue | string? | Read | The field value (/V entry). |
DefaultFieldValue | string? | Read | The default field value (/DV entry). |
FieldType | string? | Read | The field type (/FT entry). |
InnerRect | Rectangle? | Read | The annotation rectangle inset by the /RD (rectangle differences) entry — the region actually drawn inside Rect. |
Width | double | Read/Write | The width of the annotation rectangle. |
Height | double | Read/Write | The height of the annotation rectangle. |
ActiveState | string? | Read/Write | Currently-active appearance state (/AS entry). |
Alignment | TextAlignment | Read/Write | Text alignment (for free-text / widget annotations carrying rich text). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Read/Write | Horizontal alignment (exposed in addition to Alignment; the two are independently settable). |
States | AppearanceDictionary | Read | Appearance-state dictionary (the per-state sub-dict of AP/N, e.g. |
Contents | string? | Read/Write | The annotation contents (text). |
Opacity | double | Read/Write | Annotation opacity (0.0 = transparent, 1.0 = opaque). |
InteriorColor | Color? | Read/Write | The annotation interior color (/IC entry, for circle/square/line annotations). |
Title | string? | Read/Write | The annotation title (author for markup annotations). |
Name | string? | Read/Write | The annotation name (unique identifier — the /NM entry). |
Subject | string? | Read/Write | The annotation subject (/Subj entry). |
ModifiedDate | string? | Read | The modification date. |
Modified | DateTime | Read/Write | The /M (modified) date as a typed DateTime. |
AnnotationFlags | AnnotationFlags | Read/Write | Typed alias of Flags matching the public surface that exposes AnnotationFlags as a property. |
Action | PdfAction? | Read/Write | The action associated with this annotation (/A entry). |
Author | string? | Read | The annotation author (/T entry). |
AnnotationState | string? | Read | The annotation state (/State entry), e.g. |
AnnotationStateModel | string? | Read | The annotation state model (/StateModel entry), e.g. |
ReplyType | string? | Read | The reply type (/RT entry), e.g. |
InReplyTo | Annotation? | Read/Write | The annotation this one is replying to (/IRT entry). |
QuadPoints | Point[] | Read/Write | QuadPoints as an array of Point values. |
Page | Page? | Read | The page that owns this annotation, or null when it can’t be resolved (e.g. |
UpdateAppearanceOnConvert | bool | Read/Write | Whether to regenerate the appearance stream when an annotation is saved into a converted document. |
UseFontSubset | bool | Read/Write | Whether the embedded font (if any) should be subsetted. |
VerticalAlignment | VerticalAlignment | Read/Write | Vertical alignment applied to this paragraph. |
Margin | MarginInfo | Read/Write | Outer-margin info applied to this paragraph. |
IsFirstParagraphInColumn | bool | Read/Write | Force the paragraph to start a new column. |
IsKeptWithNext | bool | Read/Write | Keep this paragraph on the same page as the next one. |
IsInNewPage | bool | Read/Write | Force the paragraph to start on a new page. |
IsInLineParagraph | bool | Read/Write | Inline paragraph flag (does not start a new line). |
HyperlinkText | string? | Read/Write | Legacy string-typed hyperlink target. |
Hyperlink | Hyperlink? | Read/Write | Typed hyperlink decoration applied to the paragraph. |
ZIndex | int | Read/Write | Z-order index used by the DOM renderer. |
Methods
| Signature | Description |
|---|---|
ChoiceField(doc: Document) | Calls ChoiceField(doc) on this ChoiceField instance. |
ChoiceField(doc: Document, rect: Rectangle) | Calls ChoiceField(doc, rect) on this ChoiceField instance. |
ChoiceField(page: Page, rect: Rectangle) | Calls ChoiceField(page, rect) on this ChoiceField instance. |
AddOption(optionName: string) | Add an option to the choice field. |
AddOption(export: string, name: string) | Add an option with separate export and display values. |
DeleteOption(optionName: string) | Remove the first option matching optionName (either as a bare PdfString or as the display half of an [export, name] pair). |
Field(doc: Document) | Create a field bound to a document. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | Execute the supplied JavaScript action against this field. |
Flatten() | Flatten this field — turn its value into static page content. |
Recalculate() | Recalculate the field’s value from its calculation script. |
SetPosition(point: Aspose.Pdf.Point) | Move the field’s first widget rectangle to the supplied point (top-left corner). |
ExportToJson(stream: Stream) | Serialise this field to JSON (a single FieldExportingData object) via the supplied stream. |
ExportToJson(fileName: string) | Serialise this field to a JSON file. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Serialise this field to JSON via the supplied stream. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Serialise this field to a JSON file. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | Write the field’s name, flags and value to a JSON stream. |
ImportValueFromJson(inputJsonStream: Stream) | Read this field’s value from a JSON stream. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | Read a named field’s value from a JSON stream — a single field object (possibly nested via ChildFields) or an array of them — and apply the value of the entry whose dotted path matches fieldFullNameInJSON. |
GetEnumerator() | Iterates widget annotations for this field’s kids in the /Kids array. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | Copy widget annotations into an array starting at index. |
CopyTo(array: Field[], index: int) | Copy this field’s kids (as Field instances) into an array starting at index. |
GetWidgetEnumerator() | Enumerator typed to WidgetAnnotation. |
WidgetAnnotation(doc: Document) | Programmatic ctor — creates a bare widget annotation associated with doc’s reader. |
ExportToJson(stream: System.IO.Stream) | Serialise this widget’s field as JSON to a stream. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | Serialise this widget’s field as a single FieldExportingData JSON object to a stream. |
GetCheckedStateName() | Returns the appearance state name that represents the “on” / “checked” state of this widget (typically “Yes”), looked up from the /AP/N dict’s keys (anything that isn’t “Off”). |
Accept(visitor: AnnotationSelector) | Calls Accept(visitor) on this ChoiceField instance. |
GetRectangle(considerRotation: bool) | Bounding rectangle adjusted by considerRotation. |
ChangeAfterResize(transform: Matrix) | Adjust the annotation’s geometry after the user resized the page or the host rectangle. |
WriteXfdf(writer: System.Xml.XmlWriter) | Serialize this annotation as an XFDF element to writer (PDF 32000 §12.7.8 / XFDF 3.0). |
UpdateAppearances() | Regenerate the normal appearance stream (/AP /N) from the annotation’s current geometry and colours. |
BaseParagraph() | Creates a paragraph with default alignment, an empty margin and no hyperlink. |
Clone() | Shallow clone — copies scalar/ref-shared state. |
