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
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class RibbonForm : Form, IExtenderProvider, IMessageFilter

Constructors

RibbonForm()

Constructor of the RibbonForm.

Declaration
public RibbonForm()

Properties

Appearance

Specifies the appearance of the form.

Declaration
public RibbonForm.AppearanceType Appearance { get; set; }
Property Value
Type Description
RibbonForm.AppearanceType

AutoScroll

AutoScroll is not supported

Declaration
public override bool AutoScroll { get; set; }
Property Value
Type Description
System.Boolean

Borders

Office2007 borders.

Declaration
public virtual Padding Borders { get; set; }
Property Value
Type Description
System.Windows.Forms.Padding

ColorScheme

Specifies the office color scheme of the Ribbon Form.

Declaration
public RibbonForm.ColorSchemeType ColorScheme { get; set; }
Property Value
Type Description
RibbonForm.ColorSchemeType

CreateParams

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type Description
System.Windows.Forms.CreateParams

DisplayRectangle

Gets the bounds of the display rectangle.

Declaration
public override Rectangle DisplayRectangle { get; }
Property Value
Type Description
System.Drawing.Rectangle

EnableAeroTheme

Gets/ Sets whether the AeroTheme has to be Enabled or Disabled.

Declaration
public bool EnableAeroTheme { get; set; }
Property Value
Type Description
System.Boolean

EnableRibbonBorder

Gets/Sets the visibility of the RibbonForm Border.

Declaration
public bool EnableRibbonBorder { get; set; }
Property Value
Type Description
System.Boolean

Font

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

HeaderItem

Gets or sets the HeaderItem to be displayed in the TitleBar of the RibbonForm.

Declaration
public Control HeaderItem { get; set; }
Property Value
Type Description
System.Windows.Forms.Control
Examples

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;
}
}

HelpButtonImage

Gets or sets HelpButtonImage

Declaration
public Image HelpButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

HelpButtonToolTip

Gets or sets HelpButtonToolTip

Declaration
public string HelpButtonToolTip { get; set; }
Property Value
Type Description
System.String

MinimumSize

The minimum size the form can be resized to.

Declaration
public override Size MinimumSize { get; set; }
Property Value
Type Description
System.Drawing.Size

ShowApplicationIcon

Gets or sets TitleBarImage

Declaration
public bool ShowApplicationIcon { get; set; }
Property Value
Type Description
System.Boolean

TopLeftRadius

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

CanExtend(Object)

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

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetShortcut(Component)

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

IsThemeActive()

Indicates whether the theme is active or not.

Declaration
public static bool IsThemeActive()
Returns
Type Description
System.Boolean

OnActivated(EventArgs)

Declaration
protected override void OnActivated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnAppearanceChanged()

Declaration
protected virtual void OnAppearanceChanged()

OnControlAdded(ControlEventArgs)

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnControlRemoved(ControlEventArgs)

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnDeactivate(EventArgs)

Declaration
protected override void OnDeactivate(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnHandleCreated(EventArgs)

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnHandleDestroyed(EventArgs)

Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLayout(LayoutEventArgs)

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs levent

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

OnRightToLeftChanged(EventArgs)

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnRightToLeftLayoutChanged(EventArgs)

Declaration
protected override void OnRightToLeftLayoutChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

ProcessDialogKey(Keys)

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Keys keyData
Returns
Type Description
System.Boolean

ResetEnableAeroTheme()

To reset EnableAeroTheme

Declaration
public void ResetEnableAeroTheme()

ResetEnableRibbonBorder()

To reset EnableRibbonBorder

Declaration
public void ResetEnableRibbonBorder()

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

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

SetClientSizeCore(Int32, Int32)

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

SetShortcut(Component, Keys)

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.

ShouldSerializeEnableAeroTheme()

To Specify EnableAeroTheme to be serialized or not

Declaration
public bool ShouldSerializeEnableAeroTheme()
Returns
Type Description
System.Boolean

ShouldSerializeEnableRibbonBorder()

To Specify EnableRibbonBorder to be serialized or not

Declaration
public bool ShouldSerializeEnableRibbonBorder()
Returns
Type Description
System.Boolean

UpdateFrame()

Update the frame.

Declaration
public void UpdateFrame()

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

Events

GetMinSize

Occurs when get the Min size.

Declaration
public event GetMinSizeHandler GetMinSize
Event Type
Type Description
GetMinSizeHandler

Implements

System.ComponentModel.IExtenderProvider
System.Windows.Forms.IMessageFilter