IOleInPlaceSite::Scroll method (oleidl.h)
Instructs the container to scroll the view of the object by the specified number of pixels.
Syntax
HRESULT Scroll(
[in] SIZE scrollExtant
);
Parameters
[in] scrollExtant
The number of pixels by which to scroll in the X and Y directions.
Return value
This method returns S_OK on success. Other possible return values include the following.
| Return code | Description |
|---|---|
|
The specified pointer is not valid. |
|
An unexpected error has occurred. |
Remarks
As a result of scrolling, the object's visible rectangle can change. If that happens, the container should give the new clipping rectangle to the object by calling IOleInPlaceObject::SetObjectRects. The intersection of the lprcClipRect and lprcPosRect rectangles gives the new visible rectangle. See IOleInPlaceSite::GetWindowContext for more information.
Notes to Callers
Called by an active, in-place object when it is asking the container to scroll.Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | oleidl.h |