GetDisplayedAreaInch Method

In This Topic

Returns coordinates and dimensions, in inches, of the document's visible area within the control. The resulting rectangle relates to the current page of the document displayed in the GdViewer control and the coordinates correspond to the actual document pages area of the currently displayed page.

Syntax

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

'Declaration

 

Public Sub GetDisplayedAreaInch( _

   ByRef Left As Double, _

   ByRef Top As Double, _

   ByRef Width As Double, _

   ByRef Height As Double _

)

public void GetDisplayedAreaInch( 

   ref double Left,

   ref double Top,

   ref double Width,

   ref double Height

)

public procedure GetDisplayedAreaInch( 

   var  Left: Double;

   var  Top: Double;

   var  Width: Double;

   var  Height: Double

);

public function GetDisplayedAreaInch( 

   Left : double,

   Top : double,

   Width : double,

   Height : double

);

public: void GetDisplayedAreaInch( 

   ref double Left,

   ref double Top,

   ref double Width,

   ref double Height

)

public:

void GetDisplayedAreaInch( 

   double% Left,

   double% Top,

   double% Width,

   double% Height

)

Parameters

Left: Output parameter. The horizontal (X) coordinate (0-based) of the top left point, in inches, of the document's area visible in the control.
Top: Output parameter. The vertical (Y) coordinate (0-based) of the top left point, in inches, of the document's area visible in the control.
Width: Output parameter. The width, in inches, of the visible area rectangle.
Height: Output parameter. The height, in inches, of the visible area rectangle.

Remarks

You can regularly apply the GetStat method to determine if this method has been successful.

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 determine the fully visible rectangle of the current page within 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 left As Double = 0, top As Double = 0, width As Double = 0, height As Double = 0

GdViewer1.GetDisplayedAreaInch(left, top, width, height)

MessageBox.Show("Page width (X): " + (GdViewer1.PageInchWidth).ToString() + vbCrLf + "Page height (Y): " + (GdViewer1.PageInchHeight).ToString() + vbCrLf + vbCrLf +

                "Displayed area:" + vbCrLf + "  top-left point (X,Y): " + left + ", " + top + vbCrLf + "  width: " + width + "  height: " + height, "GdViewer.GetDisplayedAreaInch")

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

//and your document has been properly displayed as well.

double left = 0, top = 0, width = 0, height = 0;

GdViewer1.GetDisplayedAreaInch(ref left, ref top, ref width, ref height);

MessageBox.Show("Page width (X): " + (GdViewer1.PageInchWidth).ToString() + "\nPage height (Y): " + (GdViewer1.PageInchHeight).ToString() + "\n\n" +

                "Displayed area:\n  top-left point (X,Y): " + left + ", " + top + "\n  width: " + width + "  height: " + height, "GdViewer.GetDisplayedAreaInch");

Example

How to determine the fully visible rectangle of the current page within the viewer. 'We assume that the GdViewer1 control has been properly integrated 'and your document has been properly displayed as well. Dim left As Double = 0, top As Double = 0, width As Double = 0, height As Double = 0 GdViewer1.GetDisplayedAreaInch(left, top, width, height) MessageBox.Show("Page width (X): " + (GdViewer1.PageInchWidth).ToString() + vbCrLf + "Page height (Y): " + (GdViewer1.PageInchHeight).ToString() + vbCrLf + vbCrLf + "Displayed area:" + vbCrLf + " top-left point (X,Y): " + left + ", " + top + vbCrLf + " width: " + width + " height: " + height, "GdViewer.GetDisplayedAreaInch") //We assume that the GdViewer1 control has been properly integrated //and your document has been properly displayed as well. double left = 0, top = 0, width = 0, height = 0; GdViewer1.GetDisplayedAreaInch(ref left, ref top, ref width, ref height); MessageBox.Show("Page width (X): " + (GdViewer1.PageInchWidth).ToString() + "\nPage height (Y): " + (GdViewer1.PageInchHeight).ToString() + "\n\n" + "Displayed area:\n top-left point (X,Y): " + left + ", " + top + "\n width: " + width + " height: " + height, "GdViewer.GetDisplayedAreaInch");

Reference

GdViewer Class
GdViewer Members
GetStat Method
CurrentPage Property
GetDisplayedArea Method
PageInchWidth Property
PageInchHeight Property