Estrutura CHARFORMATA (richedit.h)

  • Artigo

Contém informações sobre formatação de caracteres em um controle de edição avançada.

Edição Avançada 2.0: A estrutura CHARFORMAT2 é uma extensão do Microsoft Rich Edit 2.0 da estrutura CHARFORMAT . O Microsoft Rich Edit 2.0 e posterior permite que você use qualquer estrutura com as mensagens EM_GETCHARFORMAT e EM_SETCHARFORMAT .

Sintaxe

typedef struct _charformat {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  char     szFaceName[LF_FACESIZE];
} CHARFORMATA;

Membros

cbSize

Tipo: UINT

Tamanho em bytes da estrutura especificada. Esse membro deve ser definido antes de passar a estrutura para o controle de edição avançada.

dwMask

Tipo: DWORD

Membros que contêm informações ou atributos válidos a serem definidos. Esse membro pode ser zero, um ou mais de um dos valores a seguir.

Valor Significado
CFM_ALL
 Windows 8: uma combinação dos seguintes valores: CFM_EFFECTS | CFM_SIZE | CFM_FACE | CFM_OFFSET | CFM_CHARSET
CFM_BOLD
 O valor CFE_BOLD do membro dwEffects é válido.
CFM_CHARSET
 O membro bCharSet é válido.
CFM_COLOR
 O membro crTextColor e o valor CFE_AUTOCOLOR do membro dwEffects são válidos .
CFM_EFFECTS
 Windows 8: uma combinação dos seguintes valores: CFM_BOLD | CFM_ITALIC | CFM_UNDERLINE | CFM_COLOR | CFM_STRIKEOUT | CFE_PROTECTED | CFM_LINK
CFM_FACE
 O membro szFaceName é válido.
CFM_ITALIC
 O valor CFE_ITALIC do membro dwEffects é válido.
CFM_OFFSET
 O membro yOffset é válido.
CFM_PROTECTED
 O valor CFE_PROTECTED do membro dwEffects é válido.
CFM_SIZE
 O membro yHeight é válido.
CFM_STRIKEOUT
 O valor CFE_STRIKEOUT do membro dwEffects é válido.
CFM_UNDERLINE.
 O valor CFE_UNDERLINE do membro dwEffects é válido.

dwEffects

Tipo: DWORD

Efeitos de caractere. Esse membro pode ser uma combinação dos valores a seguir.

Valor Significado
CFE_AUTOCOLOR
 A cor do texto é o valor retornado de GetSysColor(COLOR_WINDOWTEXT).
CFE_BOLD
 Os caracteres são ousados.
CFE_DISABLED
 RichEdit 2.0 e posterior: Os caracteres são exibidos com uma sombra que é deslocada por 3/4 ponto ou um pixel, o que for maior.
CFE_ITALIC
 Os caracteres são itálicos.
CFE_STRIKEOUT
 Os caracteres são atingidos.
CFE_UNDERLINE
 Os caracteres são sublinhados.
CFE_PROTECTED
 Os caracteres são protegidos; uma tentativa de modificá-los causará um código de notificação EN_PROTECTED.

yHeight

Tipo: LONG

Altura do caractere, em twips (1/1440 de uma polegada ou 1/20 do ponto de uma impressora).

yOffset

Tipo: LONG

Deslocamento de caractere, em twips, da linha de base. Se o valor desse membro for positivo, o caractere será um sobrescrito; se for negativo, o caractere será um subscrito.

crTextColor

Tipo: COLORREF

Cor de texto. Esse membro será ignorado se o efeito de caractere CFE_AUTOCOLOR for especificado. Para gerar um COLORREF, use a macro RGB .

bCharSet

Tipo: BYTE

Valor do conjunto de caracteres. O membro bCharSet pode ser um dos valores especificados para o membro lfCharSet da estrutura LOGFONT . O Microsoft Rich Edit 3.0 poderá substituir esse valor se ele for inválido para os caracteres de destino.

bPitchAndFamily

Tipo: BYTE

Família de fontes e pitch. Esse membro é o mesmo que o membro lfPitchAndFamily da estrutura LOGFONT .

szFaceName[LF_FACESIZE]

Tipo: TCHAR[LF_FACESIZE]

Matriz de caracteres terminada em nulo especificando o nome da fonte.

Comentários

Para desativar um atributo de formatação, defina o valor apropriado em dwMask , mas não defina o valor correspondente em dwEffects. Por exemplo, para desativar itálico, defina CFM_ITALIC mas não defina CFE_ITALIC.

Observação

O cabeçalho richedit.h define CHARFORMAT como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Cabeçalho richedit.h

Confira também

CHARFORMAT2

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

Referência