Classe CMFCRibbonPanel

Artigo
08/04/2024

Implementa um painel que contém um conjunto de elementos de faixa de opções. Quando é desenhado, o painel exibe o maior número possível de elementos, considerando o tamanho do painel.

Para obter mais detalhes, confira o código-fonte localizado na pasta VC\atlmfc\src\mfc de sua instalação do Visual Studio.

Sintaxe

class CMFCRibbonPanel : public CObject

Membros

Construtores Protegidos

Nome	Descrição
CMFCRibbonPanel::CMFCRibbonPanel	Constrói e inicializa um objeto `CMFCRibbonPanel`.

Métodos públicos

Nome	Descrição
CMFCRibbonPanel::Add	Adiciona um elemento de faixa de opções ao painel.
CMFCRibbonPanel::AddSeparator	Adiciona um separador ao painel da faixa de opções.
CMFCRibbonPanel::AddToolBar	Adiciona uma barra de ferramentas ao painel da faixa de opções.
CMFCRibbonPanel::FindByData
CMFCRibbonPanel::FindByID	Retorna um elemento identificado por uma ID de comando especificada.
CMFCRibbonPanel::GetCaptionHeight
CMFCRibbonPanel::GetCount	Retorna o número de elementos no painel da faixa de opções.
CMFCRibbonPanel::GetData	Retorna os dados definidos pelo usuário associados ao painel.
CMFCRibbonPanel::GetDefaultButton
CMFCRibbonPanel::GetDroppedDown
CMFCRibbonPanel::GetElement	Retorna o elemento de faixa de opções localizado em um índice especificado.
CMFCRibbonPanel::GetElements	Recupera todos os elementos contidos no painel da faixa de opções.
CMFCRibbonPanel::GetElementsByID
CMFCRibbonPanel::GetFocused	Retorna um elemento focalizado.
CMFCRibbonPanel::GetGalleryRect	Retorna um retângulo delimitador do elemento Gallery.
CMFCRibbonPanel::GetHighlighted
CMFCRibbonPanel::GetIndex
CMFCRibbonPanel::GetItemIDsList
CMFCRibbonPanel::GetName
CMFCRibbonPanel::GetParentButton
CMFCRibbonPanel::GetParentCategory	Retorna a categoria pai do painel da faixa de opções.
CMFCRibbonPanel::GetParentMenuBar
CMFCRibbonPanel::GetPreferedMenuLocation
CMFCRibbonPanel::GetPressed
CMFCRibbonPanel::GetRect
CMFCRibbonPanel::GetVisibleElements	Obtém uma matriz de elementos visíveis.
CMFCRibbonPanel::HasElement
CMFCRibbonPanel::HitTest
CMFCRibbonPanel::HitTestEx
CMFCRibbonPanel::Insert	Insere um elemento de faixa de opções na posição informada.
CMFCRibbonPanel::InsertSeparator	Insere um separador na posição determinada.
CMFCRibbonPanel::IsCenterColumnVert	Especifica se todos os elementos do painel devem ser centralizados (alinhados) verticalmente, por coluna.
CMFCRibbonPanel::IsCollapsed
CMFCRibbonPanel::IsHighlighted
CMFCRibbonPanel::IsJustifyColumns	Especifica se todas as colunas do painel têm a mesma largura.
CMFCRibbonPanel::IsMainPanel
CMFCRibbonPanel::IsMenuMode
CMFCRibbonPanel::MakeGalleryItemVisible	Rola a galeria para deixar o elemento especificado da Faixa de Opções visível.
CMFCRibbonPanel::OnKey
CMFCRibbonPanel::RecalcWidths
CMFCRibbonPanel::Remove	Remove e, opcionalmente, exclui um elemento localizado no índice especificado.
CMFCRibbonPanel::RemoveAll	Remove todos os elementos do painel da faixa de opções.
CMFCRibbonPanel::Replace	Substitui um elemento por outro com base nos respectivos valores de índice.
CMFCRibbonPanel::ReplaceByID	Substitui um elemento por outro com base em uma ID de comando especificada.
CMFCRibbonPanel::SetCenterColumnVert	Ordena o painel de modo a alinhar os elementos verticalmente, por coluna.
CMFCRibbonPanel::SetData	Associa dados definidos pelo usuário ao painel da faixa de opções.
CMFCRibbonPanel::SetElementMenu	Atribui um menu pop-up ao elemento que tem a ID de comando fornecida.
CMFCRibbonPanel::SetElementRTC	Adiciona um elemento de faixa de opções especificado pelas informações da classe de runtime fornecidas ao painel da faixa de opções.
CMFCRibbonPanel::SetElementRTCByID	Adiciona um elemento de faixa de opções especificado pelas informações da classe de runtime fornecidas ao painel da faixa de opções.
CMFCRibbonPanel::SetFocused	Define o foco para o elemento de Faixa de Opções especificado.
CMFCRibbonPanel::SetJustifyColumns	Habilita ou desabilita a justificação da coluna.
CMFCRibbonPanel::SetKeys	Define o atalho de teclado que exibe o painel de faixa de opções.
CMFCRibbonPanel::ShowPopup

