GetHScrollBarPosition Method (GdViewer)

In This Topic

Gets the current position of the horizontal scrollbar, in pixels, related to the document currently displayed in the GdViewer control. The resulting coordinate corresponds to the actual document area of the currently displayed page.

Syntax

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

'Declaration
 
Public Function GetHScrollBarPosition() As Integer

public int GetHScrollBarPosition()

public function GetHScrollBarPosition(): Integer;

public function GetHScrollBarPosition() : int;

public: int GetHScrollBarPosition();

public:
int GetHScrollBarPosition();

Return Value

The current horizontal coordinate of the horizontal scrollbar, in pixels, related to the displayed document.

Remarks

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

Just to remind you, that this coordinate is 0-based with the origin being in the top left corner in the document pages area and it is related to the current page determined by the CurrentPage property.

Example

How to get the current position of the scrollbars.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
            
    'The current position of both scrollbars after displaying the document
    'according to your currently defined GdViewer control settings.
    Dim x As Integer = GdViewer1.GetHScrollBarPosition()
    Dim y As Integer = GdViewer1.GetVScrollBarPosition()
    MessageBox.Show("The scrollbars are set to this position: " + x + ", " + y, "GdViewer.GetHScrollBarPosition")
            
    If (x <> 0) OrElse (y <> 0) Then
        'Setting the scrollbars to the required position.
        GdViewer1.SetHScrollBarPosition(0)
        GdViewer1.SetVScrollBarPosition(0)
        MessageBox.Show("The scrollbars are now set to this position: 0, 0", "GdViewer.GetHScrollBarPosition")
    End If
            
    'Do your other stuff here.
    GdViewer1.CloseDocument()
Else
    MessageBox.Show("This file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetHScrollBarPosition")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    //The current position of both scrollbars after displaying the document
    //according to your currently defined GdViewer control settings.
    int x = GdViewer1.GetHScrollBarPosition();
    int y = GdViewer1.GetVScrollBarPosition();
    MessageBox.Show("The scrollbars are set to this position: " + x + ", " + y, "GdViewer.GetHScrollBarPosition");
            
    if ((x != 0) || (y != 0))
    {
        //Setting the scrollbars to the required position.
        GdViewer1.SetHScrollBarPosition(0);
        GdViewer1.SetVScrollBarPosition(0);
        MessageBox.Show("The scrollbars are now set to this position: 0, 0", "GdViewer.GetHScrollBarPosition");
    }
            
    //Do your other stuff here.
    GdViewer1.CloseDocument();
}
else
{
    MessageBox.Show("This file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetHScrollBarPosition");
}

Reference

GdViewer Class
GdViewer Members
SetHScrollBarPosition Method
GetHScrollBarMaxPosition Method
SetHVScrollBarPosition Method
GetDisplayedArea Method
GetDocumentLeft Method
GetDocumentTop Method