Clase `CMFCRibbonBar`

Artículo
04/03/2023

La clase CMFCRibbonBar implementa una barra de cinta similar a la que se usaba en Office 2007.

Para obtener información más detallada, consulte el código fuente ubicado en la carpeta mfc de la instalación de Visual Studio. Por ejemplo, %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

Sintaxis

class CMFCRibbonBar : public CPane

Miembros

Constructores públicos

Nombre	Descripción
`CMFCRibbonBar::CMFCRibbonBar`	Constructor predeterminado.

Métodos públicos

Nombre	Descripción
`CMFCRibbonBar::ActivateContextCategory`	Activa una categoría de contexto que ya está visible.
`CMFCRibbonBar::AddCategory`	Agrega una nueva categoría de cinta de opciones a la cinta.
`CMFCRibbonBar::AddContextCategory`	Agrega una categoría de contexto.
`CMFCRibbonBar::AddMainCategory`	Agrega una nueva categoría principal de cinta de opciones.
`CMFCRibbonBar::AddPrintPreviewCategory`
`CMFCRibbonBar::AddQATOnlyCategory`
`CMFCRibbonBar::AddToTabs`	Agrega un elemento de la cinta de opciones a la derecha de una barra de cinta.
`CMFCRibbonBar::CreateEx`	Crea una barra de control y la adjunta al objeto `CPane`. (Invalida `CPane::CreateEx`).
`CMFCRibbonBar::Create`	Crea un control de barra de cinta y lo adjunta a una barra de cinta.
`CMFCRibbonBar::DeactivateKeyboardFocus`
`CMFCRibbonBar::DrawMenuImage`
`CMFCRibbonBar::DWMCompositionChanged`
`CMFCRibbonBar::EnableKeyTips`	Habilita o deshabilita las sugerencias de teclas para el control de la cinta de opciones.
`CMFCRibbonBar::EnablePrintPreview`	Habilita la pestaña Vista previa de impresión.
`CMFCRibbonBar::EnableToolTips`	Habilita o deshabilita las descripciones de información sobre herramientas y la información sobre herramientas en la barra de cinta.
`CMFCRibbonBar::FindByData`	Busca un elemento de la cinta de opciones usando los datos que un usuario especifica.
`CMFCRibbonBar::FindByID`	Busca un elemento de la cinta de opciones que tiene el identificador de comando especificado.
`CMFCRibbonBar::FindCategoryIndexByData`	Busca el índice de la categoría de la cinta que contiene los datos definidos por el usuario.
`CMFCRibbonBar::ForceRecalcLayout`
`CMFCRibbonBar::GetActiveCategory`	Obtiene un puntero a una categoría activa.
`CMFCRibbonBar::GetCaptionHeight`	Devuelve la altura del título. (Invalida `CBasePane::GetCaptionHeight`).
`CMFCRibbonBar::GetCategory`	Obtiene el puntero a una categoría ubicada en un índice especificado.
`CMFCRibbonBar::GetCategoryCount`	Obtiene el número de categorías de la cinta de la barra de cinta.
`CMFCRibbonBar::GetCategoryHeight`
`CMFCRibbonBar::GetCategoryIndex`	Devuelve el índice de una categoría de la cinta.
`CMFCRibbonBar::GetContextName`	Recupera el título de la categoría de contexto especificada con un identificador.
`CMFCRibbonBar::GetDroppedDown`
`CMFCRibbonBar::GetElementsByID`	Obtiene una matriz que contiene los punteros a todos los elementos de la cinta de opciones que tienen el identificador especificado.
`CMFCRibbonBar::GetApplicationButton`	Obtiene un puntero a un botón de la cinta de opciones.
`CMFCRibbonBar::GetFocused`	Devuelve un elemento que tiene el foco.
`CMFCRibbonBar::GetHideFlags`
`CMFCRibbonBar::GetItemIDsList`
`CMFCRibbonBar::GetKeyboardNavigationLevel`
`CMFCRibbonBar::GetKeyboardNavLevelCurrent`
`CMFCRibbonBar::GetKeyboardNavLevelParent`
`CMFCRibbonBar::GetMainCategory`	Devuelve un puntero a la categoría de cinta de opciones seleccionada actualmente.
`CMFCRibbonBar::GetQATCommandsLocation`
`CMFCRibbonBar::GetQATDroppedDown`
`CMFCRibbonBar::GetQuickAccessCommands`	Rellena una lista que contiene los identificadores de comando de todos los elementos que aparecen en la barra de herramientas de acceso rápido.
`CMFCRibbonBar::GetQuickAccessToolbarLocation`
`CMFCRibbonBar::GetTabTrancateRatio`
`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`
`CMFCRibbonBar::GetTooltipFixedWidthRegular`
`CMFCRibbonBar::GetVisibleCategoryCount`
`CMFCRibbonBar::HideAllContextCategories`	Oculta todas las categorías que están activas y visibles.
`CMFCRibbonBar::HideKeyTips`
`CMFCRibbonBar::HitTest`	Busca un puntero al elemento de la cinta de opciones que se encuentra en el punto especificado en las coordenadas de cliente de la barra de cinta.
`CMFCRibbonBar::IsKeyTipEnabled`	Determina si se habilitan sugerencias de teclas.
`CMFCRibbonBar::IsMainRibbonBar`
`CMFCRibbonBar::IsPrintPreviewEnabled`	Determina si la pestaña Vista previa de impresión está habilitada.
`CMFCRibbonBar::IsQATEmpty`
`CMFCRibbonBar::IsQuickAccessToolbarOnTop`	Especifica si la barra de herramientas de acceso rápido se encuentra encima de la barra de cinta.
`CMFCRibbonBar::IsReplaceFrameCaption`	Determina si la barra de cinta reemplaza al título del marco principal o si se agrega debajo de la leyenda del marco.
`CMFCRibbonBar::IsShowGroupBorder`
`CMFCRibbonBar::IsToolTipDescrEnabled`	Determina si las descripciones de la información sobre herramientas están habilitadas.
`CMFCRibbonBar::IsToolTipEnabled`	Determina si la información sobre herramientas de la barra de cinta está habilitada.
`CMFCRibbonBar::IsTransparentCaption`
`CMFCRibbonBar::IsWindows7Look`	Indica si la cinta de opciones tiene la apariencia de Windows 7 (botón de aplicación rectangular pequeño).
`CMFCRibbonBar::LoadFromResource`	Con sobrecarga. Carga una barra de cinta a partir de los recursos de la aplicación.
`CMFCRibbonBar::OnClickButton`
`CMFCRibbonBar::OnEditContextMenu`
`CMFCRibbonBar::OnRTLChanged`	(Invalida `CPane::OnRTLChanged`).
`CMFCRibbonBar::OnSetAccData`	(Invalida `CBasePane::OnSetAccData`).
`CMFCRibbonBar::OnShowRibbonContextMenu`
`CMFCRibbonBar::OnShowRibbonQATMenu`
`CMFCRibbonBar::OnSysKeyDown`
`CMFCRibbonBar::OnSysKeyUp`
`CMFCRibbonBar::PopTooltip`
`CMFCRibbonBar::PreTranslateMessage`	(Invalida `CBasePane::PreTranslateMessage`).
`CMFCRibbonBar::RecalcLayout`	(Invalida `CPane::RecalcLayout`).
`CMFCRibbonBar::RemoveAllCategories`	Quita todas las categorías de la cinta de opciones de la barra de cinta.
`CMFCRibbonBar::RemoveAllFromTabs`	Quita todos los elementos de la cinta de opciones del área de pestañas.
`CMFCRibbonBar::RemoveCategory`	Quita la categoría de cinta de opciones que se encuentra en el índice especificado.
`CMFCRibbonBar::SaveToXMLBuffer`	Guarda la barra de cinta en un búfer.
`CMFCRibbonBar::SaveToXMLFile`	Guarda la barra de cinta en un archivo XML.
`CMFCRibbonBar::SetActiveCategory`	Establece una categoría especificada de la cinta de opciones como activa.
`CMFCRibbonBar::SetActiveMDIChild`
`CMFCRibbonBar::SetElementKeys`	Establece las sugerencias de teclas especificadas para todos los elementos de la cinta de opciones que tienen el identificador de comando especificado.
`CMFCRibbonBar::SetApplicationButton`	Asigna un botón de la cinta de opciones de aplicación a la barra de cinta.
`CMFCRibbonBar::SetKeyboardNavigationLevel`
`CMFCRibbonBar::SetMaximizeMode`
`CMFCRibbonBar::SetQuickAccessCommands`	Agrega uno o más elementos de la cinta de opciones a la barra de herramientas de acceso rápido.
`CMFCRibbonBar::SetQuickAccessDefaultState`	Especifica el estado predeterminado de la barra de herramientas de acceso rápido.
`CMFCRibbonBar::SetQuickAccessToolbarOnTop`	Coloca la barra de herramientas de acceso rápido (QAT) encima o debajo de la barra de cinta.
`CMFCRibbonBar::SetTooltipFixedWidth`
`CMFCRibbonBar::SetWindows7Look`	Habilita/deshabilita la apariencia de Windows 7 (botón de aplicación rectangular pequeño) para la cinta de opciones.
`CMFCRibbonBar::ShowCategory`	Muestra u oculta la categoría de la cinta de opciones especificada.
`CMFCRibbonBar::ShowContextCategories`	Muestra u oculta las categorías de contexto que tienen el identificador especificado.
`CMFCRibbonBar::ShowKeyTips`
`CMFCRibbonBar::ToggleMimimizeState`	Alterna la barra de cinta entre los estados minimizado y maximizado.
`CMFCRibbonBar::TranslateChar`

