CRichEditCtrl::SetDefaultCharFormat
TOC
Collapse the table of content
Expand the table of content
This documentation is archived and is not being maintained.

CRichEditCtrl::SetDefaultCharFormat 

Sets the character formatting attributes for new text in this CRichEditCtrl object.


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

Parameters

cf

In the first version, a pointer to a CHARFORMAT structure containing the new default character formatting attributes.

In the second version, a pointer to a CHARFORMAT2 structure, which is a Rich Edit 2.0 extension to the CHARFORMAT structure, containing the default character formatting attributes.

Nonzero if successful; otherwise, 0.

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 Platform SDK.

// The pointer to my rich edit control.
extern CRichEditCtrl* pmyRichEditCtrl;
CHARFORMAT cf;

// Modify the default character format so that all new
// text is striked out and not bold.
cf.dwMask = CFM_STRIKEOUT|CFM_BOLD;
cf.dwEffects = CFE_STRIKEOUT;
pmyRichEditCtrl->SetDefaultCharFormat(cf);

// Verify the settings are what is expected.
#ifdef _DEBUG
   pmyRichEditCtrl->GetDefaultCharFormat(cf);
   ASSERT((cf.dwMask&(CFM_STRIKEOUT|CFM_BOLD)) == 
      (CFM_STRIKEOUT|CFM_BOLD));
   ASSERT((cf.dwEffects&(CFE_STRIKEOUT|CFE_BOLD)) == CFE_STRIKEOUT);
#endif
Show:
© 2016 Microsoft