Processor Constructor(String,LicenseKeychain,Boolean,Boolean)

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function New( _
   ByVal formSetFileName As String, _
   ByVal licenseKeychain As LicenseKeychain, _
   ByVal allowSavingFormSet As Boolean, _
   ByVal windowless As Boolean _
)

'Usage
 
Dim formSetFileName As String
Dim licenseKeychain As LicenseKeychain
Dim allowSavingFormSet As Boolean
Dim windowless As Boolean
 
Dim instance As New Processor(formSetFileName, licenseKeychain, allowSavingFormSet, windowless)

public Processor( 
   string formSetFileName,
   LicenseKeychain licenseKeychain,
   bool allowSavingFormSet,
   bool windowless
)

public: Processor( 
   string* formSetFileName,
   LicenseKeychain* licenseKeychain,
   bool allowSavingFormSet,
   bool windowless
)

public:
Processor( 
   String^ formSetFileName,
   LicenseKeychain^ licenseKeychain,
   bool allowSavingFormSet,
   bool windowless
)

Parameters

formSetFileName: The path to a form set file that this processor object will load and 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.
allowSavingFormSet: Indicates whether the Processor should attempt to save cached analysis data the form set file.
windowless: Indicates whether the caller is a windowless application. If true, EvaluationMode.Timeout is used.

Exception	Description
System.ArgumentNullException	Thrown if the formSetFileName or licenseKeychain parmeter is null.
System.FormatException	Thrown if the Identification property of the FormSet, loaded from the file formSetFileName, 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.
Accusoft.FormDirectorSdk.InvalidFilenameException	Thrown if the formSetFileName does not point to a valid file.
Accusoft.FormDirectorSdk.InvalidFileFormatException	Thrown if the formSetFileName points to a file that is corrupt or cannot be loaded as a form set file.

This constructor is intended to be used when a form set file or corresponding form definition files are read-only on disk or should not be modified. The allowSavingFormSet parameter allows the caller to specify that saving the form set and form definitions is not allowed, and thus no attempt will be made to save any changes. The constructor overload Processor Constructor(String,LicenseKeychain) has the same behavior as if the allowSavingFormSet argument of this constructor is true.

This constructor loads a form set from the file specified by formSetFileName. 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 memory as long as the Processor object is around.

This cached analysis data may be saved back to the form set file if the allowSavingFormSet is true, otherwise this data will not be saved to the file and it will have to be generated next time

Reference

Processor Class
Processor Members
Overload List