SetRegionColor(Int32,Color) Method

In This Topic

Sets the fill 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 define the fill color of each highlighted region when adding regions using AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Int32) or AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Int32) methods. You can determine the fill color of each highlighted region using the GetRegionColor method.

Please note that you need to redraw the control using the Redraw method to immediately apply the newly defined color.

Syntax

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

'Declaration
 
Public Overloads Function SetRegionColor( _
   ByVal RegionID As Integer, _
   ByVal Color As Color _
) As GdPictureStatus

public GdPictureStatus SetRegionColor( 
   int RegionID,
   Color Color
)

public function SetRegionColor( 
    RegionID: Integer;
    Color: Color
): GdPictureStatus;

public function SetRegionColor( 
   RegionID : int,
   Color : Color
) : GdPictureStatus;

public: GdPictureStatus SetRegionColor( 
   int RegionID,
   Color Color
)

public:
GdPictureStatus SetRegionColor( 
   int RegionID,
   Color Color
)

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.
Color: A color object that defines the new fill color of the specified region. You can obtain a suitable color using the ARGB(Byte,Byte,Byte,Byte) 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 fill color set by the toolkit is yellow, ARGB(255, 255, 0).

Example

How to change the fill color of 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
    Dim firstRegColor As Color = GdViewer1.GetRegionColor(GdViewer1.GetRegionID(1))
    Dim currColor As Color = Color.Black, newColor As Color = GdViewer1.ARGB(65, 190, 190)
    For j As Integer = 1 To regCount
        regID = GdViewer1.GetRegionID(j)
        currColor = GdViewer1.GetRegionColor(regID)
        If currColor = firstRegColor Then GdViewer1.SetRegionColor(regID, newColor)
    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.SetRegionColor")
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)
{
    Color firstRegColor = GdViewer1.GetRegionColor(GdViewer1.GetRegionID(1));
    Color currColor = Color.Black, newColor = GdViewer1.ARGB(65, 190, 190);
    for (int j = 1; j <= regCount; j++)
    {
        regID = GdViewer1.GetRegionID(j);
        currColor = GdViewer1.GetRegionColor(regID);
        if (currColor == firstRegColor)
            GdViewer1.SetRegionColor(regID, newColor);
    }
    //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.SetRegionColor");

Reference

GdViewer Class
GdViewer Members
Overload List
GetRegionColor 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
ARGB(Byte,Byte,Byte,Byte) Method