SetZoomFitViewer Method (GdViewer)

In This Topic

Fits the document currently displayed in the GdViewer control to the viewer area while keeping the aspect ratio.

This method sets the ZoomMode property to ViewerZoomMode.ZoomModeFitToViewer and refreshes the control as well.

Syntax

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

'Declaration
 
Public Function SetZoomFitViewer() As GdPictureStatus

public GdPictureStatus SetZoomFitViewer()

public function SetZoomFitViewer(): GdPictureStatus;

public function SetZoomFitViewer() : GdPictureStatus;

public: GdPictureStatus SetZoomFitViewer();

public:
GdPictureStatus SetZoomFitViewer();

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK. We strongly recommend always checking this status first.

Remarks

Just to inform you that if the ZoomMode property already has a value equal to ViewerZoomMode.ZoomModeFitToViewer, this method does nothing.

Both the BeforeZoomChange and the AfterZoomChange events are raised using this method.

You can also try the Document Viewer Sample here to find out, how to utilize zooming features in your application.

Example

How to change the current zoom mode.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
            
'Determine the current zoom mode.
MessageBox.Show("The current zoom mode is " + GdViewer1.ZoomMode.ToString() + ".", "GdViewer.SetZoomFitViewer")
            
'Set the required zoom mode. The viewer will refresh.
GdViewer1.SetZoomFitViewer()
'It is the same as assigning GdViewer1.ZoomMode = ViewerZoomMode.ZoomModeFitToViewer

//We assume that the GdViewer1 control has been properly integrated.
            
//Determine the current zoom mode.
MessageBox.Show("The current zoom mode is " + GdViewer1.ZoomMode.ToString()+ ".", "GdViewer.SetZoomFitViewer");
            
//Set the required zoom mode. The viewer will refresh.
GdViewer1.SetZoomFitViewer();
//It is the same as assigning GdViewer1.ZoomMode = ViewerZoomMode.ZoomModeFitToViewer;

Reference

GdViewer Class
GdViewer Members
ZoomMode Property
SetZoom100 Method
SetZoomWidthViewer Method
SetZoomHeightViewer Method
SetZoomViewer Method
BeforeZoomChange Event
AfterZoomChange Event