GetRectLeftOnViewer Method (GdViewer)

In This Topic

Returns the horizontal (X) coordinate (0-based) of the top left point, in pixels, of the rectangle of area selection, related to the document displayed in the GdViewer control. The resulting coordinate corresponds to the viewer area. You can determine, if the rectangle of selection is currently defined and drawn within the control, using the IsRect method.

Syntax

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

'Declaration
 
Public Function GetRectLeftOnViewer() As Integer

public int GetRectLeftOnViewer()

public function GetRectLeftOnViewer(): Integer;

public function GetRectLeftOnViewer() : int;

public: int GetRectLeftOnViewer();

public:
int GetRectLeftOnViewer();

Return Value

The horizontal coordinate of the top left point, in pixels, of the rectangle of selection, related to the viewer area.

Remarks

Be aware that you are allowed to define only one rectangle of selection within the GdViewer control. Likewise, this rectangle always relates to the currently displayed document, meaning that without displaying some document you cannot get valid rectangle's data.

Just to remind you, that this coordinate is 0-based with the origin being in the top left corner in the viewer area.

Example

How to compare the coordinates of the rectangle of selection related to the document pages area with those related to the viewer area.

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.ClearRect()
    Dim text_found As Boolean = GdViewer1.SearchText(text_to_find, 1, True)
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        If text_found AndAlso GdViewer1.IsRect() Then
            GdViewer1.CenterOnRect()
            'Finding coordinates to compare.
            Dim leftViewer As Integer = GdViewer1.GetRectLeftOnViewer()
            Dim leftDoc As Integer = GdViewer1.GetRectLeftOnDocument()
            Dim topViewer As Integer = GdViewer1.GetRectTopOnViewer()
            Dim topDoc As Integer = GdViewer1.GetRectTopOnDocument()
            MessageBox.Show("The location point on the viewer is " + leftViewer + ", " + topViewer + "." + vbLf +
                            "The location point on the document's page is " + leftDoc + ", " + topDoc + ".", "GdViewer.GetRectLeftOnViewer")
        Else
            MessageBox.Show("The given text has not been found.", "GdViewer.GetRectLeftOnViewer")
        End If
    Else
        MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectLeftOnViewer")
    End If
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectLeftOnViewer")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    string text_to_find = "GdPicture";
    GdViewer1.ClearRect();
    bool text_found = GdViewer1.SearchText(text_to_find, 1, true);
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        if (text_found && GdViewer1.IsRect())
        {
            GdViewer1.CenterOnRect();
            //Finding coordinates to compare.
            int leftViewer = GdViewer1.GetRectLeftOnViewer();
            int leftDoc = GdViewer1.GetRectLeftOnDocument();
            int topViewer = GdViewer1.GetRectTopOnViewer();
            int topDoc = GdViewer1.GetRectTopOnDocument();
            MessageBox.Show("The location point on the viewer is " + leftViewer + ", " + topViewer +
                            ".\nThe location point on the document's page is " + leftDoc + ", " + topDoc + ".", "GdViewer.GetRectLeftOnViewer");
        }
        else
            MessageBox.Show("The given text has not been found.", "GdViewer.GetRectLeftOnViewer");
    }
    else
        MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectLeftOnViewer");
}
else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectLeftOnViewer");

Reference

GdViewer Class
GdViewer Members
GetRectTopOnViewer Method
GetRectLeftOnDocument Method
GetRectTopOnDocument Method
IsRect Method
ClearRect Method
CenterOnRect Method