Classe `CMFCRibbonBar`

Artigo
07/05/2024

A classe CMFCRibbonBar implementa uma barra de faixa de opções semelhante à usada no Office 2007.

Para conhecer mais detalhes, confira o código-fonte localizado na pasta mfc da instalação do Visual Studio. Por exemplo, %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

Sintaxe

class CMFCRibbonBar : public CPane

Membros

Construtores públicos

Nome	Descrição
`CMFCRibbonBar::CMFCRibbonBar`	Construtor padrão.

Métodos públicos

Nome	Descrição
`CMFCRibbonBar::ActivateContextCategory`	Ativa uma categoria de contexto que já está visível.
`CMFCRibbonBar::AddCategory`	Adiciona uma nova categoria de faixa de opções à faixa de opções.
`CMFCRibbonBar::AddContextCategory`	Adiciona uma categoria de contexto.
`CMFCRibbonBar::AddMainCategory`	Adiciona uma nova categoria de faixa de opções principal.
`CMFCRibbonBar::AddPrintPreviewCategory`
`CMFCRibbonBar::AddQATOnlyCategory`
`CMFCRibbonBar::AddToTabs`	Adicione um elemento de faixa de opções ao lado direito de uma barra de faixa de opções.
`CMFCRibbonBar::CreateEx`	Cria uma barra de controle e a anexa ao objeto `CPane`. (Substitui `CPane::CreateEx`.)
`CMFCRibbonBar::Create`	Cria um controle de barra de faixa de opções e o anexa a uma barra de faixa de opções.
`CMFCRibbonBar::DeactivateKeyboardFocus`
`CMFCRibbonBar::DrawMenuImage`
`CMFCRibbonBar::DWMCompositionChanged`
`CMFCRibbonBar::EnableKeyTips`	Habilite ou desabilite as principais dicas para o controle da faixa de opções.
`CMFCRibbonBar::EnablePrintPreview`	Habilite a guia Visualização de Impressão.
`CMFCRibbonBar::EnableToolTips`	Habilita ou desabilita as dicas de ferramenta e as descrições da dica de ferramenta na barra de faixa de opções.
`CMFCRibbonBar::FindByData`	Localize um elemento de faixa de opções usando dados especificados por um usuário.
`CMFCRibbonBar::FindByID`	Localiza um elemento de faixa de opções que tem a ID de comando especificada.
`CMFCRibbonBar::FindCategoryIndexByData`	Localiza o índice da categoria da faixa de opções que contém os dados definidos pelo usuário.
`CMFCRibbonBar::ForceRecalcLayout`
`CMFCRibbonBar::GetActiveCategory`	Obtém um ponteiro para uma categoria ativa.
`CMFCRibbonBar::GetCaptionHeight`	Retorna a altura da legenda. (Substitui `CBasePane::GetCaptionHeight`.)
`CMFCRibbonBar::GetCategory`	Obtém o ponteiro para uma categoria localizada em um índice especificado.
`CMFCRibbonBar::GetCategoryCount`	Obtém o número das categorias de faixa de opções na barra de faixa de opções.
`CMFCRibbonBar::GetCategoryHeight`
`CMFCRibbonBar::GetCategoryIndex`	Retorna o índice de uma categoria de faixa de opções.
`CMFCRibbonBar::GetContextName`	Recupera o nome da legenda da categoria de contexto que você especifica usando uma ID.
`CMFCRibbonBar::GetDroppedDown`
`CMFCRibbonBar::GetElementsByID`	Obtém uma matriz que contém os ponteiros para todos os elementos da faixa de opções que têm a ID especificada.
`CMFCRibbonBar::GetApplicationButton`	Obtém um ponteiro para um botão da faixa de opções.
`CMFCRibbonBar::GetFocused`	Retorna um elemento focalizado.
`CMFCRibbonBar::GetHideFlags`
`CMFCRibbonBar::GetItemIDsList`
`CMFCRibbonBar::GetKeyboardNavigationLevel`
`CMFCRibbonBar::GetKeyboardNavLevelCurrent`
`CMFCRibbonBar::GetKeyboardNavLevelParent`
`CMFCRibbonBar::GetMainCategory`	Retorna um ponteiro para a categoria da faixa de opções que está selecionada no momento.
`CMFCRibbonBar::GetQATCommandsLocation`
`CMFCRibbonBar::GetQATDroppedDown`
`CMFCRibbonBar::GetQuickAccessCommands`	Preenche uma lista que contém as IDs de comando de todos os elementos que aparecem na Barra de Ferramentas de Acesso Rápido.
`CMFCRibbonBar::GetQuickAccessToolbarLocation`
`CMFCRibbonBar::GetTabTrancateRatio`
`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`
`CMFCRibbonBar::GetTooltipFixedWidthRegular`
`CMFCRibbonBar::GetVisibleCategoryCount`
`CMFCRibbonBar::HideAllContextCategories`	Oculta todas as categorias que estão ativas e visíveis.
`CMFCRibbonBar::HideKeyTips`
`CMFCRibbonBar::HitTest`	Localiza um ponteiro para o elemento da faixa de opções que está localizado no ponto especificado nas coordenadas do cliente da barra de faixa de opções.
`CMFCRibbonBar::IsKeyTipEnabled`	Determina se as dicas de chave estão habilitadas.
`CMFCRibbonBar::IsMainRibbonBar`
`CMFCRibbonBar::IsPrintPreviewEnabled`	Determina se a guia Visualização de Impressão está habilitada.
`CMFCRibbonBar::IsQATEmpty`
`CMFCRibbonBar::IsQuickAccessToolbarOnTop`	Especifica se a Barra de Ferramentas de Acesso Rápido está localizada acima da barra de faixa de opções.
`CMFCRibbonBar::IsReplaceFrameCaption`	Determina se a barra de faixa de opções substitui a legenda do quadro principal ou é adicionada abaixo da legenda do quadro.
`CMFCRibbonBar::IsShowGroupBorder`
`CMFCRibbonBar::IsToolTipDescrEnabled`	Determina se as descrições da dica de ferramenta estão habilitadas.
`CMFCRibbonBar::IsToolTipEnabled`	Determina se as dicas de ferramenta para a barra de faixa de opções estão habilitadas.
`CMFCRibbonBar::IsTransparentCaption`
`CMFCRibbonBar::IsWindows7Look`	Indica se a faixa de opções tem a aparência no estilo Windows 7 (botão de aplicativo retangular pequeno).
`CMFCRibbonBar::LoadFromResource`	Sobrecarregado. Carrega uma Barra de Faixa de Opções dos recursos do aplicativo.
`CMFCRibbonBar::OnClickButton`
`CMFCRibbonBar::OnEditContextMenu`
`CMFCRibbonBar::OnRTLChanged`	(Substitui `CPane::OnRTLChanged`.)
`CMFCRibbonBar::OnSetAccData`	(Substitui `CBasePane::OnSetAccData`.)
`CMFCRibbonBar::OnShowRibbonContextMenu`
`CMFCRibbonBar::OnShowRibbonQATMenu`
`CMFCRibbonBar::OnSysKeyDown`
`CMFCRibbonBar::OnSysKeyUp`
`CMFCRibbonBar::PopTooltip`
`CMFCRibbonBar::PreTranslateMessage`	(Substitui `CBasePane::PreTranslateMessage`.)
`CMFCRibbonBar::RecalcLayout`	(Substitui `CPane::RecalcLayout`.)
`CMFCRibbonBar::RemoveAllCategories`	Remove todas as categorias de faixa de opções da barra de faixa de opções.
`CMFCRibbonBar::RemoveAllFromTabs`	Remove todos os elementos da faixa de opções da área de guia.
`CMFCRibbonBar::RemoveCategory`	Remove a categoria da faixa de opções localizada no índice especificado.
`CMFCRibbonBar::SaveToXMLBuffer`	Salva a Barra de Faixa de Opções em um buffer.
`CMFCRibbonBar::SaveToXMLFile`	Salva a Barra de Faixa de Opções no arquivo XML.
`CMFCRibbonBar::SetActiveCategory`	Define uma categoria de faixa de opções especificada como ativa.
`CMFCRibbonBar::SetActiveMDIChild`
`CMFCRibbonBar::SetElementKeys`	Define as dicas de chave especificadas para todos os elementos da faixa de opções que têm a ID de comando especificada.
`CMFCRibbonBar::SetApplicationButton`	Atribui um botão da faixa de opções do aplicativo à barra de faixa de opções.
`CMFCRibbonBar::SetKeyboardNavigationLevel`
`CMFCRibbonBar::SetMaximizeMode`
`CMFCRibbonBar::SetQuickAccessCommands`	Adiciona um ou mais elementos de faixa de opções à Barra de Ferramentas de Acesso Rápido.
`CMFCRibbonBar::SetQuickAccessDefaultState`	Especifica o estado padrão da Barra de Ferramentas de Acesso Rápido.
`CMFCRibbonBar::SetQuickAccessToolbarOnTop`	Posiciona a QAT (Barra de Ferramentas de Acesso Rápido) acima ou abaixo da barra de faixa de opções.
`CMFCRibbonBar::SetTooltipFixedWidth`
`CMFCRibbonBar::SetWindows7Look`	Habilitar/desabilitar a aparência no estilo do Windows 7 da faixa de opções (botão de aplicativo retangular pequeno)
`CMFCRibbonBar::ShowCategory`	Mostra ou oculta a categoria de faixa de opções.
`CMFCRibbonBar::ShowContextCategories`	Mostra ou oculta as categorias de contexto que têm a ID especificada.
`CMFCRibbonBar::ShowKeyTips`
`CMFCRibbonBar::ToggleMimimizeState`	Alterna a barra de faixa de opções entre os estados minimizados e maximizados..
`CMFCRibbonBar::TranslateChar`

