Field Class
Base class for acro form fields.
Inheritance Hierarchy

Namespace: Aspose.Pdf.Forms
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.7
Syntax
public class Field : WidgetAnnotation, ICollection<WidgetAnnotation>, 
	IEnumerable<WidgetAnnotation>, IEnumerable

The Field type exposes the following members.

Constructors
  NameDescription
Public methodField
Creates field for use in Generator.
Properties
  NameDescription
Public propertyActions
Gets the annotation actions.
(Inherited from WidgetAnnotation.)
Public propertyActiveState
Gets or sets current annotation appearance state.
(Inherited from Annotation.)
Public propertyAlignment Obsolete.
Annotation alignment. This property is obsolete. Use HorizontalAligment instead.
(Inherited from Annotation.)
Public propertyAlternateName
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.
Public propertyAnnotationIndex
Gets or sets index of this anotation on the page.
Public propertyAnnotationType
Gets type of annotation.
(Inherited from WidgetAnnotation.)
Public propertyAppearance
Gets appearance dictionary of the annotation.
(Inherited from Annotation.)
Public propertyBorder
Gets or sets annotation border characteristics. Border
(Inherited from Annotation.)
Public propertyCharacteristics
Gets annotation characteristics.
(Inherited from Annotation.)
Public propertyColor
Gets or sets annotation color.
(Inherited from Annotation.)
Public propertyContents
Gets or sets annotation text.
(Inherited from Annotation.)
Public propertyCount
Gets or sets number of subfields in this field. (For example number of items in radio button field).
Public propertyDefaultAppearance
Gets or sets default appearance of the field.
(Inherited from WidgetAnnotation.)
Public propertyExportable
Gets or sets exportable flag of the field.
(Inherited from WidgetAnnotation.)
Public propertyStatic memberFitIntoRectangle
If true then font size will reduced to fit text to specified rectangle.
Public propertyFlags
Flags of the annotation.
(Inherited from Annotation.)
Public propertyFullName
Gets full qualified name of the annotation.
(Inherited from Annotation.)
Public propertyHeight
Gets or sets height of the annotation.
(Inherited from Annotation.)
Public propertyHighlighting
Annotation highlighting mode.
(Inherited from WidgetAnnotation.)
Public propertyHorizontalAlignment Obsolete.
Gets or sets text alignment for annotation.
(Inherited from Annotation.)
Public propertyHyperlink
Gets or sets the fragment hyperlink(for pdf generator).
(Inherited from BaseParagraph.)
Protected propertyInnerRect
Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation
(Inherited from Annotation.)
Public propertyIsFirstParagraphInColumn
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.)
Public propertyIsGroup
Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields.
Public propertyIsInLineParagraph
Gets or sets a paragraph is inline. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsInNewPage
Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsKeptWithNext
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.)
Public propertyIsSharedField
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.
Public propertyIsSynchronized
Returns true if dictionary is synchronized.
Public propertyItemInt32
Gets subfield contained in this field by index.
Public propertyItemString
Gets subfield contained in this field by name of the subfield.
Public propertyMappingName
Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document.
Public propertyMargin
Gets or sets a outer margin for paragraph (for pdf generation)
(Inherited from BaseParagraph.)
Public propertyStatic memberMaxFontSize
Maximail font size which can be used for field contents. -1 to don't check size.
Public propertyModified
Gets or sets date and time when annotation was recently modified.
(Inherited from Annotation.)
Public propertyName
Gets or sets annotation name on the page.
(Inherited from Annotation.)
Protected propertyNormalAppearance
Gets normal appearance.
(Inherited from Annotation.)
Public propertyOnActivated
An action which shall be performed when the annotation is activated.
(Inherited from WidgetAnnotation.)
Public propertyPageIndex
Gets index of page which contains this field.
(Overrides AnnotationPageIndex.)
Public propertyParent
Gets annotation parent.
(Inherited from WidgetAnnotation.)
Public propertyPartialName
Gets or sets partial name of the field.
Public propertyReadOnly
Gets or sets read only status of the field.
(Inherited from WidgetAnnotation.)
Public propertyRect
Gets or sets the field rectangle.
(Overrides AnnotationRect.)
Public propertyRequired
Gets or sets required status of the field.
(Inherited from WidgetAnnotation.)
Protected propertyRotatedRect
Gets rotated rectangle.
(Inherited from Annotation.)
Public propertyStates
Gets appearance dictionary of annotation.
(Inherited from Annotation.)
Public propertySyncRoot
Synchronization object.
Public propertyTabOrder
Gets or sets tab order of the field.
Public propertyTextHorizontalAlignment
Gets or sets text alignment for annotation.
(Inherited from Annotation.)
Public propertyValue
Gets or sets value of the field.
Public propertyVerticalAlignment
Gets or sets a vertical alignment of paragraph
(Inherited from BaseParagraph.)
Public propertyWidth
Gets or sets width of the annotation.
(Inherited from Annotation.)
Public propertyZIndex
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
  NameDescription
Public methodAccept
Accepts visitor.
(Inherited from WidgetAnnotation.)
Public methodClone
Clones this instance. Virtual method. Always return null.
(Inherited from BaseParagraph.)
Public methodCopyTo
Copies subfields of this field into array starting from specified index.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFlatten
Removes this field and place its value directly on the page.
(Overrides AnnotationFlatten.)
Protected methodGetConformXFAValue
Returns value correctly encoded for placing into XFA dataset.
Public methodGetEnumerator
Returns enumerator of contained fields.
Public methodGetHashCode (Inherited from Object.)
Public methodGetRectangle
Returns rectangle of annotation taking into consideration page rotation.
(Inherited from Annotation.)
Public methodGetType (Inherited from Object.)
Protected methodInitialize(Document, Rectangle)
Create annotation data structure.
(Inherited from Annotation.)
Protected methodInitialize(Page, Rectangle)
Initialize the annotation.
(Inherited from Annotation.)
Protected methodIsEqualTo
Operator for comparision field value with given value.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodReadXfdfAttributes
When overridden in a derived class, import annotation attributes from XFDF.
(Inherited from Annotation.)
Protected methodReadXfdfElements (Inherited from Annotation.)
Public methodRecalculate
Recaculates all calculated fields on the form.
Public methodSetPosition
Set position of the field.
Protected methodToImage (Inherited from Annotation.)
Public methodToString (Inherited from Object.)
Protected methodWriteXfdfAttributes
When overridden in a derived class, exports annotation attributes into XFDF.
(Inherited from Annotation.)
Protected methodWriteXfdfElements
When overridden in a derived class, exports annotation elements into XFDF.
(Inherited from Annotation.)
See Also
Inheritance Hierarchy