LEADTOOLS Forms (Leadtools.Forms.Auto assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
AddMasterForm(FormRecognitionAttributes,FormPages,Stream) Method
See Also 
Leadtools.Forms.Auto Namespace > IMasterFormsCategory Interface > AddMasterForm Method : AddMasterForm(FormRecognitionAttributes,FormPages,Stream) Method



attributes
Master Form attributes.
fields
Master Form fields.
stream
A System.IO.Stream containing the name of the Master Form image data.

The AddMasterForm(FormRecognitionAttributes,FormPages,Stream) Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

attributes
Master Form attributes.
fields
Master Form fields.
stream
A System.IO.Stream containing the name of the Master Form image data.
Adds a new Master Form to this category in both the storage device and MasterForms.

Syntax

Visual Basic (Declaration) 
Overloads Function AddMasterForm( _
   ByVal attributes As FormRecognitionAttributes, _
   ByVal fields As FormPages, _
   ByVal stream As Stream _
) As IMasterForm
Visual Basic (Usage)Copy Code
Dim instance As IMasterFormsCategory
Dim attributes As FormRecognitionAttributes
Dim fields As FormPages
Dim stream As Stream
Dim value As IMasterForm
 
value = instance.AddMasterForm(attributes, fields, stream)
C++/CLI 
IMasterForm^ AddMasterForm( 
   FormRecognitionAttributes^ attributes,
   FormPages^ fields,
   Stream^ stream
) 

Parameters

attributes
Master Form attributes.
fields
Master Form fields.
stream
A System.IO.Stream containing the name of the Master Form image data.

Return Value

Returns an object of the created IMasterForm.

Example

A full example implementation of this interface can be found in <Install Directory>\Examples\DotNet\CS\AutoMasterFormsRepository.

Remarks

Master Form information contain a form's attributes, fields, and image.

Each Master Form must have an attributes, if attributes is null, it will throw an exception.

The created Master Form is added to MasterForms and should also be created on the storage device.

The repository does not need to be refreshed after this modification to the storage device since the repository is updated by this method.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms requires a Forms Module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features