Class RibbonPanel

Control for managing layout of ToolStrips.

Inheritance

System.Object

RibbonPanel

RibbonPanelMergeContainer

Implements

IOffice12Settings

IVisualStyle

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class RibbonPanel : ContainerControl, IOffice12Settings, IVisualStyle

Constructors

RibbonPanel()

Initializes a new instance of the RibbonPanel class.

Declaration

public RibbonPanel()

RibbonPanel(ToolStripTabItem)

Initializes a new instance of the RibbonPanel class.

Declaration

public RibbonPanel(ToolStripTabItem tabItem)

Parameters

Type	Name	Description
ToolStripTabItem	tabItem	Corresponding tab item.

Fields

m_RightToLeft

Gets or set the RightToLeft.

Declaration

public RightToLeft m_RightToLeft

Field Value

Type
System.Windows.Forms.RightToLeft

Properties

AutoSize

Gets/sets the AutoSize property for the control.

Declaration

public override bool AutoSize { get; set; }

Property Value

Type
System.Boolean

BorderStyle

Gets or sets border style.

Declaration

public virtual ToolStripBorderStyle BorderStyle { get; set; }

Property Value

Type
ToolStripBorderStyle

CaptionAlignment

Gets or sets caption alignment.

Declaration

public virtual CaptionAlignment CaptionAlignment { get; set; }

Property Value

Type
CaptionAlignment

CaptionFont

Gets or sets caption font.

Declaration

public virtual Font CaptionFont { get; set; }

Property Value

Type
System.Drawing.Font

CaptionMinHeight

Gets or sets caption minimal height.

Declaration

public virtual int CaptionMinHeight { get; set; }

Property Value

Type
System.Int32

CaptionStyle

Gets or sets caption style.

Declaration

public virtual CaptionStyle CaptionStyle { get; set; }

Property Value

Type
CaptionStyle

CaptionTextStyle

Gets or sets caption text style.

Declaration

public virtual CaptionTextStyle CaptionTextStyle { get; set; }

Property Value

Type
CaptionTextStyle

DefaultBorderStyle

Gets default border style of toolstrips

Declaration

protected virtual ToolStripBorderStyle DefaultBorderStyle { get; }

Property Value

Type
ToolStripBorderStyle

DefaultCaptionStyle

Gets default caption style.

Declaration

protected virtual CaptionStyle DefaultCaptionStyle { get; }

Property Value

Type
CaptionStyle

DefaultLauncherStyle

Gets default launcher style.

Declaration

protected virtual LauncherStyle DefaultLauncherStyle { get; }

Property Value

Type
LauncherStyle

DefaultOfficeColorScheme

Gets default color scheme

Declaration

protected virtual ToolStripEx.ColorScheme DefaultOfficeColorScheme { get; }

Property Value

Type
ToolStripEx.ColorScheme

DefaultPadding

Declaration

protected override Padding DefaultPadding { get; }

Property Value

Type
System.Windows.Forms.Padding

LauncherStyle

Gets or sets launcher style.

Declaration

public LauncherStyle LauncherStyle { get; set; }

Property Value

Type
LauncherStyle

LayoutEngine

Gets the LayoutEngine (Overrides.)

Declaration

public override LayoutEngine LayoutEngine { get; }

Property Value

Type
System.Windows.Forms.Layout.LayoutEngine

LeftScrollBounds

Gets bounds of left scroll button.

Declaration

protected Rectangle LeftScrollBounds { get; }

Property Value

Type
System.Drawing.Rectangle

Location

Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.

Declaration

public Point Location { get; set; }

Property Value

Type
System.Drawing.Point

Margin

Gets or sets the space between controls.

Declaration

public Padding Margin { get; set; }

Property Value

Type
System.Windows.Forms.Padding

Office2013ColorScheme

Gets the Office2013ColorScheme

Declaration

public Office2013ColorScheme Office2013ColorScheme { get; }

Property Value

Type
Office2013ColorScheme

Office2016ColorScheme

Gets the Office2013ColorScheme

Declaration

public Office2016ColorScheme Office2016ColorScheme { get; }

Property Value

Type
Office2016ColorScheme

OfficeColorScheme

Gets or sets color scheme.

Declaration

public virtual ToolStripEx.ColorScheme OfficeColorScheme { get; set; }

Property Value

Type
ToolStripEx.ColorScheme

PushedButton

Gets or sets area in which user pushed mouse button.

Declaration

protected RibbonPanel.ScrollButtonsArea PushedButton { get; set; }

Property Value

Type
RibbonPanel.ScrollButtonsArea

Renderer

Declaration

protected virtual RibbonPanelRenderer Renderer { get; }

