Ribbon Wiki & Documentation Rss Feed

Updated Wiki: How to Obtain DLL for .NET Framework 3.5 & 4.0

adriancs — Thu, 10 Jan 2013 08:51:37 GMT

How to Obtain DLL for .NET Framework 3.5 & 4.0

The content of this page is remain for reference. You can get the precompile (new version) from new site. Please visit http://officeribbon.codeplex.com.

You can either convert the original source project of this ribbon from .NET Framework 2.0 to 3.5 or 4.0, or create a blank class project of .NET Framework 3.5/4.0.

If you choose to create a blank class, add all .cs files from the source code of System.Forms.Ribbon into your class, and add additional reference of

System.Design
System.Drawing
System.Windows.Forms

You have to modify GlobalHook.cs. Refer Solution 1 explained here: Ribbon is slowing down application

Find private void InstallHook()
~~Add a return statement at the beginning of the method so nothing is done.~~ (These is a better fix than this).
Please follow Solution 1 at here: Ribbon is slowing down application

Next, please note that, at your new WinForm project, after the first build, the target framework will automatically switched to Client Profile.

For example, if you are building a .NET Framework 4.0, Visual Studio will initially switch your WinForm project to .NET Framework 4.0 Client Profile. You have to manually switched it back to .NET Framework 4.0. This is because Client Profile does not support System.Design which required by the Ribbon to build and run. System.Design is used by Ribbon internally.

Updated Wiki: Home

adriancs — Thu, 10 Jan 2013 08:49:09 GMT

Project Description
A project on an Office-like Ribbon control.

The development/support of this project is continued at new site, please visit: http://officeribbon.codeplex.com

Orb and QuickAccess toolbar now on Non-Client Area!

Important: Read the guide for embedding the ribbon on the non-client area.

This is a Microsoft Office 2007 Ribbon Bar - like control for .NET, as all of the code in my site, is free and open source. At the time this is being written, is yet the best ribbon available for free.

Please refer to my site/blog www.menendezpoo.com for more on usage, development and news about this project

Introduction

Because of the lack of good free Ribbon controls on the web, I decided to write one myself. I've analyzed previous work on ribbon-controls. Unfortunately, most existent controls are merely bad tries. Why? well, some lack nice rendering, some lack resizing features, some lack almost everything. Of course, well developed Ribbon controls are available at a price. This ribbon is free.

Some of the design goals

Performance - This ribbon is contained on a Control window, and every element inside of it is managed as a bunch of bounds inside the control, just as the ToolStrip control does. Altough this is difficult to manage from the ribboon's inside code, this is a way to keep it at the best performed ribbon. Believe me, download the demo, run it and resize the window. It peforms beautifully.

Consistency with Office's ribbon - I read once about Jakob Nielsen saying that most users prefer the programs they use look just like word, excel or powerpoint. This is quite obvious, because people use this software every day. Providing visual consistency with the office's ribbon is very important because people already know what to expect from a ribbon-like interface. I've tried to every element in the ribbon look and behave exactly like it does in the Office's ribbon.

Ease of use for programmers - The naming of components is consistent with most WinForms names, even more with the ToolStrip elements. Property, event and method names for similar elements are named just like in the ToolStrip technology items.

Designer support - I will be adding more and more designer support so you can manage the ribbon 100% from the designer.

Using the Ribbon

The ribbon is located in the System.Windows.Forms namespace, just as every other control, I think it's annoying to use controls named as MyCoolFirm.MyCoolNameSpace.MyCoolSubNameSpace, and so on (Please do that only for bussiness objects).

You can add a reference to the compiled dll: System.Windows.Forms.Ribbon.dll or you can directly copy the source files to a folder on your project. The code is currently designed so you can just copy the source files, it doesn't need any extra resources.

Hands on: Quick Guide

The ribbon is composed mainly by three kind of elements, the tabs, the panels on the tabs (other developers call them groups) and the items inside the panels.

These elements are represented by RibbonTab, RibbonPanel and RibbonItem types. RibbonItem is an abstract class that provides basic functionality for any item hosted on a RibbonPanel or on a RibbonDropDown.

You can add tabs from the smart tag of the Ribbon, you can add panels to the tab by selecting the tab and calling the "AddPanel" verb on the bottom part of the property grid.

The elements on the ribbon are resized according to the available space for the ribbon. This is a key feature of the ribbon. It tries to bring all possible commands to the screen by resizing them, instead of hiding them on an overflow button like the old ToolStrip.

I treat this as three kinds of sizes: Large, Medium and Compact. An additional size is used for panels because panels can be collapsed, and then they will adopt the Overflow size.

Note: There's no way to directly affect the bounds of the elements on the ribbon, the size will always be determined the layout engine inside the ribbon. In fact, the layout depends on two factors: the available horizontal space on the ribbon and the size modes on the items.

If there's no available space on the ribbon for a panel, panel will be collapsed. If all panels are collapsed and space is not available yet, a scroll button will appear so user can scroll the panels horizontally.

Buttons

There's only one type of button: RibbonButton. It can be set to three styles:

RibbonButton adds the SmallImage property so you can set the image shown when button is in medium or compact mode. Although it's not restricted by functionality, it's highly recommended to use just 32 x 32 pixels for Image property and 16 x 16 for SmallImage property. Results are unexpected when sizes are different.

Note: Use the DropDownItems property to add items to the dropdown of the button.

The appearance of the buttons vary through size modes.

ItemGroups

The buttons like those on the Font and Paragraph panels are RibbonButton buttons hosted inside a RibbonItemGroup group.

Items added to RibbonItemGroup will always be measured and treated in compact size mode.

