ADRGetTemplateTag Method (GdPictureImaging)

In This Topic

Gets a TAG to an existing template.

Syntax

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

'Declaration
 
Public Function ADRGetTemplateTag( _
   ByVal TemplateID As Integer _
) As String

public string ADRGetTemplateTag( 
   int TemplateID
)

public function ADRGetTemplateTag( 
    TemplateID: Integer
): String;

public function ADRGetTemplateTag( 
   TemplateID : int
) : String;

public: string* ADRGetTemplateTag( 
   int TemplateID
)

public:
String^ ADRGetTemplateTag( 
   int TemplateID
)

Parameters

TemplateID: An existing template ID.

Return Value

The template TAG value.

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