BCGControlBar Pro for MFC
CBCGPRibbonBackstageViewItemPropertySheet

Detailed Description

The CBCGPRibbonBackstageViewItemPropertySheet class implements functionality of a child property sheet placed on Backstage View. You should use this class when you need to associate a property sheet with a view entry in the list of items displayed at the left side of Backstage View.

A property sheet placed on Backstage View displays page tabs at the left side. It's possible to create groups of tabs. You can use CBCGPRibbonBackstageViewItemPropertySheet::AddGroup to add a group and CBCGPRibbonBackstageViewItemPropertySheet::AddPage to add a page.

See also
CBCGPRibbonBackstageViewPanel, CBCGPRibbonBackstageViewItemForm

The following example illustrates how to add a view with a property sheet to Backstage View:

Copy
// Create a new backstage view panel:
CBCGPRibbonBackstageViewPanel* pBackstagePanel = m_wndRibbonBar.AddBackstageCategory( _T("File"), IDB_FILESMALL);
// Create a multi-page form:
// Add pages (groups) to this form:
pFormShare->AddGroup(_T("Share"/*"The first group"*/));
pFormShare->AddPage(&m_Page1); pFormShare->AddPage(&m_Page2);
pFormShare->AddPage(&m_Page3); pFormShare->AddPage(&m_Page4);
pFormShare->AddGroup(_T("File Types"/*"The second group - long text!"*/));
pFormShare->AddPage(&m_Page5); pFormShare->AddPage(&m_Page6);
// Set watermark image:
pFormShare->SetWaterMarkImage(IDB_BS_WATERMARK, RGB(0, 0, 192));
// Add form to backstage panel:
pBackstagePanel->AddView(0, _T("Share"), pFormShare);
+ Inheritance diagram for CBCGPRibbonBackstageViewItemPropertySheet:

Public Member Functions

 CBCGPRibbonBackstageViewItemPropertySheetConstructor.
 
 AddGroupAdds a group to property sheet.
 
 AddPageAdds a page to property sheet.
 
 RemoveAllRemoves all pages and groups.
 
- Public Member Functions inherited from CBCGPRibbonBackstageViewItemForm
 SetWaterMarkImageSets watermark image.
 
- Public Member Functions inherited from CBCGPBaseRibbonElement
 CanBeAddedToContextMenuTells whether ribbon element can be added to context menu.
 
 CanBeRemovedFromQATTells whether ribbon element can be removed from QAT.
 
 CanBeResizedInGroupVerticallyTells whether a ribbon element can be vertically resized in the parent group.
 
 GetApplicationModesGets application modes where this control is visible.
 
 GetBackstageAttachedViewReturns a ribbon element, which is placed at the right side of backstage and controlled by this ribbon element.
 
 GetCompactSizeReturns compact size of ribbon element.
 
 GetCursorAllows to specify a Ribbon control's custom mouse cursor.
 
 GetDataRetrieves a user-defined data associated with ribbon element.
 
 GetDescriptionReturns ribbon element description.
 
 GetIDReturns ribbon element command ID.
 
 GetImageSizeReturns image size of ribbon element.
 
 GetIntermediateSizeReturns the size of ribbon element in "intermediate" state.
 
 GetKeysReturns key tip associated with ribbon element.
 
 GetMenuKeysReturns key tips associated with split button.
 
 GetRectReturns bounding rectangle of ribbon element.
 
 GetSizeReturns current size of ribbon element.
 
 GetTextReturns ribbon element text.
 
 GetToolTipTextReturns tooltip text of ribbon element.
 
 HasCompactModeTells whether the ribbon element has "compact mode".
 
 HasIntermediateModeTells whether the ribbon element has "intermediate mode".
 
 HasLargeModeTells whether the ribbon element has "large mode".
 
 IsBackstageViewModeTells whether a ribbon element works in "backstage view" mode.
 
 IsCheckedTells whether ribbon element is checked.
 
 IsCompactModeTells whether ribbon element is in compact mode.
 
 IsDisabledTells whether ribbon element is disabled.
 
 IsDroppedDownTells whether ribbon element is dropped down (displays a popup menu).
 
 IsFocusedTells whether ribbon element is focused.
 
 IsHighlightedTells whether ribbon element is highlighted.
 
 IsPressedTells whether ribbon element is pressed.
 
 OnShowPopupMenuCalled when ribbon element is going to display a popup menu.
 
 SetApplicationModesSets application modes where this control is visible.
 
 SetDataAssociates a user-defined data with ribbon element.
 
 SetDescriptionSets ribbon element description.
 
 SetIDSets command ID of ribbon element.
 
 SetKeysSets a key tip for ribbon element.
 
 SetTextSets text to ribbon element.
 
 SetToolTipTextSets tooltip text for ribbon element.
 

Additional Inherited Members

- Public Types inherited from CBCGPBaseRibbonElement
enum  RibbonElementLocation
 
- Protected Member Functions inherited from CBCGPBaseRibbonElement
 OnBeforeDestroyParentMenuBarCalled by the framework before the parent menu windo is destroyed.
 
 OnProcessKeyCalled by the framework when a ribbon element should process keyboard input.
 
 OnSetFocusCalled by the framework when a ribbon element receives or loses the input focus.