Comentarios

Microsoft presentó la cinta de opciones de Office Fluent junto con el lanzamiento de Microsoft Office 2007. Esta barra de cinta es mucho más que un control nuevo. representa un nuevo paradigma de interfaz de usuario. La cinta de opciones es un panel que contiene un conjunto de pestañas denominada categorías. Cada categoría se divide lógicamente en paneles de cinta y cada panel puede contener varios controles y botones de comando.

Los elementos que aparecen en la barra de cinta se expanden y se contrae para optimizar el espacio disponible. Por ejemplo, si un panel de cinta no tiene suficiente espacio para mostrar sus elementos, se convierte en un botón de menú que muestra los subelementos en un menú emergente. La barra de cinta se comporta como una barra de control estática (no flotante) y se puede acoplar en la parte superior de un marco.

Puede usar la clase CMFCRibbonStatusBar para implementar una barra de estado similar a la que se usaba en Office 2007. Una categoría de cinta de opciones contiene (y muestra) un grupo de paneles de barra de opciones. Cada panel de cinta contiene uno o más elementos de la cinta de opciones, que se obtienen de CMFCRibbonBaseElement.

Para obtener información sobre cómo agregar una barra de cinta a la aplicación MFC existente, consulta Tutorial: Actualizar la aplicación Scribble de MFC.

Jerarquía de herencia

Requisitos

Encabezadoafxribbonbar.h:

`CMFCRibbonBar::ActivateContextCategory`

Activa una categoría de contexto que ya está visible.

BOOL ActivateContextCategory(UINT uiContextID);

Parámetros

uiContextID
[in] El identificador de categoría de contexto.

Valor devuelto

TRUE si se encuentra y activa una categoría de contexto con uiContextID; de lo contrario FALSE.

`CMFCRibbonBar::AddCategory`

Crea e inicializa una nueva categoría de cinta de opciones para la barra de cinta.

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] Nombre de la categoría de la cinta de opciones.

uiSmallImagesResID
[in] Identificador de recurso de la lista de imágenes pequeñas para la categoría de la cinta de opciones.

uiLargeImagesResID
[in] Identificador de recurso de la lista de imágenes grandes para la categoría de cinta de opciones.

sizeSmallImage
[in] Especifica el tamaño de las imágenes pequeñas para la categoría de cinta de opciones.

sizeLargeImage
[in] Especifica el tamaño de las imágenes grandes para la categoría de cinta de opciones.

nInsertAt
[in] Índice de base cero de la ubicación de la categoría.

pRTI
[in] Puntero a una CMFCRibbonCategoryclase en tiempo de ejecución de clase para crear dinámicamente una categoría de cinta en tiempo de ejecución.

Valor devuelto

Un puntero a la nueva categoría de la cinta si el método tuvo éxito; en caso contrario, NULL.

Comentarios

Si el pRTI parámetro no es NULL, la nueva categoría de cinta de opciones se crea dinámicamente mediante la clase en tiempo de ejecución.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método AddCategory de la clase CMFCRibbonBar.

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

`CMFCRibbonBar::AddContextCategory`

Crea e inicializa una nueva categoría de contexto para la barra de cinta.

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] Nombre de la categoría.

lpszContextName
[in] Nombre del subtítulo de categoría de contexto.

uiContextID
[in] Identificador de contexto.

clrContext
[in] Color del subtítulo de categoría de contexto.

uiSmallImagesResID
[in] Identificador de recurso de la imagen pequeña de una categoría de contexto.

uiLargeImagesResID
[in] Identificador de recurso de la imagen grande de una categoría de contexto.

sizeSmallImage
[in] Tamaño de una imagen pequeña.

sizeLargeImage
[in] Tamaño de una imagen grande.

pRTI
[in] Puntero a una clase en tiempo de ejecución.

Valor devuelto

