Class RibbonForm
The Ribbon form combined with RibbonControlAdv which makes up an application's user interface.
Inheritance
System.Object
RibbonForm
Implements
System.ComponentModel.IExtenderProvider
System.Windows.Forms.IMessageFilter
Assembly: Syncfusion.Tools.Windows.dll
public class RibbonForm : Form, IExtenderProvider, IMessageFilter
Constructors
Constructor of the RibbonForm.
Declaration
Properties
Specifies the appearance of the form.
Declaration
public RibbonForm.AppearanceType Appearance { get; set; }
Property Value
AutoScroll is not supported
Declaration
public override bool AutoScroll { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public virtual Padding Borders { get; set; }
Property Value
Type |
Description |
System.Windows.Forms.Padding |
|
Specifies the office color scheme of the Ribbon Form.
Declaration
public RibbonForm.ColorSchemeType ColorScheme { get; set; }
Property Value
Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type |
Description |
System.Windows.Forms.CreateParams |
|
Gets the bounds of the display rectangle.
Declaration
public override Rectangle DisplayRectangle { get; }
Property Value
Type |
Description |
System.Drawing.Rectangle |
|
Gets/ Sets whether the AeroTheme has to be Enabled or Disabled.
Declaration
public bool EnableAeroTheme { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Gets/Sets the visibility of the RibbonForm Border.
Declaration
public bool EnableRibbonBorder { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Gets or sets the System.Drawing.Font value for the RibbonForm .
Declaration
public override Font Font { get; set; }
Property Value
Type |
Description |
System.Drawing.Font |
|
Declaration
public Control HeaderItem { get; set; }
Property Value
Type |
Description |
System.Windows.Forms.Control |
|
This example demonstrates how to set HeaderItem in the RibbonForm.
public partial class Form1 : RibbonForm
{
public Form1()
{
InitializeComponent();
Button button = new Button();
button.Text = "Sign in";
this.HeaderItem = button;
}
}
Gets or sets HelpButtonImage
Declaration
public Image HelpButtonImage { get; set; }
Property Value
Type |
Description |
System.Drawing.Image |
|
Gets or sets HelpButtonToolTip
Declaration
public string HelpButtonToolTip { get; set; }
Property Value
Type |
Description |
System.String |
|
The minimum size the form can be resized to.
Declaration
public override Size MinimumSize { get; set; }
Property Value
Type |
Description |
System.Drawing.Size |
|
Gets or sets TitleBarImage
Declaration
public bool ShowApplicationIcon { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Specifies the radius for the curved top left corner of the Ribbon Form.
Declaration
public int TopLeftRadius { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Methods
Gets a value indicating whether a control can be extended.
Declaration
public bool CanExtend(object extendee)
Parameters
Type |
Name |
Description |
System.Object |
extendee |
The object which needs to extend
|
Returns
Type |
Description |
System.Boolean |
|
Declaration
protected override void Dispose(bool disposing)
Parameters
Type |
Name |
Description |
System.Boolean |
disposing |
|
Gets the RibbonForm shortcut.
Declaration
public Keys GetShortcut(Component component)
Parameters
Type |
Name |
Description |
System.ComponentModel.Component |
component |
The component which specified as shortcut.
|
Returns
Type |
Description |
System.Windows.Forms.Keys |
|
Indicates whether the theme is active or not.
Declaration
public static bool IsThemeActive()
Returns
Type |
Description |
System.Boolean |
|
Declaration
protected override void OnActivated(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected virtual void OnAppearanceChanged()
Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type |
Name |
Description |
System.Windows.Forms.ControlEventArgs |
e |
|
Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type |
Name |
Description |
System.Windows.Forms.ControlEventArgs |
e |
|
Declaration
protected override void OnDeactivate(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type |
Name |
Description |
System.Windows.Forms.LayoutEventArgs |
levent |
|
Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type |
Name |
Description |
System.Windows.Forms.PaintEventArgs |
e |
|
Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnRightToLeftLayoutChanged(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type |
Name |
Description |
System.EventArgs |
e |
|
Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
Type |
Name |
Description |
System.Windows.Forms.Keys |
keyData |
|
Returns
Type |
Description |
System.Boolean |
|
Declaration
public void ResetEnableAeroTheme()
To reset EnableRibbonBorder
Declaration
public void ResetEnableRibbonBorder()
Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type |
Name |
Description |
System.Int32 |
x |
|
System.Int32 |
y |
|
System.Int32 |
width |
|
System.Int32 |
height |
|
System.Windows.Forms.BoundsSpecified |
specified |
|
In Office2007 mode form's Size and ClientSize are equal.
Declaration
protected override void SetClientSizeCore(int x, int y)
Parameters
Type |
Name |
Description |
System.Int32 |
x |
|
System.Int32 |
y |
|
Sets the RibbonForm shortcut.
Declaration
public void SetShortcut(Component component, Keys value)
Parameters
Type |
Name |
Description |
System.ComponentModel.Component |
component |
The component which set as shortcut
|
System.Windows.Forms.Keys |
value |
The shortcut key value.
|
To Specify EnableAeroTheme to be serialized or not
Declaration
public bool ShouldSerializeEnableAeroTheme()
Returns
Type |
Description |
System.Boolean |
|
To Specify EnableRibbonBorder to be serialized or not
Declaration
public bool ShouldSerializeEnableRibbonBorder()
Returns
Type |
Description |
System.Boolean |
|
Declaration
public void UpdateFrame()
Declaration
protected override void WndProc(ref Message m)
Parameters
Type |
Name |
Description |
System.Windows.Forms.Message |
m |
|
Events
Occurs when get the Min size.
Declaration
public event GetMinSizeHandler GetMinSize
Event Type
Implements
System.ComponentModel.IExtenderProvider
System.Windows.Forms.IMessageFilter