Property Value

Type
RibbonPanelRenderer

RibbonStyle

Gets the RibbonStyle

Declaration

public RibbonStyle RibbonStyle { get; }

Property Value

Type
RibbonStyle

RightScrollBounds

Gets bounds of right scroll button.

Declaration

protected Rectangle RightScrollBounds { get; }

Property Value

Type
System.Drawing.Rectangle

RightToLeft

Gets or sets the RightToLeft of the Control.

Declaration

public override RightToLeft RightToLeft { get; set; }

Property Value

Type
System.Windows.Forms.RightToLeft

ScrollPosition

Gets or sets position of rightmost tab Item and transfer the value to ScrollPosition property.

Declaration

public int ScrollPosition { get; set; }

Property Value

Type
System.Int32

ShowCaption

Gets or sets a value indicating whether caption should be shown.

Declaration

public virtual bool ShowCaption { get; set; }

Property Value

Type	Description
System.Boolean	true, if Caption should be shown, false otherwise

ShowLauncher

Gets or sets a value indicating whether launcher should be shown.

Declaration

public virtual bool ShowLauncher { get; set; }

Property Value

Type	Description
System.Boolean	true, if Launcher should be shown, false otherwise

Size

Gets or sets the height and width of the control.

Declaration

public Size Size { get; set; }

Property Value

Type
System.Drawing.Size

TabItem

Gets or sets corresponding tab item.

Declaration

public ToolStripTabItem TabItem { get; set; }

Property Value

Type
ToolStripTabItem

Visible

Gets or sets a value indicating whether the control and all its parent controls are displayed.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Methods

AddToolStrip(ToolStripEx)

Adds new tool strip to the control.

Declaration

public void AddToolStrip(ToolStripEx toolStrip)

Parameters

Type	Name	Description
ToolStripEx	toolStrip	ToolStrip to be added.

CreateAccessibilityInstance()

Provided accessibility to the control.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Type
System.Windows.Forms.AccessibleObject

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

GetPreferredSize(Size)

Retrieves the size of a rectangular area into which a control can be fit.

Declaration

public override Size GetPreferredSize(Size proposedSize)

Parameters

Type	Name	Description
System.Drawing.Size	proposedSize	The custom-sized area for a control.

Returns

Type	Description
System.Drawing.Size	A System.Drawing.Size ordered pair, representing the width and height of a rectangle.

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

OnHandleCreated(EventArgs)

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnMouseCaptureChanged(EventArgs)

Handles release of mouse capture.

Declaration

protected override void OnMouseCaptureChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e

OnMouseLeave(EventArgs)

Reaction on deselection scroll buttons also.

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Reaction on selection scroll buttons also.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	EventArgs that contains the event data.

OnMouseUp(MouseEventArgs)

Resets timers and releases mouse capture.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	EventArgs that contains the event data.

OnNcHitTest(ref Message)

Declaration