Puntero a la categoría recién creada o NULL si el CreateObject método de pRTI no puede crear la categoría especificada.

Comentarios

Usa esta función para agregar una categoría de contexto. Las categorías de contexto son un tipo especial de categoría que se puede mostrar u ocultar en tiempo de ejecución, en función del contexto de la aplicación actual. Por ejemplo, cuando el usuario selecciona un objeto, puede mostrar pestañas especiales con categorías de contexto, que se usan para cambiar el objeto seleccionado específico.

El color de una categoría de contexto puede tener uno de estos 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`

Crea una nueva categoría de cinta principal para la barra de cinta de opciones.

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

Parámetros

lpszName
[in] Nombre de la categoría de la cinta de opciones principal.

uiSmallImagesResID
[in] Identificador de recurso de imágenes pequeñas.

uiLargeImagesResID
[in] Identificador de recurso de imágenes grandes.

sizeSmallImage
[in] Tamaño de imágenes pequeñas.

sizeLargeImage
[in] Tamaño de imágenes grandes.

Valor devuelto

Un puntero a la nueva categoría de la cinta si el método tuvo éxito; en caso contrario, NULL.

Comentarios

Si ya existe una categoría de cinta principal, se elimina.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método AddMainCategory de la clase 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`

Crea una categoría de vista previa de impresión en la barra de cinta de opciones.

CMFCRibbonCategory* AddPrintPreviewCategory();

Valor devuelto

Un puntero a la nueva categoría de la cinta si el método tuvo éxito; en caso contrario, NULL.

Comentarios

Este método crea una categoría de cinta de opciones y los controles que necesita para proporcionar una vista previa de impresión.

`CMFCRibbonBar::AddQATOnlyCategory`

Crea una categoría de cinta de opciones de la barra de herramientas de acceso rápido.

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

Parámetros

lpszName
[in] Nombre de la categoría.

uiSmallImagesResID
[in] Identificador de recurso de la lista de imágenes de la categoría.

sizeSmallImage
[in] Tamaño de imágenes para los elementos de la cinta de opciones de la categoría.

Valor devuelto

Un puntero a la nueva categoría de la cinta si el método tuvo éxito; en caso contrario, NULL.

Comentarios

La categoría de la cinta de opciones de la barra de herramientas de acceso rápido solo se usa en el cuadro de diálogo de personalización de la barra de herramientas de acceso rápido.

`CMFCRibbonBar::AddToTabs`

Agrega el elemento de cinta especificado a la fila de pestañas de la barra de cinta de opciones.

void AddToTabs(CMFCRibbonBaseElement* pElement);

Parámetros

pElement
[in] Puntero a un elemento de la cinta.

Comentarios

El elemento de la cinta de opciones se coloca antes de cualquier botón del sistema.

`CMFCRibbonBar::CMFCRibbonBar`

Construye e inicializa un objeto CMFCRibbonBar.

CMFCRibbonBar(BOOL bReplaceFrameCaption = TRUE);

Parámetros

bReplaceFrameCaption
[in] TRUE para que la barra de cinta reemplace el subtítulo de la ventana de marco principal; FALSE para buscar la barra de cinta de opciones debajo del subtítulo de la ventana de marco principal.

Comentarios

`CMFCRibbonBar::Create`

Crea una ventana para la barra de opciones.

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

Parámetros

pParentWnd
[in] Puntero a la ventana primaria de la barra de cinta de opciones.

dwStyle
[in] Una combinación lógica de estilos para la nueva ventana.

nID
[in] Identificador de la nueva ventana.

Valor devuelto

TRUE si se creó la ventana; de lo contrario FALSE.

Comentarios

Ejemplo

En el siguiente ejemplo se muestra cómo se utiliza el método Create de la clase CMFCRibbonBar.

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

`CMFCRibbonBar::CreateEx`

Crea una ventana para la barra de opciones.

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] Puntero a la ventana primaria de la barra de cinta de opciones.

dwCtrlStyle
[in] Este parámetro no se usa.

dwStyle
[in] Una combinación lógica de estilos para la nueva ventana.

nID
[in] Identificador de la nueva ventana.

Valor devuelto

TRUE si se creó la ventana; de lo contrario FALSE.

Comentarios

`CMFCRibbonBar::DeactivateKeyboardFocus`

Cierra todos los controles de información sobre claves de la barra de la barra de opciones.

void DeactivateKeyboardFocus(BOOL bSetFocus = TRUE);

Parámetros

bSetFocus
[in] TRUE para establecer el foco en la ventana primaria de la barra de cinta de opciones.

Comentarios

`CMFCRibbonBar::DrawMenuImage`

Dibuja la imagen para un botón de menú.

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

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para el botón del menú.

pMenuItem
[in] Puntero a un botón de menú de la barra de herramientas.

rectImage
[in] Rectángulo de visualización para un botón de menú.

Valor devuelto

TRUE es si se dibuja la imagen; de lo contrario FALSE.

Comentarios

`CMFCRibbonBar::DWMCompositionChanged`

Ajusta la presentación de la barra de cinta cuando la composición del Administrador de ventanas de escritorio (DWM) está habilitada o deshabilitada.

virtual void DWMCompositionChanged();

Comentarios

`CMFCRibbonBar::EnableKeyTips`

Habilita o deshabilita la característica de información sobre claves de la barra de cinta de opciones.

void EnableKeyTips(BOOL bEnable = TRUE);

Parámetros

bEnable
[in] TRUE para habilitar la característica keytips; FALSE para deshabilitar la característica de información sobre claves.

Comentarios

Al habilitar esta característica, se muestran sugerencias de teclas cuando el usuario presiona las teclas ALT o F10. Cuando el usuario presiona la tecla ALT, las sugerencias de teclas se muestran con un retraso de 200 milisegundos. Este retraso permite ejecutar métodos abreviados para que la tecla ALT presionada no interfiera con otras combinaciones que incluyan la tecla ALT.

`CMFCRibbonBar::EnablePrintPreview`

Habilita o deshabilita la característica Vista previa de impresión.

void EnablePrintPreview(BOOL bEnable = TRUE);

Parámetros

bEnable
[in] TRUE para habilitar la característica Vista previa de impresión; FALSE para deshabilitar la característica Vista previa de impresión.

Comentarios

Si bEnable es FALSE y existe una categoría de vista previa de impresión, se elimina.

De forma predeterminada, la característica Vista previa de impresión está habilitada.

`CMFCRibbonBar::EnableToolTips`

Activa o desactiva la información sobre las herramientas y las descripciones opcionales de las mismas en la barra de la cinta.

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

Parámetros

bEnable
[in] TRUE para habilitar la información sobre herramientas en la barra de cinta de opciones; FALSE para deshabilitar la información sobre herramientas en la barra de cinta de opciones.

