IOleInPlaceSite::Scroll
A version of this page is also available for
4/8/2010
Tells the container to scroll the view of the object by a specified number of pixels.
Syntax
HRESULT Scroll(
SIZE scrollExtent
);
Parameters
- scrollExtent
[in] Number of pixels by which to scroll in the X and Y directions.
Return Value
This method supports the following return values:
| Value | Description |
|---|---|
S_OK |
The method successfully executed the view scroll instruction. |
E_INVALIDARG |
The method contains an invalid argument. |
E_UNEXPECTED |
The call to the method unexpectedly failed. |
Remarks
As a result of scrolling, the object's visible rectangle can change. If that happens, the container should give the new ClipRect to the object by calling IOleInPlaceObject::SetObjectRects. The intersection of the ClipRect and PosRect rectangles gives the new visible rectangle. See IOleInPlaceSite::GetWindowContext for a discussion of ClipRect and PosRect.
Notes to Callers
Called by an active, in-place object when it is asking the container to scroll.
Requirements
| Header | Oleidl.h |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |