Accusoft.FormDirector3.Net - Updated
FormSet Class
Members 




Accusoft.FormDirectorSdk Namespace : FormSet Class
An abstract class that represents a set of forms, various processing parameters, and related data.
Object Model
FormSet ClassFormDefinitionCollection ClassFormDefinition ClassDataItem ClassDataItemCollection ClassDataItem ClassDataItemCollection ClassDataItem Class
Syntax
'Declaration
 
Public MustInherit Class FormSet 
'Usage
 
Dim instance As FormSet
public abstract class FormSet 
public __gc abstract class FormSet 
public ref class FormSet abstract 
Remarks

The primary purpose of a FormSet object is to support form identification. As a result, the core part of a FormSet object is the FormDefinitions property, which contains a collection of FormDefinition objects. If you do not need to perform form identification, you probably do not need to use a FormSet object and can rely instead on one or more FormDefinition objects.

A secondary purpose is to hold data that is stored persistently in a form set file. That includes a name of the form set, parameters for form identification, parameters for other image operations, and some miscellaneous data. For more information about the content of a form set file, see link to the overview section for form set files.

The FormSet class is an abstract class which defers the details of reading and writing form set files to a derived class, FormSetFile. You can create your own derived classes to manage reading and writing to other locations, such as a web server or database.

This class also has a few features intended for your convenience when developing a form setup or form processing application. The Tag property provides a place to store one object or value. Typically, you would store a reference to a user interface element, such as a TreeNode, or your own object with additional form data in this property.

The HasChanged property indicates whether any persistent part of a FormSet has changed since the last time you read it from or wrote it to a form set file. This is a very easy way to determine if you need to prompt a user to save any changes. Whenever you change a property that would affect a form set file, or its related form definition files, HasChanged will automatically change to true. This includes changes to contained FormDefinition and Field objects. If you change a property that does not affect a form set or form definition file (such as the Tag property), HasChanged will not change. Whenever you write a Form to a form definition file, or read a Form from a form set file, the HasChanged property will change to false.

The GetPartialHashCode method returns a hash code of much of the data that goes into a form set file. Specifically, everything that could affect form identification is part of the hash code.

Note: This class implements the IDisposable interface and you should always call the Dispose method when you have finished using it.

Inheritance Hierarchy

System.Object
   Accusoft.FormDirectorSdk.FormSet
      Accusoft.FormDirectorSdk.FormSetFile

See Also

Reference

FormSet Members
Accusoft.FormDirectorSdk Namespace
FormSetFile Class