bEnableDescr
[in] TRUE para habilitar descripciones de información sobre herramientas en la información sobre herramientas; FALSE para deshabilitar las descripciones de información sobre herramientas en la información sobre herramientas.

Comentarios

El parámetro bEnable determina si se muestra información sobre herramientas cuando el mouse mantiene el puntero sobre un elemento de cinta de opciones. El parámetro bEnableDescr determina si aparece texto descriptivo adicional con el texto de información sobre herramientas.

`CMFCRibbonBar::FindByData`

Recupera un puntero a un elemento de cinta de opciones si tiene los datos y la visibilidad especificados.

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

Parámetros

dwData
[in] Los datos asociados a un elemento de la barra de opciones.

bVisibleOnly
[in] TRUE para buscar solo elementos visibles de la cinta de opciones; FALSE para buscar todos los elementos de la cinta de opciones.

Valor devuelto

Puntero a un elemento de cinta de opciones si tiene los datos y la visibilidad especificados; de lo contrario NULL.

Comentarios

Un elemento de cinta de opciones es cualquier control que se pueda agregar a la cinta, como un botón de cinta o una categoría de cinta, o un control deslizante de la cinta.

`CMFCRibbonBar::FindByID`

Recupera un puntero al elemento de la cinta de opciones que tiene el identificador de comando y los valores de búsqueda especificados.

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

Parámetros

uiCmdID
[in] Identificador de comando de un elemento de la cinta.

bVisibleOnly
[in] TRUE para buscar solo elementos visibles de la cinta de opciones; FALSE para buscar todos los elementos de la cinta de opciones.

bExcludeQAT
[in] TRUE para excluir elementos de la barra de herramientas de acceso rápido de la búsqueda; de lo contrario, FALSE.

Valor devuelto

Un puntero a un elemento de la cinta si tiene el ID de comando y los valores de búsqueda especificados; en caso contrario, NULL.

Comentarios

Un elemento de la cinta es cualquier control de la cinta que pueda añadirse a la misma, como un botón de la cinta, una categoría de la cinta o un deslizador de la cinta.

En general, puede haber más de un elemento de cinta de opciones que tenga el mismo identificador de comando. Si desea obtener punteros a todos los elementos de la cinta de opciones que usan un identificador de comando especificado, use el método CMFCRibbonBar::GetElementsByID.

`CMFCRibbonBar::FindCategoryIndexByData`

Recupera el índice de la categoría de la cinta que contiene los datos definidos por el usuario.

int FindCategoryIndexByData(DWORD dwData) const;

Parámetros

dwData
[in] Datos asociados a una categoría de la barra.

Valor devuelto

El índice de base cero de una categoría de la cinta de opciones si el método se realizó correctamente; en caso contrario, -1.

`CMFCRibbonBar::ForceRecalcLayout`

Ajusta el diseño de todos los elementos de la barra de cinta y la ventana primaria y vuelve a dibujar la ventana completa.

void ForceRecalcLayout();

Comentarios

`CMFCRibbonBar::GetActiveCategory`

Recupera un puntero a la categoría de cinta de opciones activa.

CMFCRibbonCategory* GetActiveCategory() const;

Valor devuelto

Puntero a la categoría de cinta de opciones activa; o NULL si no hay ninguna categoría activa.

Comentarios

Una categoría está activa si tiene el foco. De forma predeterminada, la categoría activa es la primera categoría en el lado izquierdo de la barra de la cinta de opciones.

La categoría principal se muestra cuando el usuario presiona el botón de aplicación y no puede ser la categoría activa.

`CMFCRibbonBar::GetApplicationButton`

Recupera un puntero al botón de la aplicación.

CMFCRibbonApplicationButton* GetApplicationButton() const;

Valor devuelto

Puntero al botón de la aplicación; o NULL si no se ha establecido el botón.

`CMFCRibbonBar::GetCaptionHeight`

Recupera el alto del área de subtítulo de la barra de cinta de opciones.

int GetCaptionHeight() const;

Valor devuelto

Alto, en píxeles, del área de subtítulo de la barra de cinta.

Comentarios

`CMFCRibbonBar::GetCategory`

Recupera un puntero a la categoría de la cinta de opciones en el índice especificado.

CMFCRibbonCategory* GetCategory(int nIndex) const;

Parámetros

nIndex
[in] Índice de base cero de una categoría de cinta de opciones en la lista de categorías de cinta de opciones contenidas en la barra de cinta de opciones.

Valor devuelto

Puntero a la categoría de la cinta de opciones en el índice especificado; de lo contrario, NULL si nIndex estaba fuera del intervalo.

`CMFCRibbonBar::GetCategoryCount`

Recupera el número de categorías de la cinta de la barra de cinta.

int GetCategoryCount() const;

Valor devuelto

El número de categorías de la cinta de la barra de opciones.

`CMFCRibbonBar::GetCategoryHeight`

Recupera el alto de la categoría.

int GetCategoryHeight() const;

Valor devuelto

La altura de la categoría.

Comentarios

La altura de la categoría incluye el alto de la pestaña categoría.

`CMFCRibbonBar::GetCategoryIndex`

Recupera el índice de la categoría de cinta especificada.

int GetCategoryIndex(CMFCRibbonCategory* pCategory) const;

Parámetros

pCategory
[in] Puntero a una categoría de la cinta.

Valor devuelto

Índice de base cero de una categoría de cinta especificada por pCategory; o -1 si no se encuentra la categoría de la cinta de opciones.

`CMFCRibbonBar::GetContextName`

Recupera el nombre del subtítulo de la categoría de contexto especificado por un ID de contexto.

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

Parámetros

uiContextID
[in] Un identificador de contexto de categoría de la cinta de opciones.

strName
[out] El nombre de un subtítulo de categoría de contexto.

Valor devuelto

TRUE si el método se realizó correctamente; de lo contrario, FALSE si uiContextID era cero o no se encontró el subtítulo de categoría de contexto.

`CMFCRibbonBar::GetDroppedDown`

Recupera el elemento de la cinta de opciones que está actualmente descartado.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor devuelto

Elemento de la cinta de opciones que está actualmente descartado; o NULL si no hay ningún elemento de cinta de opciones actualmente descartado.

Comentarios

`CMFCRibbonBar::GetElementsByID`

Recupera una matriz de punteros a todos los elementos de la cinta de opciones que tienen un identificador de comando específico.

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

Parámetros

uiCmdID
[in] Identificador de comando de un elemento de la cinta.

arButtons
[out] Una matriz de punteros a elementos de la cinta de opciones.

Comentarios

Varios elementos de la cinta de opciones pueden tener el mismo identificador de comando porque algunos elementos de la cinta de opciones se pueden copiar en la barra de herramientas de acceso rápido.

