| ListBoxField Class |
Class represents ListBox field.
Inheritance HierarchySystemObject
Aspose.PdfBaseParagraph
Aspose.Pdf.AnnotationsAnnotation
Aspose.Pdf.AnnotationsWidgetAnnotation
Aspose.Pdf.FormsField
Aspose.Pdf.FormsChoiceField
Aspose.Pdf.FormsListBoxField
Aspose.PdfBaseParagraph
Aspose.Pdf.AnnotationsAnnotation
Aspose.Pdf.AnnotationsWidgetAnnotation
Aspose.Pdf.FormsField
Aspose.Pdf.FormsChoiceField
Aspose.Pdf.FormsListBoxField
Namespace: Aspose.Pdf.Forms
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.3
SyntaxThe ListBoxField type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ListBoxField |
Constructor for ListBoxField to be used in Generator.
|
| ListBoxField(Document, Rectangle) |
Constructor for ListBox field.
|
| ListBoxField(Page, Rectangle) |
Creates new ListBox field.
|
Properties| Name | Description | |
|---|---|---|
 | Actions |
Gets the annotation actions.
(Inherited from WidgetAnnotation.) |
| ActiveState |
Gets or sets current annotation appearance state.
(Inherited from Annotation.) |
| Alignment | Obsolete.
Annotation alignment. This property is obsolete. Use HorizontalAligment instead.
(Inherited from Annotation.) |
| AlternateName |
Gets or sets alternate name of the field (An alternate field
name that shall be used in place of the actual field name
wherever the field shall be identified in the user interface).
Alternate name is used as field tooltip in Adobe Acrobat.
(Inherited from Field.) |
| AnnotationIndex |
Gets or sets index of this anotation on the page.
(Inherited from Field.) |
| AnnotationType |
Gets type of annotation.
(Inherited from WidgetAnnotation.) |
| Appearance |
Gets appearance dictionary of the annotation.
(Inherited from Annotation.) |
| Border |
Gets or sets annotation border characteristics. Border (Inherited from Annotation.) |
| Characteristics |
Gets annotation characteristics.
(Inherited from Annotation.) |
| Color |
Gets or sets annotation color.
(Inherited from Annotation.) |
| CommitImmediately |
Gets or sets commit on selection change flag.
(Inherited from ChoiceField.) |
| Contents |
Gets or sets annotation text.
(Inherited from Annotation.) |
| Count |
Gets or sets number of subfields in this field. (For example number of items in radio button field).
(Inherited from Field.) |
| DefaultAppearance |
Gets or sets default appearance of the field.
(Inherited from WidgetAnnotation.) |
| Exportable |
Gets or sets exportable flag of the field.
(Inherited from WidgetAnnotation.) |
| Flags |
Flags of the annotation.
(Inherited from Annotation.) |
| FullName |
Gets full qualified name of the annotation.
(Inherited from Annotation.) |
| Height |
Gets or sets height of the annotation.
(Inherited from Annotation.) |
| Highlighting |
Annotation highlighting mode.
(Inherited from WidgetAnnotation.) |
| HorizontalAlignment | Obsolete.
Gets or sets text alignment for annotation.
(Inherited from Annotation.) |
| Hyperlink |
Gets or sets the fragment hyperlink(for pdf generator).
(Inherited from BaseParagraph.) |
| IsFirstParagraphInColumn |
Gets or sets a bool value that indicates whether this paragraph will be at next column.
Default is false.(for pdf generation)
(Inherited from BaseParagraph.) |
| IsGroup |
Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields.
(Inherited from Field.) |
| IsInLineParagraph |
Gets or sets a paragraph is inline.
Default is false.(for pdf generation)
(Inherited from BaseParagraph.) |
| IsInNewPage |
Gets or sets a bool value that force this paragraph generates at new page.
Default is false.(for pdf generation)
(Inherited from BaseParagraph.) |
| IsKeptWithNext |
Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph.
Default is false.(for pdf generation)
(Inherited from BaseParagraph.) |
| IsSharedField |
Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
(Inherited from Field.) |
| IsSynchronized |
Returns true if dictionary is synchronized.
(Inherited from Field.) |
| ItemInt32 |
Gets subfield contained in this field by index.
(Inherited from Field.) |
| ItemString |
Gets subfield contained in this field by name of the subfield.
(Inherited from Field.) |
| MappingName |
Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document.
(Inherited from Field.) |
| Margin |
Gets or sets a outer margin for paragraph (for pdf generation)
(Inherited from BaseParagraph.) |
| Modified |
Gets or sets date and time when annotation was recently modified.
(Inherited from Annotation.) |
| MultiSelect |
Gets or sets multiselection flag.
(Inherited from ChoiceField.) |
| Name |
Gets or sets annotation name on the page.
(Inherited from Annotation.) |
| OnActivated |
An action which shall be performed when the annotation is activated.
(Inherited from WidgetAnnotation.) |
| Options |
Gets collection of choice options.
(Inherited from ChoiceField.) |
| PageIndex |
Gets index of page which contains this field.
(Inherited from Field.) |
| Parent |
Gets annotation parent.
(Inherited from WidgetAnnotation.) |
| PartialName |
Gets or sets partial name of the field.
(Inherited from Field.) |
| ReadOnly |
Gets or sets read only status of the field.
(Inherited from WidgetAnnotation.) |
| Rect |
Gets or sets the field rectangle.
(Inherited from Field.) |
| Required |
Gets or sets required status of the field.
(Inherited from WidgetAnnotation.) |
| Selected |
Gets or sets index of the selected item. Items are numbered from 1.
(Overrides ChoiceFieldSelected.) |
| SelectedItems |
Gets or sets array of the selected items in the multiselect list. For single-select list returns array with single item.
(Overrides ChoiceFieldSelectedItems.) |
| States |
Gets appearance dictionary of annotation.
(Inherited from Annotation.) |
| SyncRoot |
Synchronization object.
(Inherited from Field.) |
| TabOrder |
Gets or sets tab order of the field.
(Inherited from Field.) |
| TextHorizontalAlignment |
Gets or sets text alignment for annotation.
(Inherited from Annotation.) |
| TopIndex |
Gets or sets index of the top visible element of the list.
|
| Value |
Gets or sets value of the field.
(Inherited from ChoiceField.) |
| VerticalAlignment |
Gets or sets a vertical alignment of paragraph
(Inherited from BaseParagraph.) |
| Width |
Gets or sets width of the annotation.
(Inherited from Annotation.) |
| ZIndex |
Gets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex
will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative
ZIndex will be placed behind the text in the page.
(Inherited from BaseParagraph.) |
Methods| Name | Description | |
|---|---|---|
| Accept |
Accepts visitor.
(Inherited from WidgetAnnotation.) |
| AddOption(String) |
Adds new option with specified name.
(Inherited from ChoiceField.) |
| AddOption(String, String) |
Adds new option with specified export value and name.
(Inherited from ChoiceField.) |
| Clone |
Clones this instance.
Virtual method. Always return null.
(Inherited from BaseParagraph.) |
| CopyTo |
Copies subfields of this field into array starting from specified index.
(Inherited from Field.) |
| DeleteOption |
Deletes option by its name.
(Inherited from ChoiceField.) |
| Equals | (Inherited from Object.) |
| Flatten |
Removes this field and place its value directly on the page.
(Inherited from Field.) |
| GetEnumerator |
Returns enumerator of contained fields.
(Inherited from Field.) |
| GetHashCode | (Inherited from Object.) |
| GetRectangle |
Returns rectangle of annotation taking into consideration page rotation.
(Inherited from Annotation.) |
| GetType | (Inherited from Object.) |
| Recalculate |
Recaculates all calculated fields on the form.
(Inherited from Field.) |
| SetPosition |
Set position of the field.
(Inherited from Field.) |
| ToString | (Inherited from Object.) |
See Also