CBCGPPropertySheet

Detailed Description

The CBCGPPropertySheet class extends the functionality of MFC's CPropertySheet. It displays property pages in many different ways. For example, as a regular property sheet (with tabs located on the top) or as outlook bar control where each outlook button corresponds to a property page.

Also, the property sheet provides the following additional features:

• Visual themes
• Page transition effect
• Custom header area
• Support for the gesture swipes for the page changing
• Colored and textured background of the pages
• Notification badges

To use CBCGPPropertySheet in your application you have to perform the following steps:

• Derive a class from CBCGPPropertySheet (for example, CMyPropertySheet).
• For each property page derive specific page classes from CBCGPPropertyPage.
• In the constructor of CMyPropertySheet call SetLook() with either CBCGPPropertySheet::PropSheetLook_OutlookBar value to use outlook bar for switching between property pages, or with CBCGPPropertySheet::PropSheetLook_Tree to use a tree control, or with CBCGPPropertySheet::PropSheetLook_OneNoteTabs to use OneNote style tabs, or with CBCGPPropertySheet::PropSheetLook_List to display a list at the left side of property sheet (similar to Office 2007 Options),
• or with CBCGPPropertySheet::PropSheetLook_AeroWizard to use Aero Wizard style.
• If you create a property sheet with outlook bar you need to call SetIconsList() to associate image list with property pages.
• For each property page call the AddPage() member function.
• Create a CBCGPPropertySheet and call DoModal.

Take a look at the PropSheetDemo sample for more information.

See also

CBCGPPropertyPage

Inheritance diagram for CBCGPPropertySheet:

Public Member Functions
	CBCGPPropertySheet	Constructs a CBCGPPropertySheet object.
	CBCGPPropertySheet	Constructs a CBCGPPropertySheet object.
	AddCustomCaptionButton	Adds a custom caption button.
	AddGroup	Adds a list group.
	AddPage	Adds a page to the property sheet.
	AddPageToTree	Adds a new property page to the tree navigation control.
	AddTreeCategory	Adds a new category to the tree navigation control.
	EnableCustomCaptionButton	Enables or disables a custom caption button.
	EnableDragClientArea	Allows to drag the window by clicking inside the client area.
	EnableLayout	Enables or disables layout manager for a property sheet.
	EnableLoadWindowPlacement	Enables loading/saving window placement from/to the registry.
	EnablePageHeader	Reserves space at the top of each page to draw a custom header.
	EnablePageSwipeGesture	Enables or disable a property page swipe gesture.
	EnablePageTransitionEffect	Enables the page transition effect.
	EnableTabsScrolling	Enables the tabs scrolling.
	EnableVisualManagerStyle	Enables/disables property sheet visual theme
	GetHeaderHeight	Returns current header height.
	GetLayout	Returns a pointer to layout manager.
	GetLook	Gets the property sheet look.
	IsAutoPrepareComboListStyles	Tells whether all child list box and combo boxes should be recreated by adding "owner-draw fixed" and "has strings" Windows styles.
	IsControlsDefaultDlgBackground	Tells whether controls background redrawing is optimized.
	IsCustomCaptionButtonEnabled	Tells whether a custom caption button is enabled.
	IsDragClientAreaEnabled	Tells whether a drag client area is enabled.
	IsKeepFocusedControlOnResize	Tells whether the current focus remains unchanged when the property sheet is being resized.
	IsLayoutEnabled	Tells whether layout management is enabled for a property sheet.
	IsMFCResourceLayout	Tells whether the dialog uses MFC resource (loaded from the dialog resource) layout.
	IsPageSwipeGestureEnabled	Tells whether property page swipe gesture is enabled.
	IsPageTransitionAvailable	Tells whether a page transition is available.
	IsPageTransitionReversedOrder	Called by the framework when page transition direction is needed.
	IsVisualManagerNCArea	Tells whether a non-client area of the window uses visual manager style.
	IsVisualManagerStyle	Tells whether a window uses visual manager style.
	IsWsCaptionStyle	Tells whether a window with themed non-client area is created with WS_CAPTION style.
	OnDrawPageHeader	Called by the framework to draw custom property page header.
	OnDrawPageNotificationBadge	Called by the framework to draw custom notification badge associated with a property page.
	OnGetPageNotificationBadgeSize	Called by the framework to retrive a size of custom notification badge associated with a property page.
	OnRemoveTreePage	Called by the framework when a page is being removed from the navigation tree.
	RemoveAllCustomCaptionButtons	Removes all custom caption buttons.
	RemoveCategory	Removes a category from the tree navigation control.
	RemovePage	Removes a page from the property sheet.
	RemovePage	Removes a page from the property sheet.
	RenamePage	Renames a page.
	RenamePage	Renames a page.
	SetActivePageWithEffects	Call this method to activate a property page with a default transition effect (specified by EnablePageTransitionEffect method).
	SetControlsDefaultDlgBackground	Enables/disables child controls background optimized redrawing.
	SetIconsList	Sets the list of images to be used in the embedded outlook bar.
	SetIconsList	Sets the list of images to be used in the embedded outlook bar.
	SetKeepFocusedControlOnResize	Specifies whether the current focus remains unchanged when the property sheet is being resized.
	SetLook	Sets the look (style) of the property sheet.
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 CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.