ITextHost::TxSetScrollPos method (textserv.h)

Article
02/22/2024

Sets the position of the scroll box (thumb) in the specified scroll bar and, if requested, redraws the scroll bar to reflect the new position of the scroll box.

Syntax

BOOL TxSetScrollPos(
  [in] INT  fnBar,
  [in] INT  nPos,
  [in] BOOL fRedraw
);

Parameters

[in] fnBar

Type: INT

Scroll bar flag. If this is SB_HORZ, horizontal scrolling is done. By default, vertical scrolling is done.

[in] nPos

Type: INT

New position in scroll box. This must be within the range of scroll bar values set by ITextHost::TxSetScrollRange.

[in] fRedraw

Type: BOOL

Redraw flag. If TRUE, the scroll bar is redrawn with the new position of the scroll box. If FALSE, the scroll bar is not redrawn.

Return value

Type: BOOL

Return TRUE if the method succeeds.

Return FALSE if the method fails.

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