Important: If a RibbonPanel will host RibbonItemGroup objects, you must set the RibbonPanel.FlowsTo property to Right. The layout on those items are treated differently because groups flow as rows.

Lists

Lists are represented by RibbonButtonList and provide two collections: Buttons and DropDownItems. This is because the list can be scrolled on the ribbon and can dropdown more items. The dropdown of list supports resizing by a grip on the south east corner.

If you want the buttons on the list to be shown on the dropdown, you will have to explicitly add another list with those buttons to the DropDownItems property.

Separators

Separators are represented by RibbonButtonSeparator and provides the well known separator functionality. When in a dropdown, separators can actually contain text. When they contain text, they will be rendered differently.

Updated Wiki: Ribbon is slowing down application

adriancs — Thu, 03 Jan 2013 14:46:35 GMT

Ribbon is slowing down application

Disscusion: http://ribbon.codeplex.com/discussions/81454

Note: The bugs stated in this page have been solved in new version of ribbon. You can get it at new site, here: http://officeribbon.codeplex.com/

Solution 1:

GlobalHook.cs Fixed Shared by han6man*

Download Source Code.
Find GlobalHook.cs
Find private void InstallHook()

http://www.codeproject.com/Messages/4020406/Re-Here-is-a-Solution-that-works-for-2-0-and-4-0-n.aspx

using System.Diagnostics;

/// <summary>
        /// Installs the actual unsafe hook
        /// </summary>
        private void InstallHook()
        {
            /// Error check
            if (Handle != 0) throw new Exception("Hook is already installed");
 
            #region htype
            int htype = 0;
 
            switch (HookType)
            {
                case HookTypes.Mouse:
                    htype = WinApi.WH_MOUSE_LL;
                    break;
                case HookTypes.Keyboard:
                    htype = WinApi.WH_KEYBOARD_LL;
                    break;
                default:
                    throw new Exception("HookType is not supported");
            }
            #endregion
 
            /// Delegate to recieve message
            _HookProc = new HookProcCallBack(HookProc);
 
            /// Hook
            //_hHook = WinApi.SetWindowsHookEx(htype, _HookProc, Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]), 0);

            _hHook = WinApi.SetWindowsHookEx(htype, _HookProc, GetCurrentModule().BaseAddress, 0); // FIX
            if (_hHook == 0) _hHook = WinApi.SetWindowsHookEx(htype, _HookProc, IntPtr.Zero, 0);  // FIX

            /// Error check
            if (Handle == 0) throw new Win32Exception(Marshal.GetLastWin32Error());
            
 
        }

Updated: 02 Jan 2013

public static ProcessModule GetCurrentModule()
{
    // need instance handle to module to create a system-wide hook
    Module[] list = System.Reflection.Assembly.GetExecutingAssembly().GetModules();
    System.Diagnostics.Debug.Assert(list != null && list.Length > 0);
    //System.Reflection.Assembly.LoadFrom("System.Windows.Forms.Ribbon.dll").ImageRuntimeVersion;
    var currentProcess = Process.GetCurrentProcess();
    var modules = currentProcess.Modules;
    ProcessModule mod = null;

    #region
    if (Environment.Version.Major < 3)
        foreach (ProcessModule m in modules)
        {
            if (m.ModuleName == list[0].Name)
            {
                mod = m;
                return mod;
            }
        }
    else if (mod == null) mod = Process.GetCurrentProcess().MainModule;

    return mod;

    #endregion
}

Solution 2:

This fix will enable you to use with MDI Client, but might experience other ribbon controls (such as dropdownlist) to refresh incorrectly.
(shared by javierdd)

Download the source code.
Find GlobalHook.cs

Find private void InstallHook()
Add a return statement at the beggining of the method so nothing is done

Solution 3:

(shared by giague)

In Ribbon.cs find

protected override void WndProc(ref Message m)

then sobstitute the proc with this one including the variable declaration

private bool MouseOnCaption = false;

It allow Dobule Click on caption bar and drag the from when in normal mode;

private bool MouseOnCaption = false;
protected override void WndProc(ref Message m)
{
    //These are constant to send Drag instruction to base.WndProc;
    const int HT_CAPTION = 0x2; const int WM_NCLBUTTONDOWN = 0xa1;
    bool bypassed = false;

    if (WinApi.IsWindows && (ActualBorderMode == RibbonWindowMode.NonClientAreaGlass || ActualBorderMode == RibbonWindowMode.NonClientAreaCustomDrawn))
    {
        if (m.Msg == WinApi.WM_NCHITTEST)
        {
            Form f = FindForm();
            Rectangle caption;
            if (RightToLeft == RightToLeft.No)
            {
                int captionLeft = QuickAcessToolbar.Visible ? QuickAcessToolbar.Bounds.Right : OrbBounds.Right;
                if (QuickAcessToolbar.Visible && QuickAcessToolbar.DropDownButtonVisible) captionLeft = QuickAcessToolbar.DropDownButton.Bounds.Right;
                caption = Rectangle.FromLTRB(captionLeft, 0, Width, CaptionBarSize);
            }
            else
            {
                int captionRight = QuickAcessToolbar.Visible ? QuickAcessToolbar.Bounds.Left : OrbBounds.Left;
                if (QuickAcessToolbar.Visible && QuickAcessToolbar.DropDownButtonVisible) captionRight = QuickAcessToolbar.DropDownButton.Bounds.Left;
                caption = Rectangle.FromLTRB(0, 0, captionRight, CaptionBarSize);
            }

            Point screenPoint = new Point(WinApi.LoWord((int)m.LParam), WinApi.HiWord((int)m.LParam));
            Point ribbonPoint = PointToClient(screenPoint);
            bool onCaptionButtons = false;

            if (CaptionButtonsVisible)
            {
                onCaptionButtons = CloseButton.Bounds.Contains(ribbonPoint) ||
                MinimizeButton.Bounds.Contains(ribbonPoint) ||
                MaximizeRestoreButton.Bounds.Contains(ribbonPoint);
            }
            //Detect if mouse is on caption andalso not on CaptionButtons
            MouseOnCaption = (!onCaptionButtons && RectangleToScreen(caption).Contains(screenPoint));
        }
        if (MouseOnCaption)
        {
            if (m.Msg == WinApi.WM_LBUTTONDBLCLK)
            {
                //If Double Click on caption change FormWindowsState
                Form f = FindForm();
                f.WindowState = f.WindowState == FormWindowState.Normal ? FormWindowState.Maximized : FormWindowState.Normal;
                bypassed = true;
            }
            if (m.Msg == WinApi.WM_LBUTTONDOWN)
            {
                //If mouse left button is down on caption create and send message to start drag.
                Form f = FindForm();
                Message mDrag = new Message();
                mDrag.HWnd = f.Handle;
                mDrag.Msg = WM_NCLBUTTONDOWN;
                mDrag.WParam = new IntPtr(HT_CAPTION);
                mDrag.LParam = IntPtr.Zero;
                base.WndProc(ref mDrag);
            }
        }

    }

    if (!bypassed)
    {
        base.WndProc(ref m);
    }
}