`CMFCRibbonBar::GetHideFlags`

Recupera las marcas que indican la cantidad de la barra de cinta de opciones visible.

DWORD GetHideFlags() const;

Valor devuelto

Marcas que indican la cantidad de la barra de cinta de opciones visible.

Comentarios

En la tabla siguiente se muestra la posible combinación de marcas para el valor devuelto:

Marca	Descripción
`AFX_RIBBONBAR_HIDE_ELEMENTS`	La barra de cinta de opciones se minimiza verticalmente y solo están visibles las pestañas de categoría, el botón principal y la barra de herramientas de acceso rápido.
`AFX_RIBBONBAR_HIDE_ALL`	El ancho de la barra de cinta de opciones es menor que el ancho mínimo y está completamente oculto.

`CMFCRibbonBar::GetItemIDsList`

Recupera los identificadores de comando de la colección especificada de elementos de la cinta de opciones en la barra de cinta.

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

Parámetros

lstItems
[out] La lista de identificadores de comando para los elementos de cinta de opciones que se encuentran en la barra de cinta de opciones.

bHiddenOnly
[in] TRUE para excluir elementos de la cinta de opciones que se muestran; FALSE para incluir todos los elementos de la cinta de opciones en la barra de la cinta de opciones.

Comentarios

`CMFCRibbonBar::GetKeyboardNavigationLevel`

Recupera el nivel de navegación actual a medida que el usuario presiona la información sobre teclas contenida en la barra de la cinta de opciones.

int GetKeyboardNavigationLevel() const;

Valor devuelto

El nivel de navegación actual a medida que el usuario presiona la información sobre teclas contenida en la barra de la cinta de opciones. En la tabla siguiente se muestran los valores devueltos posibles:

Valor	Descripción
-1	No se muestra información sobre claves.
0	Se muestra información sobre claves.
1	El usuario ha presionado una información sobre teclas mostrada.

Comentarios

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

Recupera el objeto de navegación del teclado actual en la barra de cinta de opciones.

CObject* GetKeyboardNavLevelCurrent() const;

Valor devuelto

Objeto de navegación del teclado actual en la barra de cinta de opciones; de lo contrario NULL, si ningún objeto muestra actualmente información sobre claves.

Comentarios

El objeto que actualmente muestra información sobre teclas es el objeto de navegación del teclado actual.

`CMFCRibbonBar::GetKeyboardNavLevelParent`

Recupera el objeto de navegación del teclado padre en la barra de la cinta.

CObject* GetKeyboardNavLevelParent() const;

Valor devuelto

El objeto de navegación del teclado padre en la barra de la cinta; de lo contrario NULL.

Comentarios

Cuando el usuario presiona una información sobre teclas en la barra de la cinta de opciones, el objeto de navegación del teclado actual se convierte en el objeto de navegación del teclado primario.

`CMFCRibbonBar::GetMainCategory`

Recupera un puntero a la categoría de cinta de opciones principal.

CMFCRibbonCategory* GetMainCategory() const;

Valor devuelto

Puntero a la categoría de la cinta principal.

Comentarios

La categoría principal de la cinta contiene el panel principal de la cinta de opciones.

`CMFCRibbonBar::GetQATCommandsLocation`

Recupera el rectángulo de visualización para la sección de comandos de la barra de herramientas de acceso rápido.

CRect GetQATCommandsLocation() const;

Valor devuelto

El rectángulo de visualización para la sección de comandos de la barra de herramientas de acceso rápido.

Comentarios

La sección de comandos del rectángulo de visualización no incluye el botón de personalización.

`CMFCRibbonBar::GetQATDroppedDown`

Recupera un puntero al elemento de la cinta de opciones de la barra de herramientas de acceso rápido que tiene su menú emergente desplegable.

CMFCRibbonBaseElement* GetQATDroppedDown();

Valor devuelto

Puntero al elemento de la cinta de opciones de la barra de herramientas de acceso rápido que tiene su menú emergente desplegable.

Comentarios

`CMFCRibbonBar::GetQuickAccessCommands`

Recupera una lista de identificadores de comando para los elementos de la cinta de opciones de la barra de herramientas de acceso rápido.

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

Parámetros

lstCommands
[out] Lista de identificadores de comando para los elementos de la cinta de opciones de la barra de herramientas de acceso rápido.

Comentarios

La lista no contiene elementos de cinta de opciones que son separadores de control.

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

Recupera el rectángulo de visualización para la barra de herramientas de acceso rápido.

CRect GetQuickAccessToolbarLocation() const;

Valor devuelto

Rectángulo de visualización de la barra de herramientas de acceso rápido.

Comentarios

`CMFCRibbonBar::GetTabTrancateRatio`

Recupera la reducción del tamaño de porcentaje en el ancho de pantalla de las pestañas de categoría.

int GetTabTrancateRatio() const;

Valor devuelto

Reducción del tamaño del porcentaje en el ancho de pantalla de las pestañas de categoría.

Comentarios

Las pestañas de categoría se reducen en ancho cuando no hay suficiente ancho en la barra de opciones.

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

Recupera el gran tamaño del ancho de la información sobre herramientas para la barra de opciones.

int GetTooltipFixedWidthLargeImage() const;

Valor devuelto

Tamaño grande del ancho de información sobre herramientas en píxeles.

Comentarios

Si el tamaño grande del ancho de la información sobre herramientas es 0, el ancho varía.

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

Recupera el tamaño normal del ancho de la información sobre herramientas para la barra de cinta de opciones.

int GetTooltipFixedWidthRegular() const;

Valor devuelto

Tamaño normal del ancho de información sobre herramientas en píxeles.

Comentarios

Si el tamaño normal del ancho de información sobre herramientas es 0, el ancho varía.

`CMFCRibbonBar::GetVisibleCategoryCount`

Recupera el número de categorías visibles en la barra de cinta de opciones.

int GetVisibleCategoryCount() const;

Valor devuelto

Número de categorías visibles en la barra de cinta de opciones.

Comentarios

`CMFCRibbonBar::HideAllContextCategories`

Oculta todas las categorías de contexto de la barra de cinta de opciones.

BOOL HideAllContextCategories();

Valor devuelto

TRUE si al menos una categoría de contexto estaba oculta; de lo contrario, FALSE.

Comentarios

Si una categoría de contexto está activa, la categoría activa se restablece a la primera categoría visible de la lista de categorías.

`CMFCRibbonBar::HideKeyTips`

Oculta toda la información sobre claves en la barra de la cinta de opciones.

void HideKeyTips();

Comentarios

`CMFCRibbonBar::HitTest`

Recupera un puntero al elemento de cinta especificado por la ubicación del punto.

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

Parámetros

point
[in] Ubicación del punto en las coordenadas de la barra de la cinta de opciones.

