Accusoft.FormDirector3.Net - Updated
FormDefinitionFile Class
Members 




Accusoft.FormDirectorSdk Namespace : FormDefinitionFile Class
Performs file I/O for form definition files.
Object Model
FormDefinitionFile ClassFieldCollection ClassField ClassDataItemCollection ClassDataItem ClassDataItemCollection ClassDataItem ClassTemplateImageCollection ClassTemplateImage Class
Syntax
'Declaration
 
Public Class FormDefinitionFile 
   Inherits FormDefinition
'Usage
 
Dim instance As FormDefinitionFile
public class FormDefinitionFile : FormDefinition 
public __gc class FormDefinitionFile : public FormDefinition 
public ref class FormDefinitionFile : public FormDefinition 
Remarks

This class inherits all the functionality of the FormDefinition class and adds the ability to read and write form definition files. It adds a Filename property, which can contain either a relative or absolute pathname to the form definition file.

The constructor takes a FormSetFile object, which represents the form set file that contains this form.

This class supports the locking facility defined by the FormDefinition class. When you call the Lock method, this object will open the form definition file for exclusive, read/write access. If the form definition file is already open (perhaps by another user, making changes to the same form), Lock will throw an exception. When you call the Unlock method, this object will close the file.

To help avoid possible file overwrites, you must lock a form definition file before calling the Write method. If you are writing a form-editing application, you should usually lock the form definition file as soon as the user asks you to open the file. This will give you the opportunity to immediately warn a user if the form definition file is already open, instead of waiting until a user has made changes and wants to save the form. If your application operates primarily on form set files, you should lock the form set file. You may also lock the form definition files, but it is only necessary if a form definition file might be part of more than one form set file. If your form set files have hundreds or thousands of form definition files in them, it may be best not to lock them.

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.FormDefinition
      Accusoft.FormDirectorSdk.FormDefinitionFile

See Also

Reference

FormDefinitionFile Members
Accusoft.FormDirectorSdk Namespace