GlobalHook.cs

Updated Wiki: Documentation

adriancs — Wed, 02 Jan 2013 15:40:31 GMT

Note: You can find the latest released version of ribbon at new site: http://officeribbon.codeplex.com

.

Content:

How to Use This Ribbon Control (This page)
- Cautious while using with Visual Studio 2010
How to(s)
Troubleshooting/Bugs Fix
- GloboHook.cs Fix/Exceptions Ribbon is slowing down application
Using Ribbon wtih MDI (Multi Document Interface)

Note: There are some more bugs fix at the Discussions Section shared by other user.

This ribbon will be continue to develop and it is now move to a new site. If you would like to contribute your codes and efforts to make this a better ribbon, or you wish obtain newer ribbon fix or upgrade, you may visit this project: http://officeribbon.codeplex.com/, http://www.staffinder.net/carbisoft/
See discussion >> Office 2010 Style Orb, Tooltips, and a Minimize Feature
Some bugs in this ribbon were fixed and features are extended.

How to Use This Ribbon Control

Note: To develop with .NET Framework 3.5 & 4.0.

The original develop platform of this ribbon is .NET Framework 2.0. To use this ribbon in .NET Framework 3.5 or 4.0, please read this: How to Obtain DLL for .NET Framework 3.5 & 4.0

Download: RibbonSample.zip

.

Note: The main documentation of this page has been moved to new site. Please go to new site to read details guide and documentation.

New Site: http://officeribbon.codeplex.com/documentation

Cautious While Using With Visual Studio 2010

ALWAYS SAVE AND CLOSE straight away after you have finished designing the GUI editing of Main Form (The form that contains the ribbon control).

Don't Run (Press F5) The Application while the Main Form is open in Visual Studio 2010.

Or else, you might experience that the ribbon control has disappeared. You will end up redesigning/redraw the ribbon and reconnect all the events that associated with the ribbon.

Before using the ribbon, you have to patch the GlobalHook.cs.

There are some workout for this, please read this: Ribbon is slowing down application

Updated Wiki: How to Make a New Theme, Skin for this Ribbon Programmatically

adriancs — Wed, 02 Jan 2013 15:37:58 GMT

How to Make a New Theme, Skin for this Ribbon Programmatically

Default Theme Color

Example Color Theme of RibbonProfesionalRendererColorTableBlack.cs (ready made by ribbon author).

Another Customize Theme (I made myself)

.

Note: The main documentation of this page has been moved to new site. Please go to new site to read details guide and documentation.

New Site: http://officeribbon.codeplex.com/wikipage?title=How%20to%20Make%20a%20New%20Theme%2c%20Skin%20for%20this%20Ribbon%20Programmatically

Updated Wiki: Using Ribbon wtih MDI (Multi Document Interface)

adriancs — Wed, 02 Jan 2013 15:35:28 GMT

Using Ribbon wtih MDI (Multi Document Interface)

1. Before start, we need to modify System.Windows.Forms.Ribbon.dll. This steps is shared by javierdd. See Documentation > Ribbon is slowing down application

2. Download the source code of the ribbon. Open GlobalHook.cs.

3. Find private void InstallHook(). Add a return statement at the beggining of the method so nothing is done.

4. Build the solution and obtain the newly edited System.Windows.Forms.Ribbon.dll. We'll use this to build our next MDI WinForm. Or, you can simply download it (which I've modified) from here : System.Windows.Forms.Ribbon.dll

Step 5.....

The rest of the documentation of this page has been moved to new site. Please go to new site to continue reading the guide.

New Site: http://officeribbon.codeplex.com/wikipage?title=Using%20Ribbon%20wtih%20MDI%20%28Multi%20Document%20Interface%29

Updated Wiki: Documentation

adriancs — Wed, 02 Jan 2013 15:30:47 GMT

Content:

How to Use This Ribbon Control (This page)
- Cautious while using with Visual Studio 2010
How to(s)
Troubleshooting/Bugs Fix
- GloboHook.cs Fix/Exceptions Ribbon is slowing down application
Using Ribbon wtih MDI (Multi Document Interface)

Note: There are some more bugs fix at the Discussions Section shared by other user.

How to Use This Ribbon Control

Note: To develop with .NET Framework 3.5 & 4.0.

.

Note: The main documentation of this page has been moved to new site. Please go to new site to read details guide and documentation.

