SetRegionBorderColor(Int32,Int32) Method

In This Topic

Sets the border color 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 determine the border color of each highlighted region using the GetRegionBorderColor method.

Syntax

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

'Declaration
 
Public Overloads Function SetRegionBorderColor( _
   ByVal RegionID As Integer, _
   ByVal BorderColor As Integer _
) As GdPictureStatus

public GdPictureStatus SetRegionBorderColor( 
   int RegionID,
   int BorderColor
)

public function SetRegionBorderColor( 
    RegionID: Integer;
    BorderColor: Integer
): GdPictureStatus;

public function SetRegionBorderColor( 
   RegionID : int,
   BorderColor : int
) : GdPictureStatus;

public: GdPictureStatus SetRegionBorderColor( 
   int RegionID,
   int BorderColor
)

public:
GdPictureStatus SetRegionBorderColor( 
   int RegionID,
   int BorderColor
)

Parameters

RegionID: A unique region identifier of the specified region. You can obtain this identifier using the GetRegionID method or when creating regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Int32) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Int32) methods.
BorderColor: A color value that defines the new border color of the specified region. You can obtain a suitable color using the ARGBI method.

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 border color set by the toolkit is black.

Example

How to set the border color for all defined highlighted regions.

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 AddRegion or AddRegionInches methods
'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
    For j As Integer = 1 To regCount
        regID = GdViewer1.GetRegionID(j)
        GdViewer1.SetRegionBorderWidth(regID, 4)
        GdViewer1.SetRegionBorderColor(regID, GdViewer1.ARGBI(255, 0, 191, 255))
    Next
    'Redrawing regions with the newly defined color.
    GdViewer1.Redraw()
Else
    MessageBox.Show("No highlighted region found related to this document. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionBorderColor")
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 AddRegion or AddRegionInches methods
//to define highlighted regions or define some highlighted regions using SearchText methods by yourself.
int regID = 0, regCount = GdViewer1.RegionCount();
if (regCount > 0)
{
    for (int j = 1; j <= regCount; j++)
    {
        regID = GdViewer1.GetRegionID(j);
        GdViewer1.SetRegionBorderWidth(regID, 4);
        GdViewer1.SetRegionBorderColor(regID, GdViewer1.ARGBI(255, 0, 191, 255));
    }
    //Redrawing regions with the newly defined color.
    GdViewer1.Redraw();
}
else
    MessageBox.Show("No highlighted region found related to this document. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionBorderColor");

Reference

GdViewer Class
GdViewer Members
Overload List
GetRegionBorderColor Method
RegionCount Method
GetRegionID Method
SearchText(String,Int32,Boolean) Method
AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Int32) Method
AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Int32) Method
ARGBI Method