Comentários

Os painéis de faixa de opções são agrupamentos lógicos de tarefas relacionadas que você cria dentro das categorias de faixa de opções. Conforme o tamanho da faixa de opções é alterado, o layout do painel é ajustado automaticamente de modo a exibir o maior número possível de elementos.

Você pode obter os painéis de faixa de opções contidos em uma categoria de faixa de opções chamando o método CMFCRibbonCategory::GetPanel.

Exemplo

O exemplo a seguir demonstra como configurar um objeto CMFCRibbonPanel usando vários métodos na classe CMFCRibbonPanel. O exemplo mostra como definir o atalho de teclado que exibe o painel da faixa de opções, alinhar os elementos no painel verticalmente por coluna e habilitar a justificação da coluna. Este snippet de código faz parte do exemplo de Demonstração do MS Office 2007.

// CMFCRibbonCategory* pCategory
// CMFCToolBarImages m_PanelImages
CMFCRibbonPanel *pPanelClipboard = pCategory->AddPanel(_T("Clipboard"), m_PanelImages.ExtractIcon(1));
pPanelClipboard->SetKeys(_T("zc"));
pPanelClipboard->SetCenterColumnVert();
pPanelClipboard->SetJustifyColumns();

Hierarquia de herança

CObject

CMFCRibbonPanel

Requisitos

Cabeçalho: afxRibbonPanel.h

CMFCRibbonPanel::Add

Acrescenta o elemento de faixa de opções especificado à matriz de elementos de faixa de opções contida no painel de faixa de opções.

virtual void Add(CMFCRibbonBaseElement* pElem);

Parâmetros

pElem
[in, out] Ponteiro para um elemento da faixa de opções.

Comentários

CMFCRibbonPanel::AddSeparator

Adiciona um separador ao painel da faixa de opções.

virtual void AddSeparator();

Comentários

Chame esse método para adicionar um separador ao painel da faixa de opções. O separador será adicionado ao lado do elemento da faixa de opções adicionado pela chamada anterior a CMFCRibbonPanel::Add. Para inserir um separador em uma determinada posição, chame CMFCRibbonPanel::InsertSeparator.

CMFCRibbonPanel::AddToolBar

Adiciona uma barra de ferramentas ao painel da faixa de opções.

CMFCRibbonButtonsGroup* AddToolBar(
UINT uiToolbarResID,
UINT uiColdResID = 0,
UINT uiHotResID = 0,
UINT uiDisabledResID = 0);

Parâmetros

uiToolbarResID
[in] Especifica a ID do recurso da barra de ferramentas a ser adicionada.

uiColdResID
[in] Especifica a ID do recurso das imagens frias da barra de ferramentas.

uiHotResID
[in] Especifica a ID do recurso das imagens quentes da barra de ferramentas.

uiDisabledResID
[in] Especifica a ID do recurso das imagens desabilitadas da barra de ferramentas.

Valor de retorno

Chame esse método para adicionar uma barra de ferramentas ao painel da faixa de opções. A barra de ferramentas será adicionada ao lado do elemento da faixa de opções adicionado pela chamada anterior a CMFCRibbonPanel::Add.

Comentários

Para saber mais sobre barras de ferramentas, imagens quentes, imagens frias e imagens desabilitadas, consulte Classe CMFCToolBar.

CMFCRibbonPanel::CMFCRibbonPanel

Constrói e inicializa um objeto CMFCRibbonPanel.

