SubmitFormAction

Inheritance: java.lang.Object, com.aspose.pdf.PdfAction

public final class SubmitFormAction extends PdfAction

Class which describes submit-form action.

Constructors

ConstructorDescription
SubmitFormAction()Initializes SubmitFormAction object.

Fields

FieldDescription
EXCLUDEIf clear, the Fields array specifies which fields to include in the submission.
INCLUDE_NO_VALUE_FIELDSIf set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted.
EXPORT_FORMATIf set, field names and values shall be submitted in HTML Form format.
GET_METHODIf set, field names and values shall be submitted using an HTTP GET request.
SUBMIT_COORDINATESIf set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.
XFDFIf set, field names and values shall be submitted as XFDF.
INCLUDE_APPEND_SAVESIf set, the submitted FDF file shall include the contents of all incremental updates.
INCLUDE_ANNOTATIONSIf set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document.
SUBMIT_PDFIf set, the document shall be submitted as PDF, using the MIME content type application/pdf.
CANONICAL_FORMATIf set, any submitted field values representing dates shall be converted to the standard format.
EXCL_NON_USER_ANNOTSIf set, it shall include only those markup annotations whose T entry matches the name of the current user.
EXCL_F_KEYIf set, the submitted FDF shall exclude the F entry.
EMBED_FORMIf set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

Methods

MethodDescription
getFlags()Gets flagas of submit action
setFlags(int value)Sets flagas of submit action
getUrl()Destination URL.
setUrl(FileSpecification value)Destination URL.

SubmitFormAction()

public SubmitFormAction()

Initializes SubmitFormAction object.

EXCLUDE

public static final int EXCLUDE

If clear, the Fields array specifies which fields to include in the submission.

INCLUDE_NO_VALUE_FIELDS

public static final int INCLUDE_NO_VALUE_FIELDS

If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted.

EXPORT_FORMAT

public static final int EXPORT_FORMAT

If set, field names and values shall be submitted in HTML Form format.

GET_METHOD

public static final int GET_METHOD

If set, field names and values shall be submitted using an HTTP GET request.

SUBMIT_COORDINATES

public static final int SUBMIT_COORDINATES

If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.

XFDF

public static final int XFDF

If set, field names and values shall be submitted as XFDF.

INCLUDE_APPEND_SAVES

public static final int INCLUDE_APPEND_SAVES

If set, the submitted FDF file shall include the contents of all incremental updates.

INCLUDE_ANNOTATIONS

public static final int INCLUDE_ANNOTATIONS

If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document.

SUBMIT_PDF

public static final int SUBMIT_PDF

If set, the document shall be submitted as PDF, using the MIME content type application/pdf.

CANONICAL_FORMAT

public static final int CANONICAL_FORMAT

If set, any submitted field values representing dates shall be converted to the standard format.

EXCL_NON_USER_ANNOTS

public static final int EXCL_NON_USER_ANNOTS

If set, it shall include only those markup annotations whose T entry matches the name of the current user.

EXCL_F_KEY

public static final int EXCL_F_KEY

If set, the submitted FDF shall exclude the F entry.

EMBED_FORM

public static final int EMBED_FORM

If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.

getFlags()

public int getFlags()

Gets flagas of submit action

Returns: int - int value

setFlags(int value)

public void setFlags(int value)

Sets flagas of submit action

Parameters:

ParameterTypeDescription
valueintint value

getUrl()

public FileSpecification getUrl()

Destination URL.

Returns: FileSpecification - FileSpecification value

setUrl(FileSpecification value)

public void setUrl(FileSpecification value)

Destination URL.

Parameters:

ParameterTypeDescription
valueFileSpecificationFileSpecification value