GetViewBounds Method

Summary

Current bounds of the view in physical (in control pixel) coordinates

Syntax

C++

public virtual LeadRectD GetViewBounds( 
   bool withPadding, 
   bool clipped 
)

Public Overridable Function GetViewBounds( 
   ByVal withPadding As Boolean, 
   ByVal clipped As Boolean 
) As LeadRectD

public:  
   virtual LeadRectD^ GetViewBounds( 
      bool withPadding, 
      bool clipped 
   )

Parameters

withPadding

true to include the value of ViewPadding when calculating the value, otherwise; false.

clipped

true to intersect the returned value with the current viewer control rectangle, otherwise; false.

Return Value

The view bounds in pixels or LeadRectD.Empty if the viewer does not have any items or if the view does not intersect with the control rectangle.

Remarks

The view consists of all current the items in the viewer plus any padding (set in ViewPadding). This is the area that the viewer use to determine whether horizontal and vertical scrollbars are needed and to calculate their size and position.

The view area is calculated during UpdateTransform. The current ViewLayout determines where each item is placed and calculates their sizes. The total of these sizes is calculated and multiplied by any scale factor (XScaleFactor and YScaleFactor) set by the Zoom method. The final size is the view area.

During the calculations, the viewer will calculate the transformation matrix used when rendering the view. This matrix contains the current padding, scroll offset and scale factors and stored in ViewTransform. For example, to render the view border, the viewer simply draws the value of GetViewBounds transformed with ViewTransform.

For more information, refer to Image Viewer Appearance, Image Viewer Transformation, and Image Viewer Bounds and Transform.

Example

For an example, refer to RedirectRender.

Requirements

Target Platforms