New Site: http://officeribbon.codeplex.com/documentation

Cautious While Using With Visual Studio 2010

Before using the ribbon, you have to patch the GlobalHook.cs.

There are some workout for this, please read this: Ribbon is slowing down application

Updated Wiki: Ribbon is slowing down application

adriancs — Wed, 02 Jan 2013 12:26:33 GMT

Ribbon is slowing down application

Disscusion: http://ribbon.codeplex.com/discussions/81454

Solution 1:

GlobalHook.cs Fixed Shared by han6man*

Download Source Code.
Find GlobalHook.cs
Find private void InstallHook()

http://www.codeproject.com/Messages/4020406/Re-Here-is-a-Solution-that-works-for-2-0-and-4-0-n.aspx

using System.Diagnostics;

/// <summary>
        /// Installs the actual unsafe hook
        /// </summary>
        private void InstallHook()
        {
            /// Error check
            if (Handle != 0) throw new Exception("Hook is already installed");
 
            #region htype
            int htype = 0;
 
            switch (HookType)
            {
                case HookTypes.Mouse:
                    htype = WinApi.WH_MOUSE_LL;
                    break;
                case HookTypes.Keyboard:
                    htype = WinApi.WH_KEYBOARD_LL;
                    break;
                default:
                    throw new Exception("HookType is not supported");
            }
            #endregion
 
            /// Delegate to recieve message
            _HookProc = new HookProcCallBack(HookProc);
 
            /// Hook
            //_hHook = WinApi.SetWindowsHookEx(htype, _HookProc, Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]), 0);

            _hHook = WinApi.SetWindowsHookEx(htype, _HookProc, GetCurrentModule().BaseAddress, 0); // FIX
            if (_hHook == 0) _hHook = WinApi.SetWindowsHookEx(htype, _HookProc, IntPtr.Zero, 0);  // FIX

            /// Error check
            if (Handle == 0) throw new Win32Exception(Marshal.GetLastWin32Error());
            
 
        }

Updated: 02 Jan 2013

public static ProcessModule GetCurrentModule()
{
    // need instance handle to module to create a system-wide hook
    Module[] list = System.Reflection.Assembly.GetExecutingAssembly().GetModules();
    System.Diagnostics.Debug.Assert(list != null && list.Length > 0);
    //System.Reflection.Assembly.LoadFrom("System.Windows.Forms.Ribbon.dll").ImageRuntimeVersion;
    var currentProcess = Process.GetCurrentProcess();
    var modules = currentProcess.Modules;
    ProcessModule mod = null;

    #region
    if (Environment.Version.Major < 3)
        foreach (ProcessModule m in modules)
        {
            if (m.ModuleName == list[0].Name)
            {
                mod = m;
                return mod;
            }
        }
    else if (mod == null) mod = Process.GetCurrentProcess().MainModule;

    return mod;

    #endregion
}

Solution 2:

This fix will enable you to use with MDI Client, but might experience other ribbon controls (such as dropdownlist) to refresh incorrectly.
(shared by javierdd)

Download the source code.
Find GlobalHook.cs

Find private void InstallHook()
Add a return statement at the beggining of the method so nothing is done

Solution 3:

(shared by giague)

In Ribbon.cs find

protected override void WndProc(ref Message m)

then sobstitute the proc with this one including the variable declaration

private bool MouseOnCaption = false;

It allow Dobule Click on caption bar and drag the from when in normal mode;

private bool MouseOnCaption = false;
protected override void WndProc(ref Message m)
{
    //These are constant to send Drag instruction to base.WndProc;
    const int HT_CAPTION = 0x2; const int WM_NCLBUTTONDOWN = 0xa1;
    bool bypassed = false;

    if (WinApi.IsWindows && (ActualBorderMode == RibbonWindowMode.NonClientAreaGlass || ActualBorderMode == RibbonWindowMode.NonClientAreaCustomDrawn))
    {
        if (m.Msg == WinApi.WM_NCHITTEST)
        {
            Form f = FindForm();
            Rectangle caption;
            if (RightToLeft == RightToLeft.No)
            {
                int captionLeft = QuickAcessToolbar.Visible ? QuickAcessToolbar.Bounds.Right : OrbBounds.Right;
                if (QuickAcessToolbar.Visible && QuickAcessToolbar.DropDownButtonVisible) captionLeft = QuickAcessToolbar.DropDownButton.Bounds.Right;
                caption = Rectangle.FromLTRB(captionLeft, 0, Width, CaptionBarSize);
            }
            else
            {
                int captionRight = QuickAcessToolbar.Visible ? QuickAcessToolbar.Bounds.Left : OrbBounds.Left;
                if (QuickAcessToolbar.Visible && QuickAcessToolbar.DropDownButtonVisible) captionRight = QuickAcessToolbar.DropDownButton.Bounds.Left;
                caption = Rectangle.FromLTRB(0, 0, captionRight, CaptionBarSize);
            }

            Point screenPoint = new Point(WinApi.LoWord((int)m.LParam), WinApi.HiWord((int)m.LParam));
            Point ribbonPoint = PointToClient(screenPoint);
            bool onCaptionButtons = false;

            if (CaptionButtonsVisible)
            {
                onCaptionButtons = CloseButton.Bounds.Contains(ribbonPoint) ||
                MinimizeButton.Bounds.Contains(ribbonPoint) ||
                MaximizeRestoreButton.Bounds.Contains(ribbonPoint);
            }
            //Detect if mouse is on caption andalso not on CaptionButtons
            MouseOnCaption = (!onCaptionButtons && RectangleToScreen(caption).Contains(screenPoint));
        }
        if (MouseOnCaption)
        {
            if (m.Msg == WinApi.WM_LBUTTONDBLCLK)
            {
                //If Double Click on caption change FormWindowsState
                Form f = FindForm();
                f.WindowState = f.WindowState == FormWindowState.Normal ? FormWindowState.Maximized : FormWindowState.Normal;
                bypassed = true;
            }
            if (m.Msg == WinApi.WM_LBUTTONDOWN)
            {
                //If mouse left button is down on caption create and send message to start drag.
                Form f = FindForm();
                Message mDrag = new Message();
                mDrag.HWnd = f.Handle;
                mDrag.Msg = WM_NCLBUTTONDOWN;
                mDrag.WParam = new IntPtr(HT_CAPTION);
                mDrag.LParam = IntPtr.Zero;
                base.WndProc(ref mDrag);
            }
        }

    }

    if (!bypassed)
    {
        base.WndProc(ref m);
    }
}

