GetRectCoordinatesOnDocumentInches 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 inches, 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 GetRectCoordinatesOnDocumentInches( _
   ByRef Left As Single, _
   ByRef Top As Single, _
   ByRef Width As Single, _
   ByRef Height As Single _
)

public void GetRectCoordinatesOnDocumentInches( 
   ref float Left,
   ref float Top,
   ref float Width,
   ref float Height
)

public procedure GetRectCoordinatesOnDocumentInches( 
   var  Left: Single;
   var  Top: Single;
   var  Width: Single;
   var  Height: Single
);

public function GetRectCoordinatesOnDocumentInches( 
   Left : float,
   Top : float,
   Width : float,
   Height : float
);

public: void GetRectCoordinatesOnDocumentInches( 
   ref float Left,
   ref float Top,
   ref float Width,
   ref float Height
)

public:
void GetRectCoordinatesOnDocumentInches( 
   float% Left,
   float% Top,
   float% Width,
   float% Height
)

Parameters

Left: Output parameter. The horizontal (X) coordinate (0-based) of the top left point, in inches, 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 inches, of the rectangle of selection, related to the current page.
Width: Output parameter. The width, in inches, of the rectangle of selection.
Height: Output parameter. The height, in inches, 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 draw a rectagle on the PDF document's page according to the rectangle drawn by a user within the viewer.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
'At the same let's assume that you have properly displayed a PDF document as well.
If GdViewer1.IsRect() Then
    Dim filename As String = GdViewer1.GetLastPath()
    Dim left As Single = 0, top As Single = 0, width As Single = 0, height As Single = 0
    GdViewer1.GetRectCoordinatesOnDocumentInches(left, top, width, height)
    Using oPDF As GdPicturePDF = New GdPicturePDF()
        If oPDF.LoadFromFile(filename, True) = GdPictureStatus.OK Then
            oPDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitInch)
            oPDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
            oPDF.SetLineColor(255, 69, 0)
            If oPDF.DrawRectangle(left, top, width, height, False, True) = GdPictureStatus.OK Then
                If oPDF.SaveToFile(filename) = GdPictureStatus.OK Then
                    MessageBox.Show("Done!", "GdViewer.GetRectCoordinatesOnDocumentInches")
                End If
            End If
        End If
        oPDF.CloseDocument()
    End Using
End If

//We assume that the GdViewer1 control has been properly integrated.
//At the same let's assume that you have properly displayed a PDF document as well.
if (GdViewer1.IsRect())
{
    string filename = GdViewer1.GetLastPath();
    float left = 0, top = 0, width = 0, height = 0;
    GdViewer1.GetRectCoordinatesOnDocumentInches(ref left, ref top, ref width, ref height);
    using (GdPicturePDF oPDF = new GdPicturePDF())
    {
        if (oPDF.LoadFromFile(filename, true) == GdPictureStatus.OK)
        {
            oPDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitInch);
            oPDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
            oPDF.SetLineColor(255, 69, 0);
            if (oPDF.DrawRectangle(left, top, width, height, false, true) == GdPictureStatus.OK)
            {
                if (oPDF.SaveToFile(filename) == GdPictureStatus.OK)
                {
                    MessageBox.Show("Done!", "GdViewer.GetRectCoordinatesOnDocumentInches");
                }
            }
        }
        oPDF.CloseDocument();
    }
}

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