FormSuite v6.0 - Updated
Processor Constructor(FormSet,LicenseKeychain,Boolean)




Accusoft.FormsAPI.Net Assembly > Accusoft.Forms Namespace > Processor Class > Processor Constructor : Processor Constructor(FormSet,LicenseKeychain,Boolean)
An Accusoft.FormDirectorSdk.FormSet processor object that this processor object will use for determining how to identify forms and process fields.
A LicenseKeychain object that holds the unlock codes that will be used to unlock Accusoft's form processing components, which are created by the Processor.
Indicates whether the caller is a windowless application. If true, EvaluationMode.Timeout is used.
Initializes a new instance of the Processor class.
Syntax
'Declaration
 
Public Function New( _
   ByVal formSet As FormSet, _
   ByVal licenseKeychain As LicenseKeychain, _
   ByVal windowless As Boolean _
)
'Usage
 
Dim formSet As FormSet
Dim licenseKeychain As LicenseKeychain
Dim windowless As Boolean
 
Dim instance As New Processor(formSet, licenseKeychain, windowless)
public Processor( 
   FormSet formSet,
   LicenseKeychain licenseKeychain,
   bool windowless
)
public: Processor( 
   FormSet* formSet,
   LicenseKeychain* licenseKeychain,
   bool windowless
)
public:
Processor( 
   FormSet^ formSet,
   LicenseKeychain^ licenseKeychain,
   bool windowless
)

Parameters

formSet
An Accusoft.FormDirectorSdk.FormSet processor object that this processor object will use for determining how to identify forms and process fields.
licenseKeychain
A LicenseKeychain object that holds the unlock codes that will be used to unlock Accusoft's form processing components, which are created by the Processor.
windowless
Indicates whether the caller is a windowless application. If true, EvaluationMode.Timeout is used.
Exceptions
ExceptionDescription
Thrown if the formSet or licenseKeychain parmeter is null.
Thrown if the formSet's Identification property contains Content that is not valid for the Type. For example, the Type is FormFix/Identification and the Content cannot be read by a FormFix IdentificationProcessor's ReadFromStream method.
Remarks

This constructor requires that a Accusoft.FormDirectorSdk.FormSet object be passed in. FormSet objects passed to this constructor must be fully initialized; the Processor object will not call Read on the FormSet object or any of the FormDefinition objects.

There are constructor overloads for the Processor class that do not require a FormSet object to be passed in, rather they only require the file name of a form set file to be passed in. The preferred overload is Processor Constructor(String,LicenseKeychain).

If identification has not been performed against this form set since the last time the forms or template images were modified, then processing a form against this form set will result in analysis data of the form set being generated. This data is cached in the formSet object and referenced FormDefinition objects. The flag FormSetModified will be set to true if this data is generated and cached in the formSet or FormDefinitions.

The Processor object will not attempt to save any cached analysis data back to the form set file or corresponding form definition files. It is the responsibility of the calling code to save this cached data to the form set file. Saving this data back to files on disk falls under best practices use of this product, because it prevents this information to have to be re-calculated for other instances of the Processor.

See Also

Reference

Processor Class
Processor Members
Overload List

Is this page helpful?
Yes No
Thanks for your feedback.