ADRGetCloserTemplateForFile Method (GdPictureImaging)

In This Topic

Performs a Documents Recognition Operation from an image file and returns the Document Identifier Template ID which has the best similar content.

Syntax

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

'Declaration
 
Public Function ADRGetCloserTemplateForFile( _
   ByVal FilePath As String _
) As Integer

public int ADRGetCloserTemplateForFile( 
   string FilePath
)

public function ADRGetCloserTemplateForFile( 
    FilePath: String
): Integer;

public function ADRGetCloserTemplateForFile( 
   FilePath : String
) : int;

public: int ADRGetCloserTemplateForFile( 
   string* FilePath
)

public:
int ADRGetCloserTemplateForFile( 
   String^ FilePath
)

Parameters

FilePath: The path of the image to identify. Can be an empty string. If empty, prompts the user to select a file. You can subsequently use the GetLastPath() method to retrieve the path of the selected file.

Return Value

The Template ID which has the best similar content to the specified image.

Example

Creating two templates and renaming a file using the name of the template which has the best similar content.

using (GdPictureImaging gdpictureImaging = new GdPictureImaging())
{
    // Create a template "A".
    int templateID = gdpictureImaging.ADRCreateTemplateFromFile(@"templateA.tif");
    gdpictureImaging.ADRSetTemplateTag(templateID, "TemplateA");
 
    // Create a template "B".
    templateID = gdpictureImaging.ADRCreateTemplateFromFile(@"templateB.tif");
    gdpictureImaging.ADRSetTemplateTag(templateID, "TemplateB");
 
    // Identify the template which has the best similar content and change the file name accordingly.
    templateID = gdpictureImaging.ADRGetCloserTemplateForFile("image.tif");
    string templateName = gdpictureImaging.ADRGetTemplateTag(templateID);
    File.Move("image.tif", templateName + "_image.tif");
 
    // Deletes all document identifier templates.
    int templateCount = gdpictureImaging.ADRGetTemplateCount();
    for (int i = 1; i <= templateCount; i++)
    {
        templateID = gdpictureImaging.ADRGetTemplateID(1);
        gdpictureImaging.ADRDeleteTemplate(templateID);
    }
}

Reference

GdPictureImaging Class
GdPictureImaging Members