EM_SETTABSTOPS

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This message sets the tab stops in a multiline edit control. When text is copied to the control, any tab character in the text causes space to be generated up to the next tab stop.

This message is processed only by multiline edit controls.

Syntax

EM_SETTABSTOPS 
    wParam = (WPARAM) cTabs;
    lParam = (LPARAM)(LPWORD) lpTabs;

Parameters

  • cTabs
    Specifies the number of tab stops contained in the lpTabs parameter. If this parameter is zero, the lpTabs parameter is ignored and default tab stops are set at every 32 dialog template units. If this parameter is 1, tab stops are set at every n dialog template units, where n is the distance pointed to by the ldTabs parameter. If the cTabs parameter is greater than 1, lpTabs points to an array of tab stops.
  • lpTabs
    Long pointer to an array of unsigned integers specifying the tab stops, in dialog template units. If the cTabs parameter is 1, lpTabs points to an unsigned integer containing the distance between all tab stops, in dialog template units.

Return Value

TRUE indicates that all the tabs are set. FALSE indicates otherwise.

Remarks

The EM_SETTABSTOPS message does not automatically redraw the edit control window. If the application is changing the tab stops for text already in the edit control, it should call the InvalidateRect function to redraw the edit control window.

The values specified by the lpTabs parameter are in dialog template units, which are the device-independent units used in dialog box templates. To convert measurements from dialog template units to screen units (pixels), use the MapDialogRect function.

Requirements

Header windows.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

GetDialogBaseUnits
InvalidateRect
MapDialogRect
Edit Boxes Messages