bCheckActiveCategory
[in] TRUE para buscar en la categoría activa; FALSE no buscar en la categoría activa.

bCheckPanelCaption
[in] TRUE para probar el subtítulo del panel de la cinta de opciones con el punto ubicado en él; FALSE no probar el subtítulo del panel de la cinta de opciones con el punto ubicado en él. Consulte la sección Comentarios para obtener más información.

Valor devuelto

Puntero al elemento de cinta ubicado en el punto especificado; De lo contrario, NULL si el punto no se encuentra en un elemento de cinta de opciones.

Comentarios

El subtítulo del panel de la cinta de opciones con el punto ubicado en él no se prueba a menos que el bCheckActiveCategory parámetro sea TRUE.

`CMFCRibbonBar::IsKeyTipEnabled`

Indica si la característica de información sobre claves está habilitada.

BOOL IsKeyTipEnabled() const;

Valor devuelto

TRUE si la característica está habilitada; de lo contrario, FALSE.

`CMFCRibbonBar::IsMainRibbonBar`

Indica si la barra de cinta de opciones es la barra de cinta principal.

virtual BOOL IsMainRibbonBar() const;

Valor devuelto

Siempre devuelve TRUE.

Comentarios

De forma predeterminada, este método siempre devuelve TRUE. Invalide este método para indicar si la barra de cinta de opciones es la barra de cinta principal.

`CMFCRibbonBar::IsPrintPreviewEnabled`

Indica si la característica Vista previa de impresión está habilitada.

BOOL IsPrintPreviewEnabled() const;

Valor devuelto

TRUE si la característica Vista previa de impresión está habilitada; de lo contrario, FALSE.

`CMFCRibbonBar::IsQATEmpty`

Indica si la barra de herramientas de acceso rápido contiene botones de comando.

BOOL IsQATEmpty() const;

Valor devuelto

TRUEsi la barra de herramientas de acceso rápido contiene botones de comando FALSE.

Comentarios

`CMFCRibbonBar::IsQuickAccessToolbarOnTop`

Indica si la barra de herramientas de acceso rápido se encuentra sobre o en la barra de la cinta de opciones.

BOOL IsQuickAccessToolbarOnTop() const;

Valor devuelto

TRUE si la barra de herramientas de acceso rápido se encuentra sobre la barra de cinta de opciones; FALSE si la barra de herramientas de acceso rápido se encuentra en la barra de la cinta de opciones.

`CMFCRibbonBar::IsReplaceFrameCaption`

Indica si la barra de la cinta reemplaza o está bajo el subtítulo de la ventana de marco principal.

BOOL IsReplaceFrameCaption() const;

Valor devuelto

TRUE si la barra de la cinta reemplaza el subtítulo de la ventana de marco principal; FALSE si la barra de la cinta está bajo el subtítulo de la ventana de marco principal.

`CMFCRibbonBar::IsShowGroupBorder`

Indica si los grupos de botones ubicados en la barra de la cinta muestran un borde de grupo.

virtual BOOL IsShowGroupBorder(CMFCRibbonButtonsGroup* pGroup) const;

Parámetros

pGroup
[in] Este parámetro no se usa.

Valor devuelto

Siempre devuelve FALSE.

Comentarios

De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para indicar si los grupos de botones ubicados en la barra de cinta muestran un borde de grupo.

`CMFCRibbonBar::IsToolTipDescrEnabled`

Indica si las descripciones de las herramientas están habilitadas.

BOOL IsToolTipDescrEnabled() const;

Valor devuelto

TRUE si las descripciones sobre herramientas están habilitadas; FALSE si las descripciones sobre herramientas están deshabilitadas.

Comentarios

Las descripciones de la información sobre herramientas son texto descriptivo adicional que se muestra con el texto de la información sobre herramientas.

`CMFCRibbonBar::IsToolTipEnabled`

Indica si la información sobre herramientas está habilitada o deshabilitada para la barra de cinta de opciones.

BOOL IsToolTipEnabled() const;

Valor devuelto

TRUE si las herramientas están habilitadas; FALSE si las herramientas están deshabilitadas.

`CMFCRibbonBar::IsTransparentCaption`

Indica si la pantalla está establecida para la combinación de colores Aero de Windows.

BOOL IsTransparentCaption() const;

Valor devuelto

TRUE si la combinación de colores es Windows Aero; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::OnClickButton`

Este método se mantiene por compatibilidad con las aplicaciones existentes y no debería utilizarse para nuevos desarrollos.

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

Parámetros

pButton
[in] Puntero al botón en el que se hizo clic.

point
[in] Este parámetro no se usa.

Comentarios

`CMFCRibbonBar::OnEditContextMenu`

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

Parámetros

[in] pEdit
[in] point\

Comentarios

`CMFCRibbonBar::OnRTLChanged`

Llamado por el marco de trabajo cuando el diseño cambia de dirección.

virtual void OnRTLChanged(BOOL bIsRTL);

Parámetros

bIsRTL
[in] TRUE si el diseño está de derecha a izquierda; FALSE si el diseño está de izquierda a derecha.

Comentarios

Este método ajusta el diseño de todos los controles de la barra de la cinta de opciones para la nueva dirección de diseño.

`CMFCRibbonBar::OnSetAccData`

Este método es interno del marco y no está destinado a que se lo llame desde el código del usuario.

BOOL OnSetAccData(long lVal);

Parámetros

long lVal El índice del objeto al que se puede acceder.

Valor devuelto

S_OK si es correcto; de lo contrario, FALSE o S_FALSE.

Comentarios

`CMFCRibbonBar::OnShowRibbonContextMenu`

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

Parámetros

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

Valor devuelto

Comentarios

`CMFCRibbonBar::OnShowRibbonQATMenu`

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

Parámetros

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

Valor devuelto

Comentarios

`CMFCRibbonBar::OnSysKeyDown`

Lo llama el marco cuando el usuario presiona la tecla F10 o mantiene presionada la tecla ALT y, a continuación, presiona otra tecla.

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

Parámetros

pFrameWnd
[in] Puntero a la ventana principal del marco principal de la barra de cinta de opciones.

wParam
[in] Código de tecla virtual de la tecla que se está presionando.

lParam
[in] Marcas de estado del teclado cuando se presionó la tecla.

Valor devuelto

TRUE si se procesó el evento de pulsación de teclas; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::OnSysKeyUp`

Lo llama el marco cuando el usuario suelta la tecla F10, la tecla ALT o una tecla que se presionó cuando se mantuvo presionada la tecla ALT.

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

Parámetros

pFrameWnd
[in] Puntero a la ventana principal del marco principal de la barra de cinta de opciones.

wParam
[in] Código de la llave virtual que se libera.

lParam
[in] Este parámetro no se usa.

