GetRectCoordinatesOnViewer Method (GdViewer)

In This Topic

Gets data of the currently defined rectangle of area selection refering to the displayed viewer 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 viewer 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 GetRectCoordinatesOnViewer( _
   ByRef Left As Integer, _
   ByRef Top As Integer, _
   ByRef Width As Integer, _
   ByRef Height As Integer _
)

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

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

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

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

public:
void GetRectCoordinatesOnViewer( 
   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 viewer area.
Top: Output parameter. The vertical (Y) coordinate (0-based) of the top left point, in pixels, of the rectangle of selection, related to the viewer area.
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 viewer area.

Example

How to translate the rectangle's coordinates related to the document to the coordinates related to the viewer.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated
'and your document has been properly displayed as well.
Dim left1 As Integer = 0, top1 As Integer = 0, width1 As Integer = 0, height1 As Integer = 0
Dim left2 As Integer = 0, top2 As Integer = 0, width2 As Integer = 0, height2 As Integer = 0
GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0)
GdViewer1.RectBorderSize = 2
GdViewer1.GetDisplayedArea(left1, top1, width1, height1)
GdViewer1.SetRectCoordinatesOnDocument(left1, top1, width1, height1)
GdViewer1.GetRectCoordinatesOnViewer(left2, top2, width2, height2)
MessageBox.Show("The displayed area of the document: " + left1 + ", " + top1 + " w=" + width1 + ", h=" + height1 + vbCrLf +
                "The rectangle of selection (viewer-related): " + left2 + ", " + top2 + " w=" + width2 + ", h=" + height2, "GdViewer.GetRectCoordinatesOnViewer")

//We assume that the GdViewer1 control has been properly integrated
//and your document has been properly displayed as well.
int left1 = 0, top1 = 0, width1 = 0, height1 = 0;
int left2 = 0, top2 = 0, width2 = 0, height2 = 0;
            
GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0);
GdViewer1.RectBorderSize = 2;
GdViewer1.GetDisplayedArea(ref left1, ref top1, ref width1, ref height1);
GdViewer1.SetRectCoordinatesOnDocument(left1, top1, width1, height1);
GdViewer1.GetRectCoordinatesOnViewer(ref left2, ref top2, ref width2, ref height2);
MessageBox.Show("The displayed area of the document: " + left1 + ", " + top1 + " w=" + width1 + ", h=" + height1 +
                "\nThe rectangle of selection (viewer-related): " + left2 + ", " + top2 + " w=" + width2 + ", h=" + height2, "GdViewer.GetRectCoordinatesOnViewer");

Reference

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