Comentários

A Microsoft lançou a Faixa de Opções do Office Fluent quando liberou simultaneamente o Microsoft Office 2007. Essa barra de faixa de opções não é apenas um novo controle. Ela representa um novo paradigma de interface do usuário. A faixa de opções é um painel que contém um conjunto de guias chamado de categorias. Cada categoria é dividida logicamente em painéis de faixa de opções e cada painel pode conter vários controles e botões de comando.

Os elementos que aparecem na barra de faixa de opções se expandem e se contraem para aproveitar melhor o espaço disponível. Por exemplo, se um painel de faixa de opções não tiver espaço suficiente para exibir seus elementos, ele se tornará um botão de menu que exibe subitens em um menu pop-up. A barra de faixa de opções se comporta como uma barra de controle estática (não flutuante) e pode ser encaixada na parte superior de um quadro.

Você pode usar a classe CMFCRibbonStatusBar para implementar uma barra de status semelhante à usada no Office 2007. Uma categoria de faixa de opções contém (e exibe) um grupo de painéis de faixa de opções. Cada painel da faixa de opções contém um ou mais elementos de faixa de opções, derivados de CMFCRibbonBaseElement.

Para informações sobre como adicionar uma barra de faixa de opções ao aplicativo MFC, confira Instruções passo a passo: como atualizar o aplicativo Scribble MFC.

Hierarquia de herança

Requisitos

Cabeçalho: afxribbonbar.h

`CMFCRibbonBar::ActivateContextCategory`

Ativa uma categoria de contexto que já está visível.

BOOL ActivateContextCategory(UINT uiContextID);

Parâmetros

uiContextID
[in] A ID da categoria de contexto.

Valor de retorno

TRUE se uma categoria de contexto com uiContextID for encontrada e ativada; caso contrário FALSE.

`CMFCRibbonBar::AddCategory`

Cria e inicializa uma categoria de faixa de opções para a barra de faixa de opções.

CMFCRibbonCategory* AddCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage= CSize(16,
    16),
    CSize sizeLargeImage= CSize(32,
    32),
    int nInsertAt = -1,
    CRuntimeClass* pRTI= NULL);

Parâmetros

lpszName
[in] Nome da categoria da faixa de opções.

uiSmallImagesResID
[in] ID do recurso da pequena lista de imagens para a categoria da faixa de opções.

uiLargeImagesResID
[in] ID do recurso da lista de imagens grandes para a categoria da faixa de opções.

sizeSmallImage
[in] Especifica o tamanho de imagens pequenas para a categoria da faixa de opções.

sizeLargeImage
[in] Especifica o tamanho de imagens grandes para a categoria da faixa de opções.

nInsertAt
[in] Índice baseado em zero do local da categoria.

pRTI
[in] Ponteiro para uma Classe CMFCRibbonCategory de tempo de execução de classe para criar dinamicamente uma categoria de faixa de opções em tempo de execução.

Valor de retorno

Um ponteiro para a nova categoria de faixa de opções se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

Se o parâmetro pRTI não for NULL, a categoria da faixa de opções será criada dinamicamente usando a classe de tempo de execução.

Exemplo

O seguinte exemplo demonstra como usar o método AddCategory na classe CMFCRibbonBar.

// Add "Home" category.
// CMFCRibbonBar m_wndRibbonBar
strTemp.LoadString(IDS_RIBBON_HOME);
CMFCRibbonCategory *pCategoryHome = m_wndRibbonBar.AddCategory(strTemp,
                                                               IDB_WRITESMALL, IDB_WRITELARGE);

`CMFCRibbonBar::AddContextCategory`

Cria e inicializa uma categoria de contexto para a barra de faixa de opções.

CMFCRibbonCategory* AddContextCategory(
    LPCTSTR lpszName,
    LPCTSTR lpszContextName,
    UINT uiContextID,
    AFX_RibbonCategoryColor clrContext,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32),
    CRuntimeClass* pRTI = NULL);

Parâmetros

lpszName
[in] Nome da categoria.

lpszContextName
[in] Nome da legenda da categoria de contexto.

uiContextID
[in] ID de contexto.

clrContext
[in] Cor da legenda da categoria de contexto.

uiSmallImagesResID
[in] ID do recurso da pequena imagem de uma categoria de contexto.

uiLargeImagesResID
[in] ID do recurso da imagem grande de uma categoria de contexto.

sizeSmallImage
[in] Tamanho de uma imagem pequena.

sizeLargeImage
[in] Tamanho de uma imagem grande.

pRTI
[in] Ponteiro para uma classe de runtime.

Valor de retorno

Um ponteiro para a categoria recém-criada ou NULL , se o CreateObject método de pRTI não puder criar a categoria especificada.

Comentários

Use essa função para adicionar uma categoria de contexto. As categorias de contexto são um tipo especial de categoria que pode ser mostrada ou ocultada no runtime, dependendo do contexto atual do aplicativo. Por exemplo, quando o usuário seleciona um objeto, você pode exibir guias especiais com categorias de contexto, que você usa para alterar o objeto selecionado específico.

A cor de uma categoria de contexto pode ter um dos seguintes valores:

AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

`CMFCRibbonBar::AddMainCategory`

Cria uma categoria de faixa de opções principal para a barra de faixa de opções.

CMFCRibbonMainPanel* AddMainCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Parâmetros

lpszName
[in] Nome da categoria da faixa de opções principal.

uiSmallImagesResID
[in] ID do recurso de imagens pequenas.

uiLargeImagesResID
[in] ID do recurso de imagens grandes.