Valor devuelto

TRUE si se procesó el evento de pulsación de teclas; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::PopTooltip`

Quita una información sobre herramientas de la vista.

void PopTooltip();

Comentarios

`CMFCRibbonBar::PreTranslateMessage`

Determina si la barra de cinta procesa el mensaje especificado.

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parámetros

pMsg
[in] Puntero a un mensaje.

Valor devuelto

TRUE si el mensaje ha sido procesado por la barra de la cinta; en caso contrarioFALSE.

Comentarios

`CMFCRibbonBar::RecalcLayout`

Ajusta el diseño de todos los controles de la barra de opciones.

virtual void RecalcLayout();

Comentarios

Después del ajuste del diseño, se actualiza la presentación de la barra de la cinta de opciones.

`CMFCRibbonBar::RemoveAllCategories`

Elimina todas las categorías de la cinta de opciones de la barra de opciones.

void RemoveAllCategories();

Comentarios

Este método elimina todas las categorías de la cinta de opciones de la memoria y de la lista de categorías.

`CMFCRibbonBar::RemoveAllFromTabs`

Quita todos los elementos de la cinta de opciones del área de pestañas.

void RemoveAllFromTabs();

Comentarios

Usa esta función si desea quitar todos los elementos que agregó al área de tabulación mediante el método CMFCRibbonBar::AddToTabs.

`CMFCRibbonBar::RemoveCategory`

Elimina la categoría de cinta especificada de la barra de cinta de opciones.

BOOL RemoveCategory(int nIndex);

Parámetros

nIndex
[in] El índice basado en cero de una categoría en la lista de categorías de la cinta que está contenida en la barra de la cinta.

Valor devuelto

TRUE si se eliminó la categoría de cinta especificada; de lo contrario, FALSE.

Comentarios

La categoría de cinta especificada se elimina de la memoria y de la lista de categorías.

`CMFCRibbonBar::SetActiveCategory`

Establece la categoría de cinta especificada como categoría activa.

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

Parámetros

pCategory
[in] Una categoría de cinta de opciones contenida en la barra de cinta de opciones.

bForceRestore
[in] TRUE para maximizar la barra de cinta de opciones si está minimizada; FALSE para mostrar la categoría activa en una ventana emergente si la barra de cinta de opciones está minimizada.

Valor devuelto

TRUE si la categoría especificada se estableció como la categoría activa; de lo contrario, FALSE.

Comentarios

La categoría principal de la cinta de opciones no puede ser la categoría activa.

Si no se muestra la categoría especificada por pCategory , no se puede establecer como la categoría activa.

`CMFCRibbonBar::SetActiveMDIChild`

Asocia los botones del sistema en la barra de cinta de opciones que pertenecen a una ventana secundaria de interfaz de varios documentos (MDI) a la ventana secundaria MDI especificada.

void SetActiveMDIChild(CWnd* pWnd);

Parámetros

pWnd
[in] Puntero a una ventana secundaria de MDI.

Comentarios

`CMFCRibbonBar::SetApplicationButton`

Asigna un botón de la cinta de opciones de aplicación a la barra de cinta.

void SetApplicationButton(
    CMFCRibbonApplicationButton* pButton,
    CSize sizeButton);

Parámetros

pButton
[in] Un puntero al botón de la cinta de opciones de la aplicación.

sizeButton
[in] El tamaño del botón de la cinta de opciones de la aplicación.

Comentarios

El botón de la barra de opciones de la aplicación es un botón redondeado grande situado en la esquina superior izquierda de la barra de control.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método SetApplicationButton de la clase 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`

Establece las sugerencias de teclas para todos los elementos de la cinta de opciones que tienen el identificador de comando especificado.

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

Parámetros

uiCmdID
[in] El identificador de comando de un elemento de la cinta.

lpszKeys
[in] Información sobre las teclas.

lpszMenuKeys
[in] Información sobre teclas del menú.

Valor devuelto

TRUE si se establecen las informaciones clave de al menos un elemento de cinta de opciones; de lo contrario, FALSE.

Comentarios

La información sobre teclas de menú opcional es para los elementos de la cinta de opciones con un botón de división que abre un menú emergente.

`CMFCRibbonBar::SetKeyboardNavigationLevel`

Establece el nivel de navegación del teclado a medida que el usuario presiona las teclas que se encuentran en la barra de la cinta.

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

Parámetros

pLevel
[in] Puntero al objeto de navegación del teclado actual.

bSetFocus
[in] TRUE para establecer el foco del teclado en la barra de cinta de opciones.

Comentarios

La navegación por el teclado de la barra de la cinta se inicia cuando el usuario presiona la tecla ALT o F10. El usuario selecciona el siguiente nivel de navegación presionando una información sobre teclas en la barra de la cinta de opciones. El usuario puede volver al nivel de navegación anterior presionando la tecla de escape.

`CMFCRibbonBar::SetMaximizeMode`

Ajusta la barra de cinta cuando el tamaño de la ventana de una ventana secundaria de interfaz de varios documentos (MDI) entra o sale del estado maximizado.

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

Parámetros

bMax
[in] TRUE para mostrar los botones del sistema para una ventana secundaria MDI en la barra de cinta; FALSE para quitar los botones del sistema de una ventana secundaria MDI de la barra de cinta de opciones.

pWnd
[in] Puntero a la ventana del marco principal para la barra de la cinta.

Comentarios

La barra de cinta de opciones muestra los botones del sistema para una ventana secundaria MDI en la fila de fichas cuando se maximiza una ventana secundaria MDI.

`CMFCRibbonBar::SetQuickAccessCommands`

Agrega uno o más elementos de la cinta de opciones a la barra de herramientas de acceso rápido.

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

Parámetros

lstCommands
[in] La lista de comandos que se van a colocar en la barra de herramientas de acceso rápido.

bRecalcLayout
[in] TRUE si deseas volver a dibujar la cinta después de agregar los elementos de la cinta de opciones; de lo contrario, FALSE.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método SetQuickAccessCommands de la clase 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`

Establece la barra de herramientas de acceso rápido en el estado predeterminado.

void SetQuickAccessDefaultState(const CMFCRibbonQuickAccessToolBarDefaultState& state);

Parámetros

state
[in] El estado predeterminado de la barra de herramientas de acceso rápido.

Comentarios

El estado de la barra de herramientas de acceso rápido incluye una lista de comandos y su visibilidad.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método SetQuickAccessDefaultState de la clase 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`

Coloca la barra de herramientas de acceso rápido encima o debajo de la barra de cinta.

void SetQuickAccessToolbarOnTop(BOOL bOnTop);

Parámetros

bOnTop
[in] TRUE para colocar la barra de herramientas de acceso rápido encima de la barra de cinta; FALSE para colocar la barra de herramientas de acceso rápido debajo de la barra de la cinta de opciones.

