### GetStartCap Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_stroke_style.html Gets the start cap style. ```APIDOC ## GetStartCap ### Description Gets the start cap style. ### Method GetStartCap ### Return Value Start cap style (BCGP_CAP_STYLE). ``` -------------------------------- ### ShowStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar.html Activates a start page. ```APIDOC ## ShowStartPage ### Description Activates a start page. ### Method ShowStartPage ### Parameters None. ### Return Value None. ``` -------------------------------- ### IsAutoStartPage() Source: https://help.bcgsoft.com/BCGControlBarPro/functions_i.html Checks whether the ribbon bar automatically starts on the start page. ```APIDOC ## IsAutoStartPage() ### Description Checks whether the ribbon bar automatically starts on the start page. ### Applies To - CBCGPRibbonBar ### Returns - **bool** - True if auto-start page is enabled, false otherwise. ``` -------------------------------- ### BOOL CBCGPRibbonBar::EnableStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar_a0d222e1e1826cd3f665b580b23904ac1.html Enables the start page. This method configures the start page using a dialog template and optional dialog class, and can show it on startup. ```APIDOC ## BOOL CBCGPRibbonBar::EnableStartPage ### Description Enables the start page. This method configures the start page using a dialog template and optional dialog class, and can show it on startup. ### Method EnableStartPage ### Signature BOOL CBCGPRibbonBar::EnableStartPage(UINT nDlgTemplateID, CRuntimeClass* pDlgClass, BOOL bShowOnStartup = TRUE, const CString& strPageName = _T("StartPage")) ### Parameters - **nDlgTemplateID** (UINT) - Required - Identifier for the dialog template. - **pDlgClass** (CRuntimeClass*) - Required - [in,out] The dialog class. - **bShowOnStartup** (BOOL) - Optional - Set to TRUE to show the start page on application startup. Default is TRUE. - **strPageName** (const CString&) - Optional - Start page name ("StartPage" by default). Default is _T("StartPage"). ### Returns TRUE if it succeeds, FALSE if it fails. ``` -------------------------------- ### EnableStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar.html Enables the start page. ```APIDOC ## EnableStartPage ### Description Enables the start page. ### Syntax ```cpp void EnableStartPage(BOOL bEnable = TRUE); ``` ### Parameters - `bEnable` (BOOL) - Optional - TRUE to enable the start page, FALSE to disable. Default is TRUE. ### Return Value None. ``` -------------------------------- ### BOOL CBCGPRibbonBar::ShowStartPage() Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar_a9ac72cf60e548b3729bd3e1544a24555.html Activates the start page of the ribbon bar. The start page must be configured using EnableStartPage before calling this method. ```APIDOC ## BOOL CBCGPRibbonBar::ShowStartPage() ### Description Activates a start page. The start page should be specified in CBCGPRibbonBar::EnableStartPage. ### Method ShowStartPage ### Signature BOOL CBCGPRibbonBar::ShowStartPage() ### Parameters None. ### Return Value BOOL - Returns TRUE if the start page was activated successfully; otherwise FALSE. ### Remarks Call this method to activate a start page. The start page should be specified in CBCGPRibbonBar::EnableStartPage. ### Related Methods - CBCGPRibbonBar::EnableStartPage ``` -------------------------------- ### CBCGPIntelliSenseWnd::Create Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_intelli_sense_wnd-members.html Documentation for the CBCGPIntelliSenseWnd::Create method, which initializes the IntelliSense window with data, style, position, parent, font, and optional image list and runtime class. ```APIDOC ## CBCGPIntelliSenseWnd::Create ### Description Creates the IntelliSense window with the specified data list, style, position, parent window, font, and optional image list and list box runtime class. ### Method Create ### Signature `virtual BOOL Create(CObList &lstData, DWORD dwStyle, CPoint pt, CWnd *pParentWnd, CFont *pLBFont, CImageList *pImageList = NULL, CRuntimeClass *pLBDataRTC = NULL)` ### Parameters - **lstData** (CObList&) - Required - Reference to the list of data objects to display. - **dwStyle** (DWORD) - Required - Window style flags for the IntelliSense window. - **pt** (CPoint) - Required - Initial position of the window. - **pParentWnd** (CWnd*) - Required - Pointer to the parent window. - **pLBFont** (CFont*) - Required - Pointer to the font used for the list box. - **pImageList** (CImageList*) - Optional - Pointer to an image list for icons; default is NULL. - **pLBDataRTC** (CRuntimeClass*) - Optional - Runtime class for the list box data; default is NULL. ### Return Value Returns TRUE if the window was created successfully; otherwise FALSE. ### Remarks This method is virtual and can be overridden in derived classes. It initializes the IntelliSense window with the provided data and visual settings. ``` -------------------------------- ### GetStartValue Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_gauge_colored_range_object.html Gets the start value of the range. ```APIDOC ## GetStartValue ### Description Gets the start value of the range. ### Method GetStartValue ### Returns double - The start value. ``` -------------------------------- ### SetupMenu Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_combo_gallery_ctrl-members.html Sets up a menu for the control, optionally as a split button with themed menu appearance. ```APIDOC ## SetupMenu ### Description Sets up a menu for the control, optionally as a split button with themed menu appearance. ### Method SetupMenu ### Signature `void SetupMenu(UINT nMenuResID, int nSubMenuIndex = -1, BOOL bSplitButton = FALSE, BOOL bThemedMenu = TRUE)` ### Parameters - **nMenuResID** (UINT) - Required - Resource ID of the menu to load. - **nSubMenuIndex** (int) - Optional - Index of the submenu to use. Default is -1 (use the top-level menu). - **bSplitButton** (BOOL) - Optional - Specifies whether to display as a split button. Default is FALSE. - **bThemedMenu** (BOOL) - Optional - Specifies whether to use a themed menu. Default is TRUE. ### Inherited From CBCGPMenuButton ``` -------------------------------- ### BOOL CBCGPPageTransitionManager::StartPageTransition(HWND _hwdHost_, HWND _hwndPageFrom_, HWND _hwndPageTo_, BOOL _bReverseOrder_ = FALSE, const CSize & _szPageOffset_ = CSize(0, 0), const CSize & _szPageMax_ = CSize(0, 0)) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_page_transition_manager_ad357f1aff4d464b00d3baf58cf3eb885.html Starts a 2-page transition. The method takes handles to the host window, the start page, and the finish page, along with optional parameters for reverse order, page offset, and maximum page size. ```APIDOC ## BOOL CBCGPPageTransitionManager::StartPageTransition(HWND _hwdHost_, HWND _hwndPageFrom_, HWND _hwndPageTo_, BOOL _bReverseOrder_ = FALSE, const CSize & _szPageOffset_ = CSize(0, 0), const CSize & _szPageMax_ = CSize(0, 0)) ### Description Starts a 2-page transition. ### Method StartPageTransition ### Parameters - **hwdHost** (HWND) - Required - The handle of window which processes a page transition. - **hwndPageFrom** (HWND) - Required - Handle of the start page window. - **hwndPageTo** (HWND) - Required - Handle of the finish page window. - **bReverseOrder** (BOOL) - Optional - Specify whether the transition should be performed in reversed order. You've to set this parameter to TRUE if you need to change page with a higher index to page with lower (from right to left). - **szPageOffset** (const CSize&) - Optional - The page offset. - **szPageMax** (const CSize&) - Optional - The maximum dimensions of the page. ### Returns TRUE if it succeeds, FALSE if it fails. ``` -------------------------------- ### GetStartPoint Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_complex_geometry.html Gets geometry start point. ```APIDOC ## GetStartPoint ### Description Gets geometry start point. ### Syntax ```cpp CBCGPPoint GetStartPoint() const; ``` ### Parameters None. ### Return Value The start point of the geometry. ### Remarks Returns the starting point of the geometry. ``` -------------------------------- ### CBCGPCircularGaugeScale::GetStartAngle Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_circular_gauge_scale.html Gets the start angle of the scale. ```APIDOC ## CBCGPCircularGaugeScale::GetStartAngle ### Description Gets the start angle of the scale. ### Method GetStartAngle ### Parameters None. ### Returns Start angle of the scale. ``` -------------------------------- ### SetupToolbarMenu Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_m_d_i_frame_wnd-members.html Sets up a toolbar menu. ```APIDOC ## SetupToolbarMenu(CMenu &menu, const UINT uiViewUserToolbarCmdFirst, const UINT uiViewUserToolbarCmdLast) ### Description Sets up a toolbar menu. ### Method SetupToolbarMenu ### Parameters - **menu** (CMenu&) - Required - Reference to the menu. - **uiViewUserToolbarCmdFirst** (UINT) - Required - First command ID. - **uiViewUserToolbarCmdLast** (UINT) - Required - Last command ID. ### Returns void ``` -------------------------------- ### CBCGPGaugeScaleObject::GetStart Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_gauge_scale_object_a6f3b8c13ce1952e9e9562910ffd96516.html Gets the start value of the gauge scale object. This inline method returns a double representing the start value. ```APIDOC ## CBCGPGaugeScaleObject::GetStart ### Description Gets the start value of the gauge scale object. ### Method GetStart (inline) ### Signature `double CBCGPGaugeScaleObject::GetStart() const` ### Parameters None. ### Returns - **double** - The start value. ### Remarks This is an inline method that returns the start value of the gauge scale object. ``` -------------------------------- ### Create and configure CBCGPOutlookBarPane Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_outlook_bar_pane.html Shows the steps to create an outlook bar pane, add buttons, and add it to the outlook bar. Error handling is skipped. The example includes class member declarations and the creation sequence. ```cpp class CMainFrame : public CBCGPMDIFrameWnd { ..... CBCGPOutlookBar m_wndOutlookBar; CBCGPOutlookBarPane m_wndOutlookPane; ...... }; ``` ```cpp // create the outlook bar: m_wndOutlookBar.Create(_T("Shortcuts"), this, CRect(0, 0, 100, 100), ID_VIEW_OUTLOOKBAR, WS_CHILD | WS_VISIBLE | CBRS_LEFT); // obtain the pointer to underlined outlook window CBCGPOutlookWnd* pOutlookBar = (CBCGPOutlookWnd*) m_wndOutlookBar.GetUnderlinedWindow(); // create the outlook pane m_wndOutlookPane.Create(&m_wndOutlookBar, dwDefaultToolbarStyle, ID_OUTLOOK_PANE_GENERAL, CBRS_BCGP_RESIZE); // set main frame window as the owner to receive the commands from the pane m_wndOutlookPane.SetOwner (this); m_wndOutlookPane.EnableTextLabels(); // add buttons m_wndOutlookPane.AddButton(theApp.LoadIcon (IDR_MAINFRAME), _T("About"), ID_APP_ABOUT); m_wndOutlookPane.AddButton (theApp.LoadIcon (IDR_BCGCBDTYPE), _T("Open"), ID_FILE_OPEN); // finally add the pane to the outlook bar pOutlookBar->AddTab (&m_wndOutlookPane, "General", (UINT) -1, TRUE); ``` -------------------------------- ### Create a CBCGPWinUITile object Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_win_u_i_tile.html Shows how to instantiate a CBCGPWinUITile with a name, wide flag, text color, and fill brush, then set its image, border color, badge glyph, and add it to a CBCGPWinUITiles collection. ```cpp CBCGPWinUITiles* pMUI; CBCGPWinUITile* pTile = new CBCGPWinUITile(_T("Name"), TRUE /* Is wide */, CBCGPColor::White, /* Text color */, CBCGPBrush(color, colorLight, CBCGPBrush::BCGP_GRADIENT_VERTICAL) /* Fill brush */); pTile->SetImage(CBCGPImage(IDB_TILE_ICON)); // Add icon pTile->SetBorderColor(colorLight); pTile->SetBadgeGlyph(CBCGPWinUITile::BCGP_NEW_MESSAGE); pMUI->Add(pTile, nGroup); ``` -------------------------------- ### double CBCGPGaugeColoredRangeObject::GetStartValue() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_gauge_colored_range_object_af0a90405ec013f736073fe444e538a6c.html Gets the start value of the colored range object. This inline method returns the start value as a double. ```APIDOC ## double CBCGPGaugeColoredRangeObject::GetStartValue() const ### Description Gets the start value of the colored range object. ### Method GetStartValue ### Signature `double CBCGPGaugeColoredRangeObject::GetStartValue() const` ### Parameters None. ### Returns - **double** - The start value. ``` -------------------------------- ### ShowStartPage() Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar-members.html Displays the start page in the ribbon bar. ```APIDOC ## ShowStartPage() ### Description Displays the start page in the ribbon bar. ### Method N/A (C++ member function) ### Signature `void ShowStartPage()` ### Parameters None. ### Return Value None. ### Remarks This method is a member of CBCGPRibbonBar. ``` -------------------------------- ### const CBCGPPoint& CBCGPComplexGeometry::GetStartPoint() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_complex_geometry_a30e58cb70c2cf0964bdbade6f737c13a.html Gets the geometry start point. This inline method returns a constant reference to the start point of the complex geometry. ```APIDOC ## const CBCGPPoint& CBCGPComplexGeometry::GetStartPoint() const ### Description Gets the geometry start point. ### Method GetStartPoint ### Signature ```cpp const CBCGPPoint& CBCGPComplexGeometry::GetStartPoint() const ``` ### Parameters None ### Returns The start point (const CBCGPPoint&). ``` -------------------------------- ### CBCGPChartAxis::GetAxisPos Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_chart_axis_x.html Gets axis start and end points in client coordinates. ```APIDOC ## CBCGPChartAxis::GetAxisPos ### Description Gets axis start and end points in client coordinates. ### Syntax ```cpp void GetAxisPos(CPoint& ptStart, CPoint& ptEnd) const; ``` ### Parameters - **ptStart** (CPoint&) - Required - Receives the start point. - **ptEnd** (CPoint&) - Required - Receives the end point. ``` -------------------------------- ### BOOL CBCGPMenuButton::SetupMenu(UINT _nMenuResID_, int _nSubMenuIndex_ = -1, BOOL _bSplitButton_ = FALSE, BOOL _bThemedMenu_ = TRUE) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_menu_button_a85cc64728175299f127690274f87e228.html Sets up the menu button content and appearance. Call this method to initialize the menu button. Note that this method should be called before control creation (m_hWnd should be NULL). ```APIDOC ## BOOL CBCGPMenuButton::SetupMenu(UINT _nMenuResID_, int _nSubMenuIndex_ = -1, BOOL _bSplitButton_ = FALSE, BOOL _bThemedMenu_ = TRUE) ### Description Sets up the menu button content and appearance. Call this method to initialize the menu button. Note that this method should be called before control creation (m_hWnd should be NULL). ### Method SetupMenu ### Parameters - **nMenuResID** (UINT) - Required - Menu resource ID. - **nSubMenuIndex** (int) - Optional - Specifies sub menu ID. Default is -1. - **bSplitButton** (BOOL) - Optional - Specifies whether the menu button has a "split" mode. When TRUE, the client area is "splitted": clicking on left side invokes a default button's action; right side (around arrow) - opens the menu. Default is FALSE. - **bThemedMenu** (BOOL) - Optional - Specifies whether a drop-down menu should be themed (current visual manager style is applied). Default is TRUE. ### Returns True if it succeeds, false if it fails. ``` -------------------------------- ### CBCGPChartAxis::GetAxisPos Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_chart_axis_polar_x.html Gets axis start and end points in client coordinates. ```APIDOC ## CBCGPChartAxis::GetAxisPos ### Description Gets axis start and end points in client coordinates. ### Method GetAxisPos ### Parameters None explicitly documented. ### Returns - **CPoint** - Start and end points. ``` -------------------------------- ### Create a single CBCGPWinUITile object Source: https://help.bcgsoft.com/BCGSuite/class_c_b_c_g_p_win_u_i_tile.html Shows how to instantiate a CBCGPWinUITile, set its image, border color, badge glyph, and add it to a CBCGPWinUITiles collection. The tile can be regular or wide, and uses a gradient fill brush. ```cpp CBCGPWinUITiles* pMUI; CBCGPWinUITile* pTile = new CBCGPWinUITile(_T("Name"), TRUE /* Is wide */, CBCGPColor::White, /* Text color */, CBCGPBrush(color, colorLight, CBCGPBrush::BCGP_GRADIENT_VERTICAL) /* Fill brush */); pTile->SetImage(CBCGPImage(IDB_TILE_ICON)); // Add icon pTile->SetBorderColor(colorLight); pTile->SetBadgeGlyph(CBCGPWinUITile::BCGP_NEW_MESSAGE); pMUI->Add(pTile, nGroup); ``` -------------------------------- ### CBCGPGaugeColoredRangeObject::GetStartWidth Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_gauge_colored_range_object_a1b62c30de4567217449219de56023a69.html Gets the width of the first point in the range. This method is const and returns a double value representing the start width. ```APIDOC ## CBCGPGaugeColoredRangeObject::GetStartWidth ### Description Gets the width of the first point in the range. ### Method GetStartWidth ### Signature `double GetStartWidth() const` ### Returns - **double** - The start width. ``` -------------------------------- ### Create(CObList &lstData, DWORD dwStyle, CPoint pt, CWnd *pParentWnd, CFont *pLBFont, CImageList *pImageList=NULL, CRuntimeClass *pLBDataRTC=NULL) Source: https://help.bcgsoft.com/BCGPEdit/class_c_b_c_g_p_intelli_sense_wnd-members.html Creates the IntelliSense window with the given data list, style, position, parent window, font, optional image list, and optional runtime class for list box data. ```APIDOC ## Create(CObList &lstData, DWORD dwStyle, CPoint pt, CWnd *pParentWnd, CFont *pLBFont, CImageList *pImageList=NULL, CRuntimeClass *pLBDataRTC=NULL) ### Description Creates the IntelliSense window with the given data list, style, position, parent window, font, optional image list, and optional runtime class for list box data. ### Method Create ### Parameters - **lstData** (CObList&) - Required - List of data items to display. - **dwStyle** (DWORD) - Required - Window style flags. - **pt** (CPoint) - Required - Position of the window. - **pParentWnd** (CWnd*) - Required - Pointer to the parent window. - **pLBFont** (CFont*) - Required - Pointer to the font for the list box. - **pImageList** (CImageList*) - Optional - Pointer to an image list for icons. - **pLBDataRTC** (CRuntimeClass*) - Optional - Runtime class for list box data. ### Return Value Not specified in the source. ### Remarks This is a virtual member function of CBCGPIntelliSenseWnd. ``` -------------------------------- ### CBCGPAnimationManager usage example Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_animation_manager.html Shows how to derive a class from CBCGPAnimationManager, override the animation callbacks, and start an animation with a specified range, duration, and type. ```cpp class CMyClass : public CObject public CBCGPAnimationManager { virtual void OnAnimationValueChanged(double dblOldValue, double dblNewValue) { TRACE(_T("The current animation value is: %f\n"), dblNewValue); } virtual void OnAnimationFinished() { TRACE(_T("The animation is finished.\n")); } }; CMyClass myObject; // Start animation. The values range is: 0 - 100, duration 2 seconds, // animation type is "Accelerate / Decelerate": myObject.StartAnimation(0, 100, 2, CBCGPAnimationManager::BCGPANIMATION_AccelerateDecelerate); ``` -------------------------------- ### Override CreateDocumentWindow to load documents from registry Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_m_d_i_frame_wnd_a94b8fd84a32eb0a124118a102544a55d.html Called by the framework during loading of documents previously saved in the registry. Override this method to properly create documents when they're being loaded from the registry. The example handles a special 'Start Page' virtual document (g_strStartViewName) and uses document templates to open files. ```cpp // g_strStartViewName is a name of "virtual document" Start Page, it's not actually loaded from a disk file, // therefore we need a special processing for this case. // CBCGPMDIChildWnd* CMainFrame::CreateDocumentWindow (LPCTSTR lpcszDocName, CObject* pObj) { if (lpcszDocName != NULL && lpcszDocName[0] != '\0') { CDocument* pDoc = NULL; if (g_strStartViewName.Compare(lpcszDocName) == 0) { pDoc = theApp.m_pStartDocTemplate->OpenDocumentFile (NULL); } else { pDoc = AfxGetApp()->OpenDocumentFile(lpcszDocName); } if (pDoc != NULL) { POSITION pos = pDoc->GetFirstViewPosition(); if (pos != NULL) { CView* pView = pDoc->GetNextView(pos); return DYNAMIC_DOWNCAST(CBCGPMDIChildWnd, pView->GetParent ()); } } } return NULL; } ``` -------------------------------- ### Create Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_controls_layout.html Initializes a layout manager. ```APIDOC ## Create ### Description Initializes a layout manager. ### Method Create ### Parameters None. ### Returns None. ``` -------------------------------- ### CBCGPRibbonBar::ShowStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_frame_caption_bar-members.html Shows the start page. ```APIDOC ## ShowStartPage ### Description Shows the start page. ### Method ShowStartPage() ### Parameters None ### Returns void ``` -------------------------------- ### CBCGPAnimationManager::StartAnimation Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_page_transition_manager-members.html Starts a generic animation with specified start and final values. ```APIDOC ## StartAnimation ### Description Starts a generic animation with specified start and final values. ### Method StartAnimation ### Signature void StartAnimation(double dblStartValue, double dblFinalValue, double dblDurationInSeconds, BCGPAnimationType type, CBCGPAnimationManagerOptions *pOptions=NULL, double dblDelayInSeconds=0.0) ### Parameters - **dblStartValue** (double) - Required - Start value of the animation. - **dblFinalValue** (double) - Required - Final value of the animation. - **dblDurationInSeconds** (double) - Required - Duration of the animation in seconds. - **type** (BCGPAnimationType) - Required - Type of animation. - **pOptions** (CBCGPAnimationManagerOptions*) - Optional - Pointer to animation options. Default is NULL. - **dblDelayInSeconds** (double) - Optional - Delay before animation starts in seconds. Default is 0.0. ### Return Value None. ``` -------------------------------- ### CBCGPRibbonBar::ShowStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_status_bar-members.html Shows the start page. ```APIDOC ## ShowStartPage() ### Description Shows the start page. ### Parameters None. ### Return Value None. ``` -------------------------------- ### StartAnimation Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_chart_funnel_series-members.html Starts an animation of a value from a start to an end value over a specified duration. ```APIDOC ## StartAnimation ### Description Starts an animation of a value from a start to an end value over a specified duration. ### Method StartAnimation ### Signature `void StartAnimation(double dblStartValue, double dblFinalValue, double dblDurationInSeconds, BCGPAnimationType type, CBCGPAnimationManagerOptions *pOptions = NULL, double dblDelayInSeconds = 0.0)` ### Parameters - **dblStartValue** (double) - Required - The starting value. - **dblFinalValue** (double) - Required - The final value. - **dblDurationInSeconds** (double) - Required - Duration of the animation in seconds. - **type** (BCGPAnimationType) - Required - The type of animation. - **pOptions** (CBCGPAnimationManagerOptions*) - Optional - Pointer to animation options. Default is NULL. - **dblDelayInSeconds** (double) - Optional - Delay before animation starts in seconds. Default is 0.0. ### Return Value None. ``` -------------------------------- ### CBCGPMenuButton::SetupMenu Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_menu_button-members.html Sets up the menu associated with the button, allowing specification of a menu resource, submenu index, split button style, and themed menu appearance. ```APIDOC ## CBCGPMenuButton::SetupMenu ### Description Sets up the menu associated with the button, allowing specification of a menu resource, submenu index, split button style, and themed menu appearance. ### Method SetupMenu ### Signature void SetupMenu(UINT nMenuResID, int nSubMenuIndex = -1, BOOL bSplitButton = FALSE, BOOL bThemedMenu = TRUE) ### Parameters - **nMenuResID** (UINT) - Required - Resource ID of the menu to attach. - **nSubMenuIndex** (int) - Optional - Index of the submenu to use; -1 for the top-level menu. - **bSplitButton** (BOOL) - Optional - If TRUE, the button is displayed as a split button. - **bThemedMenu** (BOOL) - Optional - If TRUE, the menu is drawn with visual manager themes. ### Remarks Call this method to associate a menu with the button. The menu will be displayed when the button is clicked. ``` -------------------------------- ### StartAnimation Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_base_chart_stock_series-members.html Starts an animation on the series from a start value to a final value over a duration. ```APIDOC ## StartAnimation ### Description Starts an animation on the series from a start value to a final value over a duration. ### Method StartAnimation ### Signature `void StartAnimation(double dblStartValue, double dblFinalValue, double dblDurationInSeconds, BCGPAnimationType type, CBCGPAnimationManagerOptions *pOptions = NULL, double dblDelayInSeconds = 0.0)` ### Parameters - **dblStartValue** (double) - The start value. - **dblFinalValue** (double) - The final value. - **dblDurationInSeconds** (double) - Duration in seconds. - **type** (BCGPAnimationType) - The animation type. - **pOptions** (CBCGPAnimationManagerOptions*) - Optional. Animation options (default is NULL). - **dblDelayInSeconds** (double) - Optional. Delay in seconds (default is 0.0). ### Return Value None. ``` -------------------------------- ### CBCGPToolBar::EnableQuickCustomization Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_calculator-members.html Enables or disables quick customization. ```APIDOC ## EnableQuickCustomization ### Description Enables or disables quick customization. ### Method EnableQuickCustomization ### Signature static void EnableQuickCustomization(BOOL bEnable = TRUE) ### Parameters - **bEnable** (BOOL) - Optional - TRUE to enable, FALSE to disable. Default is TRUE. ### Return Value None. ``` -------------------------------- ### void CBCGPCalendarBar::SetFirstDayOfWeek(int _nDay_) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_calendar_bar_a40e0f2f3fc2ab219e3f339cd19ca388f.html Sets the starting week day for the calendar object. Call this function to set the starting week day. By default, the starting week day is taken from the current locale. ```APIDOC ## void CBCGPCalendarBar::SetFirstDayOfWeek(int _nDay_) ### Description Sets the starting week day for the calendar object. Call this function to set the starting week day. By default, the starting week day is taken from the current locale. ### Method SetFirstDayOfWeek ### Parameters - **nDay** (int) - Required - Specifies the starting week day - a number from 0 to 6. ### Return Value void ### Remarks This is an inline function. ``` -------------------------------- ### IsAutoStartPage Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar.html Check whether a start page is automatically displayed on application startup. ```APIDOC ## IsAutoStartPage ### Description Check whether a start page is automatically displayed on application startup. ### Method IsAutoStartPage ### Parameters None explicitly documented. ### Returns Boolean indicating if auto start page is enabled. ``` -------------------------------- ### SetupToolbarMenu(CMenu &menu, const UINT uiViewUserToolbarCmdFirst, const UINT uiViewUserToolbarCmdLast) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_frame_wnd-members.html Inline method to set up a toolbar menu. ```APIDOC ## SetupToolbarMenu(CMenu &menu, const UINT uiViewUserToolbarCmdFirst, const UINT uiViewUserToolbarCmdLast) ### Description Sets up a toolbar menu with user toolbar commands. ### Method inline ### Parameters - **menu** (CMenu&) - Reference to the menu to set up. - **uiViewUserToolbarCmdFirst** (UINT) - First command ID for user toolbars. - **uiViewUserToolbarCmdLast** (UINT) - Last command ID for user toolbars. ### Returns void ``` -------------------------------- ### CBCGPAnimationManager::StartAnimation Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_animation_manager.html Starts an animation with specified start and end values, duration, and animation type. ```APIDOC ## StartAnimation ### Description Starts an animation with the given start and end values, duration, and animation type. ### Method StartAnimation ### Parameters - **dblStartValue** (double) - Required - The start value of the animation. - **dblEndValue** (double) - Required - The end value of the animation. - **dblDuration** (double) - Required - The duration of the animation in seconds. - **animationType** (BCGPAnimationType) - Required - The type of animation to use (e.g., BCGPANIMATION_AccelerateDecelerate). ### Example ```cpp myObject.StartAnimation(0, 100, 2, CBCGPAnimationManager::BCGPANIMATION_AccelerateDecelerate); ``` ``` -------------------------------- ### GetStart() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_appointment-members.html Returns the start date and time of the appointment. ```APIDOC ## GetStart() const ### Description Returns the start date and time of the appointment. ### Method GetStart() const ### Return Value COleDateTime - The start date and time. ``` -------------------------------- ### void CBCGPRecurrenceBaseRule::SetDateStart(const COleDateTime &_dtStart) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_recurrence_base_rule_a4a7dd167c59514226d2b7d19ddfae8d1.html Sets the start date for the recurrence rule. Use this method to set the start date for the recurrence rule. The rule begins to generate recurrent appointments starting from this date. ```APIDOC ## void CBCGPRecurrenceBaseRule::SetDateStart(const COleDateTime &_dtStart) ### Description Sets the start date for the recurrence rule. Use this method to set the start date for the recurrence rule. The rule begins to generate recurrent appointments starting from this date. ### Method SetDateStart ### Parameters - **dtStart** (const COleDateTime &) - Required - Specifies the start date. ### Returns void ``` -------------------------------- ### BOOL CBCGPPageTransitionManager::StartPageTransition(HWND _hwdHost_, const CArray& _arPages_, BOOL _bReverseOrder_ = FALSE, const CSize& _szPageOffset_ = CSize(0, 0), const CSize& _szPageMax_ = CSize(0, 0)) Source: https://help.bcgsoft.com/BCGSuite/class_c_b_c_g_p_page_transition_manager_a4cb2a24817094a61eb4995c627a7b041.html Starts the page transition for the array of pages. The host window processes the transition, and the method returns TRUE if it succeeds, FALSE if it fails. ```APIDOC ## BOOL CBCGPPageTransitionManager::StartPageTransition(HWND _hwdHost_, const CArray& _arPages_, BOOL _bReverseOrder_ = FALSE, const CSize& _szPageOffset_ = CSize(0, 0), const CSize& _szPageMax_ = CSize(0, 0)) ### Description Starts the page transition for the array of pages. ### Method StartPageTransition ### Parameters - **hwdHost** (HWND) - Required - The handle of window which processes a page transition. - **arPages** (const CArray&) - Required - The array of pages. - **bReverseOrder** (BOOL) - Optional - Specify whether the transition should be performed in reversed order. You've to set this parameter to TRUE if you need to change page with a higher index to page with lower (from right to left). Default is FALSE. - **szPageOffset** (const CSize&) - Optional - The page offset. Default is CSize(0, 0). - **szPageMax** (const CSize&) - Optional - The maximum dimensions of the page. Default is CSize(0, 0). ### Returns TRUE if it succeeds, FALSE if it fails. ``` -------------------------------- ### void CBCGPChartSeries::SetGroupID(int _nGroupID_ = 0, BOOL _bRecalcMinMaxValues_ = TRUE) Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_chart_series_a7110761d77b2d407c33e73eb6cdb87fc.html Sets the series group ID. The group ID is used for stacked series and defines which series should stack. The default value is 0. For example, if you have 5 series and leave the default (0) for the first three series, and set 1 for the last two series, you'll get two stacks and will be able to see side-by-side stacked columns/bars for the bar series. ```APIDOC ## void CBCGPChartSeries::SetGroupID(int _nGroupID_ = 0, BOOL _bRecalcMinMaxValues_ = TRUE) ### Description Sets the series group ID. The group ID is used for stacked series and defines what series should stack. The default value is 0. For example, if you have 5 series and leave the default (0) for the first three series, and set 1 for the last two series, you'll get two stacks and will be able to see side-by-side stacked columns/bars for the bar series. ### Method SetGroupID ### Parameters - **nGroupID** (int) - Optional - Specifies the new group id. Default is 0. - **bRecalcMinMaxValues** (BOOL) - Optional - Specifies whether min/max values should be recalculated. Set it to TRUE if you assign Group ID after data points have been added to a series. Default is TRUE. ### Return Value void ``` -------------------------------- ### Initialize BCGP_GRID_COLOR_DATA theme Source: https://help.bcgsoft.com/BCGControlBarPro/struct_b_c_g_p___g_r_i_d___c_o_l_o_r___d_a_t_a.html Creates a static BCGP_GRID_COLOR_DATA theme with partial color specifications. Use -1 to leave elements unpainted and apply the theme later with CBCGPGridCtrl::SetColorTheme. ```cpp static BCGP_GRID_COLOR_DATA theme1 = { -1, // Grid background color -1, // Grid foreground color -1, // Header foreground color { // Even rows colors: RGB(246, 250, 253), -1, -1, 0, -1 }, { // Odd rows colors: -1, -1, -1, 0, -1 }, { // Group colors: RGB(210, 230, 249), RGB(16, 37, 127), RGB(228, 241, 251), 90, -1 }, { // Selected group colors: RGB(250, 199, 97), RGB(0, 0, 0), -1, 0, RGB(192, 192, 192) }, { // Selected rows colors: RGB(255, 229, 153), -1, -1, 0, RGB(192, 192, 192) }, { // Header item colors: RGB(154, 194, 237), RGB(16, 37, 127), RGB(189, 214, 242), 90, RGB(136, 176, 228) }, { // Selected header item colors: -1, -1, -1, 0, -1 }, { // Left offset colors: RGB(207, 221, 240), -1, RGB(227, 234, 244), 90, RGB(136, 176, 228) }, -1, // Grid horizontal line text -1, // Grid vertical line text }; ``` -------------------------------- ### CBCGPPlannerManagerCtrl::GetDateStart Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_planner_manager_ctrl_a170a6cbf0f20f7c649c39fa113d5414e.html Returns the start date of the current view. Use this method to retrieve the start date of the current view. ```APIDOC ## CBCGPPlannerManagerCtrl::GetDateStart ### Description Returns the start date of the current view. ### Method GetDateStart ### Signature const COleDateTime& CBCGPPlannerManagerCtrl::GetDateStart() const ### Parameters None ### Returns A reference to a COleDateTime object containing the start day of the current view. ### Remarks Use this method to retrieve the start date of the current view. ``` -------------------------------- ### OnInitToolsPage() : CBCGPToolbarCustomize Source: https://help.bcgsoft.com/BCGControlBarPro/functions_o.html Called to initialize the tools page. ```APIDOC ## OnInitToolsPage() ### Description Called to initialize the tools page. ### Class CBCGPToolbarCustomize ### Signature `virtual void OnInitToolsPage(CBCGPToolsPage* pPage);` ### Parameters - `pPage` (CBCGPToolsPage*) - Pointer to the tools page. ### Return Value None. ``` -------------------------------- ### StartPart Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_diagram_custom_shape-members.html Starts a new part of the custom shape with optional shadow, shadow offset, start point, and closed flag. ```APIDOC ## StartPart ### Description Starts a new part of the custom shape with optional shadow, shadow offset, start point, and closed flag. ### Method StartPart ### Signature StartPart(BOOL bShadow=FALSE, const CBCGPPoint &ptShadowOffset=CBCGPPoint(0., 0.), const CBCGPPoint &ptStart=CBCGPPoint(-1.,-1.), BOOL bIsClosed=TRUE) ### Parameters - **bShadow** (BOOL) - Optional - Indicates whether to draw a shadow. Default is FALSE. - **ptShadowOffset** (const CBCGPPoint&) - Optional - The shadow offset. Default is (0., 0.). - **ptStart** (const CBCGPPoint&) - Optional - The start point of the part. Default is (-1., -1.). - **bIsClosed** (BOOL) - Optional - Indicates whether the part is closed. Default is TRUE. ### Return Value None. ``` -------------------------------- ### BOOL CBCGPRibbonBar::IsStartPageEnabled() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar_ae42c000fe72ec6c85e5e212792bc7f31.html Tells whether a start page is enabled. Returns TRUE if a start page is enabled, FALSE if not. ```APIDOC ## BOOL CBCGPRibbonBar::IsStartPageEnabled() const ### Description Tells whether a start page is enabled. ### Method IsStartPageEnabled ### Signature `BOOL CBCGPRibbonBar::IsStartPageEnabled() const` ### Parameters None. ### Returns - **BOOL** - TRUE if a start page is enabled, FALSE if not. ### Remarks This method is inline. ``` -------------------------------- ### BOOL CBCGPRibbonBar::IsAutoStartPage() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar_a4755f398c3930246453056397e68beaa.html Checks whether a start page is automatically displayed on application startup. This method is inline and const, and returns a BOOL value. ```APIDOC ## BOOL CBCGPRibbonBar::IsAutoStartPage() const ### Description Checks whether a start page is automatically displayed on application startup. ### Method IsAutoStartPage ### Signature ```cpp BOOL CBCGPRibbonBar::IsAutoStartPage() const ``` ### Parameters None. ### Return Value - **BOOL** - Returns TRUE if a start page is automatically displayed on application startup; otherwise FALSE. ### Remarks This method is inline and const. It is a member of the CBCGPRibbonBar class. ``` -------------------------------- ### CBCGPRibbonPaletteMenuButton Example Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_palette_menu_button.html Demonstrates how to construct a CBCGPRibbonPaletteMenuButton and replace an existing toolbar button with it in a popup menu. ```APIDOC ## CBCGPRibbonPaletteMenuButton Example ### Description This example shows how to create a CBCGPRibbonPaletteMenuButton and replace an existing toolbar button with it in a popup menu. ### Code ```cpp BOOL CMainFrame::OnShowPopupMenu(CBCGPPopupMenu* pMenuPopup) { ... int nBulletIndex = pMenuBar->CommandToIndex(ID_PARA_BULLETS); if (nBulletIndex >= 0) { CBCGPToolbarButton* pExButton = pMenuBar->GetButton(nBulletIndex); ASSERT_VALID(pExButton); CBCGPRibbonPaletteMenuButton paletteBullet(pExButton->m_nID, pExButton->GetImage(), pExButton->m_strText); InitBulletPalette(&paletteBullet.GetPalette()); pMenuBar->ReplaceButton(ID_PARA_BULLETS, paletteBullet); } ... } ``` ``` -------------------------------- ### StartAnimation Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_grid_ctrl-members.html Starts an animation on the grid control with specified start and final values, duration, animation type, options, and optional delay. ```APIDOC ## StartAnimation ### Description Starts an animation on the grid control with specified start and final values, duration, animation type, options, and optional delay. ### Method StartAnimation ### Signature `void StartAnimation(double dblStartValue, double dblFinalValue, double dblDurationInSeconds, BCGPAnimationType type, CBCGPAnimationManagerOptions *pOptions=NULL, double dblDelayInSeconds=0.0)` ### Parameters - **dblStartValue** (double) - Required - The starting value of the animation. - **dblFinalValue** (double) - Required - The final value of the animation. - **dblDurationInSeconds** (double) - Required - The duration of the animation in seconds. - **type** (BCGPAnimationType) - Required - The type of animation. - **pOptions** (CBCGPAnimationManagerOptions*) - Optional - Pointer to animation manager options. Default is NULL. - **dblDelayInSeconds** (double) - Optional - Delay before animation starts in seconds. Default is 0.0. ### Return Value None. ``` -------------------------------- ### Init() Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_file_prop-members.html Initializes the property. ```APIDOC ## Init() ### Description Initializes the property. ### Method Init ### Signature `void Init()` ### Access protected ``` -------------------------------- ### COleDateTime CBCGPGanttItem::GetStartTime() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_gantt_item_aa4d319816e03eb1e5b1b0ebe3443e6b2.html Returns the start time of a task item. Call this function to determine the start time of a task. ```APIDOC ## COleDateTime CBCGPGanttItem::GetStartTime() const ### Description Returns the start time of a task item. Call this function to determine the start time of a task. ### Method GetStartTime ### Signature `COleDateTime CBCGPGanttItem::GetStartTime() const` ### Parameters None. ### Return Value `COleDateTime` - The start time of the task item. ### Remarks This is an inline function. ### Related Classes - CBCGPGanttItem ``` -------------------------------- ### double CBCGPColorPickerCtrl::GetStartAngle() const Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_color_picker_ctrl_a49366a26f02e07788e29b855f68220c0.html Retrieves the color wheel start angle. This method is inline and returns the start angle as a double. ```APIDOC ## double CBCGPColorPickerCtrl::GetStartAngle() const ### Description Retrieves the color wheel start angle. ### Method GetStartAngle ### Signature `double CBCGPColorPickerCtrl::GetStartAngle() const` ### Parameters None. ### Return Value - **double** - The start angle of the color wheel. ### Remarks This method is inline. ``` -------------------------------- ### CBCGPCircularGaugeScale::GetStartAngle Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_circular_gauge_scale_ae9aae497662121eba41f946e4f827150.html Returns the start angle of the scale. This inline method takes no parameters and returns a double representing the start angle. ```APIDOC ## CBCGPCircularGaugeScale::GetStartAngle ### Description Returns the start angle of the scale. ### Method GetStartAngle ### Signature `double CBCGPCircularGaugeScale::GetStartAngle() const` ### Parameters None. ### Returns - **double** - The start angle. ``` -------------------------------- ### Create Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_docking_control_bar.html Creates the Windows control and attaches it to the CBCGPDockingControlBar object. ```APIDOC ## Create ### Description Creates the Windows control and attaches it to the CBCGPDockingControlBar object. ### Method Create ### Parameters No parameters documented. ``` -------------------------------- ### Create Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_ribbon_bar.html Creates the Windows control and attaches it to CBCGPRibbonBar. ```APIDOC ## Create ### Description Creates the Windows control and attaches it to CBCGPRibbonBar. ### Syntax ```cpp BOOL Create(CWnd* pParentWnd, DWORD dwStyle = 0, UINT nID = 0); ``` ### Parameters - `pParentWnd` (CWnd*) - Required - Pointer to the parent window. - `dwStyle` (DWORD) - Optional - The window style. Default is 0. - `nID` (UINT) - Optional - The control ID. Default is 0. ### Return Value TRUE if successful; otherwise FALSE. ``` -------------------------------- ### Create Source: https://help.bcgsoft.com/BCGControlBarPro/class_c_b_c_g_p_hot_spot_image_ctrl.html Initializes a hot spot image control. ```APIDOC ## Create ### Description Initializes a hot spot image control. ### Method Create ### Parameters Not specified in the source. ```