sizeSmallImage
[in] O tamanho de imagens pequenas.

sizeLargeImage
[in] O tamanho de imagens grandes.

Valor de retorno

Ponteiro para a nova categoria da faixa de opções principal se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

Se uma categoria de faixa de opções principal já existir, ela será excluída.

Exemplo

O seguinte exemplo demonstra como usar o método AddMainCategory na classe CMFCRibbonBar.

// m_wndRibbonBar is declared as a protected member variable
// CMFCRibbonBar m_wndRibbonBar.
// strTemp is a CString variable.
strTemp.LoadString(IDS_RIBBON_FILE);
CMFCRibbonMainPanel *pMainPanel = m_wndRibbonBar.AddMainCategory(strTemp,
                                                                 IDB_FILESMALL, IDB_FILELARGE);

`CMFCRibbonBar::AddPrintPreviewCategory`

Cria uma categoria de visualização de impressão na barra de faixa de opções.

CMFCRibbonCategory* AddPrintPreviewCategory();

Valor de retorno

Um ponteiro para a nova categoria de faixa de opções se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

Esse método cria uma categoria de faixa de opções e os controles necessários para fornecer uma visualização de impressão.

`CMFCRibbonBar::AddQATOnlyCategory`

Cria uma categoria de faixa de opções da barra de ferramentas de acesso rápido.

CMFCRibbonCategory* AddQATOnlyCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    CSize sizeSmallImage = CSize(16,
    16));

Parâmetros

lpszName
[in] Nome da categoria.

uiSmallImagesResID
[in] ID do recurso da lista de imagens para a categoria.

sizeSmallImage
[in] Tamanho das imagens para elementos da faixa de opções na categoria.

Valor de retorno

Um ponteiro para a nova categoria se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

A categoria de faixa de opções da barra de ferramentas de acesso rápido só é usada na caixa de diálogo de personalização da barra de ferramentas de acesso rápido.

`CMFCRibbonBar::AddToTabs`

Adiciona o elemento de faixa de opções especificado à linha de guias da barra de faixa de opções.

void AddToTabs(CMFCRibbonBaseElement* pElement);

Parâmetros

pElement
[in] Ponteiro para um elemento de faixa de opções.

Comentários

O elemento da faixa de opções é posicionado antes de qualquer botão do sistema.

`CMFCRibbonBar::CMFCRibbonBar`

Constrói e inicializa um objeto CMFCRibbonBar.

CMFCRibbonBar(BOOL bReplaceFrameCaption = TRUE);

Parâmetros

bReplaceFrameCaption
[in] TRUE para a barra de faixa de opções substituir a legenda da janela de quadro principal; FALSE para localizar a barra de faixa de opções sob a legenda da janela de quadro principal.

Comentários

`CMFCRibbonBar::Create`

Cria uma janela para a barra de faixa de opções.

BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Parâmetros

pParentWnd
[in] Ponteiro para a janela pai da barra de faixa de opções.

dwStyle
[in] Uma combinação lógica de estilos para a nova janela.

nID
[in] ID da nova janela.

Valor de retorno

TRUE se a janela foi criada; caso contrário, FALSE.

Comentários

Exemplo

O exemplo a seguir demonstra como usar o método Create da classe CMFCRibbonBar.

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.Create(this, WS_CHILD | CBRS_TOP);

`CMFCRibbonBar::CreateEx`

Cria uma janela para a barra de faixa de opções.

BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle = 0,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Parâmetros

pParentWnd
[in] Ponteiro para a janela pai da barra de faixa de opções.

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

dwStyle
[in] Uma combinação lógica de estilos para a nova janela.

nID
[in] ID da nova janela.

Valor de retorno

TRUE se a janela foi criada; caso contrário, FALSE.

Comentários

`CMFCRibbonBar::DeactivateKeyboardFocus`

Fecha todos os controles de dica de chave na barra de faixa de opções.

void DeactivateKeyboardFocus(BOOL bSetFocus = TRUE);

Parâmetros

bSetFocus
[in] TRUE para definir o foco para a janela pai da barra de faixa de opções.

Comentários

`CMFCRibbonBar::DrawMenuImage`

Desenha a imagem para um botão de menu.

BOOL DrawMenuImage(
    CDC* pDC,
    const CMFCToolBarMenuButton* pMenuItem,
    const CRect& rectImage);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para o botão de menu.

pMenuItem
[in] Ponteiro para um botão de menu da barra de ferramentas.

rectImage
[in] O retângulo de exibição para um botão de menu.

Valor de retorno

TRUE se a imagem tiver sido desenhada; caso contrário FALSE.

Comentários

`CMFCRibbonBar::DWMCompositionChanged`

Ajusta a exibição da barra de faixa de opções quando a composição do DWM (Gerenciador de Janelas da Área de Trabalho) está habilitada ou desabilitada.

virtual void DWMCompositionChanged();

Comentários

`CMFCRibbonBar::EnableKeyTips`

Habilita ou desabilita o recurso de dica de chave para a barra de faixa de opções.

void EnableKeyTips(BOOL bEnable = TRUE);

Parâmetros

bEnable
[in] TRUE para habilitar o recurso de dicas de chave; FALSE para desabilitar o recurso de dicas de chave.

Comentários

Quando você habilita esse recurso, as dicas de chave são exibidas quando o usuário pressiona as teclas ALT ou F10. Quando o usuário pressiona a tecla ALT, as dicas de chave são exibidas com um atraso de 200 milissegundos. Esse atraso permite que atalhos sejam executados para que a tecla ALT pressionada não interfira em outras combinações que incluam a tecla ALT.

`CMFCRibbonBar::EnablePrintPreview`

Habilita ou desabilita o recurso Visualização de Impressão.

void EnablePrintPreview(BOOL bEnable = TRUE);

Parâmetros

bEnable
[in] TRUE para habilitar o recurso Visualização de Impressão; FALSE para desabilitar o recurso Visualização de Impressão.

Comentários

Se bEnable for FALSE e houver uma categoria de visualização de impressão, ela será excluída.

Por padrão, o recurso Visualização de Impressão está habilitado.

`CMFCRibbonBar::EnableToolTips`

Habilita ou desabilita dicas de ferramentas e descrições opcionais da dica de ferramenta na barra de faixa de opções.

void EnableToolTips(
    BOOL bEnable = TRUE,
    BOOL bEnableDescr = TRUE);

Parâmetros

bEnable
[in] TRUE para habilitar dicas de ferramentas na barra de faixa de opções; FALSE para desabilitar dicas de ferramenta na barra de faixa de opções.

bEnableDescr
[in] TRUE para habilitar descrições de dica de ferramenta na dica de ferramenta; FALSE para desabilitar descrições da dica de ferramenta na dica de ferramenta.

Comentários

O parâmetro bEnable determina se as dicas de ferramenta são exibidas quando o cursor do mouse focaliza um elemento de faixa de opções. O parâmetro bEnableDescr determina se o texto descritivo adicional aparece com o texto da dica de ferramenta.

`CMFCRibbonBar::FindByData`

Recupera um ponteiro para um elemento de faixa de opções se ele tiver os dados e a visibilidade especificados.

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

Parâmetros

dwData
[in] Os dados associados a um elemento de faixa de opções.

bVisibleOnly
[in] TRUE para pesquisar apenas elementos de faixa de opções visíveis; FALSE para pesquisar todos os elementos da faixa de opções.

Valor de retorno

Um ponteiro para um elemento de faixa de opções se ele tiver os dados e a visibilidade especificados; caso contrário, NULL.

Comentários

Um elemento de faixa de opções é qualquer controle que você pode adicionar à faixa de opções, como um botão de faixa de opções ou uma categoria de faixa de opções ou um controle deslizante da faixa de opções.

