RestrictScrollOffset Method

Summary

Ensures a scroll position is inside the minimum and maximum scroll value currently allowed.

Syntax

C++

public virtual LeadPoint RestrictScrollOffset( 
   LeadPoint value 
)

Public Overridable Function RestrictScrollOffset( 
   ByVal value As LeadPoint 
) As LeadPoint

public:  
   virtual LeadPoint^ RestrictScrollOffset( 
      LeadPoint^ value 
   )

Parameters

value

Scroll position in pixels.

Return Value

The trimmed value.

Remarks

This method will check value against 0,0 and the current value of MaximumScrollSize and make sure the value is inside the current scroll range. ScrollByRestrict uses this method to ensure the scrolling is always in the current range regardless of the value of RestrictScroll.

Requirements

Target Platforms