BCGControlBar Pro for MFC
CBCGPRibbonBackstageViewPanel

Detailed Description

The CBCGPRibbonBackstageViewPanel class is a key class to manipulate the Backstage View.

"Backstage View" interface was introduced in Microsoft Office 2010. Ribbon Control has a special category called "Backstage Category" (see CBCGPRibbonBar::AddBackstageCategory). When you click this category's tab, Ribbon Control gets minimized and opens a backstage view, which fills the entire client area. This area is broken into two parts: a list of items at the left side and view area at the right side. The list of items may contain commands and view names.

  • When you click a command, backstage view is closed, returning the application to the previous state (meaning docking bar positions etc) and the command is executed.
  • When you click a view name, the corresponding view is displayed at the right side. This view may contain any additional information related to the current logical view selected at the left side. The logical view can be represented either by form (CBCGPRibbonBackstageViewItemForm), or property sheet (CBCGPRibbonBackstageViewItemPropertSheet).

You need to perform the following steps in order to initialize Backstage View:

Commands and views are displayed in the same order as you call AddCommand() and AddView() during initialization.

See also
CBCGPRibbonBackstageViewItemForm, CBCGPRibbonBackstageViewItemPropertySheet
+ Inheritance diagram for CBCGPRibbonBackstageViewPanel:

Public Member Functions

 AddCommandAdds a command to Backstage View
 
 AddPrintPreviewAdds a "Print" page.
 
 AddRecentViewAdds a "Recent" page.
 
 AddSeparatorToBottomAdds separator to bottom.
 
 AddViewAdds view to Backstage View.
 
 AttachPrintPreviewToItemAttaches a "Print" page to existing item.
 
 AttachRecentViewToItemAttaches a "Recent" page to existing item.
 
 AttachViewToItemAttaches a page to existing item.
 
- Public Member Functions inherited from CBCGPRibbonMainPanel
 AddRecentFilesListAdds a text string, which will be placed in the "recent files list" menu.
 
 AddToBottomAdds an element to the bottom area of the main panel.
 
 AddToRightAdds a ribbon element to the right pane.
 
 EnableCommandSearchShows or hides command search box at the bottom of Main Ribbon Panel.
 
- Public Member Functions inherited from CBCGPRibbonPanel
 AddSeparatorAdds a separator to the ribbon panel.
 
 AddToolBarAdds a toolbar to the ribbon panel.
 
 EnableLaunchButtonTells the ribbon panel to display the launch button.
 
 FindByDataFinds an element by its user-defined data.
 
 FindByIDFinds an element by its command ID.
 
 GetApplicationModesGets application modes where this panel is visible.
 
 GetCountReturns the number of elements in the ribbon panel.
 
 GetDataReturns the value of user-defined data associated with the panel.
 
 GetElementReturns a pointer to ribbon element located at the specified index.
 
 GetElementsRetrieves all elements contained in ribbon panel.
 
 GetParentCategoryReturns parent category
 
 InsertInserts a ribbon element at the given position.
 
 InsertSeparatorInserts a separator at the given position.
 
 IsAlwaysAlignByColumnTells whether the ribbon panel should be alway aligned by column.
 
 IsCenterColumnVertTells whether all panel elements should be centered (aligned) vertically, by column.
 
 IsJustifyColumnsTells whether all panel columns take the same width, or not.
 
 IsPreserveElementOrderTells whether the ribbon panel preserves the element order, or not.
 
 RemoveRemoves and optionally deletes an element located at the specified index.
 
 RemoveAllRemoves all elements from ribbon panel.
 
 ReplaceReplaces one element with another by index.
 
 ReplaceByIDReplaces one element with another by command ID.
 
 SetAlwaysAlignByColumnSpecifies whether the ribbon panel should be alway aligned by column.
 
 SetApplicationModesSets application modes where this panel is visible.
 
 SetCenterColumnVertOrders the panel to align elements vertically, by column.
 
 SetDataAssociates user-defined data with ribbon panel.
 
 SetElementMenuAssigns a popup menu to element with the given command ID.
 
 SetElementMenuAssigns a popup menu to element with the given command ID.
 
 SetElementRTCSpecifies a runtime class of element located at the given position.
 
 SetElementRTCByIDSpecifies a runtime class of element with given command ID.
 
 SetJustifyColumnsEnables or disables justification of columns.
 
 SetKeysSets a key tip for the "default" panel button.
 
 SetPreserveElementOrderTells the Ribbon panel whether to preserve the element order, or not.
 
- Public Member Functions inherited from CBCGPPageTransitionManager
 GetAnimationOptionsGets a page transition animation options.
 
 GetAnimationTypeGets a page transition animation type.
 
 GetPageTransitionEffectGets a page transition effect.
 
 SetPageTransitionEffectSpecifies a page transition effect.
 
 StartPageTransitionStarts the page transition for the array of pages.
 
 StartPageTransitionStarts 2-page transition.
 
 StopPageTransitionStops the page transition.
 
- Public Member Functions inherited from CBCGPAnimationManager
 CBCGPAnimationManagerDefault constructor.
 
 GetAnimatedValueGets current animated value.
 
 GetAnimationDurationGets animation duration.
 
 GetLastAnimationErrorGets the animation error returned by recent call to Windows Animation API.
 
 IsAnimatedChecks if animation is running.
 
 StartAnimationStarts an animation.
 
 StartFlashAnimationStarts "flash" animation.
 
 StopAnimationStops an animation.
 

Additional Inherited Members

- Public Types inherited from CBCGPPageTransitionManager
enum  BCGPPageTransitionEffect
 
- Public Types inherited from CBCGPAnimationManager
enum  BCGPAnimationType
 
- Static Public Member Functions inherited from CBCGPAnimationManager
 IsAnimationSupportedByOSChecks if animation is supported by OS.
 
- Protected Member Functions inherited from CBCGPRibbonPanel
 CBCGPRibbonPanelConstructs a ribbon panel object.
 
 CBCGPRibbonPanelConstructs a ribbon panel object.
 
 CBCGPRibbonPanelConstructs a ribbon panel object.
 
- Protected Member Functions inherited from CBCGPAnimationManager
 OnAnimationIdleCalled by the framework in an animation idle time.