CMFCRibbonPanel(
LPCTSTR lpszName = NULL,
HICON hIcon = NULL);

CMFCRibbonPanel(CMFCRibbonGallery* pPaletteButton);

Parâmetros

lpszName
[in] O nome do painel da faixa de opções.

hIcon
[in] Identificador do ícone do botão padrão para o painel da faixa de opções.

pPaletteButton
[in] Ponteiro para uma galeria de faixas de opções para o painel da faixa de opções.

CMFCRibbonPanel::FindByData

Recupera o elemento da faixa de opções associado aos dados especificados.

CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData) const;

Parâmetros

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

Valor de retorno

Ponteiro para um elemento da faixa de opções caso o método tenha tido êxito; caso contrário, NULL.

Comentários

CMFCRibbonPanel::FindByID

Recupera o elemento da faixa de opções identificado pela ID de comando especificada.

CMFCRibbonBaseElement* FindByID(UINT uiCmdID) const;

Parâmetros

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

Valor de retorno

O elemento de faixa de opções identificado pela ID de comando especificada; caso contrário, NULL se nenhum elemento de faixa de opções for identificado com a ID de comando especificada.

CMFCRibbonPanel::GetCaptionHeight

Recupera a altura de uma legenda para o painel de faixa de opções.

int GetCaptionHeight() const;

Valor de retorno

A altura, em pixels, de uma legenda para o painel de faixa de opções.

Comentários

CMFCRibbonPanel::GetCount

Recupera o número de elementos de faixa de opções contidos no painel da faixa de opções.

int GetCount() const;

Valor de retorno

O número de elementos de faixa de opções contidos no painel da faixa de opções.

CMFCRibbonPanel::GetData

Retorna os dados definidos pelo usuário associados ao painel.

DWORD_PTR GetData() const;

Valor de retorno

Os dados definidos pelo usuário associados ao painel.

CMFCRibbonPanel::GetDefaultButton

Recupera o botão padrão para o painel da faixa de opções.

CMFCRibbonButton& GetDefaultButton();

Valor de retorno

O botão padrão para o painel da faixa de opções.

Comentários

O botão padrão é exibido quando um painel de faixa de opções não tem espaço suficiente para exibir os elementos da faixa de opções.

CMFCRibbonPanel::GetDroppedDown

Recupera um ponteiro para um elemento de faixa de opções se o menu de item pop-up for descartado.

CMFCRibbonBaseElement* GetDroppedDown() const;

Valor de retorno

Ponteiro para o elemento de faixa de opções cujo menu pop-up é descartado; caso contrário, NULL se nenhum elemento de faixa de opções tiver o menu pop-up descartado.

Comentários

Somente os elementos de faixa de opções contidos no painel da faixa de opções são testados.

CMFCRibbonPanel::GetElement

Retorna o elemento de faixa de opções localizado em um índice especificado.

CMFCRibbonBaseElement* GetElement(int nIndex) const;

Parâmetros

nIndex
[in] Especifica o índice baseado em zero do elemento a ser recuperado.

Valor de retorno

Um ponteiro válido para o elemento de faixa de opções de base localizado na posição nIndex no painel da faixa de opções, ou NULL se não houver um elemento no índice especificado.

CMFCRibbonPanel::GetElements

Recupera todos os elementos de faixa de opções contidos no painel da faixa de opções.

