Field
Contents
[
Hide
]Field class
Base class for acro form fields.
The Field type exposes the following members:
Constructors
| Name | Description |
|---|---|
| Field(doc) | Initializes a new instance of the Field class |
Properties
| Name | Description |
|---|---|
| vertical_alignment | None |
| horizontal_alignment | Gets or sets text alignment for annotation. |
| margin | None |
| is_first_paragraph_in_column | None |
| is_kept_with_next | None |
| is_in_new_page | None |
| is_in_line_paragraph | None |
| hyperlink | None |
| z_index | None |
| update_appearance_on_convert | If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. |
| use_font_subset | If this property set to true, fonts will be added to document as subsets. Default value is true. |
| flags | Flags of the annotation. |
| annotation_type | Gets type of annotation. |
| width | Gets or sets width of the annotation. |
| actions | Gets the annotation actions. |
| height | Gets or sets height of the annotation. |
| rect | Gets or sets the field rectangle. |
| contents | Gets or sets annotation text. |
| name | Gets or sets annotation name on the page. |
| modified | Gets or sets date and time when annotation was recently modified. |
| color | Gets or sets annotation color. |
| border | Gets or sets annotation border characteristics. border |
| active_state | Gets or sets current annotation appearance state. |
| characteristics | Gets annotation characteristics. |
| states | Gets appearance dictionary of annotation. |
| alignment | Annotation alignment. This property is obsolete. Use HorizontalAligment instead. |
| text_horizontal_alignment | Gets or sets text alignment for annotation. |
| full_name | Gets full qualified name of the annotation. |
| appearance | Gets appearance dictionary of the annotation. |
| page_index | Gets index of page which contains this field. |
| on_activated | An action which shall be performed when the annotation is activated. |
| highlighting | Annotation highlighting mode. |
| parent | Gets annotation parent. |
| default_appearance | Gets or sets default appearance of the field. |
| read_only | Gets or sets read only status of the field. |
| required | Gets or sets required status of the field. |
| exportable | Gets or sets exportable flag of the field. |
| partial_name | Gets or sets partial name of the field. |
| alternate_name | 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. |
| mapping_name | Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document. |
| value | Gets or sets value of the field. |
| is_synchronized | Returns true if dictionary is synchronized. |
| sync_root | Synchronization object. |
| is_group | Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields. |
| annotation_index | Gets or sets index of this anotation on the page. |
| is_shared_field | 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. |
| fit_into_rectangle | If true then font size will reduced to fit text to specified rectangle. |
| max_font_size | Maximail font size which can be used for field contents. -1 to don’t check size. |
| min_font_size | Minimal font size which can be used for field contents. -1 to don’t check size. |
| tab_order | Gets or sets tab order of the field. |
Indexer
| Name | Description |
|---|---|
| [index] | Gets subfield contained in this field by index. |
Methods
| Name | Description |
|---|---|
| clone() | None |
| get_rectangle(consider_rotation) | Returns rectangle of annotation taking into consideration page rotation. |
| accept(visitor) | Accepts visitor. |
| flatten() | Removes this field and place its value directly on the page. |
| change_after_resize(transform) | Update parameters and appearance, according to the matrix transform. |
| recalculate() | Recaculates all calculated fields on the form. |
| copy_to(array, index) | Copies subfields of this field into array starting from specified index. |
| set_position(point) | Set position of the field. |
See Also
- namespace aspose.pdf.forms
- assembly Aspose.PDF