`CMFCRibbonBar::FindByID`

Recupera um ponteiro para o elemento da faixa de opções que tem a ID de comando e os valores de pesquisa especificados.

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE,
    BOOL bExcludeQAT = FALSE) const;

Parâmetros

uiCmdID
[in] ID de comando para um elemento de faixa de opções.

bVisibleOnly
[in] TRUE para pesquisar apenas elementos de faixa de opções visíveis; FALSE para pesquisar todos os elementos da faixa de opções.

bExcludeQAT
[in] TRUE para excluir elementos da barra de ferramentas de acesso rápido da pesquisa; caso contrário, FALSE.

Valor de retorno

Um ponteiro para um elemento de faixa de opções se ele tiver a ID de comando e os valores de pesquisa especificados; caso contrário, NULL.

Comentários

Um elemento de faixa de opções é qualquer controle de faixa de opções que pode ser adicionado à faixa de opções, como um botão de faixa de opções ou uma categoria de faixa de opções, ou um controle deslizante de faixa de opções.

Em geral, pode haver mais de um elemento de faixa de opções com a mesma ID de comando. Para obter ponteiros para todos os elementos da faixa de opções que usam uma ID de comando especificada, use o método CMFCRibbonBar::GetElementsByID.

`CMFCRibbonBar::FindCategoryIndexByData`

Recupera o índice da categoria de faixa de opções que contém os dados especificados.

int FindCategoryIndexByData(DWORD dwData) const;

Parâmetros

dwData
[in] Os dados associados a uma categoria de faixa de opções.

Valor de retorno

O índice baseado em zero de uma categoria de faixa de opções se o método tiver sido bem-sucedido; caso contrário, -1.

`CMFCRibbonBar::ForceRecalcLayout`

Ajusta o layout de todos os itens na barra de faixa de opções e na janela pai e redesenha a janela inteira.

void ForceRecalcLayout();

Comentários

`CMFCRibbonBar::GetActiveCategory`

Recupera um ponteiro para a categoria de faixa de opções ativa.

CMFCRibbonCategory* GetActiveCategory() const;

Valor de retorno

Um ponteiro para a categoria de faixa de opções ativa; ou NULL se nenhuma categoria estiver ativa.

Comentários

Uma categoria estará ativa se tiver o foco. Por padrão, a categoria ativa é a primeira categoria no lado esquerdo da barra de faixa de opções.

A categoria principal é exibida quando o usuário pressiona o botão do aplicativo e não pode ser a categoria ativa.

`CMFCRibbonBar::GetApplicationButton`

Recupera um ponteiro para o botão de aplicativo.

CMFCRibbonApplicationButton* GetApplicationButton() const;

Valor de retorno

Um ponteiro para o botão de aplicativo; ou NULL se o botão não tiver sido definido.

`CMFCRibbonBar::GetCaptionHeight`

Recupera a altura da área de legenda para a barra de faixa de opções.

int GetCaptionHeight() const;

Valor de retorno

A altura, em pixels, da área de legenda para a barra de faixa de opções.

Comentários

`CMFCRibbonBar::GetCategory`

Recupera um ponteiro para a categoria de faixa de opções no índice especificado.

CMFCRibbonCategory* GetCategory(int nIndex) const;

Parâmetros

nIndex
[in] O índice baseado em zero de uma categoria de faixa de opções na lista de categorias de faixa de opções contidas na barra de faixa de opções.

Valor de retorno

Um ponteiro para a categoria da faixa de opções no índice especificado; caso contrário, NULL, se nIndex estava fora do intervalo.

`CMFCRibbonBar::GetCategoryCount`

Recupera o número de categorias de faixa de opções na barra de faixa de opções.

int GetCategoryCount() const;

Valor de retorno

O número das categorias de faixa de opções na barra de faixa de opções.

`CMFCRibbonBar::GetCategoryHeight`

Recupera a altura da categoria.

int GetCategoryHeight() const;

Valor de retorno

A altura da categoria.

Comentários

A altura da categoria inclui a altura da guia categoria.

`CMFCRibbonBar::GetCategoryIndex`

Recupera o índice da categoria de faixa de opções especificada.

int GetCategoryIndex(CMFCRibbonCategory* pCategory) const;

Parâmetros

pCategory
[in] Ponteiro para uma categoria de faixa de opções.

Valor de retorno

O índice baseado em zero de uma categoria de faixa de opções especificada por pCategory; ou -1, se a categoria da faixa de opções não for encontrada.

`CMFCRibbonBar::GetContextName`

Recupera o nome da legenda da categoria de contexto especificada por uma ID de contexto.

BOOL GetContextName(
    UINT uiContextID,
    CString& strName) const;

Parâmetros

uiContextID
[in] Uma ID de contexto de categoria de faixa de opções.

strName
[out] O nome de uma legenda de categoria de contexto.

Valor de retorno

TRUE se o método tiver sido bem-sucedido; caso contrário, FALSE, se uiContextID era zero ou a legenda da categoria de contexto não foi encontrada.

`CMFCRibbonBar::GetDroppedDown`

Recupera o elemento de faixa de opções que está suspenso no momento.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor de retorno

O elemento de faixa de opções que está suspenso no momento; ou NULL, se nenhum elemento da faixa de opções estiver suspenso no momento.

Comentários

`CMFCRibbonBar::GetElementsByID`

Recupera uma matriz de ponteiros para todos os elementos da faixa de opções que têm uma ID de comando específica.

void GetElementsByID(
    UINT uiCmdID,
    CArray<CMFCRibbonBaseElement*,CMFCRibbonBaseElement*>& arButtons);

Parâmetros

uiCmdID
[in] ID de comando de um elemento de faixa de opções.

arButtons
[out] Uma matriz de ponteiros para elementos da faixa de opções.

Comentários

Vários elementos de faixa de opções podem ter a mesma ID de comando porque alguns elementos da faixa de opções podem ser copiados para a barra de ferramentas de acesso rápido.

`CMFCRibbonBar::GetHideFlags`

Recupera os sinalizadores que indicam quanto da barra de faixa de opções está visível.

DWORD GetHideFlags() const;

Valor de retorno

Os sinalizadores que indicam quanto da barra de faixa de opções está visível.

Comentários

A seguinte tabela lista a possível combinação de sinalizadores para o valor retornado:

Sinalizador	Descrição
`AFX_RIBBONBAR_HIDE_ELEMENTS`	A barra de faixa de opções é minimizada verticalmente e somente as guias de categoria, o botão principal e a barra de ferramentas de acesso rápido ficam visíveis.
`AFX_RIBBONBAR_HIDE_ALL`	A largura da barra de faixa de opções é menor que a largura mínima e está completamente oculta.

`CMFCRibbonBar::GetItemIDsList`

Recupera as IDs de comando para a coleção especificada de elementos de faixa de opções na barra de faixa de opções.

