- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
ActionSubmitForm
DsPdfJS API / ActionSubmitForm
Class: ActionSubmitForm
Represents an action that causes a script to be compiled and executed by the JavaScript interpreter.
Extends
Constructors
Constructor
new ActionSubmitForm(
om,uri?):ActionSubmitForm
Creates a new ActionSubmitForm.
Parameters
om
ObjectManager that controls the lifetime of the ActionSubmitForm.
uri?
string
The URL of the script at the Web server that will process the submission.
Returns
ActionSubmitForm
Overrides
ActionFieldsBase.constructor
Constructor
new ActionSubmitForm(
uri?):ActionSubmitForm
Creates a new ActionSubmitForm.
Parameters
uri?
string
The URL of the script at the Web server that will process the submission.
Returns
ActionSubmitForm
Overrides
ActionFieldsBase.constructor
Accessors
canonicalDateFormat
Get Signature
get canonicalDateFormat():
boolean
Gets or sets a value indicating whether any submitted field values representing dates are converted to the standard format described in PDF specification.
Returns
boolean
Set Signature
set canonicalDateFormat(
value):void
Gets or sets a value indicating whether any submitted field values representing dates are converted to the standard format described in PDF specification.
Parameters
value
boolean
Returns
void
excludeSpecifiedFields
Get Signature
get excludeSpecifiedFields():
boolean
Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.
Returns
boolean
Set Signature
set excludeSpecifiedFields(
value):void
Gets or sets a value indicating whether the fields specified by the 'fields' list should be excluded for processing. By default this property is "false", which means that the fields in the list are processed. If this property is set to "true", the fields in the list are excluded from processing.
Parameters
value
boolean
Returns
void
Inherited from
ActionFieldsBase.excludeSpecifiedFields
fdfFormat
Get Signature
get fdfFormat():
FDFFormatFlags
Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.
Returns
Set Signature
set fdfFormat(
value):void
Gets or sets additional flags used if submitFormat is SubmitFormatType#FDF.
Parameters
value
Returns
void
fields
Get Signature
get fields(): (
string|Field)[] |null
Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.
See
Returns
(string | Field)[] | null
Set Signature
set fields(
value):void
Gets the list of fields that should be processed or excluded from processing (depending on the value of 'excludeSpecifiedFields') by this action. An item in this list can be either a field's name specified as a "string", or the Field object itself. An empty list means that all fields are included.
See
Parameters
value
(string | Field)[] | null
Returns
void
Inherited from
htmlFormFormat
Get Signature
get htmlFormFormat():
HtmlFormFormatFlags
Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.
Returns
Set Signature
set htmlFormFormat(
value):void
Gets or sets additional flags used if submitFormat is SubmitFormatType#HtmlForm.
Parameters
value
Returns
void
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
includeFieldsWithNoValue
Get Signature
get includeFieldsWithNoValue():
boolean
Gets or sets a value indicating whether the fields without a value should be included in request.
Returns
boolean
Set Signature
set includeFieldsWithNoValue(
value):void
Gets or sets a value indicating whether the fields without a value should be included in request.
Parameters
value
boolean
Returns
void
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
pdfFormat
Get Signature
get pdfFormat():
GetMethod
Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.
Returns
Set Signature
set pdfFormat(
value):void
Gets or sets additional flags used if submitFormat is SubmitFormatType#PDF.
Parameters
value
Returns
void
submitFormat
Get Signature
get submitFormat():
SubmitFormatType
Gets or sets the format which should be used in request.
Returns
Set Signature
set submitFormat(
value):void
Gets or sets the format which should be used in request.
Parameters
value
Returns
void
uri
Get Signature
get uri():
FileSpecification|null
Gets or sets the value defining URL of the script at the Web server that will process the submission.
See
Returns
FileSpecification | null
Set Signature
set uri(
value):void
Gets or sets the value defining URL of the script at the Web server that will process the submission.
See
Parameters
value
string | FileSpecificationProperties | FileSpecification | null
Returns
void
Methods
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void