Aspose::Pdf::Forms::Field class
Contents
[
Hide
]Field class
Base class for acro form fields.
class Field : public Aspose::Pdf::Annotations::WidgetAnnotation,
public System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>
Methods
| Method | Description |
|---|---|
| CopyTo(System::ArrayPtr<System::SharedPtr<Field>>, int32_t) | Copies subfields of this field into array starting from specified index. |
| CopyToWidgetArray(System::ArrayPtr<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>, int32_t) | Copies subfields of this field into array starting from specified index. |
| ExecuteFieldJavaScript(System::SharedPtr<Aspose::Pdf::Annotations::JavascriptAction>) | Executes a specified JavaScript action for the field. |
| Field(System::SharedPtr<Document>) | Creates field for use in Generator. |
| Flatten() override | Removes this field and place its value directly on the page. |
| get_AlternateName() | Gets 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. |
| get_AnnotationIndex() | Gets index of this anotation on the page. |
| get_Count() const override | Gets number of subfields in this field. (For example number of items in radio button field). |
| static get_FitIntoRectangle() | If true then font size will reduced to fit text to specified rectangle. |
| get_IsGroup() const | Gets boolean value which indicates is this field non-terminal field i.e. group of fields. |
| get_IsSharedField() const | 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. |
| get_IsSynchronized() | Returns true if dictionary is synchronized. |
| get_MappingName() | Gets mapping name of the field that shall be used when exporting interactive form field data from the document. |
| static get_MaxFontSize() | Maximail font size which can be used for field contents. -1 to don’t check size. |
| static get_MinFontSize() | Minimal font size which can be used for field contents. -1 to don’t check size. |
| get_PageIndex() override | Gets index of page which contains this field. |
| get_PartialName() | Gets partial name of the field. |
| get_Rect() override | Gets the field rectangle. |
| get_SyncRoot() const | Synchronization object. |
| get_TabOrder() | Gets tab order of the field. |
| virtual get_Value() | Gets value of the field. |
| GetEnumerator() override | Returns enumerator of contained fields. |
| idx_get(System::String) | Gets subfield contained in this field by name of the subfield. |
| idx_get(int32_t) | Gets subfield contained in this field by index. |
| Recalculate() | Recaculates all calculated fields on the form. |
| set_AlternateName(System::String) | 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. |
| set_AnnotationIndex(int32_t) | Sets index of this anotation on the page. |
| static set_FitIntoRectangle(bool) | If true then font size will reduced to fit text to specified rectangle. |
| set_IsSharedField(bool) | 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. |
| set_MappingName(System::String) | Sets mapping name of the field that shall be used when exporting interactive form field data from the document. |
| static set_MaxFontSize(double) | Maximail font size which can be used for field contents. -1 to don’t check size. |
| static set_MinFontSize(double) | Minimal font size which can be used for field contents. -1 to don’t check size. |
| set_PartialName(System::String) | Sets partial name of the field. |
| set_Rect(System::SharedPtr<Rectangle>) override | Sets the field rectangle. |
| set_TabOrder(int32_t) | Sets tab order of the field. |
| virtual set_Value(System::String) | Sets value of the field. |
| virtual SetPosition(System::SharedPtr<Point>) | Set position of the field. |
| SetTemplateWeakPtr(uint32_t) override | Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. |
See Also
- Class WidgetAnnotation
- Class ICollection
- Namespace Aspose::Pdf::Forms
- Library Aspose.PDF for C++