CMFCRibbonSeparator Class

Implements the ribbon separator.

class CMFCRibbonSeparator : public CMFCRibbonBaseElement

Members

Public Constructors

Name

Description

CMFCRibbonSeparator::CMFCRibbonSeparator

Constructs a CMFCRibbonSeparator object.

Public Methods

Name

Description

CMFCRibbonSeparator::AddToListBox

Adds a separator to the Commands list in the Customize dialog box. (Overrides CMFCRibbonBaseElement::AddToListBox.)

CMFCRibbonSeparator::CreateObject

Used by the framework to create a dynamic instance of this class type.

CMFCRibbonSeparator::GetThisClass

Used by the framework to obtain a pointer to the CRuntimeClass object that is associated with this class type.

Protected Methods

Name

Description

CMFCRibbonSeparator::CopyFrom

A copy method that sets a separator's member variables from another object.

CMFCRibbonSeparator::GetRegularSize

Returns the size of a separator.

CMFCRibbonSeparator::IsSeparator

Indicates whether this is a separator.

CMFCRibbonSeparator::IsTabStop

Indicates whether this is a tab stop.

CMFCRibbonSeparator::OnDraw

Called by the system to draw the separator on either the ribbon or the Quick Access Toolbar.

CMFCRibbonSeparator::OnDrawOnList

Called by the system to draw the separator on the Commands list.

Remarks

A ribbon separator is a vertical or horizontal line that logically separates ribbon elements. A separator can be drawn on the ribbon control, the main application menu, the ribbon status bar, and the Quick Access Toolbar.

To use a separator in your application, construct the new object and add it to the main application menu as shown here:

CMFCRibbonMainPanel* pMainPanel = m_wndRibbonBar.AddMainCategory(_T("Main Menu"), IDB_FILESMALL, IDB_FILELARGE); 
...
pMainPanel->Add(new CMFCRibbonSeparator(TRUE));

Call CMFCRibbonPanel::AddSeparator to add separators to ribbon panels. The separators are allocated and added internally by the AddSeparator method.

Inheritance Hierarchy

CObject

   CMFCRibbonBaseElement

      CMFCRibbonSeparator

Requirements

Header: afxbaseribbonelement.h

See Also

Concepts

MFC Hierarchy Chart

Other Resources

Classes (MFC Feature Pack)