CListBox::SetTabStops

Syntax

BOOL SetTabStops( int nTabStops, LPINT rgTabStops );

void SetTabStops();

BOOL SetTabStops( int cxEachStop );

Parameters

nTabStops

Specifies the number of tab stops to have in the list box.

rgTabStops

Points to the first member of an array of integers containing the tab-stop positions in dialog units. (A dialog unit is a horizontal or vertical distance. One horizontal dialog unit is equal to one-fourth of the current dialog base width unit,

and one vertical dialog unit is equal to one-eighth of the current dialog base height unit. The dialog base units are computed based on the height and width of the current system font. The GetDialogBaseUnits Windows function returns the current dialog base units in pixels.) The tab stops must be sorted in increasing order; back tabs are not allowed.

cxEachStop

Tab stops are set at every cxEachStop dialog units.

Remarks

Sets the tab-stop positions in a list box.

If SetTabStops() is called, nTabStops is 0, rgTabStops is NULL, and the default tab stop is 2 dialog units.

If nTabStops is 1, tab stops will be separated by the distance specified by rgTabStops.

If rgTabStops points to more than a single value, then a tab stop will be set for each value in rgTabStops, up to the number specified by nTabStops.

To respond to a call to the SetTabStops member function, the list box must have been created with the LBS_USETABSTOPS style.

Return Value

TRUE if all the tabs were set; otherwise FALSE.

See Also

LB_SETTABSTOPS, ::GetDialogBaseUnits