Aspose::Pdf::Facades::FormEditor class
Contents
[
Hide
]FormEditor class
Class for editing forms (ading/deleting field etc)
class FormEditor : public Aspose::Pdf::Facades::SaveableFacade
Methods
| Method | Description |
|---|---|
| AddField(FieldType, const System::String&, int32_t, float, float, float, float) | Add field of specified type to the form. |
| AddField(FieldType, const System::String&, const System::String&, int32_t, float, float, float, float) | Add field of specified type to the form. |
| AddFieldScript(const System::String&, const System::String&) | Add JavaScript for a PushButton field. If old event exists, new event is added after it. |
| AddListItem(const System::String&, const System::String&) | Adds new item to the list box. |
| AddListItem(const System::String&, const System::ArrayPtr<System::String>&) | Add a new item with Export value to the existing list box field, only for AcroForm combo box field. |
| AddSubmitBtn(const System::String&, int32_t, const System::String&, const System::String&, float, float, float, float) | Add submit button on the form. |
| Close() override | Closes the facade. |
| CopyInnerField(const System::String&, const System::String&, int32_t) | 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(const System::String&, const System::String&, int32_t, float, float) | 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(const System::String&, const System::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(const System::String&, const System::String&, int32_t) | 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(const System::String&, const System::String&, int32_t, float, float) | 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(const System::String&) | Changes visual attributes of the specified field. |
| DecorateField(FieldType) | Changes visual attributes of all fields with the specified field type. |
| DecorateField() | Changes visual attributes of all fields in the PDF document. |
| DelListItem(const System::String&, const System::String&) | Delete item from the list field. |
| FormEditor(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<System::IO::Stream>&) | Constructor for FormEditor. |
| FormEditor(const System::String&, const System::String&) | Constructor for FormEditor. |
| FormEditor() | Constructor for FormEditor. |
| FormEditor(const System::SharedPtr<Aspose::Pdf::Document>&) | Initializes new FormEditor object on base of the document . |
| FormEditor(const System::SharedPtr<Aspose::Pdf::Document>&, const System::String&) | Initializes new FormEditor object on base of the document . |
| FormEditor(const System::SharedPtr<Aspose::Pdf::Document>&, const System::SharedPtr<System::IO::Stream>&) | Initializes new FormEditor object on base of the document . |
| FormEditor(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<System::Web::HttpResponse>&) | Creates FormEditor which will save result into HttpResponse object. |
| FormEditor(const System::String&, const System::SharedPtr<System::Web::HttpResponse>&) | Creates FormEditor which will save result into HttpResponse object. |
| get_AttachmentName() const | Gets name of attachment when result of operation is stored into HttpResponse objects as attachment. |
| get_ContentDisposition() const | Gets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline. |
| get_DestFileName() const | Gets destination file name. |
| get_DestStream() const | Gets destination stream. |
| get_ExportItems() const | Sets options for combo box with export values. |
| get_Facade() const | Sets visual attributes of the field. |
| get_Items() const | Sets items which will be added t onewly created list box or combo box. |
| get_RadioButtonItemSize() const | Gets size of radio button item size (when new radio button field is added). ** 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(); ** |
| get_RadioGap() | The member to record the gap between two neighboring radio buttons in pixels,default is 50. |
| get_RadioHoriz() const | The flag to indicate whether the radios are arranged horizontally or vertically, default value is true. |
| get_Response() const | Gets Response object where result of operation will be stored. |
| get_SaveOptions() const | Gets save options when result is stored as HttpResponse. Default value: PdfSaveOptions. |
| get_SrcFileName() const | Gets name of source file. |
| get_SrcStream() const | Gets source stream. |
| get_SubmitFlag() const | Set the submit button’s submission flags. |
| GetFieldAppearance(const System::String&) | Get field flags. |
| MoveField(const System::String&, float, float, float, float) | Set new position of field. |
| RemoveField(const System::String&) | Remove field from the form. |
| RemoveFieldAction(const System::String&) | Remove submit action of the field. |
| RenameField(const System::String&, const System::String&) | 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() | Saves changes into destination file. |
| set_AttachmentName(const System::String&) | Sets name of attachment when result of operation is stored into HttpResponse objects as attachment. |
| set_ContentDisposition(Aspose::Pdf::ContentDisposition) | Sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline. |
| set_ConvertTo(PdfFormat) | 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. |
| set_DestFileName(const System::String&) | Sets destination file name. |
| set_DestStream(const System::SharedPtr<System::IO::Stream>&) | Sets destination stream. |
| set_ExportItems(const System::ArrayPtr<System::ArrayPtr<System::String>>&) | Sets options for combo box with export values. |
| set_Facade(const System::SharedPtr<FormFieldFacade>&) | Sets visual attributes of the field. |
| set_Items(const System::ArrayPtr<System::String>&) | Sets items which will be added t onewly created list box or combo box. |
| set_RadioButtonItemSize(double) | Sets size of radio button item size (when new radio button field is added). ** 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(); ** |
| set_RadioGap(float) | The member to record the gap between two neighboring radio buttons in pixels,default is 50. |
| set_RadioHoriz(bool) | The flag to indicate whether the radios are arranged horizontally or vertically, default value is true. |
| set_Response(const System::SharedPtr<System::Web::HttpResponse>&) | Sets Response object where result of operation will be stored. |
| set_SaveOptions(const System::SharedPtr<Aspose::Pdf::SaveOptions>&) | Sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions. |
| set_SrcFileName(const System::String&) | Sets name of source file. |
| set_SrcStream(const System::SharedPtr<System::IO::Stream>&) | Sets source stream. |
| set_SubmitFlag(SubmitFormFlag) | Set the submit button’s submission flags. |
| SetFieldAlignment(const System::String&, int32_t) | Set the alignment style of a text field. |
| SetFieldAlignmentV(const System::String&, int32_t) | Set the vertical alignment style of a text field. |
| SetFieldAppearance(const System::String&, Annotations::AnnotationFlags) | Set field flags. |
| SetFieldAttribute(const System::String&, PropertyFlag) | Set attributes of field. |
| SetFieldCombNumber(const System::String&, int32_t) | 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(const System::String&, int32_t) | Sets maximum character count of the text field. |
| SetFieldScript(const System::String&, const System::String&) | Set JavaScript for a PushButton field. If old JavaScript existed, it will be replaced by the new one. |
| SetSubmitFlag(const System::String&, SubmitFormFlag) | Set submit flag of submit button. |
| SetSubmitUrl(const System::String&, const System::String&) | Sets URL of the button. |
| Single2Multiple(const System::String&) | Change a single-lined text field to a multiple-lined one. |
See Also
- Class SaveableFacade
- Namespace Aspose::Pdf::Facades
- Library Aspose.PDF for C++
