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:

• Call CBCGPRibbonBar::AddBackstageCategory and store the returned pointer to CBCGPRibbonBackstageViewPanel.
• Call CBCGPRibbonBackstageViewPanel::AddCommand to add commands.
• Add dialog resources if you need any views.
• Call CBCGPRibbonBackstageViewPanel::AddView to add views specifying Resource IDs of dialog templates you've added in step 3.

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
	AddCommand	Adds a command to Backstage View
	AddPrintPreview	Adds a "Print" page.
	AddRecentView	Adds a "Recent" page.
	AddSeparatorToBottom	Adds separator to bottom.
	AddView	Adds view to Backstage View.
	AttachPrintPreviewToItem	Attaches a "Print" page to existing item.
	AttachRecentViewToItem	Attaches a "Recent" page to existing item.
	AttachViewToItem	Attaches a page to existing item.
	GetSelectedViewIndex	Returns a zero-based index of the currently selected backstage view.
Public Member Functions inherited from CBCGPRibbonMainPanel
	AddRecentFilesList	Adds a text string, which will be placed in the "recent files list" menu.
	AddToBottom	Adds an element to the bottom area of the main panel.
	AddToRight	Adds a ribbon element to the right pane.
	EnableCommandSearch	Shows or hides command search box at the bottom of Main Ribbon Panel.
Public Member Functions inherited from CBCGPRibbonPanel
	AddSeparator	Adds a separator to the ribbon panel.
	AddToolBar	Adds a toolbar to the ribbon panel.
	EnableLaunchButton	Tells the ribbon panel to display the launch button.
	FindByData	Finds an element by its user-defined data.
	FindByID	Finds an element by its command ID.
	GetApplicationModes	Gets application modes where this panel is visible.
	GetCount	Returns the number of elements in the ribbon panel.
	GetData	Returns the value of user-defined data associated with the panel.
	GetElement	Returns a pointer to ribbon element located at the specified index.
	GetElements	Retrieves all elements contained in ribbon panel.
	GetParentCategory	Returns parent category
	Insert	Inserts a ribbon element at the given position.
	InsertSeparator	Inserts a separator at the given position.
	IsAlwaysAlignByColumn	Tells whether the ribbon panel should be alway aligned by column.
	IsCenterColumnVert	Tells whether all panel elements should be centered (aligned) vertically, by column.
	IsJustifyColumns	Tells whether all panel columns take the same width, or not.
	IsPreserveElementOrder	Tells whether the ribbon panel preserves the element order, or not.
	Remove	Removes and optionally deletes an element located at the specified index.
	RemoveAll	Removes all elements from ribbon panel.
	Replace	Replaces one element with another by index.
	ReplaceByID	Replaces one element with another by command ID.
	SetAlwaysAlignByColumn	Specifies whether the ribbon panel should be alway aligned by column.
	SetApplicationModes	Sets application modes where this panel is visible.
	SetCenterColumnVert	Orders the panel to align elements vertically, by column.
	SetData	Associates user-defined data with ribbon panel.
	SetElementMenu	Assigns a popup menu to element with the given command ID.
	SetElementMenu	Assigns a popup menu to element with the given command ID.
	SetElementRTC	Specifies a runtime class of element located at the given position.
	SetElementRTCByID	Specifies a runtime class of element with given command ID.
	SetJustifyColumns	Enables or disables justification of columns.
	SetKeys	Sets a key tip for the "default" panel button.
	SetPreserveElementOrder	Tells the Ribbon panel whether to preserve the element order, or not.
Public Member Functions inherited from CBCGPPageTransitionManager
	GetAnimationOptions	Gets a page transition animation options.
	GetAnimationType	Gets a page transition animation type.
	GetPageTransitionEffect	Gets a page transition effect.
	SetPageTransitionEffect	Specifies a page transition effect.
	StartPageTransition	Starts the page transition for the array of pages.
	StartPageTransition	Starts 2-page transition.
	StopPageTransition	Stops the page transition.
Public Member Functions inherited from CBCGPAnimationManager
	CBCGPAnimationManager	Default constructor.
	GetAnimatedValue	Gets current animated value.
	GetAnimationDuration	Gets animation duration.
	GetLastAnimationError	Gets the animation error returned by recent call to Windows Animation API.
	IsAnimated	Checks if animation is running.
	StartAnimation	Starts an animation.
	StartFlashAnimation	Starts "flash" animation.
	StopAnimation	Stops 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
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
Protected Member Functions inherited from CBCGPRibbonPanel
	CBCGPRibbonPanel	Constructs a ribbon panel object.
	CBCGPRibbonPanel	Constructs a ribbon panel object.
	CBCGPRibbonPanel	Constructs a ribbon panel object.
Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.