Classe CMFCRibbonEdit

Implementa um controle de edição localizado em uma barra de faixa de opções.

Sintaxe

class CMFCRibbonEdit : public CMFCRibbonButton

Membros

Construtores públicos

Nome	Descrição
CMFCRibbonEdit::CMFCRibbonEdit	Constrói um objeto CMFCRibbonEdit.

Métodos públicos

Nome	Descrição
CMFCRibbonEdit::CanBeStretched	Indica se a altura do controle CMFCRibbonEdit pode aumentar verticalmente até a altura de uma linha de faixa de opções.
CMFCRibbonEdit::CMFCRibbonEdit	Constrói um objeto CMFCRibbonEdit.
CMFCRibbonEdit::CopyFrom	Copia o estado do objeto CMFCRibbonEdit especificado para o objeto CMFCRibbonEdit atual.
CMFCRibbonEdit::CreateEdit	Cria uma nova caixa de texto para o objeto CMFCRibbonEdit.
CMFCRibbonEdit::DestroyCtrl	Destrói o objeto CMFCRibbonEdit.
CMFCRibbonEdit::DropDownList	Solta uma caixa de listagem.
CMFCRibbonEdit::EnableSpinButtons	Habilita e define o intervalo do botão de rotação para a caixa de texto.
CMFCRibbonEdit::GetCompactSize	Recupera o tamanho compacto do objeto CFMCRibbonEdit.
CMFCRibbonEdit::GetEditText	Recupera o texto na caixa de texto.
CMFCRibbonEdit::GetIntermediateSize	Recupera o tamanho intermediário do objeto CMFCRibbonEdit.
CMFCRibbonEdit::GetTextAlign	Recupera o alinhamento do texto na caixa de texto.
CMFCRibbonEdit::GetWidth	Recupera a largura, em pixels, do controle CMFCRibbonEdit.
CMFCRibbonEdit::HasCompactMode	Indica se o tamanho da exibição do controle CMFCRibbonEdit pode ser compacto.
CMFCRibbonEdit::HasFocus	Indica se o controle CMFCRIbbonEdit tem o foco.
CMFCRibbonEdit::HasLargeMode	Indica se o tamanho da exibição do controle CMFCRibbonEdit pode ser grande.
CMFCRibbonEdit::HasSpinButtons	Indica se a caixa de texto tem um botão de rotação.
CMFCRibbonEdit::IsHighlighted	Indica se o controle CMFCRibbonEdit está realçado.
CMFCRibbonEdit::OnAfterChangeRect	Chamado pela estrutura quando as dimensões do retângulo de exibição para o controle CMFCRibbonEdit são alteradas.
CMFCRibbonEdit::OnDraw	Chamado pela estrutura para desenhar o controle CMFCRibbonEdit.
CMFCRibbonEdit::OnDrawLabelAndImage	Chamado pela estrutura para desenhar o rótulo e a imagem do controle CMFCRibbonEdit.
CMFCRibbonEdit::OnDrawOnList	Chamado pela estrutura para desenhar o controle CMFCRibbonEdit em uma caixa de listagem de comandos.
CMFCRibbonEdit::OnEnable	Chamado pela estrutura para habilitar ou desabilitar o controle CMFCRibbonEdit.
CMFCRibbonEdit::OnHighlight	Chamado pela estrutura quando o ponteiro entra ou sai dos limites do controle CMFCRibbonEdit.
CMFCRibbonEdit::OnKey	Chamado pela estrutura quando o usuário pressiona uma dica de tecla e o controle CMFCRibbonEdit tem o foco.
CMFCRibbonEdit::OnLButtonDown	Chamado pela estrutura para atualizar o controle CMFCRibbonEdit quando o usuário pressiona o botão esquerdo do mouse no controle.
CMFCRibbonEdit::OnLButtonUp	Chamado pela estrutura quando o usuário libera o botão esquerdo do mouse.
CMFCRibbonEdit::OnRTLChanged	Chamado pela estrutura para atualizar o controle CMFCRibbonEdit quando a direção do layout é alterada.
CMFCRibbonEdit::OnShow	Chamado pela estrutura para exibir ou ocultar o controle CMFCRibbonEdit.
CMFCRibbonEdit::Redraw	Atualiza a exibição do controle CMFCRibbonEdit.
CMFCRibbonEdit::SetACCData	Define os dados de acessibilidade do objeto CMFCRibbonEdit.
CMFCRibbonEdit::SetEditText	Define o texto na caixa de texto.
CMFCRibbonEdit::SetTextAlign	Define o alinhamento de texto da caixa de texto.
CMFCRibbonEdit::SetWidth	Define a largura da caixa de texto para o controle CMFCRibbonEdit.

