AddMasterForm(FormRecognitionAttributes,FormPages,string) Method

Summary

Adds a new Master Form to this category in both the storage device and MasterForms.

Syntax

C++/CLI

Java

Python

public IMasterForm AddMasterForm( 
   FormRecognitionAttributes attributes, 
   FormPages fields, 
   string fileName 
)

public abstract IMasterForm addMasterForm( 
   FormRecognitionAttributes attributes, 
   FormPages fields, 
   java.lang.String fileName 
);

IMasterForm^ AddMasterForm(  
   FormRecognitionAttributes^ attributes, 
   FormPages^ fields, 
   String^ fileName 
)

def AddMasterForm(self,attributes,fields,fileName):

attributes
Master Form attributes.

fields
Master Form fields.

fileName
A System.String containing the name of the Master Form image file.

Returns an object of the created IMasterForm.

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.

Example

A full example implementation of this interface can be found in <INSTALLDIR>\Examples\Forms\DotNet\AutoMasterFormsRepository.

Requirements

Help Version 23.0.2024.2.29