public interface IForm
extends com.aspose.ms.System.IDisposable
Class representing Acro form object.
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes opened files without any changes.
|
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.
|
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 |
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.
|
String |
getDestFileName()
Gets destiination file name.
|
OutputStream |
getDestStream()
Gets destination stream.
|
IDocument |
getDocument()
Gets the document
Form is working on. |
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.
|
String |
getRichText(String fieldName)
Get a Rich Text field's value, including the formattinf information of
every character.
|
String |
getSrcFileName()
Gets source file name.
|
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.
|
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 |
setConvertTo(int value)
Sets PDF file format.
|
void |
setDestFileName(String value)
Sets destiination file name.
|
void |
setDestStream(OutputStream value)
Gets destination stream.
|
void |
setSrcFileName(String value)
Sets source file name.
|
void |
setSrcStream(InputStream value)
Gets source stream.
|
String getSrcFileName()
Gets source file name.
Form form = new com.aspose.pdf.Form(); form.setSrcFileName("file.pdf");
void setSrcFileName(String value)
Sets source file name.
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.
String getDestFileName()
Gets destiination file name.
void setDestFileName(String value)
Sets destiination file name.
Form form = new com.aspose.pdf.Form(); form.setDestFileName("file.pdf");
InputStream getSrcStream()
Gets source stream.
void setSrcStream(InputStream value)
Gets source stream.
Form form = new com.aspose.pdf.Form(); form.setSrcStream (new FileInputStream("source.pdf"), FileMode.Open, FileAccess.Read));
OutputStream getDestStream()
Gets destination stream.
void setDestStream(OutputStream value)
Gets destination stream.
Form form = new com.aspose.pdf.Form(); form.DestStream = new FileInputStream("file.pdf", FileMode.Open, FileAccess.Read);
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); }
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); }
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);
fieldName
- Name of field to read.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); } }
fieldName
- The field's name to be filled.fieldValue
- The field's value which must be a valid value for some fields.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); } }
fieldName
- The field's name to be filled.index
- The selected box's index in the whole radio box group.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); } }
fieldName
- The field's name to be filled.beChecked
- A boolean flag: true means to check the box, while false to
uncheck it..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"));
fieldName
- Field NameGetButtonOptionValues
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());
fieldName
- Field NameString 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"));
fieldName
- The fully qualified field name.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"));
fieldName
- The fully qualified field name.int getFieldLimit(String fieldName)
Get the limitation of text field.
Form form = new Form("PdfForm.pdf"); System.out.println(form.getFieldLimit("textfieldBox"));
fieldName
- The qualified field name.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();
void close()
Closes opened files without any changes.
void flattenAllFields()
Flattens all the fields.
Form form = new Form("PdfForm.pdf"); form.flattenAllFields();
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");
fieldName
- The name of the field to be flattened.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");
fieldName
- The fully qualified field name.data
- The new barcode value.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();
inputFdfStream
- The input fdf stream.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();
outputFdfStream
- The output fdf stream.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();
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();
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();
inputXfdfStream
- The input xfdf(xml) stream.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();
outputXfdfStream
- The output xml stream.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();
fieldName
- The fully qualified field name.fieldValues
- A String array which contains several items to be selected.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();
fieldName
- the old field namenewFieldName
- the new field nameString 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"));
fieldName
- The fully qualified field name of the Rich Text field.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" : " ");
fieldName
- The qualified field name.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"); }
fieldName
- Field name.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"); }
fieldName
- Field nameIDocument getDocument()
Gets the document Form
is working on.
void importXml(InputStream inputXmlStream, boolean IgnoreFormTemplateChanges)
Imports the content of the fields from the xml file and put them into the new pdf.
inputXmlStream
- The input xml stream.IgnoreFormTemplateChanges
- If this parameter is true then all changes of the XFA form
template will not be savedCopyright © 2018 Aspose. All Rights Reserved.