Comentários

Exemplo

O exemplo a seguir demonstra como construir um objeto CMFCRibbonEdit, mostra botões de rotação próximos ao controle de edição e define o texto do controle de edição. Este snippet de código faz parte do exemplo de Demonstração do MS Office 2007.

CMFCRibbonEdit *pEditIndentLeft = new CMFCRibbonEdit(ID_PAGELAYOUT_INDENT_LEFT, 72, _T("Left:\nil"), 13);
// specify the min and max value of the spin button control
pEditIndentLeft->EnableSpinButtons(0, 1000);
// set the text of the edit control
pEditIndentLeft->SetEditText(_T("0"));

Requisitos

Cabeçalho: afxRibbonEdit.h

CMFCRibbonEdit::CanBeStretched

Indica se a altura do controle CMFCRibbonEdit pode aumentar verticalmente até a altura de uma linha de faixa de opções.

virtual BOOL CanBeStretched();

Valor de retorno

Sempre retorna FALSE.

Comentários

CMFCRibbonEdit::CMFCRibbonEdit

Constrói um objeto CMFCRibbonEdit.

CMFCRibbonEdit(
    UINT nID,
    int nWidth,
    LPCTSTR lpszLabel = NULL,
    int nImage = -1);

CMFCRibbonEdit();

Parâmetros

Nid
[in] ID de comando para o controle CMFCRibbonEdit.

nWidth
[in] A largura, em pixels, da caixa de texto do controle CMFCRibbonEdit.

lpszLabel
[in] O rótulo do controle CMFCRibbonEdit.

nImage
[in] Índice da imagem pequena a ser usada para o controle CMFCRibbonEdit. A coleção de imagens pequenas é mantida pela categoria de faixa de opções pai.

Comentários

O controle CMFCRibbonEdit não usa uma imagem grande.

CMFCRibbonEdit::CopyFrom

Copia o estado do objeto CMFCRibbonEdit especificado para o objeto CMFCRibbonEdit atual.

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Parâmetros

src
[in] O objeto CMFCRibbonEdit de origem.

Comentários

O parâmetro src precisa ser do tipo CMFCRibbonEdit.

CMFCRibbonEdit::CreateEdit

Cria uma nova caixa de texto para o objeto CMFCRibbonEdit.

virtual CMFCRibbonRichEditCtrl* CreateEdit(
    CWnd* pWndParent,
    DWORD dwEditStyle);

Parâmetros

pWndParent
[in] Um ponteiro para a janela pai do objeto CMFCRibbonEdit.

dwEditStyle
Especifica o estilo dos rótulos da caixa de texto. Você pode combinar os estilos de janela listados na seção Comentários com os estilos de controle de edição descritos no SDK do Windows.

Valor de retorno

Um ponteiro para a nova caixa de texto se o método for bem-sucedido. Caso contrário, NULL.

Comentários

Substitua esse método em uma classe derivada para criar uma caixa de texto personalizada.

É possível aplicar os estilos de janela a seguir a uma caixa de texto:

• WS_CHILD

• WS_VISIBLE

• WS_DISABLED

• WS_GROUP

• WS_TABSTOP

CMFCRibbonEdit::DestroyCtrl

Destrói o objeto CMFCRibbonEdit.

virtual void DestroyCtrl();

Comentários

CMFCRibbonEdit::DropDownList

Solta uma caixa de listagem.

virtual void DropDownList();

Comentários

Por padrão, esse método não faz nada. Substitua esse método para soltar uma caixa de listagem.

CMFCRibbonEdit::EnableSpinButtons

Habilita e define o intervalo do botão de rotação para a caixa de texto.

void EnableSpinButtons(
    int nMin,
    int nMax);

Parâmetros

nMin
[in] O valor mínimo do botão de rotação.

nMax
[in] O valor máximo do botão de rotação.

Comentários

Os botões de rotação exibem uma seta para cima e para baixo e permitem que os usuários se movam por meio de um conjunto fixo de valores.

CMFCRibbonEdit::GetCompactSize

Recupera o tamanho compacto do objeto CMFCRibbonEdit.

