GetRectCoordinatesOnDocument Method (GdViewer)

In This Topic

Gets data of the currently defined rectangle of area selection refering to the document pages area. This method gets the rectangle's coordinates and dimensions, in pixels, which determine the rectangle of selection related to the document displayed in the GdViewer control. The resulting values correspond to the actual document pages area.

Be aware that the rectangle of selection always relates to the displayed document. You can find out, if this rectangle is defined and drawn, using the IsRect method.

Syntax

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

'Declaration
 
Public Sub GetRectCoordinatesOnDocument( _
   ByRef Left As Integer, _
   ByRef Top As Integer, _
   ByRef Width As Integer, _
   ByRef Height As Integer _
)

public void GetRectCoordinatesOnDocument( 
   ref int Left,
   ref int Top,
   ref int Width,
   ref int Height
)

public procedure GetRectCoordinatesOnDocument( 
   var  Left: Integer;
   var  Top: Integer;
   var  Width: Integer;
   var  Height: Integer
);

public function GetRectCoordinatesOnDocument( 
   Left : int,
   Top : int,
   Width : int,
   Height : int
);

public: void GetRectCoordinatesOnDocument( 
   ref int Left,
   ref int Top,
   ref int Width,
   ref int Height
)

public:
void GetRectCoordinatesOnDocument( 
   int% Left,
   int% Top,
   int% Width,
   int% Height
)

Parameters

Left: Output parameter. The horizontal (X) coordinate (0-based) of the top left point, in pixels, of the rectangle of selection, related to the current page.
Top: Output parameter. The vertical (Y) coordinate (0-based) of the top left point, in pixels, of the rectangle of selection, related to the current page.
Width: Output parameter. The width, in pixels, of the rectangle of selection.
Height: Output parameter. The height, in pixels, of the rectangle of selection.

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 all coordinates are 0-based with the origin being in the top left corner in the document pages area and they are related to the current page determined by the CurrentPage property.

Example

How to enlarge the specified rectangle of selection on the displayed document.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated
'and your document has been properly displayed as well.
            
'Setting some custom properties for the rectangle of selection.
GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0)
GdViewer1.RectBorderSize = 2
            
If GdViewer1.SelectAllText() = GdPictureStatus.OK Then
    Dim regions As RectangleF() = GdViewer1.GetSelectedTextRegions()
    If (GdViewer1.GetStat() = GdPictureStatus.OK) AndAlso (regions.Count() > 0) Then
        'The first region surely exists.
        Dim rect As RectangleF = regions.ElementAt(0)
        Dim left As Integer = 0, top As Integer = 0, width As Integer = 0, height As Integer = 0
        GdViewer1.SetRectCoordinatesOnDocumentInches(rect.Left, rect.Top, rect.Width, rect.Height)
        GdViewer1.GetRectCoordinatesOnDocument(left, top, width, height)
        GdViewer1.SetRectCoordinatesOnDocument(left - 2, top - 2, width + 4, height + 4)
        GdViewer1.CenterOnRect()
    Else
        MessageBox.Show("The text region can't be found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectCoordinatesOnDocument")
    End If
Else
    MessageBox.Show("The text can't be selected. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectCoordinatesOnDocument")
End If

//We assume that the GdViewer1 control has been properly integrated
//and your document has been properly displayed as well.
            
//Setting some custom properties for the rectangle of selection.
GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0);
GdViewer1.RectBorderSize = 2;
            
if (GdViewer1.SelectAllText() == GdPictureStatus.OK)
{
    RectangleF[] regions = GdViewer1.GetSelectedTextRegions();
    if ((GdViewer1.GetStat() == GdPictureStatus.OK) && (regions.Count() > 0))
    {
        //The first region surely exists.
        RectangleF rect = regions.ElementAt(0);
        int left = 0, top = 0, width = 0, height = 0;
        GdViewer1.SetRectCoordinatesOnDocumentInches(rect.Left, rect.Top, rect.Width, rect.Height);
        GdViewer1.GetRectCoordinatesOnDocument(ref left, ref top, ref width, ref height);
        GdViewer1.SetRectCoordinatesOnDocument(left-2, top-2, width+4, height+4);
        GdViewer1.CenterOnRect();
    }
    else
        MessageBox.Show("The text region can't be found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectCoordinatesOnDocument");
}
else
    MessageBox.Show("The text can't be selected. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRectCoordinatesOnDocument");

Reference

GdViewer Class
GdViewer Members
SetRectCoordinatesOnDocument Method
GetRectCoordinatesOnDocumentInches Method
SetRectCoordinatesOnViewer Method
IsRect Method
ClearRect Method
CenterOnRect Method
SetRectBorderColor Method
RectBorderSize Property
SearchText(String,Int32,Boolean) Method