[转]Easily Add a Ribbon into a WinForms Application
时间:2022-03-13 20:18
本文转自:
Easily add ribbon to WinForm Application for .NET Framework 2.0, 3.5, 4.0 & 4.5Style 2007
Style 2010
Style 2013
Content
- (Update)
Part 1: Background
The ribbon that is going to be used in this article is an open source project created by Jose Menendez Poo. However, the original author of the ribbon has stopped support of it. A group of fans of this ribbon re-host and continue to develop/enhance and support the ribbon.
The original ribbon creator has posted an article explaining what this ribbon is all about at []. However, that article doesn‘t describe how to use it in your project. Therefore, this article will show how to use it.
Old Site: (By original author, but has stopped support)
New Site: (Re-host by fans of the ribbon)
Part 2: How to Use this Ribbon Control
Reminder: Please note that this ribbon does not work on .NET 3.5 Client Profile and .NET 4.0 Client Profile. You have to switch the target framework to .NET 3.5 or .NET 4.0. When you first create a project, Visual Studio might initially set the target framework to Client Profile.
If the project is using Client Profile, you might receive this error while you are trying to build the solution:
Hide Copy CodeError 3 The type or namespace name ‘Ribbon‘ does not exist in the namespace ‘System.Windows.Forms‘ (are you missing an assembly reference?)
- Get System.Windows.Forms.Ribbon35.dll from download.
- Create a blank WinForms project.
- Add Ribbon into Visual Studio Toolbox.
Right Click on Toolbox > Add Tab.
Give the new tab a name "
Ribbon
".Right Click on the New Tab [Ribbon] > Choose Items...
[Browse...] Where are you? System.Windows.Forms.Ribbon35.dl?
There you are... Gotcha... Select it...
Only
[Ribbon]
can be dragged intoForm
. Others, as the picture below said, they are not needed to exist in toolbox. However, it‘s not going to harm your computer or project if you select all the items belonging to ribbon (by default). It‘s up to you.And finally, what you‘re going to do is just...
Another Way
Manually code it behind.
You can add the ribbon into WinForm too with code behind.
Add a reference of System.Windows.Forms.Ribbon35.dll into your project. Build the solution.
Open the designer of Main Form. In this example, Form1.Designer.cs.
Add these three lines of code:
Hide Copy Codeprivate System.Windows.Forms.Ribbon ribbon1; ribbon1 = new System.Windows.Forms.Ribbon(); this.Controls.Add(ribbon1);
into Form1.Designer.cs:
Hide Copy Codeprivate void InitializeComponent() { ribbon1 = new System.Windows.Forms.Ribbon(); this.components = new System.ComponentModel.Container(); this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; this.Text = "Form1"; this.Controls.Add(ribbon1); } private System.Windows.Forms.Ribbon ribbon1;
Save and Close Form1.Designer.cs.
Double click and open Form1.cs, and now the
Ribbon
control is added into the main form.Let‘s continue...
- Click on the
Ribbon
and click Add Tab. - Click on the newly added
RibbonTab
, then click Add Panel. - Click on the newly added
RibbonPanel
, go to Properties. You will see a set of available controls that can be added to theRibbonPanel
.You might not able to see the extra command links of "Add Button", "Add ButtonList", "Add ItemGroup"... etc. at the Properties Explorer.
Right click at the Properties Explorer and tick/check the [
Commands
]. - Try to add some buttons into the
RibbonPanel
. - Click on the
RibbonButton
, go to Properties. - Let‘s try to change the image and the label text of the button.
- This is how your ribbon looks like now.
- Now, create the click event for the buttons. Click on
RibbonButton
, go to Properties, modify theName
of the button. - Click on the
RibbonButton
, go to properties > Click on Events > Double Click on event of Click. - Events created.
Hide Copy Code
public Form1() { InitializeComponent(); } void cmdNew_Click(object sender, EventArgs e) { MessageBox.Show("Button \"New\" Clicked."); } void cmdSave_Click(object sender, EventArgs e) { MessageBox.Show("Button \"Save\" Clicked."); }
- Press F5 to run the application. Done.
- You might want to inherit your Main Form into a
RibbonForm
to have extra features. Such as:Note: Inherit the Main Form to
RibbonForm
will have some compatibility problems with some of theSystem.Windows.Forms
controls. (especially MDI Client Control) This problem is solved in released version 10 May 2013. - In the code for Form1.cs, change inheritance of
Form
from this line: Hide Copy Codepublic partial class Form1 : Form
to
Hide Copy CodeRibbonForm
:public partial class Form1 : RibbonForm
Part 3: Caution While Using With Visual Studio 2010
... deleted ....
Part 4: Using this Ribbon with an MDI Enabled WinForm
The following guide will show how to apply this ribbon with an MDI (Multi Document Interface) enabled WinForm.
Note: In previous version of Ribbon, inheritance of RibbonForm is not supported well with MDI Enabled WinForm. This problem is solved in released version of 10 May 2013.
Start
- Let‘s design a ribbon winform something like this as example. In the properties window, set
IsMdiContainer
toTrue
. - Create another simple form that will be loaded into the MDI Container of
MainForm
. - At code behind of
Form1
, add in the below codes: Hide Copy Codepublic partial class Form1 : Form { public Form1() { InitializeComponent(); } protected override void OnLoad(EventArgs e) { base.OnLoad(e); this.ControlBox = false; this.WindowState = FormWindowState.Maximized; this.BringToFront(); } }
- At code behind of
MainForm
, create the click events forRibbonButton
atMainForm
:Note: In the previous version of Ribbon, inheritance of RibbonForm is not supported well with MDI Enabled WinForm. This problem is solved in released version of 10 May 2013.
Hide Copy Codepublic partial class MainForm : RibbonForm { public MainForm() { InitializeComponent(); } private void ribbonButton_Form1_Click(object sender, EventArgs e) { // Load Form1 } private void ribbonButton_Close_Click(object sender, EventArgs e) { // Close All Forms } }
- Code for loading
Form1
into MDI: Hide Copy Codeprivate void ribbonButton_Form1_Click(object sender, EventArgs e) { foreach (Form f in this.MdiChildren) { if (f.GetType() == typeof(Form1)) { f.Activate(); return; } } Form form1 = new Form1(); form1.MdiParent = this; form1.Show(); }
- Code for closing all opened forms in MDI:
Hide Copy Code
private void ribbonButton_Close_Click(object sender, EventArgs e) { while (this.ActiveMdiChild != null) { this.ActiveMdiChild.Close(); } }
- That‘s it. Enjoy.
Part 5: Alternative Ribbon
You may also want to have a look at:
Part 6: How to Make a New Theme, Skin for this Ribbon Programmatically
Default Theme
Example color theme of RibbonProfesionalRendererColorTableBlack.cs (ready made by ribbon author).
Another custom theme:
Note: A Theme Builder is included in the demo app, you can obtain it from the download. You can build a new Theme easily with Theme Builder. In new released Ribbon (13 Jan 2013), Ribbon can write and read a theme file. Read more:
- To make your own color theme, create another class and inherit
RibbonProfesionalRendererColorTable
. - Change all the color objects into your desired colors.
- Example: (the first five colors have been filled for your reference).
In this example, we‘ll name the new theme
Hide Shrink Copy CodeMyCoolThemeSkin
.using System; using System.Collections.Generic; using System.Text; using System.Drawing; namespace System.Windows.Forms { public class MyCoolThemeSkin : RibbonProfesionalRendererColorTable { public MyCoolThemeSkin() { #region Fields OrbDropDownDarkBorder = Color.Yellow; OrbDropDownLightBorder = Color.FromKnownColor(KnownColor.WindowFrame); OrbDropDownBack = Color.FromName("Red"); OrbDropDownNorthA = FromHex("#C2FF3D"); OrbDropDownNorthB = Color.FromArgb(201, 100, 150); OrbDropDownNorthC = OrbDropDownNorthD = OrbDropDownSouthC = OrbDropDownSouthD = OrbDropDownContentbg = OrbDropDownContentbglight = OrbDropDownSeparatorlight = OrbDropDownSeparatordark = Caption1 = Caption2 = Caption3 = Caption4 = Caption5 = Caption6 = Caption7 = QuickAccessBorderDark = QuickAccessBorderLight = QuickAccessUpper = QuickAccessLower = OrbOptionBorder = OrbOptionBackground = OrbOptionShine = Arrow = ArrowLight = ArrowDisabled = Text = RibbonBackground = TabBorder = TabNorth = TabSouth = TabGlow = TabText = TabActiveText = TabContentNorth = TabContentSouth = TabSelectedGlow = PanelDarkBorder = PanelLightBorder = PanelTextBackground = PanelTextBackgroundSelected = PanelText = PanelBackgroundSelected = PanelOverflowBackground = PanelOverflowBackgroundPressed = PanelOverflowBackgroundSelectedNorth = PanelOverflowBackgroundSelectedSouth = ButtonBgOut = ButtonBgCenter = ButtonBorderOut = ButtonBorderIn = ButtonGlossyNorth = ButtonGlossySouth = ButtonDisabledBgOut = ButtonDisabledBgCenter = ButtonDisabledBorderOut = ButtonDisabledBorderIn = ButtonDisabledGlossyNorth = ButtonDisabledGlossySouth = ButtonSelectedBgOut = ButtonSelectedBgCenter = ButtonSelectedBorderOut = ButtonSelectedBorderIn = ButtonSelectedGlossyNorth = ButtonSelectedGlossySouth = ButtonPressedBgOut = ButtonPressedBgCenter = ButtonPressedBorderOut = ButtonPressedBorderIn = ButtonPressedGlossyNorth = ButtonPressedGlossySouth = ButtonCheckedBgOut = ButtonCheckedBgCenter = ButtonCheckedBorderOut = ButtonCheckedBorderIn = ButtonCheckedGlossyNorth = ButtonCheckedGlossySouth = ItemGroupOuterBorder = ItemGroupInnerBorder = ItemGroupSeparatorLight = ItemGroupSeparatorDark = ItemGroupBgNorth = ItemGroupBgSouth = ItemGroupBgGlossy = ButtonListBorder = ButtonListBg = ButtonListBgSelected = DropDownBg = DropDownImageBg = DropDownImageSeparator = DropDownBorder = DropDownGripNorth = DropDownGripSouth = DropDownGripBorder = DropDownGripDark = DropDownGripLight = SeparatorLight = SeparatorDark = SeparatorBg = SeparatorLine = TextBoxUnselectedBg = TextBoxBorder = #endregion } public Color FromHex(string hex) { if (hex.StartsWith("#")) hex = hex.Substring(1); if (hex.Length != 6) throw new Exception("Color not valid"); return Color.FromArgb( int.Parse(hex.Substring(0, 2), system.Globalization.NumberStyles.HexNumber), int.Parse(hex.Substring(2, 2), System.Globalization.NumberStyles.HexNumber), int.Parse(hex.Substring(4, 2), System.Globalization.NumberStyles.HexNumber)); } } }
- Then, in the
Load
event of MainForm.cs, add this line: Hide Copy Codenamespace RibbonDemo { public partial class MainForm : RibbonForm { public MainForm() { InitializeComponent(); ChangeTheme(); } private void ChangeTheme() { Theme.ColorTable = new MyCoolThemeSkin(); ribbon.Refresh(); this.Refresh(); } } }
Part 7: Known Issues
Are resolved.
Article Change Log
- March 20, 2018 - Too many changes... unable to list out.... go to project site for more information
License
This article, along with any associated source code and files, is licensed under
相关推荐
- Android系统编程入门系列之界面Activity交互响应
- 新型横向移动工具原理分析、代码分析、优缺点以及检测方案
- uni-app滚动视图容器(scroll-view)之监听上拉事件
- uniapp h5,app两端复制文本
- Android系统编程入门系列之界面Activity响应丝滑的传统动画
- 【Azure 应用服务】App Service 配置 Application Settings 访问Storage Account得到 could not be resolved: '*.file.core.windows.net'的报错。没有解析成对应中国区 Storage Account地址 *.file.core.chinacloudapi.cn
- 诺基亚短信生成!太好玩了
- iOS 跳转App Store进行评分
- 开发一个即时通讯App
- 关闭苹果IOS app自动更新
电脑软件
本类排行
- 1关闭苹果IOS app自动更新
- 2iOS 跳转App Store进行评分
- 3诺基亚短信生成!太好玩了
- 4Android系统编程入门系列之界面Activity响应丝滑的传统动画
- 5uniapp h5,app两端复制文本
- 6uni-app滚动视图容器(scroll-view)之监听上拉事件
- 7新型横向移动工具原理分析、代码分析、优缺点以及检测方案
- 8Android系统编程入门系列之界面Activity交互响应
- 9开发一个即时通讯App
- 10【Azure 应用服务】App Service 配置 Application Settings 访问Storage Account得到 could not be resolved: '*.file.core.windows.net'的报错。没有解析成对应中国区 Storage Account地址 *.file.core.chinacloudapi.cn