GlobalHook.cs

New Comment on "Ribbon is slowing down application"

han6man — Wed, 02 Jan 2013 10:11:27 GMT

public static ProcessModule GetCurrentModule() { // need instance handle to module to create a system-wide hook Module[] list = System.Reflection.Assembly.GetExecutingAssembly().GetModules(); System.Diagnostics.Debug.Assert(list != null && list.Length > 0); //System.Reflection.Assembly.LoadFrom("System.Windows.Forms.Ribbon.dll").ImageRuntimeVersion; var currentProcess = Process.GetCurrentProcess(); var modules = currentProcess.Modules; ProcessModule mod = null; #region if (Environment.Version.Major < 3) foreach (ProcessModule m in modules) { if (m.ModuleName == list[0].Name) { mod = m; return mod; } } else if (mod == null) mod = Process.GetCurrentProcess().MainModule; return mod; #endregion }

Updated Wiki: Documentation

adriancs — Tue, 01 Jan 2013 12:42:16 GMT

Content:

How to Use This Ribbon Control (This page)
- Cautious while using with Visual Studio 2010
How to(s)
Troubleshooting/Bugs Fix
- GloboHook.cs Fix/Exceptions Ribbon is slowing down application
Using Ribbon wtih MDI (Multi Document Interface)

Note: There are some more bugs fix at the Discussions Section shared by other user.

How to Use This Ribbon Control

Updated: Note for Visual Studio 2012

You have to modify some of the source code before using it in Visual Studio 2012. Open the source code, find this file > GlobalHook.cs. Open GlobalHook.cs and find this method:

private void InstallHook()
{ 
    /// Error check
    if (Handle != 0) throw new Exception("Hook is already installed");
 
    ...
    ...
}

Replace the whole method with this:

private void InstallHook()
{
    return;
}

You should be able to compile it regardless of target framework of 2.0, 3.5, 4.0 or 4.5. This might not be the best patch, but this is what I currently know that work.

1st Way: Using code to add the ribbon
2nd Way: Add as Toolbox item
3rd Way: Add the source file into your project

1st Way: Using code to add the ribbon

Add a Reference to System.Windows.Forms.Ribbon.dll in your project.

Right click on Reference in Solution Explorer, choose Add.

Locate System.Windows.Forms.Ribbon.dll.

Open the designer of Main Form. In this example, Form1.Designer.cs.

This is the initial code for Form1.Designer.cs

namespace WindowsFormsApplication1
{
    partial class Form1
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
        private System.ComponentModel.IContainer components = null;

        /// <summary>
        /// Clean up any resources being used.
        /// </summary>
        /// <param name="disposing">true if managed
        /// resources should be disposed; otherwise, false.</param>
        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

        #region Windows Form Designer generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {
            this.components = new System.ComponentModel.Container();
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.Text = "Form1";
        }

        #endregion
    }
}

Add three lines of code into Form1.Designer.cs

private System.Windows.Forms.Ribbon ribbon1;
this.ribbon1 = new System.Windows.Forms.Ribbon();
this.Controls.Add(this.ribbon1);

Save and close Form1.Designer.cs.

Double click and open Form1.cs, and now the Ribbon control is added into the main form.

2nd Way: Add as toolbox item and drag/drop

This is more simpler way to add the ribbon into the form. Just simply create a new tab at Toolbox.

Drag and drop the DLL into the new tab.

Click on any area of Toolbox. Right click > Add Tab.

Give the new tab a name.

Drag the DLL into the new tab area.

Drag the Ribbon into the Form. Thats it.

And this will automatically add a reference of System.Windows.Forms.Ribbon for you.

3rd Way: Add the source file into your project

Create a folder in the solution explorer of your project and add all the source cs file of the ribbon.

Build your project.

Then drag & drop the ribbon control from toolbox explorer into the form.

The benefit of adding the ribbon this way is you won't have another separate assembly (DLL) to deliver with your application. The source of the ribbon is embed directly into your project.

Some of you might not able to see the extra command links of "Add Button", "Add ButtonList", "Add ItemGroup"... etc at the Properties Explorer.

What you need to do is right click at the Properties Explorer and Tick/Check the [Commands].

7. Try add some buttons into the RibbonPanel.

8. Click on the RibbonButtons, go to Properties. Lets try to change the image and the label text of the button.

9. This is how your ribbon looks like now.
10. Now, create the click event for the buttons. Click on the RibbonButton, go to Properties, modify the Name of the button.

11. Open the code of Form1.cs.

12. This is what we have initially

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
    }
}

13. Add the Button Clicked event for the RibbonButton.

public Form1()
{
    InitializeComponent();
    cmdNew.Click += new EventHandler(cmdNew_Click);
    cmdSave.Click += new EventHandler(cmdSave_Click);
}

void cmdNew_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"New\" Clicked.");
}

void cmdSave_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"Save\" Clicked.");
}