void GetElements(CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Parâmetros

arElements
[out] Uma matriz a ser preenchida com todos os elementos de faixa de opções contidos no painel da faixa de opções.

Comentários

CMFCRibbonPanel::GetElementsByID

Adiciona elementos de faixa de opções que têm a ID de comando especificada para a matriz especificada.

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

Parâmetros

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

arElements
[in] Matriz de elementos de faixa de opções.

Comentários

Somente os elementos de faixa de opções contidos no painel da faixa de opções são testados.

CMFCRibbonPanel::GetHighlighted

Recupera o elemento de faixa de opções realçado no painel da faixa de opções.

CMFCRibbonBaseElement* GetHighlighted() const;

Valor de retorno

Ponteiro para o elemento de faixa de opções realçado no painel da faixa de opções.

Comentários

CMFCRibbonPanel::GetIndex

Recupera o índice baseado em zero do elemento de faixa de opções especificado na matriz de elementos de faixa de opções contidos no painel da faixa de opções.

virtual int GetIndex(CMFCRibbonBaseElement* pElem) const;

Parâmetros

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

Valor de retorno

Índice baseado em zero do elemento de faixa de opções especificado se o método tiver sido bem-sucedido; caso contrário, -1.

Comentários

CMFCRibbonPanel::GetItemIDsList

Recupera as IDs de comando para todos os elementos de faixa de opções no painel da faixa de opções.

void GetItemIDsList(CList<UINT, UINT>& lstItems) const;

Parâmetros

lstItems
[out] A lista de IDs de comando para elementos de faixa de opções contidos no painel de faixa de opções.

Comentários

CMFCRibbonPanel::GetName

Recupera o nome do painel da faixa de opções.

LPCTSTR GetName() const;

Valor de retorno

O nome do painel da faixa de opções.

Comentários

CMFCRibbonPanel::GetParentButton

CMFCRibbonBaseElement* GetParentButton() const;

Valor de retorno

Comentários

CMFCRibbonPanel::GetParentCategory

Retorna a categoria pai do painel da faixa de opções.

CMFCRibbonCategory* GetParentCategory() const;

Valor de retorno

Um ponteiro para a categoria de faixa de opções que contém esse painel de faixa de opções.

CMFCRibbonPanel::GetParentMenuBar

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Valor de retorno

Comentários

CMFCRibbonPanel::GetPreferedMenuLocation

Recupera o retângulo de exibição preferencial para o menu pop-up do painel da faixa de opções.

virtual BOOL GetPreferedMenuLocation(CRect& rect);

Parâmetros

rect
[out] Esse parâmetro não é usado.

Valor de retorno

Sempre retorna FALSE.

Comentários

Esse método sempre retorna FALSE. Substitua esse método para recuperar o retângulo de exibição preferencial para o menu pop-up do painel da faixa de opções.

CMFCRibbonPanel::GetPressed

Recuperará um ponteiro para um elemento de faixa de opções no painel da faixa de opções se o usuário o pressionar no momento.

CMFCRibbonBaseElement* GetPressed() const;

Valor de retorno

Um ponteiro para um elemento de faixa de opções se o usuário o pressionar no momento; caso contrário, NULL.

Comentários

CMFCRibbonPanel::GetRect

Recupera o retângulo de exibição para o painel da faixa de opções.

const CRect& GetRect() const;

Valor de retorno

O retângulo de exibição para o painel da faixa de opções.

Comentários

CMFCRibbonPanel::HasElement

Indica se o painel da faixa de opções contém o elemento de faixa de opções especificado.

BOOL HasElement(const CMFCRibbonBaseElement* pElem) const;

Parâmetros

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

Valor de retorno

TRUE se o painel da faixa de opções contiver o elemento de faixa de opções especificado; caso contrário, FALSE.

Comentários

CMFCRibbonPanel::Highlight

Define a cor de realce do painel de faixa de opções selecionado e do elemento de faixa de opções especificado pelo ponto.

virtual void Highlight(
BOOL bHighlight,
CPoint point);

Parâmetros

bHighlight
[in] TRUE para realçar o painel da faixa de opções; FALSE para desfazer o realce do painel da faixa de opções.

point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Comentários

CMFCRibbonPanel::HitTest

Recuperará um elemento de faixa de opções se o ponto especificado estiver localizado nele.

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

Parâmetros

point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

bCheckPanelCaption
[in] TRUE para testar a legenda do painel de faixa de opções; caso contrário, FALSE.

Valor de retorno

Ponteiro para um elemento de faixa de opções se o ponto especificado estiver localizado nele; caso contrário, NULL.

Comentários

Somente os elementos de faixa de opções contidos no painel da faixa de opções são testados.

CMFCRibbonPanel::HitTestEx

Recupera o índice baseado em zero do elemento de faixa de opções em que o ponto especificado está localizado.

virtual int HitTestEx(CPoint point) const;

Parâmetros

point
[in] As coordenadas x e y do ponteiro, relativas ao canto superior esquerdo da janela.

Valor de retorno

O índice baseado em zero do elemento de faixa de opções em que o ponto especificado está localizado; caso contrário, -1.

Comentários

Somente os elementos de faixa de opções contidos no painel da faixa de opções são testados.

CMFCRibbonPanel::Insert

Insere o elemento de faixa de opções especificado na posição especificada na matriz de elementos de faixa de opções contida no painel da faixa de opções.

virtual BOOL Insert(
CMFCRibbonBaseElement* pElem,
int nIndex);

Parâmetros

pElem
[in, out] Ponteiro para um elemento da faixa de opções.

nIndex
[in] Valor baseado em zero, que vai de -1 ao número de elementos de faixa de opções contidos na matriz.

Valor de retorno

TRUE se o elemento de faixa de opções foi inserido com êxito; caso contrário, FALSE.

Comentários

Se o valor de nIndex for -1 ou se nIndex for igual ao número de elementos de faixa de opções na matriz, o elemento de faixa de opções especificado será adicionado ao final da matriz. Se o valor de nIndex estiver fora do intervalo, o método falhará.

CMFCRibbonPanel::InsertSeparator

Insere um separador na posição determinada.

virtual BOOL InsertSeparator(int nIndex);

Parâmetros

nIndex
[in] Especifica o índice baseado em zero em que o separador foi inserido.

Valor de retorno

TRUE se o separador tiver sido inserido com êxito; caso contrário, FALSE.

Comentários

Chame esse método para inserir um separador na posição especificada por nIndex. Para inserir um separador ao lado do elemento de faixa de opções adicionado mais recentemente, chame CMFCRibbonPanel::AddSeparator.

CMFCRibbonPanel::IsCenterColumnVert

Indica se as posições verticais dos elementos da faixa de opções estão centralizados dentro do retângulo de exibição.

BOOL IsCenterColumnVert() const;

Valor de retorno

TRUE se as posições verticais dos elementos da faixa de opções estiverem centralizados dentro do retângulo de exibição; caso contrário, FALSE.

CMFCRibbonPanel::IsCollapsed

Indica se o tamanho de exibição do painel da faixa de opções está minimizado na direção horizontal.

BOOL IsCollapsed() const;

Valor de retorno

TRUE se o tamanho de exibição do painel da faixa de opções estiver minimizado na direção horizontal; caso contrário, FALSE.

Comentários

Quando um painel de faixa de opções é recolhido, ele exibe apenas o botão padrão, o nome e uma seta suspensa.

CMFCRibbonPanel::IsHighlighted

Indica se a exibição do painel de faixa de opções está realçada.

BOOL IsHighlighted() const;

Valor de retorno

TRUE se a exibição do painel de faixa de opções estiver realçada; caso contrário, FALSE.

Comentários

A exibição de um painel de faixa de opções é realçada quando o ponteiro está sobre ela.

CMFCRibbonPanel::IsJustifyColumns

Indica se as dimensões de exibição dos elementos de faixa de opções que estão na mesma coluna no painel da faixa de opções estão configuradas com a mesma largura.

BOOL IsJustifyColumns() const;

Valor de retorno

TRUE se as dimensões de exibição dos elementos de faixa de opções que estão na mesma coluna no painel da faixa de opções estiverem configuradas com a mesma largura; caso contrário, FALSE.

CMFCRibbonPanel::IsMainPanel

Indica se o painel de faixa de opções é o principal painel de faixa de opções.

virtual BOOL IsMainPanel() const;

Valor de retorno

Sempre retorna FALSE.

Comentários

Esse método sempre retorna FALSE. Substitua esse método para indicar se o painel de faixa de opções é o principal painel de faixa de opções.

O principal painel de faixa de opções é exibido quando o usuário seleciona o botão do aplicativo.

CMFCRibbonPanel::IsMenuMode

BOOL IsMenuMode() const;

Valor de retorno

Comentários

CMFCRibbonPanel::OnKey

virtual BOOL OnKey(UINT nChar);

Parâmetros

[in] nChar

Valor de retorno

Comentários

CMFCRibbonPanel::RecalcWidths

Recalcula a largura de cada configuração de layout de exibição para o painel de faixa de opções.

virtual void RecalcWidths(
CDC* pDC,
int nHeight);

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para o painel de faixa de opções.

nHeight
[in] A altura do painel de faixa de opções.

Comentários

Um painel de faixa de opções altera sua configuração de layout à medida que a largura disponível é alterada.

CMFCRibbonPanel::Remove

Remove e, opcionalmente, exclui um elemento localizado no índice especificado.

BOOL Remove(
int nIndex,
BOOL bDelete = TRUE);

Parâmetros

nIndex
[in] Especifica o índice baseado em zero do elemento removido do painel de faixa de opções.

bDelete
[in] TRUE para excluir o elemento que está sendo removido; caso contrário, FALSE.

Valor de retorno

TRUE se o elemento foi removido e excluído (se bDelete for TRUE); FALSE se o elemento não foi removido ou se não há nenhum elemento de faixa de opções em nIndex.

Comentários

Chame esse método para remover um elemento do painel de faixa de opções.

CMFCRibbonPanel::RemoveAll

Exclui todos os elementos de faixa de opções do painel de faixa de opções.

void RemoveAll();

Comentários

Todos os elementos de faixa de opções são excluídos do painel de faixa de opções e destruídos.

CMFCRibbonPanel::Replace

Substitui um elemento por outro com base em seus valores de índice.

BOOL Replace(
int nIndex,
CMFCRibbonBaseElement* pElem);

Parâmetros

nIndex
[in] Especifica o índice baseado em zero do elemento a ser substituído.

pElem
[in, out] Um ponteiro válido para o elemento que substitui o elemento original.

Valor de retorno

TRUE se o elemento de faixa de opções original tiver sido substituído com êxito pelo novo elemento de faixa de opções; FALSE se o elemento de faixa de opções não tiver sido substituído ou se não houver nenhum elemento no índice especificado.

Comentários

Para substituir um elemento de faixa de opções pela ID de comando, chame CMFCRibbonPanel::ReplaceByID.

CMFCRibbonPanel::ReplaceByID

Substitui um elemento por outro com base em uma ID de comando especificada.

BOOL ReplaceByID(
UINT uiCmdID,
CMFCRibbonBaseElement* pElem);

Parâmetros

uiCmdID
[in] Especifica a ID de comando do elemento a ser substituído.

pElem
[in, out] Um ponteiro válido para o elemento que substituirá o elemento original.

Valor de retorno

Comentários

Para substituir um elemento de faixa de opções com base na posição, chame CMFCRibbonPanel::Replace.

CMFCRibbonPanel::SetCenterColumnVert

Habilita ou desabilita a centralização das posições verticais dos elementos de faixa de opções dentro do retângulo de exibição.

void SetCenterColumnVert(BOOL bSet = TRUE);

Parâmetros

bSet
[in] TRUE para centralizar as posições verticais dos elementos de faixa de opções dentro do retângulo de exibição; FALSE para desabilitar esse recurso.

Comentários

CMFCRibbonPanel::SetData

Associa dados definidos pelo usuário ao painel da faixa de opções.

void SetData(DWORD_PTR dwData);

Parâmetros

dwData
[in] Especifica os dados definidos pelo usuário a serem definidos.

Comentários

Chame esse método para associar dados definidos pelo usuário ao painel de faixa de opções.

CMFCRibbonPanel::SetElementMenu

Atribui um menu pop-up ao elemento que tem a ID de comando fornecida.

BOOL SetElementMenu(
UINT uiCmdID,
HMENU hMenu,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

BOOL SetElementMenu(
UINT uiCmdID,
UINT uiMenuResID,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

Parâmetros

uiCmdID
[in] Especifica a ID de comando do elemento de faixa de opções a que o menu é adicionado.

hMenu
[in] Especifica o identificador do menu do Windows a ser adicionado ao painel de faixa de opções.

bIsDefautCommand
[in] TRUE para especificar que o comando associado ao elemento de faixa de opções deverá ser executado se o elemento de faixa de opções for acionado por clique. Nesse caso, o menu é aberto apenas quando o usuário clica na seta ao lado do elemento de faixa de opções. FALSE para especificar que o comando associado ao elemento de faixa de opções não deverá ser executado se o elemento de faixa de opções for acionado por clique. Nesse caso, o menu pop-up será exibido independentemente de onde o usuário clicar no elemento.

bRightAlign
[in] TRUE para especificar que o menu pop-up está alinhado à direita; caso contrário, FALSE.

uiMenuResID
[in] Especifica a ID do recurso do menu a ser adicionado ao painel de faixa de opções.

Valor de retorno

TRUE se o menu tiver sido atribuído ao elemento de faixa de opções; caso contrário, FALSE.

Comentários

Chame esse método para atribuir um menu pop-up ao elemento de faixa de opções que tem a ID de comando fornecida.

CMFCRibbonPanel::SetElementRTC

Adiciona o elemento de faixa de opções especificado pelas informações da classe de runtime fornecidas ao painel da faixa de opções.

CMFCRibbonBaseElement* SetElementRTC(
int nIndex,
CRuntimeClass* pRTC);

Parâmetros

nIndex
[in] Especifica o índice baseado em zero do elemento de faixa de opções a ser adicionado.

pRTC
[in, out] Um ponteiro para as informações da classe de runtime do elemento de faixa de opções que é adicionado ao painel de faixa de opções.

Valor de retorno

O elemento de faixa de opções criado usando as informações de classe de runtime especificadas.

Comentários

Se quiser adicionar um elemento personalizado (por exemplo, um botão de cor) ao painel de faixa de opções, você deverá especificar as informações de classe de runtime do elemento personalizado. A faixa de opções armazena essas informações, cria o elemento personalizado e substitui um elemento existente localizado (identificado) pela ID de comando especificada. Em seguida, a faixa de opções retorna um ponteiro para o elemento recém-criado.

CMFCRibbonPanel::SetElementRTCByID

Adiciona um elemento de faixa de opções especificado pelas informações da classe de runtime fornecidas ao painel da faixa de opções.

CMFCRibbonBaseElement* SetElementRTCByID(
UINT uiCmdID,
CRuntimeClass* pRTC);

Parâmetros

uiCmdID
[in] Especifica a ID de comando do elemento de faixa de opções a ser adicionado.

pRTC
[in, out] Um ponteiro para as informações da classe de runtime associada ao elemento de faixa de opções que é adicionado ao painel de faixa de opções.

Valor de retorno

O elemento de faixa de opções criado usando as informações de classe de runtime especificadas.

Comentários

Se quiser adicionar um elemento personalizado (por exemplo, um botão de cor) ao painel de faixa de opções, você deverá especificar as informações de classe de runtime do elemento personalizado. A faixa de opções armazena essas informações, cria o elemento personalizado e substitui um elemento existente localizado pela ID de comando especificada. Em seguida, ela retorna um ponteiro para o elemento recém-criado.

Exemplo

O seguinte exemplo mostra como usar o método SetElementRTCByID:

// Load and add toolbar with standard buttons. This toolbar
// should display a custom color button with id ID_CHAR_COLOR:

pPanel->AddToolBar(IDR_MAINFRAME,
    IDB_MAINFRAME256);

CMFCRibbonColorButton* pColorButton =
(CMFCRibbonColorButton*)pPanel->SetElementRTCByID(
ID_CHAR_COLOR,
    RUNTIME_CLASS (CMFCRibbonColorButton));

// SetElementRTCByID sets runtime class and returns a pointer
// to the newly created custom button,
    which can be set up immediately:
pColorButton->EnableAutomaticButton(_T("Automatic"),
    RGB (0,
    0,
    0));

CMFCRibbonPanel::SetJustifyColumns

Habilita ou desabilita o ajuste da largura dos elementos de faixa de opções na mesma coluna.

void SetJustifyColumns(BOOL bSet = TRUE);

Parâmetros

bSet
[in] TRUE para ajustar a largura dos elementos de faixa de opções na mesma coluna como a largura do maior elemento de faixa de opções na coluna; FALSE para desabilitar esse ajuste de largura.

Comentários

Quando esse recurso é habilitado em um painel de faixa de opções, as larguras dos elementos de faixa de opções na mesma coluna são ajustadas como a largura do maior elemento de faixa de opções na mesma coluna.

CMFCRibbonPanel::SetKeys

Define a dica de tecla do botão padrão do painel da faixa de opções.

void SetKeys(LPCTSTR lpszKeys);

Parâmetros

lpszKeys
[in] A dica de tecla do botão padrão do painel da faixa de opções.

Comentários

O botão padrão é exibido quando um painel de faixa de opções não tem espaço suficiente para exibir os elementos da faixa de opções.

CMFCRibbonPanel::ShowPopup

Cria e exibe um menu pop-up para o painel de faixa de opções.

CMFCRibbonPanelMenu* ShowPopup(CMFCRibbonDefaultPanelButton* pButton = NULL);

Parâmetros

pButton
[in] Ponteiro para o botão padrão para o painel da faixa de opções.

Valor de retorno

Ponteiro para o menu pop-up do painel de faixa de opções se o método tiver sido bem-sucedido; caso contrário, NULL.

Comentários

O menu pop-up do painel de faixa de opções só ficará disponível quando a exibição do painel de faixa de opções for recolhida.

CMFCRibbonPanel::SetFocused

Define o foco para o elemento de Faixa de Opções especificado.

void SetFocused(CMFCRibbonBaseElement* pNewFocus);

Parâmetros

pNewFocus
Um ponteiro para um elemento de Faixa de Opções que recebe o foco.

Comentários

CMFCRibbonPanel::MakeGalleryItemVisible

Rola a galeria para deixar o elemento especificado da Faixa de Opções visível.

void MakeGalleryItemVisible(CMFCRibbonBaseElement* pItem);

Parâmetros

pItem
Um ponteiro para um elemento de Faixa de Opções a ser exibido.

Comentários

CMFCRibbonPanel::IsWindows7Look

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

BOOL IsWindows7Look() const;

Valor de retorno

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

Comentários

CMFCRibbonPanel::GetVisibleElements

Recupera uma matriz de elementos visíveis.

void GetVisibleElements(
CArray<CMFCRibbonBaseElement*,
CMFCRibbonBaseElement*>& arElements);

Parâmetros

arElements
Quando a função retorna, esse parâmetro contém uma matriz de elementos visíveis.

Comentários

CMFCRibbonPanel::GetGalleryRect

Retorna um retângulo delimitador de um elemento da Galeria.

CRect GetGalleryRect();

Valor de retorno

Tamanho e posição do elemento de Galeria dentro deste painel.

Comentários

CMFCRibbonPanel::GetFocused

Retorna um elemento focalizado.

CMFCRibbonBaseElement* GetFocused() const;

Valor de retorno

Um ponteiro para um elemento focalizado ou NULL.

Comentários

Confira também

Gráfico da hierarquia
Classes
Classe CObject
Classe CMFCRibbonCategory
Classe CMFCRibbonBaseElement

Partilhar via

Classe CMFCRibbonPanel

Sintaxe

Membros

Construtores Protegidos

Métodos públicos

Comentários

Exemplo

Hierarquia de herança

Requisitos

CMFCRibbonPanel::Add

Parâmetros

Comentários

CMFCRibbonPanel::AddSeparator

Comentários

CMFCRibbonPanel::AddToolBar

Parâmetros

Valor de retorno

Comentários

CMFCRibbonPanel::CMFCRibbonPanel

Parâmetros

CMFCRibbonPanel::FindByData

Parâmetros

Valor de retorno

Comentários

CMFCRibbonPanel::FindByID

Parâmetros

Valor de retorno

CMFCRibbonPanel::GetCaptionHeight

Valor de retorno

Comentários

CMFCRibbonPanel::GetCount

Valor de retorno

CMFCRibbonPanel::GetData

Valor de retorno

CMFCRibbonPanel::GetDefaultButton

Valor de retorno

Comentários

CMFCRibbonPanel::GetDroppedDown

Valor de retorno

Comentários

CMFCRibbonPanel::GetElement

Parâmetros

Valor de retorno

CMFCRibbonPanel::GetElements

Parâmetros

Comentários

CMFCRibbonPanel::GetElementsByID

Parâmetros

Comentários

CMFCRibbonPanel::GetHighlighted

Valor de retorno

Comentários

CMFCRibbonPanel::GetIndex

Parâmetros

Valor de retorno

Comentários

CMFCRibbonPanel::GetItemIDsList

Parâmetros

Comentários

CMFCRibbonPanel::GetName

Valor de retorno

Comentários

CMFCRibbonPanel::GetParentButton

Valor de retorno

Comentários

CMFCRibbonPanel::GetParentCategory

Valor de retorno

CMFCRibbonPanel::GetParentMenuBar

Valor de retorno

Comentários

CMFCRibbonPanel::GetPreferedMenuLocation

Parâmetros

Valor de retorno

Comentários

CMFCRibbonPanel::GetPressed

Valor de retorno

Comentários

CMFCRibbonPanel::GetRect

Valor de retorno