SetRegionColorSelection(Int32,Color) Method

In This Topic

Sets the fill color of a highlighted region, when it is selected by the user. The region is 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 this fill color of each highlighted region using the GetRegionColorSelection method.

Syntax

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

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

public GdPictureStatus SetRegionColorSelection( 
   int RegionID,
   Color ColorSelection
)

public function SetRegionColorSelection( 
    RegionID: Integer;
    ColorSelection: Color
): GdPictureStatus;

public function SetRegionColorSelection( 
   RegionID : int,
   ColorSelection : Color
) : GdPictureStatus;

public: GdPictureStatus SetRegionColorSelection( 
   int RegionID,
   Color ColorSelection
)

public:
GdPictureStatus SetRegionColorSelection( 
   int RegionID,
   Color ColorSelection
)

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.
ColorSelection: A color object that defines the new fill color of the specified highlighted region when it is selected by the user. 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 aquamarine, ARGBI(255, 127, 255, 212).

Example

How to redefine the color for the user selection of highlighted regions.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    Dim text_to_find As String = "GdPicture"
    Dim regID As Integer = 0, occurrence As Integer = 1
    Dim left As Single = 0, top As Single = 0, width As Single = 0, height As Single = 0
    'Removing previously defined regions, if any.
    GdViewer1.RemoveAllRegions()
    While GdViewer1.SearchText(GdViewer1.CurrentPage, text_to_find, occurrence, True, True, left, top, width, height)
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            regID = GdViewer1.AddRegionInches("", left, top, width, height, ForegroundMixMode.ForegroundMixModeMASKPEN, GdViewer1.ARGB(176, 224, 230))
            If GdViewer1.GetStat() = GdPictureStatus.OK Then
                GdViewer1.SetRegionName(regID, "Region" + regID.ToString())
                'Setting the custom color for user selection.
                GdViewer1.SetRegionColorSelection(regID, GdViewer1.ARGB(0, 191, 255))
                occurrence += 1
            Else
                Exit While
            End If
        Else
            Exit While
        End If
    End While
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        GdViewer1.Redraw()
        If GdViewer1.RegionCount() = 0 Then MessageBox.Show("The given text has not been found.", "GdViewer.SetRegionColorSelection")
    Else
        MessageBox.Show("An error has occurred. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionColorSelection")
    End If
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionColorSelection")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    string text_to_find = "GdPicture";
    int regID = 0, occurrence = 1;
    float left = 0, top = 0, width = 0, height = 0;
    //Removing previously defined regions, if any.
    GdViewer1.RemoveAllRegions();
    while (GdViewer1.SearchText(GdViewer1.CurrentPage, text_to_find, occurrence, true, true, ref left, ref top, ref width, ref height))
    {
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
        {
            regID = GdViewer1.AddRegionInches("", left, top, width, height, ForegroundMixMode.ForegroundMixModeMASKPEN, GdViewer1.ARGB(176, 224, 230));
            if (GdViewer1.GetStat() == GdPictureStatus.OK)
            {
                GdViewer1.SetRegionName(regID, "Region" + regID.ToString());
                //Setting the custom color for user selection.
                GdViewer1.SetRegionColorSelection(regID, GdViewer1.ARGB(0, 191, 255));
                occurrence += 1;
            }
            else
                break;
        }
        else
            break;
    }
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        GdViewer1.Redraw();
        if (GdViewer1.RegionCount() == 0)
            MessageBox.Show("The given text has not been found.", "GdViewer.SetRegionColorSelection");
    }
    else
        MessageBox.Show("An error has occurred. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionColorSelection");
}
else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SetRegionColorSelection");

Reference

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