14. Press F5 to run the application. Done.

15. You might want to inherit your Main Form into a RibbonForm to have extra feature. Such as:
Note: Inherit the Main Form to RibbonForm will have some compatible problems with some of System.Windows.Forms controls.

16. At the code of Form1.cs, change this line:

public partial class Form1 : Form

to this line:

public partial class Form1 : RibbonForm

Here is the sample project explain above:

Download: RibbonSample.zip

Cautious While Using With Visual Studio 2010

Before using the ribbon, you have to patch the GlobalHook.cs.

There are some workout for this, please read this: Ribbon is slowing down application

Updated Wiki: Documentation

adriancs — Tue, 01 Jan 2013 12:34:59 GMT

Content:

How to Use This Ribbon Control (This page)
- Cautious while using with Visual Studio 2010
How to(s)
Troubleshooting/Bugs Fix
- GloboHook.cs Fix/Exceptions Ribbon is slowing down application
Using Ribbon wtih MDI (Multi Document Interface)

Note: There are some more bugs fix at the Discussions Section shared by other user.

How to Use This Ribbon Control

Updated: Note for Visual Studio 2012

You have to modify some of the source code before using it in Visual Studio 2012. Open the source code, find this file > GlobalHook.cs. Open GlobalHook.cs and find this method:

private void InstallHook()
{ 
    /// Error check
    if (Handle != 0) throw new Exception("Hook is already installed");
 
    ...
    ...
}

Replace the whole method with this:

private void InstallHook()
{
    return;
}

You should be able to compile it regardless of target framework of 2.0, 3.5, 4.0 or 4.5. This might not be the best patch, but this is what I currently know that work.

1st Way: Using code to add the ribbon
2nd Way: Add as Toolbox item
3rd Way: Add the source file into your project

1st Way: Using code to add the ribbon

Add a Reference to System.Windows.Forms.Ribbon.dll in your project.

Right click on Reference in Solution Explorer, choose Add.

Locate System.Windows.Forms.Ribbon.dll.

Open the designer of Main Form. In this example, Form1.Designer.cs.

This is the initial code for Form1.Designer.cs

namespace WindowsFormsApplication1
{
    partial class Form1
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
        private System.ComponentModel.IContainer components = null;

        /// <summary>
        /// Clean up any resources being used.
        /// </summary>
        /// <param name="disposing">true if managed
        /// resources should be disposed; otherwise, false.</param>
        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

        #region Windows Form Designer generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {
            this.components = new System.ComponentModel.Container();
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.Text = "Form1";
        }

        #endregion
    }
}

Add three lines of code into Form1.Designer.cs

private System.Windows.Forms.Ribbon ribbon1;
this.ribbon1 = new System.Windows.Forms.Ribbon();
this.Controls.Add(this.ribbon1);

Save and close Form1.Designer.cs.

Double click and open Form1.cs, and now the Ribbon control is added into the main form.

2nd Way: Add as toolbox item and drag/drop

This is more simpler way to add the ribbon into the form. Just simply create a new tab at Toolbox.

Drag and drop the DLL into the new tab.

3rd Way: Add the source file into your project

Create a folder in the solution explorer of your project and add all the source cs file of the ribbon.

Build your project.

Then drag & drop the ribbon control from toolbox explorer into the form.

The benefit of adding the ribbon this way is you won't have another separate assembly (DLL) to deliver with your application. The source of the ribbon is embed directly into your project.

4. Click on the Ribbon and Click Add Tab.

5. Click on the newly added RibbonTab, then click Add Panel.

6. Click on the newly added RibbonPanel, go to Properties. A set of available controls that can be added to the RibbonPanel.

7. Try add some buttons into the RibbonPanel.

8. Click on the RibbonButtons, go to Properties. Lets try to change the image and the label text of the button.

9. This is how your ribbon looks like now.
10. Now, create the click event for the buttons. Click on the RibbonButton, go to Properties, modify the Name of the button.

11. Open the code of Form1.cs.

12. This is what we have initially

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
    }
}

13. Add the Button Clicked event for the RibbonButton.

public Form1()
{
    InitializeComponent();
    cmdNew.Click += new EventHandler(cmdNew_Click);
    cmdSave.Click += new EventHandler(cmdSave_Click);
}

void cmdNew_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"New\" Clicked.");
}

void cmdSave_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"Save\" Clicked.");
}

14. Press F5 to run the application. Done.

public partial class Form1 : Form

to this line:

public partial class Form1 : RibbonForm

Here is the sample project explain above:

Download: RibbonSample.zip

Cautious While Using With Visual Studio 2010

Before using the ribbon, you have to patch the GlobalHook.cs.

There are some workout for this, please read this: Ribbon is slowing down application

Updated Wiki: Programmatically Add RibbonButtons Into Ribbon

adriancs — Tue, 18 Dec 2012 12:17:21 GMT

Programmatically Add RibbonButtons Into Ribbon

This tip is contributed by Franziska.
http://www.codeproject.com/Messages/4454699/Re-Programmatically-add-Buttons-to-a-Panel-or-set-.aspx

To add a ribbon button programmatically into a ribbon, after create the Item/Button or whatever you want to add to the RibbonPanel, add it immediately after creating it, then set the Text/Images an DO NOT use SetBounds, the it measures the required size for itself.

Example:

This is correct

RibbonButton rbBtn =  new RibbonButton("Button1");
// below line must be added here
ribbonPanel2.Items.Add(rbBtn);
// Then, you can change any properties after that
// Examples of properties changes:
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
// Don't add the button into panel here
// ribbonPanel2.Items.Add(rbBtn);

This is wrong

RibbonButton rbBtn =  new RibbonButton("Button1");
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
ribbonPanel2.Items.Add(rbBtn);