protected virtual bool OnNcHitTest(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m

Returns

Type
System.Boolean

OnNcPaint(ref Message)

Declaration

protected virtual bool OnNcPaint(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m

Returns

Type
System.Boolean

OnPaint(PaintEventArgs)

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e

OnPaintBackground(PaintEventArgs)

Declaration

protected override void OnPaintBackground(PaintEventArgs pe)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	pe

OnParentChanged(EventArgs)

Updates toolstrips appearance.

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs that contains the event data.

OnSizeChanged(EventArgs)

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnTabCheckStateChanged(Object, EventArgs)

Occurs when Tab check state changed.

Declaration

public void OnTabCheckStateChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The source of the control.
System.EventArgs	e	Te EventArgs contains the event data.

OnToolStripAdded(ToolStripEx)

Declaration

protected virtual void OnToolStripAdded(ToolStripEx ts)

Parameters

Type	Name	Description
ToolStripEx	ts

OnToolStripItemClicked(Object, ToolStripItemClickedEventArgs)

Occurs when ToolStripItem clicked.

Declaration

public void OnToolStripItemClicked(object sender, ToolStripItemClickedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The source of the control.
System.Windows.Forms.ToolStripItemClickedEventArgs	e	Thee ToolStripItemClickedEventArgs contains the event data.

OnToolStripRemoved(ToolStripEx)

Declaration

protected virtual void OnToolStripRemoved(ToolStripEx ts)

Parameters

Type	Name	Description
ToolStripEx	ts

OnVisibleChanged(EventArgs)

Declaration

protected override void OnVisibleChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

ResetBorderStyle()

Resets the BorderStyle property to it's default value.

Declaration

public void ResetBorderStyle()

ResetCaptionAlignment()

Resets the CaptionAlignment property to it's default value.

Declaration

public void ResetCaptionAlignment()

ResetCaptionFont()

Resets the CaptionFont property to it's default value.

Declaration

public void ResetCaptionFont()

ResetCaptionMinHeight()

Resets the CaptionMinHeight property to it's default value.

Declaration

public void ResetCaptionMinHeight()

ResetCaptionStyle()

Resets the CaptionStyle property to it's default value.

Declaration

public void ResetCaptionStyle()

ResetCaptionTextStyle()

Resets the CaptionTextStyle property to it's default value.

Declaration

public void ResetCaptionTextStyle()

ResetLauncherStyle()

Resets the LauncherStyle property to it's default value.

Declaration

public void ResetLauncherStyle()

ResetMargin()

Resets the Margin property to it's default value.

Declaration

public void ResetMargin()

ResetOfficeColorScheme()

Resets the OfficeColorScheme property to it's default value.

Declaration

public void ResetOfficeColorScheme()

ResetShowCaption()

Resets the ShowCaption property to it's default value.

Declaration

public void ResetShowCaption()

ResetShowLauncher()

Resets the ShowLauncher property to it's default value.

Declaration

public void ResetShowLauncher()

ShouldSerializeBorderStyle()

Indicates whether the current value of the BorderStyle property is to be serialized.

Declaration

public bool ShouldSerializeBorderStyle()

Returns

Type
System.Boolean

ShouldSerializeCaptionAlignment()

Indicates whether the current value of the CaptionAlignment property is to be serialized.

Declaration

public bool ShouldSerializeCaptionAlignment()

Returns

Type
System.Boolean

ShouldSerializeCaptionFont()

Indicates whether the current value of the CaptionFont property is to be serialized.

Declaration

public bool ShouldSerializeCaptionFont()

Returns

Type
System.Boolean

ShouldSerializeCaptionMinHeight()

Indicates whether the current value of the CaptionMinHeight property is to be serialized.

Declaration

public bool ShouldSerializeCaptionMinHeight()

Returns

Type
System.Boolean

ShouldSerializeCaptionStyle()

Indicates whether the current value of the CaptionStyle property is to be serialized.

Declaration

public bool ShouldSerializeCaptionStyle()

Returns

Type
System.Boolean

ShouldSerializeCaptionTextStyle()

Indicates whether the current value of the CaptionTextStyle property is to be serialized.

Declaration

public bool ShouldSerializeCaptionTextStyle()

Returns

Type
System.Boolean

ShouldSerializeLauncherStyle()

Indicates whether the current value of the LauncherStyle property is to be serialized.

Declaration

public bool ShouldSerializeLauncherStyle()

Returns

Type
System.Boolean

ShouldSerializeMargin()

Indicates whether the current value of the Margin property is to be serialized.

Declaration

public bool ShouldSerializeMargin()

Returns

Type
System.Boolean

ShouldSerializeOfficeColorScheme()

Indicates whether the current value of the OfficeColorScheme property is to be serialized.

Declaration

public bool ShouldSerializeOfficeColorScheme()

Returns

Type
System.Boolean

ShouldSerializeShowCaption()

Indicates whether the current value of the ShowCaption property is to be serialized.

Declaration

public bool ShouldSerializeShowCaption()

Returns

Type
System.Boolean

ShouldSerializeShowLauncher()

Indicates whether the current value of the ShowLauncher property is to be serialized.

Declaration

public bool ShouldSerializeShowLauncher()

Returns

Type
System.Boolean

UpdateCaptions()

Redraws toolstrips.

Declaration

public void UpdateCaptions()

UpdateRenderers()

Redraws toolstrips using new renderers.

Declaration

public void UpdateRenderers()

UpdateRenderers(Boolean)

Redraws toolstrips using new renderers.

Declaration

public void UpdateRenderers(bool office12Mode)

Parameters

Type	Name	Description
System.Boolean	office12Mode

WndProc(ref Message)

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m

Events

ToolStripAdded

Occurs when new toolstrip is added to the collection.

Declaration

public event ToolStripEventHandler ToolStripAdded

Event Type

Type
ToolStripEventHandler

ToolStripItemClicked

Occurs when toolstrip item is clicked.

Declaration

public event ToolStripItemClickedEventHandler ToolStripItemClicked

Event Type

Type
System.Windows.Forms.ToolStripItemClickedEventHandler

ToolStripRemoved

Occurs when toolstrip is removed from the collection.

Declaration

public event ToolStripEventHandler ToolStripRemoved

Event Type

Type
ToolStripEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type
System.String

Implements

IOffice12Settings

IVisualStyle