GetRegionBorderColor Method (GdViewer)

In This Topic

Gets 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 define the border color of each highlighted region using the SetRegionBorderColor(Int32,Color) method.

Syntax

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

'Declaration

 

Public Function GetRegionBorderColor( _

   ByVal RegionID As Integer _

) As Color

public Color GetRegionBorderColor( 

   int RegionID

)

public function GetRegionBorderColor( 

    RegionID: Integer

): Color;

public function GetRegionBorderColor( 

   RegionID : int

) : Color;

public: Color GetRegionBorderColor( 

   int RegionID

)

public:

Color GetRegionBorderColor( 

   int RegionID

)

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.

Return Value

The border color of the specified region. The GetStat method can be subsequently used to determine if this method has been successful.

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 find out some region properties.

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"

    GdViewer1.RemoveAllRegions()

    Dim text_found As Boolean = GdViewer1.SearchText(text_to_find, 0, True, True)

    If GdViewer1.GetStat() = GdPictureStatus.OK Then

        If text_found Then

            'Taking the first region to determine default values for some region properties set by the toolkit.

            Dim regID As Integer = GdViewer1.GetRegionID(1)

            If GdViewer1.GetStat() = GdPictureStatus.OK Then

                Dim message As String = "The number of highlighted regions: " + GdViewer1.RegionCount().ToString()

                message = message + vbCrLf + "name: " + GdViewer1.GetRegionName(regID).ToString()

                message = message + "  color: " + GdViewer1.GetRegionColor(regID).ToString()

                message = message + vbCrLf + "border width: " + GdViewer1.GetRegionBorderWidth(regID).ToString()

                message = message + "  border color: " + GdViewer1.GetRegionBorderColor(regID).ToString()

                message = message + "  color selection: " + GdViewer1.GetRegionColorSelection(regID).ToString()

                MessageBox.Show(message, "GdViewer.GetRegionColor")

            Else

                MessageBox.Show("The regionID has not been found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor")

            End If

        Else

            MessageBox.Show("The given text has not been found.", "GdViewer.GetRegionBorderColor")

        End If

    Else

        MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor")

    End If

Else

    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor")

End If

//We assume that the GdViewer1 control has been properly integrated.

if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)

{

    string text_to_find = "GdPicture";

    GdViewer1.RemoveAllRegions();

    bool text_found = GdViewer1.SearchText(text_to_find, 0, true, true);

    if (GdViewer1.GetStat() == GdPictureStatus.OK)

    {

        if (text_found)

        {

            //Taking the first region to determine default values for some region properties set by the toolkit.

            int regID = GdViewer1.GetRegionID(1);

            if (GdViewer1.GetStat() == GdPictureStatus.OK)

            {

                string message = "The number of highlighted regions: " + GdViewer1.RegionCount().ToString();

                message = message + "\nname: " + GdViewer1.GetRegionName(regID).ToString();

                message = message + "  color: " + GdViewer1.GetRegionColor(regID).ToString();

                message = message + "\nborder width: " + GdViewer1.GetRegionBorderWidth(regID).ToString();

                message = message + "  border color: " + GdViewer1.GetRegionBorderColor(regID).ToString();

                message = message + "  color selection: " + GdViewer1.GetRegionColorSelection(regID).ToString();

                MessageBox.Show(message, "GdViewer.GetRegionColor");

            }

            else

            {

                MessageBox.Show("The regionID has not been found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor");

            }

        }

        else

            MessageBox.Show("The given text has not been found.", "GdViewer.GetRegionBorderColor");

    }

    else

        MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor");

}

else

    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionBorderColor");

Reference

GdViewer Class
GdViewer Members
SetRegionBorderColor(Int32,Color) 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
GetRegionColor Method
SetRegionColor(Int32,Color) Method