void GetItemIDsList(CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

Parâmetros

lstItems
[out] A lista de IDs de comando para elementos de faixa de opções que estão contidos na barra de faixa de opções.

bHiddenOnly
[in] TRUE para excluir elementos da faixa de opções que são exibidos; FALSE para incluir todos os elementos da faixa de opções na barra de faixa de opções.

Comentários

`CMFCRibbonBar::GetKeyboardNavigationLevel`

Recupera o nível de navegação atual à medida que o usuário pressiona as dicas de tecla contidas na barra de faixa de opções.

int GetKeyboardNavigationLevel() const;

Valor de retorno

O nível de navegação atual à medida que o usuário pressiona as dicas de tecla contidas na barra de faixa de opções. A seguinte tabela lista os possíveis valores retornados:

Valor	Descrição
-1	As dicas de tecla não são exibidas.
0	As dicas de tecla são exibidas.
1	O usuário pressionou uma dica de tecla exibida.

Comentários

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

Recupera o objeto de navegação de teclado atual na barra de faixa de opções.

CObject* GetKeyboardNavLevelCurrent() const;

Valor de retorno

O objeto de navegação de teclado atual na barra de faixa de opções; caso contrário NULL, se nenhum objeto exibir dicas de tecla no momento.

Comentários

O objeto que está atualmente exibindo dicas de tecla é o objeto de navegação de teclado atual.

`CMFCRibbonBar::GetKeyboardNavLevelParent`

Recupera o objeto de navegação do teclado pai na barra de faixa de opções.

CObject* GetKeyboardNavLevelParent() const;

Valor de retorno

O objeto de navegação do teclado pai na barra de faixa de opções; caso contrário, NULL.

Comentários

Quando o usuário pressiona uma dica de tecla na barra de faixa de opções, o objeto de navegação do teclado atual se torna o objeto de navegação do teclado pai.

`CMFCRibbonBar::GetMainCategory`

Recupera um ponteiro para a categoria de faixa de opções principal.

CMFCRibbonCategory* GetMainCategory() const;

Valor de retorno

Um ponteiro para a categoria da faixa de opções principal.

Comentários

A categoria principal da faixa de opções contém o painel principal da faixa de opções.

`CMFCRibbonBar::GetQATCommandsLocation`

Recupera o retângulo de exibição para a seção de comandos da barra de ferramentas de acesso rápido.

CRect GetQATCommandsLocation() const;

Valor de retorno

O retângulo de exibição para a seção de comandos da barra de ferramentas de acesso rápido.

Comentários

A seção de comandos do retângulo de exibição não inclui o botão de personalização.

`CMFCRibbonBar::GetQATDroppedDown`

Recupera um ponteiro para o elemento de faixa de opções na barra de ferramentas de acesso rápido que tem seu menu pop-up suspenso.

CMFCRibbonBaseElement* GetQATDroppedDown();

Valor de retorno

Um ponteiro para o elemento da faixa de opções na barra de ferramentas de acesso rápido que tem seu menu pop-up suspenso.

Comentários

`CMFCRibbonBar::GetQuickAccessCommands`

Recupera uma lista de IDs de comando para os elementos da faixa de opções na barra de ferramentas de acesso rápido.

void GetQuickAccessCommands(CList<UINT,UINT>& lstCommands);

Parâmetros

lstCommands
[out] A lista de IDs de comando para os elementos da faixa de opções na barra de ferramentas de acesso rápido.

Comentários

A lista não contém elementos de faixa de opções que são separadores de controle.

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

Recupera o retângulo de exibição para a barra de ferramentas de acesso rápido.

CRect GetQuickAccessToolbarLocation() const;

Valor de retorno

O retângulo de exibição para a barra de ferramentas de acesso rápido.

Comentários

`CMFCRibbonBar::GetTabTrancateRatio`

Recupera a redução de tamanho percentual na largura de exibição das guias de categoria.

int GetTabTrancateRatio() const;

Valor de retorno

A redução de tamanho percentual na largura de exibição das guias de categoria.

Comentários

A largura das guias de categoria é reduzida quando não há espaço suficiente na barra de faixa de opções.

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

Recupera o tamanho grande da largura da dica de ferramenta para a barra de faixa de opções.

int GetTooltipFixedWidthLargeImage() const;

Valor de retorno

O tamanho grande da largura da dica de ferramenta em pixels.

Comentários

Se o tamanho grande da largura da dica de ferramenta é 0, a largura varia.

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

Recupera o tamanho regular da largura da dica de ferramenta para a barra de faixa de opções.

int GetTooltipFixedWidthRegular() const;

Valor de retorno

O tamanho regular da largura da dica de ferramenta em pixels.

Comentários

Se o tamanho regular da largura da dica de ferramenta é 0, a largura varia.

`CMFCRibbonBar::GetVisibleCategoryCount`

Recupera o número de categorias visíveis na barra de faixa de opções.

int GetVisibleCategoryCount() const;

Valor de retorno

O número de categorias visíveis na barra de faixa de opções.

Comentários

`CMFCRibbonBar::HideAllContextCategories`

Oculta todas as categorias de contexto na barra de faixa de opções.

BOOL HideAllContextCategories();

Valor de retorno

TRUE se pelo menos uma categoria de contexto estava oculta; caso contrário, FALSE.

Comentários

Se uma categoria de contexto estiver ativa, a categoria ativa será redefinida para a primeira categoria visível na lista de categorias.

`CMFCRibbonBar::HideKeyTips`

Oculta todas as dicas de tecla na barra de faixa de opções.

void HideKeyTips();

Comentários

`CMFCRibbonBar::HitTest`

Recupera um ponteiro para o elemento de faixa de opções especificado pelo local do ponto.

virtual CMFCRibbonBaseElement* HitTest(
    CPoint point,
    BOOL bCheckActiveCategory= FALSE,
    BOOL bCheckPanelCaption= FALSE);

Parâmetros

point
[in] Local do ponto nas coordenadas da barra de faixa de opções.

bCheckActiveCategory
[in] TRUE para pesquisar a categoria ativa; FALSE para não pesquisar a categoria ativa.

bCheckPanelCaption
[in] TRUE para testar a legenda do painel da faixa de opções com o ponto localizado nele; FALSE para não testar a legenda do painel da faixa de opções com o ponto localizado nele. Consulte a seção Comentários para obter mais informações.

Valor de retorno

Um ponteiro para o elemento de faixa de opções localizado no ponto especificado; caso contrário NULL, se o ponto não estiver localizado em um elemento de faixa de opções.

Comentários

A legenda do painel da faixa de opções com o ponto localizado nele não é testada, a menos que o parâmetro bCheckActiveCategory seja TRUE.

`CMFCRibbonBar::IsKeyTipEnabled`

Indica se o recurso de dicas de ferramentas está habilitado.

BOOL IsKeyTipEnabled() const;

Valor de retorno

TRUE se o recurso de dicas de ferramenta estiver habilitado; caso contrário, FALSE.

`CMFCRibbonBar::IsMainRibbonBar`

Indica se a barra de faixa de opções é a barra de faixa de opções primária.

virtual BOOL IsMainRibbonBar() 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 a barra de faixa de opções é a barra de faixa de opções primária.

`CMFCRibbonBar::IsPrintPreviewEnabled`

Indica se o recurso Visualização de Impressão está habilitado.

BOOL IsPrintPreviewEnabled() const;

Valor de retorno

TRUE se o recurso Visualização de Impressão estiver habilitado; caso contrário, FALSE.

`CMFCRibbonBar::IsQATEmpty`

Indica se a barra de ferramentas de acesso rápido contém botões de comando.

BOOL IsQATEmpty() const;

Valor de retorno

TRUE se a barra de ferramentas de acesso rápido contiver botões de comando; caso contrário FALSE.

Comentários

`CMFCRibbonBar::IsQuickAccessToolbarOnTop`

Indica se a barra de ferramentas de acesso rápido está localizada sobre ou sob a barra de faixa de opções.

BOOL IsQuickAccessToolbarOnTop() const;

Valor de retorno

TRUE se a barra de ferramentas de acesso rápido estiver localizada na barra de faixa de opções; FALSE se a barra de ferramentas de acesso rápido estiver localizada sob a barra de faixa de opções.

`CMFCRibbonBar::IsReplaceFrameCaption`

Indica se a barra de faixa de opções substitui ou está na legenda da janela de quadro principal.

BOOL IsReplaceFrameCaption() const;

Valor de retorno

TRUE se a barra de faixa de opções substitui a legenda da janela de quadro principal; FALSE se a barra de faixa de opções está na legenda da janela de quadro principal.

`CMFCRibbonBar::IsShowGroupBorder`

Indica se os grupos de botões localizados na barra de faixa de opções exibem uma borda de grupo.

virtual BOOL IsShowGroupBorder(CMFCRibbonButtonsGroup* pGroup) const;

Parâmetros

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

Valor de retorno

Sempre retorna FALSE.

Comentários

Por padrão, esse método sempre retorna FALSE. Substitua esse método para indicar se os grupos de botões localizados na barra de faixa de opções exibem uma borda de grupo.

`CMFCRibbonBar::IsToolTipDescrEnabled`

Indica se as descrições da dica de ferramenta estão habilitadas.

BOOL IsToolTipDescrEnabled() const;

Valor de retorno

TRUE se as descrições da dica de ferramenta estão habilitadas; FALSE se as descrições da dica de ferramenta estão desabilitadas.

Comentários

As descrições da dica de ferramenta são texto descritivo adicional exibido com o texto da dica de ferramenta.

`CMFCRibbonBar::IsToolTipEnabled`

Indica se as dicas de ferramenta estão habilitadas ou desabilitadas para a barra de faixa de opções.

BOOL IsToolTipEnabled() const;

Valor de retorno

TRUE se as dicas de ferramenta estão habilitadas; FALSE se as dicas de ferramenta estão desabilitadas.

`CMFCRibbonBar::IsTransparentCaption`

Indica se a exibição está definida para o esquema de cores do Windows Aero.

BOOL IsTransparentCaption() const;

Valor de retorno

TRUE se o esquema de cores é o Windows Aero; caso contrário FALSE.

Comentários

`CMFCRibbonBar::OnClickButton`

Esse método é retido para compatibilidade com versões anteriores de aplicativos existentes e não deve ser usado para novo desenvolvimento.

virtual void OnClickButton(
    CMFCRibbonButton* pButton,
    CPoint point);

Parâmetros

pButton
[in] Ponteiro para o botão que foi clicado.

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

Comentários

`CMFCRibbonBar::OnEditContextMenu`

virtual void OnEditContextMenu(
    CMFCRibbonRichEditCtrl* pEdit,
    CPoint point);

Parâmetros

[in] pEdit
[in] point\

Comentários

`CMFCRibbonBar::OnRTLChanged`

Chamado pela estrutura quando o layout muda de direção.

virtual void OnRTLChanged(BOOL bIsRTL);

Parâmetros

bIsRTL
[in] TRUE se o layout é da direita para a esquerda; FALSE se o layout é da esquerda para a direita.

Comentários

Esse método ajusta o layout de todos os controles na barra de faixa de opções para a nova direção de layout.

`CMFCRibbonBar::OnSetAccData`

Esse método é interno para a Estrutura e não deve ser chamado do código do usuário.

BOOL OnSetAccData(long lVal);

Parâmetros

long lVal O índice do objeto acessível.

Valor de retorno

S_OK se bem-sucedido; caso contrário, FALSE ou S_FALSE.

Comentários

`CMFCRibbonBar::OnShowRibbonContextMenu`

virtual BOOL OnShowRibbonContextMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Parâmetros

[in] pWnd
[in] x
[in] y
[in] pHit\

Valor de retorno

Comentários

`CMFCRibbonBar::OnShowRibbonQATMenu`

virtual BOOL OnShowRibbonQATMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Parâmetros

[in] pWnd
[in] x
[in] y
[in] pHit\

Valor de retorno

Comentários

`CMFCRibbonBar::OnSysKeyDown`

Chamado pela estrutura quando o usuário pressiona a tecla F10 ou segura a tecla ALT e pressiona outra tecla.

BOOL OnSysKeyDown(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Parâmetros

pFrameWnd
[in] Ponteiro para a janela de quadro principal pai da barra de faixa de opções.

wParam
[in] Código de chave virtual da tecla que está sendo pressionada.

lParam
[in] Sinalizadores de estado do teclado quando a tecla foi pressionada.

Valor de retorno

TRUE se o evento de pressionamento de tecla foi processado; caso contrário FALSE.

Comentários

`CMFCRibbonBar::OnSysKeyUp`

Chamado pela estrutura quando o usuário libera a tecla F10, a tecla ALT ou uma tecla que foi pressionada enquanto a tecla ALT era mantida pressionada.

BOOL OnSysKeyUp(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Parâmetros

pFrameWnd
[in] Ponteiro para a janela de quadro principal pai da barra de faixa de opções.

wParam
[in] Código de tecla virtual da tecla que está sendo liberada.

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

Valor de retorno

TRUE se o evento de pressionamento de tecla foi processado; caso contrário FALSE.

Comentários

`CMFCRibbonBar::PopTooltip`

Remove uma dica de ferramenta do modo de exibição.

void PopTooltip();

Comentários

`CMFCRibbonBar::PreTranslateMessage`

Determina se a mensagem especificada é processada pela barra de faixa de opções.

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parâmetros

pMsg
[in] Ponteiro para uma mensagem.

Valor de retorno

TRUE se a mensagem foi processada pela barra de faixa de opções; caso contrário, FALSE.

Comentários

`CMFCRibbonBar::RecalcLayout`

Ajusta o layout de todos os controles na barra de faixa de opções.

virtual void RecalcLayout();

Comentários

Após o ajuste de layout, a exibição da barra de faixa de opções é atualizada.

`CMFCRibbonBar::RemoveAllCategories`

Exclui todas as categorias de faixa de opções da barra de faixa de opções.

void RemoveAllCategories();

Comentários

Esse método exclui todas as categorias de faixa de opções da memória e da lista de categorias.

`CMFCRibbonBar::RemoveAllFromTabs`

Remove todos os elementos da faixa de opções da área de guia.

void RemoveAllFromTabs();

Comentários

Use essa função se quiser remover todos os elementos que você adicionou à área de guia usando o método CMFCRibbonBar::AddToTabs.

`CMFCRibbonBar::RemoveCategory`

Exclui a categoria de faixa de opções especificada da barra de faixa de opções.

BOOL RemoveCategory(int nIndex);

Parâmetros

nIndex
[in] O índice baseado em zero de uma categoria na lista de categorias de faixa de opções contidas na barra de faixa de opções.

Valor de retorno

TRUE se a categoria de faixa de opções especificada tiver sido excluída; caso contrário, FALSE.

Comentários

A categoria de faixa de opções especificada é excluída da memória e da lista de categorias.

`CMFCRibbonBar::SetActiveCategory`

Define a categoria de faixa de opções especificada como a categoria ativa.

BOOL SetActiveCategory(
    CMFCRibbonCategory* pCategory,
    BOOL bForceRestore= FALSE);

Parâmetros

pCategory
[in] Uma categoria de faixa de opções que está contida na barra de faixa de opções.

bForceRestore
[in] TRUE para maximizar a barra de faixa de opções se ela está minimizada; FALSE para exibir a categoria ativa em uma janela pop-up se a barra de faixa de opções está minimizada.

Valor de retorno

TRUE se a categoria especificada foi definida como a categoria ativa; caso contrário FALSE.

Comentários

A categoria principal da faixa de opções não pode ser a categoria ativa.

Se a categoria especificada por pCategory não for exibida, ela não poderá ser definida como a categoria ativa.

`CMFCRibbonBar::SetActiveMDIChild`

Associa os botões do sistema na barra de faixa de opções que pertencem a uma janela filho da interface MDI à janela filho da MDI especificada.

void SetActiveMDIChild(CWnd* pWnd);

Parâmetros

pWnd
[in] Ponteiro para uma janela filho da MDI.

Comentários

`CMFCRibbonBar::SetApplicationButton`

Atribui um botão da faixa de opções do aplicativo à barra de faixa de opções.

void SetApplicationButton(
    CMFCRibbonApplicationButton* pButton,
    CSize sizeButton);

Parâmetros

pButton
[in] Um ponteiro para o botão da faixa de opções do aplicativo.

sizeButton
[in] O tamanho do botão da faixa de opções do aplicativo.

Comentários

O botão da faixa de opções do aplicativo é um botão arredondado grande localizado no canto superior esquerdo do controle Faixa de Opções.

Exemplo

O seguinte exemplo demonstra como usar o método SetApplicationButton na classe CMFCRibbonBar.

// Init main button:
// CMFCRibbonApplicationButton m_MainButton
m_MainButton.SetImage(IDB_MAIN);
m_MainButton.SetText(_T("\nf"));
m_MainButton.SetToolTipText(strTemp);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetApplicationButton(&m_MainButton, CSize(45, 45));

`CMFCRibbonBar::SetElementKeys`

Define as dicas de tecla para todos os elementos da faixa de opções que têm a ID de comando especificada.

BOOL SetElementKeys(
    UINT uiCmdID,
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys= NULL);

Parâmetros

uiCmdID
[in] A ID de comando de um elemento de faixa de opções.

lpszKeys
[in] A dica de tecla.

lpszMenuKeys
[in] A dica de tecla do menu.

Valor de retorno

TRUE se as dicas de tecla de pelo menos um elemento de faixa de opções estiverem definidas; caso contrário, FALSE.

Comentários

A dica de tecla de menu opcional é para elementos de faixa de opções com um botão de divisão que abre um menu pop-up.

`CMFCRibbonBar::SetKeyboardNavigationLevel`

Define o nível de navegação do teclado à medida que o usuário pressiona as dicas de tecla contidas na barra de faixa de opções.

void SetKeyboardNavigationLevel(
    CObject* pLevel,
    BOOL bSetFocus = TRUE);

Parâmetros

pLevel
[in] Ponteiro para o objeto de navegação do teclado atual.

bSetFocus
[in] TRUE para definir o foco do teclado para a barra de faixa de opções.

Comentários

A navegação do teclado da barra de faixa de opções é iniciada quando o usuário pressiona a tecla ALT ou F10. O usuário seleciona o próximo nível de navegação pressionando uma dica de tecla na barra de faixa de opções. O usuário pode retornar ao nível da navegação anterior pressionando a tecla de escape.

`CMFCRibbonBar::SetMaximizeMode`

Ajusta a barra de faixa de opções quando o tamanho da janela de uma janela filho da interface MDI entra ou sai do estado maximizado.

void SetMaximizeMode(
    BOOL bMax,
    CWnd* pWnd = NULL);

Parâmetros

bMax
[in] TRUE para exibir os botões do sistema para uma janela filho MDI na barra de faixa de opções; FALSE para remover os botões do sistema para uma janela filho MDI da barra de faixa de opções.

pWnd
[in] Ponteiro para a janela de quadro principal para a barra de faixa de opções.

Comentários

A barra de faixa de opções exibe botões do sistema para uma janela filho MDI na linha de guia quando uma janela filho MDI é maximizada.

`CMFCRibbonBar::SetQuickAccessCommands`

Adiciona um ou mais elementos de faixa de opções à Barra de Ferramentas de Acesso Rápido.

void SetQuickAccessCommands(
    const CList<UINT,UINT>& lstCommands,
    BOOL bRecalcLayout=TRUE);

Parâmetros

lstCommands
[in] A lista de comandos a serem colocados na Barra de Ferramentas de Acesso Rápido.

bRecalcLayout
[in] TRUE se quiser redesenhar a faixa de opções depois de adicionar os elementos da faixa de opções; caso contrário, FALSE.

Exemplo

O seguinte exemplo demonstra como usar o método SetQuickAccessCommands na classe CMFCRibbonBar.

// Add quick access commands to the toolbar
CList<UINT, UINT> lstQATCmds;

lstQATCmds.AddTail(ID_FILE_NEW);
lstQATCmds.AddTail(ID_FILE_OPEN);
lstQATCmds.AddTail(ID_FILE_SAVE);
lstQATCmds.AddTail(ID_FILE_PRINT_DIRECT);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessCommands(lstQATCmds);

`CMFCRibbonBar::SetQuickAccessDefaultState`

Define a barra de ferramentas de acesso rápido como o estado padrão.

void SetQuickAccessDefaultState(const CMFCRibbonQuickAccessToolBarDefaultState& state);

Parâmetros

state
[in] O estado padrão da barra de ferramentas de acesso rápido.

Comentários

O estado da barra de ferramentas de acesso rápido inclui uma lista de comandos e sua visibilidade.

Exemplo

O seguinte exemplo demonstra como usar o método SetQuickAccessDefaultState na classe CMFCRibbonBar.

CMFCRibbonQuickAccessToolBarDefaultState *qaToolBarState =
    new CMFCRibbonQuickAccessToolBarDefaultState();
qaToolBarState->AddCommand(ID_FILE_NEW, true);
qaToolBarState->AddCommand(ID_FILE_OPEN, true);
// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessDefaultState(*qaToolBarState);

`CMFCRibbonBar::SetQuickAccessToolbarOnTop`

Posiciona a barra de ferramentas de acesso rápido acima ou abaixo da barra de faixa de opções.

void SetQuickAccessToolbarOnTop(BOOL bOnTop);

Parâmetros

bOnTop
[in] TRUE para posicionar a barra de ferramentas de acesso rápido acima da barra de faixa de opções; FALSE para posicionar a barra de ferramentas de acesso rápido abaixo da barra de faixa de opções.

`CMFCRibbonBar::SetTooltipFixedWidth`

Define os tamanhos regulares e grandes das larguras fixas da dica de ferramenta para a barra de faixa de opções.

void SetTooltipFixedWidth(
    int nWidthRegular,
    int nWidthLargeImage);

Parâmetros

nWidthRegular
[in] A largura, em pixels, de uma dica de ferramenta de tamanho fixo regular.

nWidthLargeImage
[in] A largura, em pixels, de uma dica de ferramenta de tamanho fixo grande.

Comentários

Definir um parâmetro como 0 faz com que a largura correspondente varie.

`CMFCRibbonBar::ShowCategory`

Mostra ou oculta a categoria de faixa de opções.

void ShowCategory(
    int nIndex,
    BOOL bShow=TRUE);

Parâmetros

nIndex
[in] O índice da categoria da faixa de opções.

bShow
[in] Se TRUE, mostrar a categoria da faixa de opções; caso contrário, ocultar a categoria da faixa de opções.

`CMFCRibbonBar::ShowContextCategories`

Mostra ou oculta as categorias de contexto que têm a ID especificada.

void ShowContextCategories(
    UINT uiContextID,
    BOOL bShow=TRUE);

Parâmetros

uiContextID
[in] A ID da categoria de contexto.

bShow
[in] Se TRUE, mostrar as categorias que têm a ID especificada; caso contrário, ocultar as categorias que têm a ID especificada.

`CMFCRibbonBar::ShowKeyTips`

Mostra as dicas de chave para cada elemento de faixa de opções na barra de faixa de opções.

void ShowKeyTips();

Comentários

`CMFCRibbonBar::ToggleMimimizeState`

Alterna a barra de faixa de opções entre os estados minimizado e maximizado.

void ToggleMimimizeState();

Comentários

O erro de ortografia no nome do método é um problema conhecido.

No estado minimizado, o controle da faixa de opções está oculto e somente as guias são exibidas. Quando o usuário clica em uma guia, o controle da faixa de opções é exibido como uma janela pop-up. A janela é fechada quando o usuário clica ou executa um comando.

`CMFCRibbonBar::TranslateChar`

Determina se o código de caractere de pressionamento de tecla especificado é processado pela barra de faixa de opções.

virtual BOOL TranslateChar(UINT nChar);

Parâmetros

nChar
[in] Um código de caractere de pressionamento de tecla do usuário.

Valor de retorno

TRUE se o caractere foi processado pela faixa de opções; caso contrário, FALSE.

Comentários

O recurso dicas de tecla permite que os usuários naveguem pela barra de faixa de opções usando o teclado.

`CMFCRibbonBar::GetFocused`

Retorna um elemento focalizado.

virtual CMFCRibbonBaseElement* GetFocused();

Valor de retorno

Um ponteiro para um elemento focado ou NULL.

Comentários

`CMFCRibbonBar::IsWindows7Look`

Indica se a faixa de opções tem uma aparência do Windows 7 (botão de aplicativo retangular pequeno).

BOOL IsWindows7Look() const;

Valor de retorno

TRUE se a faixa de opções tem uma aparência do Windows 7; caso contrário, FALSE.

Comentários

`CMFCRibbonBar::LoadFromResource`

Sobrecarregado. Carrega uma Barra de Faixa de Opções dos recursos do aplicativo.

virtual BOOL LoadFromResource(
    UINT uiXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

virtual BOOL LoadFromResource(
    LPCTSTR lpszXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

Parâmetros

uiXMLResID
Especifica a ID do recurso da cadeia de caracteres XML com informações da Barra de Faixa de Opções.

lpszResType
Especifica o tipo do recurso localizado em uiXMLResID.

hInstance
Identificador para o módulo cujo arquivo executável contém o recurso. Se hInstance for NULL, o sistema carregará o recurso do módulo que foi usado para criar o processo atual.

lpszXMLResID
Especifica a ID do recurso (na forma de cadeia de caracteres) com informações da Barra de Faixa de Opções.

Valor de retorno

TRUE se o carregamento for bem-sucedido; caso contrário, FALSE.

Comentários

`CMFCRibbonBar::SaveToXMLBuffer`

Salva a Barra de Faixa de Opções em um buffer.

UINT SaveToXMLBuffer(LPBYTE* ppBuffer) const;

Parâmetros

ppBuffer
Quando essa função retorna, ppBuffer aponta para um buffer alocado por esse método e contém informações da Barra de Faixa de Opções no formato XML.

Valor de retorno

TRUE se for bem-sucedido, caso contrário, FALSE.

Comentários

`CMFCRibbonBar::SaveToXMLFile`

Salva a Barra de Faixa de Opções em um arquivo XML.

BOOL SaveToXMLFile(LPCTSTR lpszFilePath) const;

Parâmetros

lpszFilePath
Especifica o arquivo de saída.

Valor de retorno

TRUE se for bem-sucedido, caso contrário, FALSE.

Comentários

`CMFCRibbonBar::SetWindows7Look`

Habilita ou desabilita uma aparência do Windows 7 (botão de aplicativo retangular pequeno) para a Faixa de Opções.

void SetWindows7Look(
    BOOL bWindows7Look,
    BOOL bRecalc = TRUE);

Parâmetros

bWindows7Look
TRUE define uma aparência do Windows 7; caso contrário, FALSE.

bRecalc
TRUE recalcula o layout da faixa de opções; caso contrário, FALSE.

Comentários

Confira também

Gráfico da hierarquia
Classes
Classe CPane
Classe CMFCRibbonCategory
Classe CMFCRibbonPanel
Classe CMFCRibbonBaseElement
Guia passo a passo: Como atualizar o aplicativo Scribble MFC

Compartilhar via

Classe CMFCRibbonBar

Sintaxe

Membros

Construtores públicos

Métodos públicos

Comentários

Hierarquia de herança

Requisitos

CMFCRibbonBar::ActivateContextCategory

Parâmetros

Valor de retorno

CMFCRibbonBar::AddCategory

Parâmetros

Valor de retorno

Comentários

Exemplo

CMFCRibbonBar::AddContextCategory

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::AddMainCategory

Parâmetros

Valor de retorno

Comentários

Exemplo

CMFCRibbonBar::AddPrintPreviewCategory

Valor de retorno

Comentários

CMFCRibbonBar::AddQATOnlyCategory

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::AddToTabs

Parâmetros

Comentários

CMFCRibbonBar::CMFCRibbonBar

Parâmetros

Comentários

CMFCRibbonBar::Create

Parâmetros

Valor de retorno

Comentários

Exemplo

CMFCRibbonBar::CreateEx

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::DeactivateKeyboardFocus

Parâmetros

Comentários

CMFCRibbonBar::DrawMenuImage

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::DWMCompositionChanged

Comentários

CMFCRibbonBar::EnableKeyTips

Parâmetros

Comentários

CMFCRibbonBar::EnablePrintPreview

Parâmetros

Comentários

CMFCRibbonBar::EnableToolTips

Parâmetros

Comentários

CMFCRibbonBar::FindByData

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::FindByID

Parâmetros

Valor de retorno

Comentários

CMFCRibbonBar::FindCategoryIndexByData

Parâmetros

Valor de retorno

CMFCRibbonBar::ForceRecalcLayout

Comentários

CMFCRibbonBar::GetActiveCategory

Classe `CMFCRibbonBar`

`CMFCRibbonBar::ActivateContextCategory`

`CMFCRibbonBar::AddCategory`

`CMFCRibbonBar::AddContextCategory`

`CMFCRibbonBar::AddMainCategory`

`CMFCRibbonBar::AddPrintPreviewCategory`

`CMFCRibbonBar::AddQATOnlyCategory`

`CMFCRibbonBar::AddToTabs`

`CMFCRibbonBar::CMFCRibbonBar`

`CMFCRibbonBar::Create`

`CMFCRibbonBar::CreateEx`

`CMFCRibbonBar::DeactivateKeyboardFocus`

`CMFCRibbonBar::DrawMenuImage`

`CMFCRibbonBar::DWMCompositionChanged`

`CMFCRibbonBar::EnableKeyTips`

`CMFCRibbonBar::EnablePrintPreview`

`CMFCRibbonBar::EnableToolTips`

`CMFCRibbonBar::FindByData`

`CMFCRibbonBar::FindByID`

`CMFCRibbonBar::FindCategoryIndexByData`

`CMFCRibbonBar::ForceRecalcLayout`

`CMFCRibbonBar::GetActiveCategory`

`CMFCRibbonBar::GetApplicationButton`

`CMFCRibbonBar::GetCaptionHeight`

`CMFCRibbonBar::GetCategory`

`CMFCRibbonBar::GetCategoryCount`

`CMFCRibbonBar::GetCategoryHeight`

`CMFCRibbonBar::GetCategoryIndex`

`CMFCRibbonBar::GetContextName`

`CMFCRibbonBar::GetDroppedDown`

`CMFCRibbonBar::GetElementsByID`

`CMFCRibbonBar::GetHideFlags`

`CMFCRibbonBar::GetItemIDsList`

`CMFCRibbonBar::GetKeyboardNavigationLevel`

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

`CMFCRibbonBar::GetKeyboardNavLevelParent`

`CMFCRibbonBar::GetMainCategory`

`CMFCRibbonBar::GetQATCommandsLocation`

`CMFCRibbonBar::GetQATDroppedDown`

`CMFCRibbonBar::GetQuickAccessCommands`

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

`CMFCRibbonBar::GetTabTrancateRatio`

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

`CMFCRibbonBar::GetVisibleCategoryCount`