com.aspose.pdf.facades

Interface IForm

  • All Superinterfaces:
    com.aspose.ms.System.IDisposable
    All Known Implementing Classes:
    Form, FormWeb


    public interface IForm
    extends com.aspose.ms.System.IDisposable

    Class representing Acro form object.

    • Method Detail

      • getSrcFileName

        String getSrcFileName()

        Gets source file name.


         
         
         Form form = new com.aspose.pdf.Form();
         form.setSrcFileName("file.pdf");
         
        Returns:
        String object
      • setSrcFileName

        void setSrcFileName(String value)

        Sets source file name.

        Parameters:
        value - String object
      • setConvertTo

        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.

        Parameters:
        value - PdfFormat element
        See Also:
        PdfFormat
      • getDestFileName

        String getDestFileName()

        Gets destiination file name.

        Returns:
        String object
      • setDestFileName

        void setDestFileName(String value)

        Sets destiination file name.


         
         
         Form form = new com.aspose.pdf.Form();
         form.setDestFileName("file.pdf");
         
        Parameters:
        value - String object
      • getSrcStream

        InputStream getSrcStream()

        Gets source stream.

        Returns:
        InputStream object
      • setSrcStream

        void setSrcStream(InputStream value)

        Gets source stream.


         
         
         Form form = new com.aspose.pdf.Form();
         form.setSrcStream(new FileInputStream("source.pdf"));
         
        Parameters:
        value - InputStream object
      • getDestStream

        OutputStream getDestStream()

        Gets destination stream.

        Returns:
        OutputStream object
      • setDestStream

        void setDestStream(OutputStream value)

        Gets destination stream.


         
         
         Form form = new com.aspose.pdf.Form();
         form.DestStream = new FileInputStream("file.pdf");
         
        Parameters:
        value - OutputStream object
      • getFieldNames

        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);
         }
         
        Returns:
        String[] object
      • getFormSubmitButtonNames

        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);
         }
         
        Returns:
        String[] object
      • getFieldFacade

        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);
         
        Parameters:
        fieldName - Name of field to read.
        Returns:
        FormFieldFacade object
      • fillField

        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("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);
             }
         }
         
        Parameters:
        fieldName - The field's name to be filled.
        fieldValue - The field's value which must be a valid value for some fields.
        Returns:
        boolean value
      • fillField

        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);
             }
         }
         
        Parameters:
        fieldName - The field's name to be filled.
        index - The selected box's index in the whole radio box group.
        Returns:
        boolean value
      • fillField

        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);
             }
         }
         
        Parameters:
        fieldName - The field's name to be filled.
        beChecked - A boolean flag: true means to check the box, while false to uncheck it..
        Returns:
        boolean value
      • getButtonOptionCurrentValue

        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"));
         
        Parameters:
        fieldName - Field Name
        Returns:
        String value for the current radio group optino. See also GetButtonOptionValues
      • getButtonOptionValuesInternal

        com.aspose.ms.System.Collections.Generic.Dictionary<String,String> getButtonOptionValuesInternal(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");
         java.util.Map values = form.getButtonOptionValues("Color");
         System.out.println(values.get("White").toString());
         System.out.println(values.get("Black").toString());
         
        Parameters:
        fieldName - Field Name
        Returns:
        Hash table of option values keyed by form item name
      • getButtonOptionValues

        Hashtable<String,String> 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");
         java.util.Map values = form.getButtonOptionValues("Color");
         System.out.println(values.get("White").toString());
         System.out.println(values.get("Black").toString());
         
        Parameters:
        fieldName - Field Name
        Returns:
        Hash table of option values keyed by form item name
      • getField

        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"));
         
        Parameters:
        fieldName - The fully qualified field name.
        Returns:
        The field's value.
      • getFullFieldName

        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"));
         
        Parameters:
        fieldName - The fully qualified field name.
        Returns:
        The full field name.
      • getFieldLimit

        int getFieldLimit(String fieldName)

        Get the limitation of text field.


         
         
         Form form = new Form("PdfForm.pdf");
         System.out.println(form.getFieldLimit("textfieldBox"));
         
        Parameters:
        fieldName - The qualified field name.
        Returns:
        Return the limitation number of characters a text field can be filled. It not set, return 0.
      • save

        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();
         
      • close

        void close()

        Closes opened files without any changes.

      • flattenAllFields

        void flattenAllFields()

        Flattens all the fields.


         
         
         Form form = new Form("PdfForm.pdf");
         form.flattenAllFields();
         
      • flattenField

        void flattenField(String fieldName)

        Flattens a specified field with the fully qualified field name. Any other field will remain Unchangeable. If the fieldName is invalid, all the fields will remain unchangeable.


         
         
         Form form = new Form("PdfForm.pdf");
         form.flattenField("textField");
         
        Parameters:
        fieldName - The name of the field to be flattened.
      • fillBarcodeField

        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");
         
        Parameters:
        fieldName - The fully qualified field name.
        data - The new barcode value.
        Returns:
        If filling succeed, return true; otherwise, false.
      • importFdf

        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"));
         form.save();
         
        Parameters:
        inputFdfStream - The input fdf stream.
      • exportFdf

        void exportFdf(OutputStream outputFdfStream)

        Exports the content of the fields of the pdf into the fdf stream.


         
         
         Form form = new Form("PdfForm.pdf");
         OutputStream stream = new FileOutputStream("export.fdf");
         form.exportFdf(stream);
         stream.close();
         
        Parameters:
        outputFdfStream - The output fdf stream.
      • importXml

        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");
         InputStream fs = new FileInputStream("import.xml");
         form.importXml(fs);
         form.save();
         
        Parameters:
        inputXmlStream - InputStream object
      • exportXml

        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"));
         OutputStream fs = new FileOutputStream("export.xml");
         form.exportXml(fs);
         fs.close();
         
        Parameters:
        outputXmlStream - OutputStream object
      • importXfdf

        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");
         InputStream fs = new FileInputStream("export_old.xfdf");
         form.importXfdf(fs);
         fs.close();
         form.save();
         
        Parameters:
        inputXfdfStream - The input xfdf(xml) stream.
      • exportXfdf

        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");
         OutputStream fs = new FileOutputStream("export.xfdf");
         form.exportXfdf(fs);
         fs.close();
         
        Parameters:
        outputXfdfStream - The output xml stream.
      • fillField

        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();
         
        Parameters:
        fieldName - The fully qualified field name.
        fieldValues - A String array which contains several items to be selected.
      • renameField

        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();
         
        Parameters:
        fieldName - the old field name
        newFieldName - the new field name
      • getRichText

        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"));
         
        Parameters:
        fieldName - The fully qualified field name of the Rich Text field.
        Returns:
        Return a String containing formatting information of the Rich Text field.
      • getSubmitFlags

        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" : " ");
         
        Parameters:
        fieldName - The qualified field name.
        Returns:
        SubmitFormFlag element
        See Also:
        SubmitFormFlag
      • getFieldType

        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");
         }
         
        Parameters:
        fieldName - Field name.
        Returns:
        Element of FileType enumeration corresponding to field type.
        See Also:
        FieldType
      • getFieldFlag

        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");
         }
         
        Parameters:
        fieldName - Field name
        Returns:
        Property flag (ReadOnly/ Required/NoExport
        See Also:
        PropertyFlag
      • fillImageField

        void fillImageField(String fieldName,
                          String imageFileName)

        Pastes an image onto the existing button field as its appearance according to its fully qualified field name.


         
         
         Form form = new Form("PdfForm.pdf", "PdfForm_filled.pdf");
         form.fillImageField("fieldName", "file.jpg");
         form.save();
         
        Parameters:
        fieldName - The fully qualified field name of the image button field.
        imageFileName - The path of the image file, relative and absolute are both ok.
      • fillImageField

        void fillImageField(String fieldName,
                          InputStream imageStream)

        Overloads function of FillImageField. The input is a image stream.


         
         
         Form form = new Form("PdfForm.pdf", "PdfForm_filled.pdf");
         form.fillImageField("fieldName", new FileInputStream("file.jpg"));
         
        Parameters:
        fieldName - The fully qualified field name.
        imageStream - The image's stream.
      • getDocument

        IDocument getDocument()

        Gets the document Form is working on.

        Returns:
        IDocument object
      • importXml

        void importXml(InputStream inputXmlStream,
                     boolean IgnoreFormTemplateChanges)

        Imports the content of the fields from the xml file and put them into the new pdf.

        Parameters:
        inputXmlStream - The input xml stream.
        IgnoreFormTemplateChanges - If this parameter is true then all changes of the XFA form template will not be saved
      • fillField

        boolean fillField(String fieldName,
                        String value,
                        boolean fitFontSize)

        FillField

        Parameters:
        fieldName - Name of field
        value - New value of the field
        fitFontSize - If true, the font size in the edit boxes will be fitted.
        Returns:
        boolean value
      • getContentDisposition

        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.

        Returns:
        ContentDisposition element
        See Also:
        ContentDisposition
      • setContentDisposition

        void setContentDisposition(int value)

        Sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.

        Parameters:
        value - ContentDisposition element
        See Also:
        ContentDisposition
      • getSaveOptions

        SaveOptions getSaveOptions()

        Gets or sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.

        Returns:
        SaveOptions object
      • setSaveOptions

        void setSaveOptions(SaveOptions value)

        Gets or sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.

        Parameters:
        value - SaveOptions object
      • getAttachmentName

        String getAttachmentName()

        Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.

        Returns:
        string object
      • setAttachmentName

        void setAttachmentName(String value)

        Sets name of attachment when result of operation is stored into HttpResponse objects as attachment.

        Parameters:
        value - String object