CEdit::SetTabStops

Syntax

BOOL SetTabStops( int nTabStops, LPINT rgTabStops );

void SetTabStops();

BOOL SetTabStops( int cxEachStop );

Parameters

nTabStops

Specifies the number of tab stops contained in rgTabStops. If this parameter is greater then 1, then rgTabStops points to an array of tab stops.

rgTabStops

Points to an array of unsigned integers specifying the tab stops in dialog units. If nTabStops is 1, this parameter points to an unsigned integer containing the distance between all tab stops (in dialog units).

cxEachStop

Specifies that tab stops are to be set at every cxEachStop dialog units.

Remarks

Sets the tab stops in a multiple-line edit control. When text is copied to a multiple- line edit control, any tab character in the text will cause space to be generated up to the next tab stop.

If nTabStops is 0, rgTabStops is ignored and default tab stops are set at every 32 dialog units.

This member function is only processed by multiple-line edit controls.

SetTabStops does not automatically redraw the edit window. If the application is changing the tab stops for text already in the edit control, it needs to call CWnd::InvalidateRect to redraw the edit window.

Return Value

TRUE if the tabs were set; otherwise FALSE.

See Also

::GetDialogBaseUnits, CWnd::InvalidateRect, EM_SETTABSTOPS