pdfsubmitaction-ag凯发旗舰厅



com.spire.pdf.actions
class pdfsubmitaction

java.lang.object
  extended by com.spire.pdf.actions.pdfaction
      extended by com.spire.pdf.actions.pdfformaction
          extended by com.spire.pdf.actions.pdfsubmitaction
all implemented interfaces:
ipdfwrapper

public class pdfsubmitaction
extends pdfformaction

represents pdf form's submit action.

see also:
this type of action allows a user to go to a resource on the internet, tipically a hypertext link.

constructor summary
pdfsubmitaction(java.lang.string url)
          initializes a new instance of the class.
 
method summary
 boolean getcanonicaldatetimeformat()
          if set, any submitted field values representing dates are converted to the standard format.
  getdataformat()
          gets or sets the submit data format.
 boolean getembedform()
          gets or sets a value indicating whether to include form to submit data stream.
 boolean getexcludenonuserannotations()
          gets or sets a value indicating whether to exclude non user annotations form submit data stream.
  gethttpmethod()
          gets or sets the http method.
 boolean getinclude()
          gets or sets a value indicating whether fields contained in fields collection will be included for submitting.
 boolean getincludeannotations()
          gets or sets a value indicating whether to submit annotations.
 boolean getincludeincrementalupdates()
          gets or sets a value indicating whether to submit form's incremental updates.
 boolean getincludenovaluefields()
          gets or sets a value indicating whether to submit fields without value.
 boolean getsubmitcoordinates()
          gets or sets a value indicating whether to submit mouse pointer coordinates.
 java.lang.string geturl()
          gets an url address where the data should be transferred.
 void setcanonicaldatetimeformat(boolean value)
           
 void setdataformat( value)
           
 void setembedform(boolean value)
           
 void setexcludenonuserannotations(boolean value)
           
 void sethttpmethod( value)
           
 void setinclude(boolean value)
          sets a value indicating whether fields contained in collection will be included for resetting or submitting.
 void setincludeannotations(boolean value)
           
 void setincludeincrementalupdates(boolean value)
           
 void setincludenovaluefields(boolean value)
           
 void setsubmitcoordinates(boolean value)
           
 
methods inherited from class com.spire.pdf.actions.pdfformaction
getfields, setfields
 
methods inherited from class com.spire.pdf.actions.pdfaction
getdictionary, getnextaction, setnextaction
 
constructor detail

pdfsubmitaction

public pdfsubmitaction(java.lang.string url)
initializes a new instance of the class.
parameters:
url - the url.
method detail

geturl

public java.lang.string geturl()
gets an url address where the data should be transferred.

gethttpmethod

public  gethttpmethod()
gets or sets the http method.

sethttpmethod

public void sethttpmethod( value)

getcanonicaldatetimeformat

public boolean getcanonicaldatetimeformat()
if set, any submitted field values representing dates are converted to the standard format. the interpretation of a form field as a date is not specified explicitly in the field itself but only in the javascript code that processes it. true if use canonical date time format when submit data; otherwise, false.

setcanonicaldatetimeformat

public void setcanonicaldatetimeformat(boolean value)

getsubmitcoordinates

public boolean getsubmitcoordinates()
gets or sets a value indicating whether to submit mouse pointer coordinates. if set, the coordinates of the mouse click that caused the submit-form action are transmitted as part of the form data.

setsubmitcoordinates

public void setsubmitcoordinates(boolean value)

getincludenovaluefields

public boolean getincludenovaluefields()
gets or sets a value indicating whether to submit fields without value. if set, all fields designated by the fields collection and the flag are submitted, regardless of whether they have a value. for fields without a value, only the field name is transmitted. true if submit fields without value or the empty ones; otherwise, false.

setincludenovaluefields

public void setincludenovaluefields(boolean value)

getincludeincrementalupdates

public boolean getincludeincrementalupdates()
gets or sets a value indicating whether to submit form's incremental updates. meaningful only when the form is being submitted in forms data format. if set, the submitted fdf file includes the contents of all incremental updates to the underlying pdf document. if clear, the incremental updates are not included. true if incremental updates should be submitted; otherwise, false.

setincludeincrementalupdates

public void setincludeincrementalupdates(boolean value)

getincludeannotations

public boolean getincludeannotations()
gets or sets a value indicating whether to submit annotations. meaningful only when the form is being submitted in forms data format. if set, the submitted fdf file includes all markup annotations in the underlying pdf document. if clear, markup annotations are not included.

setincludeannotations

public void setincludeannotations(boolean value)

getexcludenonuserannotations

public boolean getexcludenonuserannotations()
gets or sets a value indicating whether to exclude non user annotations form submit data stream. meaningful only when the form is being submitted in forms data format and the property is set to true. true if non user annotations should be excluded; otherwise, false.

setexcludenonuserannotations

public void setexcludenonuserannotations(boolean value)

getembedform

public boolean getembedform()
gets or sets a value indicating whether to include form to submit data stream. meaningful only when the form is being submitted in forms data format. if set, the property is a file name containing an embedded file stream representing the pdf file from which the fdf is being submitted.

setembedform

public void setembedform(boolean value)

getdataformat

public  getdataformat()
gets or sets the submit data format.

setdataformat

public void setdataformat( value)

getinclude

public boolean getinclude()
gets or sets a value indicating whether fields contained in fields collection will be included for submitting.
overrides:
getinclude in class pdfformaction

setinclude

public void setinclude(boolean value)
description copied from class: pdfformaction
sets a value indicating whether fields contained in collection will be included for resetting or submitting. if include property is true, only the fields in this collection will be reset or submitted. if include property is false, the fields in this collection are not reset or submitted and only the remaining form fields are reset or submitted. if the collection is null or empty, then all the form fields are reset and the include property is ignored.
overrides:
setinclude in class pdfformaction


网站地图