SetRegionName Method (GdViewer)

In This Topic

Sets the name of a highlighted region specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

You can define the name of each highlighted region when adding regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method. You can determine the name of each highlighted region using the GetRegionName method.

Syntax

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

'Declaration
 
Public Function SetRegionName( _
   ByVal RegionID As Integer, _
   ByVal Name As String _
) As GdPictureStatus

public GdPictureStatus SetRegionName( 
   int RegionID,
   string Name
)

public function SetRegionName( 
    RegionID: Integer;
    Name: String
): GdPictureStatus;

public function SetRegionName( 
   RegionID : int,
   Name : String
) : GdPictureStatus;

public: GdPictureStatus SetRegionName( 
   int RegionID,
   string* Name
)

public:
GdPictureStatus SetRegionName( 
   int RegionID,
   String^ Name
)

Parameters

RegionID: A unique region identifier of the specified region. You can obtain this identifier using the GetRegionID method or when creating regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method.
Name: The new name of the specified region.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK. We strongly recommend always checking this status first.

Remarks

Be aware that if the required region does not exist, the method will fail.

Just to inform you, that the default region name set by the toolkit is "SearchRegion"+occurrence_number when defining regions by using SearchText(String,Int32,Boolean) methods.

Example

How to reset the name of the highlighted region.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated and your document has been properly displayed as well.
            
'To successfully follow this example, please use the code snippet attached to the AddRegion method to define highlighted regions
'or define some highlighted regions using SearchText methods by yourself.
Dim regID As Integer = 0, regCount As Integer = GdViewer1.RegionCount()
If regCount > 0 Then
    Dim message As String = "The number of regions: " + regCount.ToString()
    For j As Integer = 0 To regCount-1
        regID = GdViewer1.GetRegionID(j)
        message = message + vbCrLf + "regID: " + regID.ToString() + "  prev.name: " + GdViewer1.GetRegionName(regID) + "  current name: "
        GdViewer1.SetRegionName(regID, "Region" + regID.ToString())
        message += GdViewer1.GetRegionName(regID)
    Next
    MessageBox.Show(message, "GdViewer.SetRegionName")
Else
    MessageBox.Show("No highlighted region found related to this document. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionName")
End If

//We assume that the GdViewer1 control has been properly integrated and your document has been properly displayed as well.
            
//To successfully follow this example, please use the code snippet attached to the AddRegion method to define highlighted regions
//or define some highlighted regions using SearchText methods by yourself.
int regID = 0, regCount = GdViewer1.RegionCount();
if (regCount > 0)
{
    string message = "The number of regions: " + regCount.ToString();
    for (int j = 0; j < regCount-1; j++)
    {
        regID = GdViewer1.GetRegionID(j);
        message = message + "\nregID: " + regID.ToString() + "  prev.name: " + GdViewer1.GetRegionName(regID) + "  current name: ";
        GdViewer1.SetRegionName(regID, "Region" + regID.ToString());
        message += GdViewer1.GetRegionName(regID);
    }
    MessageBox.Show(message, "GdViewer.SetRegionName");
}
else
    MessageBox.Show("No highlighted region found related to this document. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionName");

Reference

GdViewer Class
GdViewer Members
GetRegionName Method
RegionCount Method
GetRegionID Method
SearchText(String,Int32,Boolean) Method
SearchText(String,Int32,Boolean,Boolean) Method
AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) Method