| FormEditor Class |
Class for editing forms (ading/deleting field etc)
Inheritance HierarchyNamespace: Aspose.Pdf.Facades
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.3
SyntaxThe FormEditor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | FormEditor |
Constructor for FormEditor.
|
| FormEditor(Document) |
Initializes new FormEditor object on base of the document.
|
| FormEditor(Stream, Stream) | Obsolete.
Constructor for FormEditor.
|
| FormEditor(Stream, HttpResponse) | Obsolete.
Creates FormEditor which will save result into HttpResponse object.
|
| FormEditor(String, String) | Obsolete.
Constructor for FormEditor
|
| FormEditor(String, HttpResponse) | Obsolete.
Creates FormEditor which will save result into HttpResponse object.
|
| FormEditor(Document, Stream) | Obsolete.
Initializes new FormEditor object on base of the document.
|
| FormEditor(Document, String) | Obsolete.
Initializes new FormEditor object on base of the document.
|
Properties| Name | Description | |
|---|---|---|
 | AttachmentName |
Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
|
| ContentDisposition |
Gets or sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment.
Default: inline.
|
| ConvertTo |
Sets PDF file format. Result file will be saved in specified file format.
If this property is not specified then file will be save in default PDF format without conversion.
|
| DestFileName | Obsolete.
Gets or sets destination file name.
|
| DestStream | Obsolete.
Gets or sets destination stream.
|
| Document |
Gets the document facade is working on.
(Inherited from Facade.) |
| ExportItems | Sets options for combo box with export values. |
| Facade |
Sets visual attributes of the field.
|
| Items |
Sets items which will be added t onewly created list box or combo box.
ExamplesC# formEditor = new Aspose.Pdf.Facades.FormEditor("input.pdf", "output.pdf"); formEditor.Items = new string[] { "AAA", "BBB", "CCC" }; formEditor.AddField(FieldType.ListBox, "AddedListBoxField", "BBB", 1, 10, 30, 110, 130); formEditor.Save(); |
| RadioButtonItemSize |
Gets or sets size of radio button item size (when new radio button field is added).
C# formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_RadioButton.pdf"); formEditor.RadioGap = 4; formEditor.RadioHoriz = false; formEditor.RadioButtonItemSize = 20; formEditor.Items = new string[] { "First", "Second", "Third" }; formEditor.AddField(FieldType.Radio, "AddedRadioButtonField", "Second", 1, 10, 30, 110, 130); formEditor.Save(); |
| RadioGap |
The member to record the gap between two neighboring radio buttons in pixels,default is 50.
|
| RadioHoriz |
The flag to indicate whether the radios are arranged horizontally or vertically, default value is true.
|
| Response |
Gets or sets Response object where result of operation will be stored.
|
| SaveOptions |
Gets or sets save options when result is stored as HttpResponse.
Default value: PdfSaveOptions.
|
| SrcFileName | Obsolete.
Gets or sets name of source file.
|
| SrcStream | Obsolete.
Gets or sets source stream.
|
| SubmitFlag |
Set the submit button's submission flags
|
Methods| Name | Description | |
|---|---|---|
| AddField(FieldType, String, Int32, Single, Single, Single, Single) |
Add field of specified type to the form.
|
| AddField(FieldType, String, String, Int32, Single, Single, Single, Single) |
Add field of specified type to the form.
|
| AddFieldScript |
Add JavaScript for a PushButton field. If old event exists, new event is added after it.
|
| AddListItem(String, String) |
Adds new item to the list box.
|
| AddListItem(String, String) |
Add a new item with Export value to the existing list box field, only for AcroForm combo box field.
|
| AddSubmitBtn |
Add submit button on the form.
|
| BindPdf(Stream) |
Initializes the facade.
(Inherited from Facade.) |
| BindPdf(String) |
Initializes the facade.
(Inherited from Facade.) |
| BindPdf(Document) |
Initializes the facade.
(Inherited from Facade.) |
| Close |
Closes the facade.
(Overrides FacadeClose.) |
| CopyInnerField(String, String, Int32) |
Copies an existing field to the same position in specified page number.
A new document will be produced, which contains everything the source document has except for the newly copied field.
|
| CopyInnerField(String, String, Int32, Single, Single) |
Copies an existing field to a new position specified by both page number and ordinates.
A new document will be produced, which contains everything the source document has except for the newly copied field.
|
| CopyOuterField(String, String) |
Copies an existing field from one PDF document to another document with original page number and ordinates.
Notice: Only for AcroForm fields (excluding radio box).
|
| CopyOuterField(String, String, Int32) |
Copies an existing field from one PDF document to another document with specified page number and original ordinates.
Notice: Only for AcroForm fields (excluding radio box).
|
| CopyOuterField(String, String, Int32, Single, Single) |
Copies an existing field from one PDF document to another document with specified page number and ordinates.
Notice: Only for AcroForm fields (excluding radio box).
|
| DecorateField |
Changes visual attributes of all fields in the PDF document.
|
| DecorateField(String) |
Changes visual attributes of the specified field.
|
| DecorateField(FieldType) |
Changes visual attributes of all fields with the specified field type.
|
| DelListItem |
Delete item from the list field.
|
| Dispose |
Disposes the facade.
(Inherited from Facade.) |
| Equals | (Inherited from Object.) |
| GetFieldAppearance |
Get field flags.
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MoveField |
Set new position of field.
|
| RemoveField |
Remove field from the form.
|
| RemoveFieldAction |
Remove submit action of the field.
|
| RenameField |
Change name of the field.
|
| ResetFacade |
Reset all visual attribtues to empty value.
|
| ResetInnerFacade |
Reset all visual attribtues of inner facade to empty value.
|
| Save | Obsolete.
Saves changes into destination file.
|
| Save(Stream) |
Saves the PDF document to the specified stream.
(Inherited from SaveableFacade.) |
| Save(String) |
Saves the PDF document to the specified file.
(Inherited from SaveableFacade.) |
| SetFieldAlignment |
Set the alignment style of a text field.
|
| SetFieldAlignmentV |
Set the vertical alignment style of a text field.
|
| SetFieldAppearance |
Set field flags
|
| SetFieldAttribute |
Set attributes of field.
|
| SetFieldCombNumber |
Sets number of combs for a regular single-line text field (the field is
automatically divided into as many equally spaced positions, or combs,
as the value of combNumber parameter).
|
| SetFieldLimit |
Sets maximum character count of the text field.
|
| SetFieldScript |
Set JavaScript for a PushButton field. If old JavaScript existed, it will be replaced by the new one.
|
| SetSubmitFlag |
Set submit flag of submit button.
|
| SetSubmitUrl |
Sets URL of the button.
|
| Single2Multiple |
Change a single-lined text field to a multiple-lined one.
|
| ToString | (Inherited from Object.) |
See Also