virtual CSize GetCompactSize(CDC* pDC);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para o objeto CMFCRibbonEdit.

Valor de retorno

O tamanho compacto do objeto CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::GetEditText

Recupera o texto na caixa de texto.

CString GetEditText() const;

Valor de retorno

O texto na caixa de texto.

Comentários

CMFCRibbonEdit::GetIntermediateSize

Recupera o tamanho intermediário do objeto CMFCRibbonEdit.

virtual CSize GetIntermediateSize(CDC* pDC);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para o objeto CMFCRibbonEdit.

Valor de retorno

O tamanho intermediário do objeto CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::GetTextAlign

Recupera o alinhamento do texto na caixa de texto.

int GetTextAlign() const;

Valor de retorno

Um valor enumerado de alinhamento de texto. Confira a seção Comentários para obter valores possíveis.

Comentários

O valor retornado é um dos seguintes estilos de controle de edição:

• ES_LEFT para alinhamento à esquerda

• ES_CENTER para alinhamento central

• ES_RIGHT para alinhamento à direita

Para obter mais informações sobre esses estilos, consulte Editar Estilos de Controle.

CMFCRibbonEdit::GetWidth

Recupera a largura, em pixels, do controle CMFCRibbonEdit.

int GetWidth(BOOL bInFloatyMode = FALSE) const;

Parâmetros

bInFloatyMode
[in] TRUE se o controle CMFCRibbonEdit estiver no modo flutuante. Caso contrário, FALSE.

Valor de retorno

A largura, em pixels, do controle CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::HasCompactMode

Indica se o tamanho da exibição do controle CMFCRibbonEdit pode ser compacto.

virtual BOOL HasCompactMode() const;

Valor de retorno

Sempre retorna TRUE.

Comentários

Por padrão, esse método sempre retorna TRUE. Substitua esse método para indicar se o tamanho da exibição pode ser compacto.

CMFCRibbonEdit::HasFocus

Indica se o controle CMFCRibbonEdit tem o foco.

virtual BOOL HasFocus() const;

Valor de retorno

TRUE se o controle CMFCRibbonEdit tiver o foco. Caso contrário, FALSE.

Comentários

CMFCRibbonEdit::HasLargeMode

Indica se o tamanho da exibição do controle CMFCRibbonEdit pode ser grande.

virtual BOOL HasLargeMode() const;

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para indicar se o tamanho da exibição pode ser grande.

CMFCRibbonEdit::HasSpinButtons

Indica se a caixa de texto tem um botão de rotação.

virtual BOOL HasSpinButtons() const;

Valor de retorno

TRUE se a caixa de texto tiver um botão de rotação. Caso contrário, FALSE.

Comentários

CMFCRibbonEdit::IsHighlighted

Indica se o controle CMFCRibbonEdit está realçado.

virtual BOOL IsHighlighted() const;

Valor de retorno

TRUE se o controle CMFCRibbonEdit estiver realçado. Caso contrário, FALSE.

Comentários

CMFCRibbonEdit::OnAfterChangeRect

Chamado pela estrutura quando as dimensões do retângulo de exibição para o controle CMFCRibbonEdit forem alteradas.

virtual void OnAfterChangeRect(CDC* pDC);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para a controle CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::OnDraw

Chamado pela estrutura para desenhar o controle CMFCRibbonEdit.

virtual void OnDraw(CDC* pDC);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para a controle CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::OnDrawLabelAndImage

Chamado pela estrutura para desenhar o rótulo e a imagem do controle CMFCRibbonEdit.

virtual void OnDrawLabelAndImage(CDC* pDC);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para a controle CMFCRibbonEdit.

Comentários

CMFCRibbonEdit::OnDrawOnList

Chamado pela estrutura para desenhar o controle CMFCRibbonEdit em uma caixa de listagem de comandos.

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para a controle CMFCRibbonEdit.

strText
[in] O texto de exibição.

nTextOffset
[in] Distância, em pixels, do lado esquerdo da caixa de listagem até o texto de exibição.

rect
[in] O retângulo de exibição para o controle CMFCRibbonEdit.

bIsSelected
[in] Esse parâmetro não é usado.

bHighlighted
[in] Esse parâmetro não é usado.

Comentários

A caixa de listagem de comandos exibe controles de faixa de opções para permitir que os usuários personalizem a barra de ferramentas de acesso rápido.

CMFCRibbonEdit::OnEnable

Chamado pela estrutura para habilitar ou desabilitar o controle CMFCRibbonEdit.

