BCGControlBar Pro for MFC
CBCGPPropertySheetCtrl

Detailed Description

The CBCGPPropertySheetCtrl allows to create CBCGPPropertySheet as child of the dialog or any other window..

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

  • Add invisible empty Picture control (place holder) to the Dialog Editor.
  • Add CBCGPPropertySheetCtrl member variable to the dialog class (e.g, m_wndPropSheet)
  • Add control initialization code to your OnInitDialog (see code below).

Take a look at the PropSheetDemo sample for more information.

See also
CBCGPPropertySheet, CBCGPPropertyPage
Copy
class CMyDialog : public CBCGPDialog
{
...
CBCGPPropertySheetCtrl m_wndPropSheet;
};
BOOL CMyDialog::OnInitDialog()
{
CBCGPDialog::OnInitDialog();
m_wndPropSheet.EnableVisualManagerStyle();
m_wndPropSheet.m_bIsAutoDestroy = FALSE;
m_wndPropSheet.AddPage(&m_Page1);
m_wndPropSheet.AddPage(&m_Page2);
if (!m_wndPropSheet.CreateOnPlaceHolder(this, IDC_PROP_SHEET_FRAME))
{
return TRUE;
}
return TRUE;
}
+ Inheritance diagram for CBCGPPropertySheetCtrl:

Public Member Functions

 CBCGPPropertySheetCtrlDefault constructor.
 
 GetRecommendedSizeGets property sheet control recommended size (minimal for displaying all pages and navigation pane).
 
- Public Member Functions inherited from CBCGPPropertySheet
 CBCGPPropertySheetConstructs a CBCGPPropertySheet object.
 
 CBCGPPropertySheetConstructs a CBCGPPropertySheet object.
 
 AddCustomCaptionButtonAdds a custom caption button.
 
 AddGroupAdds a list group.
 
 AddPageAdds a page to the property sheet.
 
 AddPageToTreeAdds a new property page to the tree navigation control.
 
 AddTreeCategoryAdds a new category to the tree navigation control.
 
 EnableCustomCaptionButtonEnables or disables a custom caption button.
 
 EnableDragClientAreaAllows to drag the window by clicking inside the client area.
 
 EnableLayoutEnables or disables layout manager for a property sheet.
 
 EnableLoadWindowPlacementEnables loading/saving window placement from/to the registry.
 
 EnablePageHeaderReserves space at the top of each page to draw a custom header.
 
 EnablePageSwipeGestureEnables or disable a property page swipe gesture.
 
 EnablePageTransitionEffectEnables the page transition effect.
 
 EnableTabsScrollingEnables the tabs scrolling.
 
 EnableVisualManagerStyleEnables/disables property sheet visual theme
 
 GetHeaderHeightReturns current header height.
 
 GetLayoutReturns a pointer to layout manager.
 
 GetLookGets the property sheet look.
 
 IsAutoPrepareComboListStylesTells whether all child list box and combo boxes should be recreated by adding "owner-draw fixed" and "has strings" Windows styles.
 
 IsControlsDefaultDlgBackgroundTells whether controls background redrawing is optimized.
 
 IsCustomCaptionButtonEnabledTells whether a custom caption button is enabled.
 
 IsDragClientAreaEnabledTells whether a drag client area is enabled.
 
 IsLayoutEnabledTells whether layout management is enabled for a property sheet.
 
 IsMFCResourceLayoutTells whether the dialog uses MFC resource (loaded from the dialog resource) layout.
 
 IsPageSwipeGestureEnabledTells whether property page swipe gesture is enabled.
 
 IsPageTransitionAvailableTells whether a page transition is available.
 
 IsPageTransitionReversedOrderCalled by the framework when page transition direction is needed.
 
 IsVisualManagerNCAreaTells whether a non-client area of the window uses visual manager style.
 
 IsVisualManagerStyleTells whether a window uses visual manager style.
 
 IsWsCaptionStyleTells whether a window with themed non-client area is created with WS_CAPTION style.
 
 OnDrawPageHeaderCalled by the framework to draw custom property page header.
 
 OnDrawPageNotificationBadgeCalled by the framework to draw custom notification badge associated with a property page.
 
 OnGetPageNotificationBadgeSizeCalled by the framework to retrive a size of custom notification badge associated with a property page.
 
 OnRemoveTreePageCalled by the framework when a page is being removed from the navigation tree.
 
 RemoveAllCustomCaptionButtonsRemoves all custom caption buttons.
 
 RemoveCategoryRemoves a category from the tree navigation control.
 
 RemovePageRemoves a page from the property sheet.
 
 RemovePageRemoves a page from the property sheet.
 
 RenamePageRenames a page.
 
 RenamePageRenames a page.
 
 SetActivePageWithEffectsCall this method to activate a property page with a default transition effect (specified by EnablePageTransitionEffect method).
 
 SetControlsDefaultDlgBackgroundEnables/disables child controls background optimized redrawing.
 
 SetIconsListSets the list of images to be used in the embedded outlook bar.
 
 SetIconsListSets the list of images to be used in the embedded outlook bar.
 
 SetLookSets the look (style) of the property sheet.
 
- 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.
 

Public Attributes

 m_bAlwaysShowScrollButtonsSpecifies whether scroll buttons should be always displayed on the tab control. The default value is FALSE.
 
 m_bIsAutoDestroySpecifies whether this object should automatically destroyed. The default value is TRUE.
 

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 CBCGPAnimationManager
 OnAnimationIdleCalled by the framework in an animation idle time.