ITextHost::TxScrollWindowEx method (textserv.h)

Article
02/22/2024

Requests the text host to scroll the content of the specified client area.

Syntax

void TxScrollWindowEx(
  [in] INT     dx,
  [in] INT     dy,
  [in] LPCRECT lprcScroll,
  [in] LPCRECT lprcClip,
  [in] HRGN    hrgnUpdate,
  [in] LPRECT  lprcUpdate,
  [in] UINT    fuScroll
);

Parameters

[in] dx

Type: INT

Amount of horizontal scrolling.

[in] dy

Type: INT

Amount of vertical scrolling.

[in] lprcScroll

Type: LPCRECT

The coordinates for the scroll rectangle.

[in] lprcClip

Type: LPCRECT

The coordinates for the clip rectangle.

[in] hrgnUpdate

Type: HRGN

Handle to the update region.

[in] lprcUpdate

Type: LPRECT

The coordinates for the update rectangle.

[in] fuScroll

Type: UINT

Scrolling flags. This parameter can be one of the following values.

Value	Meaning
SW_ERASE	Erases the newly invalidated region by sending a WM_ERASEBKGND message to the window when specified with the SW_INVALIDATE flag.
SW_INVALIDATE	Invalidates the region identified by the hrgnUpdate parameter after scrolling.
SW_SCROLLCHILDREN	Scrolls all child windows that intersect the rectangle pointed to by the lprcScroll parameter. The child windows are scrolled by the number of pixels specified by the dx and dy parameters. The system sends a WM_MOVE message to all child windows that intersect the lprcScroll rectangle, even if they do not move.
SW_SMOOTHSCROLL	Scrolls using smooth scrolling. Use the HIWORD portion of the fuScroll parameter to indicate how much time the smooth-scrolling operation should take.

Return value

None

Remarks

This method is only valid when the control is in-place active; calls while the control is inactive may fail.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	textserv.h
DLL	Msftedit.dll