public final class Form extends SaveableFacade
Modifier and Type | Class and Description |
---|---|
static class |
AForm.FormImportResult
Class which describes result if field import.
|
static class |
AForm.ImportStatus
Status of imported field
|
Constructor and Description |
---|
Form()
Construtcor of Form without parameters.
|
Form(IDocument document)
Initializes new
Form object on base of the document . |
Form(IDocument document,
OutputStream destStream)
Initializes new
Form object on base of the document . |
Form(IDocument document,
String destFileName)
Initializes new
Form object on base of the document . |
Form(InputStream srcStream)
Constructor for form.
|
Form(InputStream srcStream,
OutputStream destStream)
Constructor of Form with two stream parameters.
|
Form(InputStream srcStream,
String destFileName)
Constructor of Form
Form form = new Form(new FileInputStream("PdfForm.pdf", FileMode.Open, FileAccess.Read), "PdfForm_Updated.pdf");
|
Form(String srcFileName)
Constructor of Form.
|
Form(String srcFileName,
OutputStream destStream)
Constructor of Form.
|
Form(String srcFileName,
String destFileName)
Constructor of Form class.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes opened files without any changes.
|
void |
dispose()
Closes all opened resources.
|
void |
exportFdf(OutputStream outputFdfStream)
Exports the content of the fields of the pdf into the fdf stream.
|
void |
exportXfdf(OutputStream outputXfdfStream)
Exports the content of the fields of the pdf into the xml stream.
|
void |
exportXml(OutputStream outputXmlStream)
Exports the content of the fields of the pdf into the xml stream.
|
void |
extractXfaData(OutputStream outputXmlStream)
Extracts XFA data packet
|
boolean |
fillBarcodeField(String fieldName,
String data)
Fill a barcode field according to its fully qualified field name.
|
boolean |
fillField(String fieldName,
boolean beChecked)
Fills the check box field with a boolean value.
|
boolean |
fillField(String fieldName,
int index)
Fills the radio box field with a valid index value according to a fully qualified field name.
|
boolean |
fillField(String fieldName,
String fieldValue)
Fills the field with a valid value according to a fully qualified field name.
|
void |
fillField(String fieldName,
String[] fieldValues)
Fill a field with multiple selections.Note: only for AcroForm List Box Field.
|
boolean |
fillField(String fieldName,
String value,
boolean fitFontSize)
FillField
|
void |
flattenAllFields()
Flattens all the fields.
|
void |
flattenField(String fieldName)
Flattens a specified field with the fully qualified field name.
|
String |
getAttachmentName()
Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
|
String |
getButtonOptionCurrentValue(String fieldName)
Returns the current value for radio button option fields.
|
com.aspose.ms.System.Collections.Hashtable |
getButtonOptionValues(String fieldName)
Gets the radio button option fields and related values based on the field name.
|
int |
getContentDisposition()
Gets or sets how content will be stored when result of operation is stored into HttpResponse object.
|
String |
getDestFileName()
Deprecated.
|
OutputStream |
getDestStream()
Gets destination stream.
|
String |
getField(String fieldName)
Gets the field's value according to its field name.
|
FormFieldFacade |
getFieldFacade(String fieldName)
Returns FrofmFieldFacade object containing all appearance attributes.
|
int |
getFieldFlag(String fieldName)
Returns flags of the field.
|
int |
getFieldLimit(String fieldName)
Get the limitation of text field.
|
String[] |
getFieldNames()
Gets list of field names on the form.
|
int |
getFieldType(String fieldName)
Returns type of field.
|
String[] |
getFormSubmitButtonNames()
Gets all form submit button names.
|
String |
getFullFieldName(String fieldName)
Gets the full field name according to its short field name.
|
AForm.FormImportResult[] |
getImportResult()
Result of last import operation.
|
String |
getRichText(String fieldName)
Get a Rich Text field's value, including the formattinf information of every character.
|
SaveOptions |
getSaveOptions()
Gets or sets save options when result is stored as HttpResponse.
|
String |
getSrcFileName()
Deprecated.
|
InputStream |
getSrcStream()
Gets source stream.
|
int |
getSubmitFlags(String fieldName)
Returns the submit button's submission flags
Form form = new Form("PdfForm.pdf");
System.out.println( ( form.getSubmitFlags("btnSubmit") | SubmitFormFlag.Xfdf ! |
void |
importFdf(InputStream inputFdfStream)
Imports the content of the fields from the fdf file and put them into the new pdf.
|
void |
importXfdf(InputStream inputXfdfStream)
Imports the content of the fields from the xfdf(xml) file and put them into the new pdf.
|
void |
importXml(InputStream inputXmlStream)
Imports the content of the fields from the xml file and put them into the new pdf.
|
void |
importXml(InputStream inputXmlStream,
boolean IgnoreFormTemplateChanges)
Imports the content of the fields from the xml file and put them into the new pdf.
|
boolean |
isRequiredField(String fieldName)
Determines whether field is required or not.
|
void |
renameField(String fieldName,
String newFieldName)
Renames a field.
|
void |
save()
Saves the value of the filled fields and close the opened Pdf document.
|
void |
setAttachmentName(String value) |
void |
setContentDisposition(int value) |
void |
setConvertTo(int value)
Sets PDF file format.
|
void |
setDestFileName(String value)
Deprecated.
|
void |
setDestStream(OutputStream value)
Gets destination stream.
|
void |
setSaveOptions(SaveOptions value) |
void |
setSrcFileName(String value)
Deprecated.
|
void |
setSrcStream(InputStream value)
Gets source stream.
|
void |
setXfaData(InputStream inputXmlStream) |
save, save, save
bindPdf, bindPdf, bindPdf, bindPdf, bindPdf, getDocument
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDocument
public Form()
Construtcor of Form without parameters.
Form form = new com.aspose.pdf.facades.Form(); form.setSrcFileName( "file.pdf");
public Form(IDocument document)
Initializes new Form
object on base of the document
.
document
- Pdf document.public Form(IDocument document, OutputStream destStream)
Initializes new Form
object on base of the document
.
document
- Pdf document.destStream
- Destination stream.public Form(IDocument document, String destFileName)
Initializes new Form
object on base of the document
.
document
- Pdf document.destFileName
- Path of the destination file.public Form(InputStream srcStream)
Constructor for form.
Form form = new Form(new FileInputStream("PdfForm.pdf", FileMode.Open, FileAccess.Read);
srcStream
- source stream.public Form(InputStream srcStream, OutputStream destStream)
Constructor of Form with two stream parameters. Specify same source and destination stream for incremental update.
Form form = new Form(new FileInputStream( "InFile.pdf", FileMode.Open, FileAccess.Read, "OutFile.pdf", FileMode.Create, FileAccess.Write);
srcStream
- Source stream.destStream
- Destination stream.public Form(InputStream srcStream, String destFileName)
Constructor of Form
Form form = new Form(new FileInputStream("PdfForm.pdf", FileMode.Open, FileAccess.Read), "PdfForm_Updated.pdf");
srcStream
- Source stream.destFileName
- Destination file path.public Form(String srcFileName)
Constructor of Form.
Form form = new Form("PdfForm.pdf");
srcFileName
- Source file path.public Form(String srcFileName, OutputStream destStream)
Constructor of Form.
Form form = new Form("PdfForm.pdf", "PdfForm_Updated.pdf");
srcFileName
- Source file path.destStream
- Destination file path.public Form(String srcFileName, String destFileName)
Constructor of Form class. Specify same source file name and destination file name to perform incremental update.
Form form = new Form("PdfForm.pdf", "PdfForm_Updated.pdf");
srcFileName
- Path of the source file.destFileName
- Path of the destination file.public AForm.FormImportResult[] getImportResult()
Result of last import operation. Array of objects which descibre result of import for each field.
@Deprecated public String getSrcFileName()
Gets source file name.
Form form = new com.aspose.pdf.Form(); form.setSrcFileName("file.pdf");
getSrcFileName
in interface IForm
@Deprecated public void setSrcFileName(String value)
Sets source file name.
setSrcFileName
in interface IForm
public void setConvertTo(int value)
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.
setConvertTo
in interface IForm
@Deprecated public String getDestFileName()
Gets destiination file name.
getDestFileName
in interface IForm
@Deprecated public void setDestFileName(String value)
Sets destiination file name.
Form form = new com.aspose.pdf.Form(); form.setDestFileName("file.pdf");
setDestFileName
in interface IForm
public InputStream getSrcStream()
Gets source stream.
getSrcStream
in interface IForm
public void setSrcStream(InputStream value)
Gets source stream.
Form form = new com.aspose.pdf.Form(); form.setSrcStream (new FileInputStream("source.pdf"), FileMode.Open, FileAccess.Read));
setSrcStream
in interface IForm
public OutputStream getDestStream()
Gets destination stream.
getDestStream
in interface IForm
public void setDestStream(OutputStream value)
Gets destination stream.
Form form = new com.aspose.pdf.Form(); form.DestStream = new FileInputStream("file.pdf", FileMode.Open, FileAccess.Read);
setDestStream
in interface IForm
public String[] getFieldNames()
Gets list of field names on the form.
Form form = new Form("PdfForm.pdf"); String[] fields = form.getFieldNames(); for(String field : fields) { System.out.println(field); }
getFieldNames
in interface IForm
public String[] getFormSubmitButtonNames()
Gets all form submit button names.
Form form = new Form("PdfForm.pdf"); String[] submits = form.getFormSubmitButtonNames(); for(String btn : submits) { System.out.println(btn); }
getFormSubmitButtonNames
in interface IForm
public FormFieldFacade getFieldFacade(String fieldName)
Returns FrofmFieldFacade object containing all appearance attributes.
com.aspose.pdf.facades.Form form = new com.aspose.pdf.facades.Form("form.pdf")); FormFieldFacade field = form.getFieldFacade("field1"); System.out.println("Color of field border: " + field.BorderColor);
getFieldFacade
in interface IForm
fieldName
- Name of field to read.public boolean fillField(String fieldName, String fieldValue)
Fills the field with a valid value according to a fully qualified field name. Before filling the fields, every field's names and its corresponding valid values must be known. Both the fields' name and values are case sensitive. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.TextField" you should specify full name and not "TextField". You can use FieldNames property to explore existing field names and search required field by its partial name.
Form form = new Form(TestSettings.GetInputFile("PdfForm.pdf")); form.fillField("FirstName", "John"); form.fillField("LastName", "Smith");//how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); for(String fieldName : form.getFieldNames()) { if (fieldName.endsWith("TextField")) { System.out.println("Full name is: " + fieldName); } }
public boolean fillField(String fieldName, int index)
Fills the radio box field with a valid index value according to a fully qualified field name. Before filling the fields, only field's name must be known. While the value can be specified by its index. Notice: Only be applied to Radio Box, Combo Box and List Box fields. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.ListBoxField" you should specify full name and not "ListBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name.
Form form = new Form("PdfForm.pdf"); form.fillField("listboxField", 2); form.fillField("comboboxField", 2); form.fillField("radiobuttonField", 2);//how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); for(String fieldName : form.getFieldNames()) { if (fieldName.endsWith("ListBoxField")) { System.out.println("Full name is: " + fieldName); } }
public boolean fillField(String fieldName, boolean beChecked)
Fills the check box field with a boolean value. Notice: Only be applied to Check Box. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.CheckBoxField" you should specify full name and not "CheckBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name.
Form form = new Form("PdfForm.pdf"); form.fillField("checkboxField", true);//how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); for(String fieldName : form.getFieldNames()) { if (fieldName.endsWith("CheckBoxField")) { System.out.println("Full name is: " + fieldName); } }
public String getButtonOptionCurrentValue(String fieldName)
Returns the current value for radio button option fields.
Form form = new Form("PdfForm.pdf"); System.out.println(form.GetButtonOptionCurrentValue("btnField"));
getButtonOptionCurrentValue
in interface IForm
fieldName
- Field NameGetButtonOptionValues
public com.aspose.ms.System.Collections.Hashtable getButtonOptionValues(String fieldName)
Gets the radio button option fields and related values based on the field name. This method has meaning for radio button groups.
Form form = new Form("PdfForm.pdf"); Hashtable values = form.getButtonOptionValues("Color"); System.out.println(values["White"].toString()); System.out.println(values["Black"].toString());
getButtonOptionValues
in interface IForm
fieldName
- Field Namepublic String getField(String fieldName)
Gets the field's value according to its field name.
Form form = new Form("PdfForm.pdf"); System.out.println("Field value = " + form.getField("Field1"));
public String getFullFieldName(String fieldName)
Gets the full field name according to its short field name.
Form form = new Form("PdfForm.pdf"); System.out.println("Full field name is : " + form.getFullFieldName("textField"));
getFullFieldName
in interface IForm
fieldName
- The fully qualified field name.public int getFieldLimit(String fieldName)
Get the limitation of text field.
Form form = new Form("PdfForm.pdf"); System.out.println(form.getFieldLimit("textfieldBox"));
getFieldLimit
in interface IForm
fieldName
- The qualified field name.public void save()
Saves the value of the filled fields and close the opened Pdf document.
Form form = new Form("PdfForm.pdf", "PdfForm_Changed.pdf"); form.fillField("textField", "new value"); form.save();
public void close()
Closes opened files without any changes.
public void dispose()
Closes all opened resources.
public void flattenAllFields()
Flattens all the fields.
Form form = new Form("PdfForm.pdf"); form.flattenAllFields();
flattenAllFields
in interface IForm
public void flattenField(String fieldName)
Flattens a specified field with the fully qualified field name. Any other field will remain unchangable. If the fieldName is invalid, all the fields will remain unchangable.
Form form = new Form("PdfForm.pdf"); form.flattenField("textField");
flattenField
in interface IForm
fieldName
- The name of the field to be flattened.public boolean fillBarcodeField(String fieldName, String data)
Fill a barcode field according to its fully qualified field name.
Form form = new Form("PdfForm.pdf"); form.fillBarcodeField("textField", "42207252");
fillBarcodeField
in interface IForm
fieldName
- The fully qualified field name.data
- The new barcode value.public void importFdf(InputStream inputFdfStream)
Imports the content of the fields from the fdf file and put them into the new pdf.
Form form = new Form("PdfForm.pdf", "PdfForm_imported.pdf"); form.importFdf(new FileInputStream("data.fdf", FileMode.Open, FileAccess.Read)); form.save();
public void exportFdf(OutputStream outputFdfStream)
Exports the content of the fields of the pdf into the fdf stream.
Form form = new Form("PdfForm.pdf"); Stream stream = new FileInputStream("export.fdf", FileMode.Create, FileAccess.Write); form.exportFdf(stream); stream.Close();
public void importXml(InputStream inputXmlStream)
Imports the content of the fields from the xml file and put them into the new pdf.
Form form = new Form("PdfForm.pdf", "Form_Imported.pdf"); FileInputStream fs = new FileInputStream(TestSettings.GetInputFile("import.xml"), FileMode.Open, FileAccess.Read); form.importXml(fs); form.save();
public void exportXml(OutputStream outputXmlStream)
Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported.
Form form = new Form("PdfForm.pdf")); FileOutputStream fs = new FileOutputStream("export.xml"); form.exportXml(fs); fs.close();
public void extractXfaData(OutputStream outputXmlStream)
Extracts XFA data packet
outputXmlStream
- public void setXfaData(InputStream inputXmlStream)
public void importXfdf(InputStream inputXfdfStream)
Imports the content of the fields from the xfdf(xml) file and put them into the new pdf.
Form form = new Form("PdfForm.pdf", "Form_ImportXfdf.pdf"); Stream fs = new FileInputStream("export_old.xfdf", FileMode.Open, FileAccess.Read); form.importXfdf(fs); fs.close(); form.save();
importXfdf
in interface IForm
inputXfdfStream
- The input xfdf(xml) stream.public void exportXfdf(OutputStream outputXfdfStream)
Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported.
Form form = new Form("PdfForm.pdf"); FileInputStream fs = new FileInputStream("export.xfdf", FileMode.Create, FileAccess.Write); form.exportXfdf(fs); fs.close();
exportXfdf
in interface IForm
outputXfdfStream
- The output xml stream.public void fillField(String fieldName, String[] fieldValues)
Fill a field with multiple selections.Note: only for AcroForm List Box Field.
Form form = new com.aspose.pdf.Form("PdfForm.pdf", "Form_Updated.pdf"); form.fillField("ListBox1", new String[] { "Three", "One" }); form.save();
public void renameField(String fieldName, String newFieldName)
Renames a field. Either AcroForm field or XFA field is OK.
Form form = new Form("PdfForm.pdf", "PdfFormUpdated.pdf"); form.renameField("field", "field1"); form.save();
renameField
in interface IForm
fieldName
- the old field namenewFieldName
- the new field namepublic String getRichText(String fieldName)
Get a Rich Text field's value, including the formattinf information of every character.
Form form = new Form("PdfForm.pdf"); System.out.println(form.getRichText("txtDescriptionRTF"));
getRichText
in interface IForm
fieldName
- The fully qualified field name of the Rich Text field.public int getSubmitFlags(String fieldName)
Returns the submit button's submission flags
Form form = new Form("PdfForm.pdf"); System.out.println( ( form.getSubmitFlags("btnSubmit") | SubmitFormFlag.Xfdf != 0) ? " XFDF" : " "); /// System.out.println( ( form.getSubmitFlags("btnSubmit") | SubmitFormFlag.Fdf != 0) ? " FDF" : " "); System.out.println( ( form.getSubmitFlags("btnSubmit") | SubmitFormFlag.Pdf != 0) ? " PDF" : " ");
getSubmitFlags
in interface IForm
fieldName
- The qualified field name.public int getFieldType(String fieldName)
Returns type of field.
Form form = new Form("PdfForm.pdf"); if (form.GetFieldType("textField") == FieldType.Text) { System.out.println("Type of field is text"); }
getFieldType
in interface IForm
fieldName
- Field name.public boolean isRequiredField(String fieldName)
Determines whether field is required or not.
fieldName
- The name of field.public int getFieldFlag(String fieldName)
Returns flags of the field.
Form form = new Form("PdfForm.pdf"); if (form.getFieldFlag("textField") == ProptyFlag.ReadOnly) { System.out.println("Field is read-only"); }
getFieldFlag
in interface IForm
fieldName
- Field namepublic void importXml(InputStream inputXmlStream, boolean IgnoreFormTemplateChanges)
Imports the content of the fields from the xml file and put them into the new pdf.
public int getContentDisposition()
Gets or sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.
public void setContentDisposition(int value)
public SaveOptions getSaveOptions()
Gets or sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.
public void setSaveOptions(SaveOptions value)
public String getAttachmentName()
Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
public void setAttachmentName(String value)
Copyright © 2017 Aspose. All Rights Reserved.