Share via

CMFCColorBar::SetDocumentColors

  • Article

Sets the list of colors that are used in the current document.

void SetDocumentColors(
   LPCTSTR lpszCaption,
   CList<COLORREF,COLORREF>& lstDocColors,
   BOOL bShowWhenDocked=FALSE 
);

Parameters

  • [in] lpszCaption
    A caption that is displayed when the color bar control is not docked.

  • [in] lstDocColors
    A list of colors that replaces the current document colors.

  • [in] bShowWhenDocked
    TRUE to show document colors when the color bar control is docked; otherwise, FALSE. The default value is FALSE.

Remarks

Document colors are the colors that are currently used in a document. The framework automatically maintains a list of document colors, but you can use this method to modify the list.

Requirements

Header: afxcolorbar.h

See Also

Reference

CMFCColorBar Class

Hierarchy Chart