`CMFCRibbonBar::SetTooltipFixedWidth`

Establece los tamaños normales y grandes de anchos fijos de información sobre herramientas para la barra de cinta de opciones.

void SetTooltipFixedWidth(
    int nWidthRegular,
    int nWidthLargeImage);

Parámetros

nWidthRegular
[in] El ancho, en píxeles, de información sobre herramientas de tamaño fijo normal.

nWidthLargeImage
[in] El ancho, en píxeles, de una información sobre herramientas de gran tamaño fijo.

Comentarios

Si se establece un parámetro en 0, el ancho correspondiente varía.

`CMFCRibbonBar::ShowCategory`

Muestra u oculta la categoría de la cinta de opciones especificada.

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

Parámetros

nIndex
[in] El índice de la categoría de la cinta de opciones.

bShow
[in] Si TRUE, muestre la categoría de la cinta de opciones; de lo contrario, oculta la categoría de la barra de opciones.

`CMFCRibbonBar::ShowContextCategories`

Muestra u oculta las categorías de contexto que tienen el identificador especificado.

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

Parámetros

uiContextID
[in] El identificador de categoría de contexto.

bShow
[in] Si TRUE, muestra las categorías que tienen el identificador especificado; de lo contrario, oculta las categorías que tienen el identificador especificado.

`CMFCRibbonBar::ShowKeyTips`

Muestra la información sobre claves de cada elemento de la cinta de opciones en la barra de cinta de opciones.

void ShowKeyTips();

Comentarios

`CMFCRibbonBar::ToggleMimimizeState`

Alterna la barra de cinta entre los estados minimizado y maximizado.

void ToggleMimimizeState();

Comentarios

El error ortográfico en el nombre del método es un problema conocido.

En el estado minimizado, el control de cinta está oculto y solo se muestran las pestañas. Cuando el usuario hace clic en una pestaña, el control de cinta se muestra como una ventana emergente. La ventana se cierra cuando el usuario hace clic fuera o ejecuta un comando.

`CMFCRibbonBar::TranslateChar`

Determina si la barra de cinta procesa el código de carácter de pulsación de tecla especificado.

virtual BOOL TranslateChar(UINT nChar);

Parámetros

nChar
[in] Un código de carácter de pulsación de tecla de usuario.

Valor devuelto

si el código de carácter ha sido procesado por la barra de la cinta TRUE; en caso contrarioFALSE.

Comentarios

La característica keytips permite a los usuarios navegar por la barra de cinta mediante el teclado.

`CMFCRibbonBar::GetFocused`

Devuelve un elemento que tiene el foco.

virtual CMFCRibbonBaseElement* GetFocused();

Valor devuelto

Puntero a un elemento centrado o NULL.

Comentarios

`CMFCRibbonBar::IsWindows7Look`

Indica si la cinta de opciones tiene la apariencia de Windows 7 (botón de aplicación rectangular pequeño).

BOOL IsWindows7Look() const;

Valor devuelto

TRUE si la cinta de opciones tiene un aspecto de Windows 7; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::LoadFromResource`

Con sobrecarga. Carga una barra de cinta a partir de los recursos de la aplicación.

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 el identificador de recurso de la cadena XML con información de la barra de opciones.

lpszResType
Especifica el tipo del recurso ubicado en uiXMLResID.

hInstance
Manejador del módulo cuyo archivo ejecutable contiene el recurso. Si hInstance es NULL, el sistema carga el recurso desde el módulo que se usó para crear el proceso actual.

lpszXMLResID
Especifica el ID del recurso (en forma de cadena) con la información de la Barra de opciones.

Valor devuelto

TRUE si la carga se ejecuta correctamente; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::SaveToXMLBuffer`

Guarda la barra de cinta en un búfer.

UINT SaveToXMLBuffer(LPBYTE* ppBuffer) const;

Parámetros

ppBuffer
Cuando esta función devuelve, ppBuffer apunta a un búfer asignado por este método y contiene información de barra de opciones en formato XML.

Valor devuelto

TRUE si es correcto; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::SaveToXMLFile`

Guarda la barra de opciones en un archivo XML.

BOOL SaveToXMLFile(LPCTSTR lpszFilePath) const;

Parámetros

lpszFilePath
Especifica el archivo de salida.

Valor devuelto

TRUE si es correcto; de lo contrario, FALSE.

Comentarios

`CMFCRibbonBar::SetWindows7Look`

Habilita o deshabilita una apariencia de Windows 7 (pequeño botón de aplicación rectangular) para la barra de opciones.

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

Parámetros

bWindows7Look
TRUE establece un aspecto de Windows 7; de lo contrario FALSE.

bRecalc
TRUE recalcula el diseño de la cinta de opciones; de lo contrario FALSE.

Comentarios

Consulte también

Gráfico de jerarquías
Clases
CPane (clase)
CMFCRibbonCategory (clase)
CMFCRibbonPanel (clase)
CMFCRibbonBaseElement (clase)
Tutorial: Actualizar la aplicación Scribble de MFC

Compartir a través de

Clase CMFCRibbonBar

Sintaxis

Miembros

Constructores públicos

Métodos públicos

Comentarios

Jerarquía de herencia

Requisitos

CMFCRibbonBar::ActivateContextCategory

Parámetros

Valor devuelto

CMFCRibbonBar::AddCategory

Parámetros

Valor devuelto

Comentarios

Ejemplo

CMFCRibbonBar::AddContextCategory

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::AddMainCategory

Parámetros

Valor devuelto

Comentarios

Ejemplo

CMFCRibbonBar::AddPrintPreviewCategory

Valor devuelto

Comentarios

CMFCRibbonBar::AddQATOnlyCategory

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::AddToTabs

Parámetros

Comentarios

CMFCRibbonBar::CMFCRibbonBar

Parámetros

Comentarios

CMFCRibbonBar::Create

Parámetros

Valor devuelto

Comentarios

Ejemplo

CMFCRibbonBar::CreateEx

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::DeactivateKeyboardFocus

Parámetros

Comentarios

CMFCRibbonBar::DrawMenuImage

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::DWMCompositionChanged

Comentarios

CMFCRibbonBar::EnableKeyTips

Parámetros

Comentarios

CMFCRibbonBar::EnablePrintPreview

Parámetros

Comentarios

CMFCRibbonBar::EnableToolTips

Parámetros

Comentarios

CMFCRibbonBar::FindByData

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::FindByID

Parámetros

Valor devuelto

Comentarios

CMFCRibbonBar::FindCategoryIndexByData

Parámetros

Valor devuelto

CMFCRibbonBar::ForceRecalcLayout

Comentarios

CMFCRibbonBar::GetActiveCategory

Clase `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`