virtual void OnEnable(BOOL bEnable);

Parâmetros

bEnable
[in] TRUE para habilitar o controle e FALSE para desabilitá-lo.

Comentários

CMFCRibbonEdit::OnHighlight

Chamado pela estrutura quando o ponteiro entra ou sai dos limites do controle CMFCRibbonEdit.

virtual void OnHighlight(BOOL bHighlight);

Parâmetros

bHighlight
[in] TRUE se o ponteiro estiver nos limites do controle CMFCRibbonEdit. Caso contrário, FALSE.

Comentários

CMFCRibbonEdit::OnKey

Chamado pela estrutura quando o usuário pressiona uma dica de tecla e o controle CMFCRibbonEdit tem o foco.

virtual BOOL OnKey(BOOL bIsMenuKey);

Parâmetros

bIsMenuKey
[in] TRUE se a dica de tecla exibir um menu de item pop-up. Caso contrário, FALSE.

Valor de retorno

TRUE se o evento foi tratado. Caso contrário, FALSE.

Comentários

CMFCRibbonEdit::OnLButtonDown

Chamado pela estrutura para atualizar o controle CMFCRibbonEdit quando o usuário pressiona o botão esquerdo do mouse no controle.

virtual void OnLButtonDown(CPoint point);

Parâmetros

point
[in] Esse parâmetro não é usado.

Comentários

CMFCRibbonEdit::OnLButtonUp

Chamado pela estrutura quando o usuário libera o botão esquerdo do mouse.

virtual void OnLButtonUp(CPoint point);

Parâmetros

point
[in] Esse parâmetro não é usado.

Comentários

CMFCRibbonEdit::OnRTLChanged

Chamado pela estrutura para atualizar o controle CMFCRibbonEdit quando a direção do layout é alterada.

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

bIsRTL
[in] TRUE se o layout for da direita para a esquerda, se o layout for da esquerda para a direita, será FALSE.

Comentários

CMFCRibbonEdit::OnShow

Chamado pela estrutura para exibir ou ocultar o controle CMFCRibbonEdit.

virtual void OnShow(BOOL bShow);

Parâmetros

bShow
[in] TRUE para mostrar o controle e FALSE para ocultá-lo.

Comentários

CMFCRibbonEdit::Redraw

Atualiza a exibição do controle CMFCRibbonEdit.

virtual void Redraw();

Comentários

Esse método redesenha o retângulo de exibição para objeto CMFCRibbonEdit chamando CWnd::RedrawWindow indiretamente com os sinalizadores RDW_INVALIDATE, RDW_ERASE e RDW_UPDATENOW definidos.

CMFCRibbonEdit::SetACCData

Define os dados de acessibilidade para o objeto CMFCRibbonEdit.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Parâmetros

pParent
Ponteiro para a janela pai do objeto CMFCRibbonEdit.

data
Os dados de acessibilidade do objeto CMFCRibbonEdit.

Valor de retorno

Sempre retorna TRUE.

Comentários

CMFCRibbonEdit::SetEditText

Define o texto na caixa de texto.

void SetEditText(CString strText);

Parâmetros

strText
[in] O texto da caixa de texto.

CMFCRibbonEdit::SetTextAlign

Define o alinhamento de texto da caixa de texto.

void SetTextAlign(int nAlign);

Parâmetros

nAlign
[in] Um valor enumerado de alinhamento de texto. Confira a seção Comentários para obter valores possíveis.

Comentários

O parâmetro nAlign é um dos estilos de controle de edição a seguir:

• ES_LEFT para alinhamento à esquerda

• ES_CENTER para alinhamento central

• ES_RIGHT para alinhamento à direita

Para obter mais informações sobre esses estilos, consulte Editar Estilos de Controle.

CMFCRibbonEdit::SetWidth

Define a largura da caixa de texto para o controle CMFCRibbonEdit.

void SetWidth(
    int nWidth,
    BOOL bInFloatyMode = FALSE);

Parâmetros

nWidth
[in] A largura, em pixels, da caixa de texto.

bInFloatyMode
TRUE para definir a largura do modo flutuante e FALSE para definir a largura do modo regular.

Comentários

O controle CMFCRibbonEdit tem duas larguras, dependendo do modo de exibição: o modo flutuante e o modo regular.

Confira também

Gráfico da hierarquia
Classes
Classe CMFCRibbonButton
Classe CMFCRibbonBar