Updated Wiki: Programmatically Add RibbonButtons Into Ribbon

adriancs — Tue, 18 Dec 2012 12:16:34 GMT

Programmatically Add RibbonButtons Into Ribbon

This tip is contributed by Franziska.
http://www.codeproject.com/Messages/4454699/Re-Programmatically-add-Buttons-to-a-Panel-or-set-.aspx

Example:

This is correct

RibbonButton rbBtn =  new RibbonButton("Button1");
// below line must be added here
ribbonPanel2.Items.Add(rbBtn);
// Then, you can change any properties after that
// Examples of properties changes:
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
// Don't add the button into panel here
// ribbonPanel2.Items.Add(rbBtn);

This is wrong

RibbonButton rbBtn =  new RibbonButton("Button1");
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
ribbonPanel2.Items.Add(rbBtn);

Updated Wiki: Programmatically Add RibbonButtons Into Ribbon

adriancs — Tue, 18 Dec 2012 12:12:22 GMT

Programmatically Add RibbonButtons Into Ribbon

This tip is contributed by Franziska.
http://www.codeproject.com/Messages/4454699/Re-Programmatically-add-Buttons-to-a-Panel-or-set-.aspx

This is correct

RibbonButton rbBtn =  new RibbonButton("Button1");
// below line must be added here
ribbonPanel2.Items.Add(rbBtn);
// Then, you can change any properties after that
// Examples of properties changes:
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
// Don't add the button into panel here
// ribbonPanel2.Items.Add(rbBtn);

This is wrong

RibbonButton rbBtn =  new RibbonButton("Button1");
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
ribbonPanel2.Items.Add(rbBtn);

Updated Wiki: How to Display Tool Tip

adriancs — Tue, 18 Dec 2012 12:09:29 GMT

How to Display Tool Tip

This is a temporary workout. To display a tool tip, you have to manually create it. Below code will show you how is it be done.

Example 1:

public partial class Form1 : Form
{
    ToolTip tip = new ToolTip();
    public Form1()
    {
        InitializeComponent();
        ribbonButton1.MouseEnter += new MouseEventHandler(ribbonButton1_MouseEnter);
        ribbonButton2.MouseEnter += new MouseEventHandler(ribbonButton2_MouseEnter);
    }
 
    void ribbonButton2_MouseEnter(object sender, MouseEventArgs e)
    {
        tip.Show("ribbonButton2, this is.", this, e.Location.X, e.Location.Y, 1000);
    }
 
    void ribbonButton1_MouseEnter(object sender, MouseEventArgs e)
    {
        tip.Show("This is ribbonButton1", this, e.Location.X, e.Location.Y, 1000);
    }
}

Example 2:

public partial class Form1 : Form
{
    object _ob;
    Timer timer1 = new Timer();
 
    public Form1()
    {
        InitializeComponent();
        timer1.Interval = 500;
        timer1.Tick += new EventHandler(timer1_Tick);
        ribbonButton1.ToolTip = "This is ribbonButton1.";
        ribbonButton1.MouseEnter += new MouseEventHandler(ribbonButton1_MouseEnter);
        ribbonButton1.MouseLeave += new MouseEventHandler(ribbonButton1_MouseLeave);
    }
 
    void ribbonButton1_MouseLeave(object sender, MouseEventArgs e)
    {
        timer1.Stop();
    }
 
    void ribbonButton1_MouseEnter(object sender, MouseEventArgs e)
    {
        _ob = sender;
        timer1.Start();
    }
 
    void timer1_Tick(object sender, EventArgs e)
    {
        timer1.Stop();
        if (_ob == null)
            return;
 
        int x = 40;
        int y = 100; 
 
        if (_ob.GetType() == typeof(RibbonButton))
        {
            ToolTip tp = new ToolTip();
            tp.Show(((RibbonButton)_ob).ToolTip, this, x, y, 1000);
        }
    }
}

Updated Wiki: Documentation

adriancs — Tue, 18 Dec 2012 12:06:50 GMT

Content:

How to Use This Ribbon Control
- Cautious while using with Visual Studio 2010
How to(s)
- How to Apply Keyboard Shortcuts
- How to Obtain DLL for .NET Framework 3.5 & 4.0
- How to Display Tool Tip
- Programmatically Add RibbonButtons Into Ribbon
- How to Make a New Theme, Skin for this Ribbon Programmatically (Change color of each elements)
Troubleshooting/Bugs Fix
- GloboHook.cs Fix/Exceptions Ribbon is slowing down application
Using Ribbon wtih MDI (Multi Document Interface)

Note: There are some more bugs fix at the Discussions Section shared by other user.

How to Use This Ribbon Control

1. Download the Ribbon Source and obtain System.Windows.Forms.Ribbon.dll at Download page of this project.

Note: To develop with .NET Framework 3.5 & 4.0.
The original develop platform of this ribbon is .NET Framework 2.0. To use this ribbon in .NET Framework 3.5 or 4.0, please read this: How to Obtain DLL for .NET Framework 3.5 & 4.0

2. Create a blank WinForm Project.

3. Adding Ribbon into Form.
There are 2 methods to add the Ribbon into the Form.

1st method: Using Code to add it.
2nd method: Drag and Drop

1st Method: Using Code to add it.

3.1.1. Add a Reference of System.Windows.Forms.Ribbon.dll to your project.
3.1.2. Right click on Reference at the Solution Explorer, choose Add.

3.1.3. Locate the System.Windows.Forms.Ribbon.dll.

3.1.4. Open the designer of the Main Form. In this example, Form1.Designer.cs.

3.1.5. This is the initial code for Form1.Designer.cs:

namespace WindowsFormsApplication1
{
    partial class Form1
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
        private System.ComponentModel.IContainer components = null;

        /// <summary>
        /// Clean up any resources being used.
        /// </summary>
        /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

        #region Windows Form Designer generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {
            this.components = new System.ComponentModel.Container();
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.Text = "Form1";
        }

        #endregion
    }
}

3.1.6. Add three lines of code into Form1.Designer.cs.

private System.Windows.Forms.Ribbon ribbon1;
this.ribbon1 = new System.Windows.Forms.Ribbon();
this.Controls.Add(this.ribbon1);

3.1.7. Save and close Form1.Designer.cs.

3.1.8. Double click and open Form1.cs, and now the Ribbon control is added into the main form.

2nd Method: Drag and Drop

3.2. 2nd Method: Drag and Drop

3.2.1. This is more simpler way to add the ribbon into the form. Just simply create a new tab at Toolbox. 3.2.2. Drag and drop the DLL into the new tab.
3.2.3. Click on any area of Toolbox. Right click > Add Tab.

3.2.4. Give the new tab a name.

3.2.5. Drag the DLL into the new tab area.

3.2.6. Drag the Ribbon into the Form. Thats it.

And this will automatically add a reference of System.Windows.Forms.Ribbon for you.

4. Click on the Ribbon and Click Add Tab.

5. Click on the newly added RibbonTab, then click Add Panel.

6. Click on the newly added RibbonPanel, go to Properties. A set of available controls that can be added to the RibbonPanel.

7. Try add some buttons into the RibbonPanel.

8. Click on the RibbonButtons, go to Properties. Lets try to change the image and the label text of the button.

9. This is how your ribbon looks like now.
10. Now, create the click event for the buttons. Click on the RibbonButton, go to Properties, modify the Name of the button.

11. Open the code of Form1.cs.

12. This is what we have initially:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
    }
}

13. Add the Button Clicked event for the RibbonButton.

public Form1()
{
    InitializeComponent();
    cmdNew.Click += new EventHandler(cmdNew_Click);
    cmdSave.Click += new EventHandler(cmdSave_Click);
}

void cmdNew_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"New\" Clicked.");
}

void cmdSave_Click(object sender, EventArgs e)
{
    MessageBox.Show("Button \"Save\" Clicked.");
}

14. Press F5 to run the application. Done.

15. You might want to inherit your Main Form into a RibbonForm to have extra feature. Such as:
Note: Inherit the Main Form to RibbonForm will have some compatible problems with some of System.Windows.Forms controls.

16. At the code of Form1.cs, change this line:

public partial class Form1 : Form

to this line:

public partial class Form1 : RibbonForm

Here is the sample project explain above:
Download: RibbonSample.zip

Cautious While Using With Visual Studio 2010

Before using the ribbon, you have to patch the GlobalHook.cs.

There are some workout for this, please read this: Ribbon is slowing down application

Updated Wiki: Programmatically Add RibbonButtons Into Ribbon

adriancs — Tue, 18 Dec 2012 12:04:58 GMT

Programmatically Add RibbonButtons Into Ribbon

This is correct

RibbonButton rbBtn =  new RibbonButton("Button1");
// below line must be added here
ribbonPanel2.Items.Add(rbBtn);
// Then, you can change any properties after that
// Examples of properties changes:
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
// Don't add the button into panel here
// ribbonPanel2.Items.Add(rbBtn);

This is wrong

RibbonButton rbBtn =  new RibbonButton("Button1");
rbBtn.Image = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.SmallImage = global::RibbonTest.Properties.Resources.fileopen;
rbBtn.Text = "My Dynamic Added Button";
ribbonPanel2.Items.Add(rbBtn);

New Comment on "Documentation"

jcmatoso — Thu, 23 Aug 2012 11:38:28 GMT

Does it work with Visual Basic Express rel.8 or 10? If so where iss the code? João

Updated Wiki: How to Obtain DLL for .NET Framework 3.5 & 4.0

adriancs — Sun, 03 Jun 2012 10:31:39 GMT

How to Obtain DLL for .NET Framework 3.5 & 4.0

System.Design
System.Drawing
System.Windows.Forms

You have to modify GlobalHook.cs. Refer Solution 1 explained here: Ribbon is slowing down application

Find private void InstallHook()
~~Add a return statement at the beginning of the method so nothing is done.~~ (These is a better fix than this).
Please follow Solution 1 at here: Ribbon is slowing down application

Updated Wiki: How to Apply Keyboard Shortcuts

adriancs — Fri, 01 Jun 2012 03:24:06 GMT

How to Apply Keyboard Shortcuts

Shortcut keys can be executed by using a hidden menu strip.

Create a Menu Strip, add some menu items and assign some shortcut keys to the items.

Below are some of the examples that you can use to associate the menu items' shorcut key to the Ribbon Buttons.

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }

    private void ribbonButton1_Click(object sender, EventArgs e)
    {
        MessageBox.Show("Ribbon button 1 clicked");
    }

    private void ribbonButton2_Click(object sender, EventArgs e)
    {
        menuItem2ToolStripMenuItem.PerformClick();
    }

    private void ribbonButton3_Click(object sender, EventArgs e)
    {
        Function3();
    }

    private void Function3()
    {
        MessageBox.Show("Function 3 launched");
    }

    private void menuItem1ToolStripMenuItem_Click(object sender, EventArgs e)
    {
        ribbonButton1.PerformClick();
    }

    private void menuItem2ToolStripMenuItem_Click(object sender, EventArgs e)
    {
        MessageBox.Show("Menu Item 2 clicked.");
    }

    private void menuItem3ToolStripMenuItem_Click(object sender, EventArgs e)
    {
        Function3();
    }
}