CRichEditCtrl::SetWordCharFormat

Article
12/01/2015

Sets the character formatting attributes for the currently selected word in this CRichEditCtrl object.

Syntax

      BOOL SetWordCharFormat(
   CHARFORMAT& cf 
);
BOOL SetWordCharFormat(
   CHARFORMAT2& cf 
);

Parameters

cf
In the first version, a pointer to a CHARFORMAT structure containing the new character formatting attributes for the currently selected word.

In the second version, a pointer to a CHARFORMAT2 structure, which is a Rich Edit 2.0 extension to the CHARFORMAT structure, containing the new character formatting attributes for the currently selected word.

Return Value

Nonzero if successful; otherwise, 0.

Remarks

Only the attributes specified by the dwMask member of cf are changed by this function.

For more information, see the EM_SETCHARFORMAT message and the CHARFORMAT and CHARFORMAT2 structures in the Windows SDK.

Example

CHARFORMAT cf;

// Modify the word format so that the selected word is 
// displayed in bold and not striked out.
cf.cbSize = sizeof(cf);
cf.dwMask = CFM_STRIKEOUT|CFM_BOLD;
cf.dwEffects = CFE_BOLD;
m_myRichEditCtrl.SetWordCharFormat(cf);

Requirements

Header: afxcmn.h