Class SuperAccelerator

Inheritance
System.Object
BaseComponent
SuperAccelerator
Implements
System.IDisposable
System.Windows.Forms.IMessageFilter
System.ComponentModel.IExtenderProvider
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class SuperAccelerator : BaseComponent, IThemeProvider, IVisualStyle, IDisposable, IMessageFilter, IExtenderProvider

Constructors

SuperAccelerator()

Declaration
public SuperAccelerator()

SuperAccelerator(Control)

Declaration
public SuperAccelerator(Control owner)
Parameters
Type Name Description
System.Windows.Forms.Control owner

Properties

Active

Gets or sets whether the accelerator should be active or not.

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

true if active; otherwise, false.

Alignment

Gets/Sets the SuperAccelerator alignment

Declaration
public AcceleratorAlignment Alignment { get; set; }
Property Value
Type
AcceleratorAlignment

Appearance

Gets/Sets the SuperAccelerator appearance

Declaration
public Appearance Appearance { get; set; }
Property Value
Type
Appearance

BackColor

Gets ot sets the backcolor of the accelerator key.

Declaration
public Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

DisplayShortcuts

Gets or sets whether an underline should be drawn under the accelerator text.

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

EnableSuperAcceleratorOnF10

Gets/Sets whether to show/hide the SuperAccelerator when F10 key is pressed.

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

Font

Gets or sets the font for the accelerator key.

Declaration
public Font Font { get; set; }
Property Value
Type
System.Drawing.Font

ForeColor

Gets or sets the forecolor for the accelerator key text.

Declaration
public Color ForeColor { get; set; }
Property Value
Type
System.Drawing.Color

ThemeStyle

Gets or sets the SuperAcceleratorVisualStyle value used to customize the appearance of the SuperAccelerator.

Declaration
public SuperAcceleratorVisualStyle ThemeStyle { get; set; }
Property Value
Type
SuperAcceleratorVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

Methods

Dispose(Boolean)

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

GetAccelerator(Control)

Declaration
public string GetAccelerator(Control component)
Parameters
Type Name Description
System.Windows.Forms.Control component
Returns
Type
System.String

GetAccelerator(ToolStripItem)

Gets accelerator associated with a component

Declaration
public string GetAccelerator(ToolStripItem component)
Parameters
Type Name Description
System.Windows.Forms.ToolStripItem component
Returns
Type
System.String

GetCollapsedDropDownAccelerator(ToolStripEx)

Gets the accelerator to a CollapsedDropDownButton instance on ToolStripEx.

Declaration
public string GetCollapsedDropDownAccelerator(ToolStripEx toolStrip)
Parameters
Type Name Description
ToolStripEx toolStrip

The ToolStripEx with CollapsedDropDownButton to which the accelerator should be get.
Returns
Type
System.String

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type
System.String
Overrides

GetMenuButtonAccelerator(RibbonControlAdv)

Gets the accelerator of a MenuButton instance on RibbonControlAdv.

Declaration
public string GetMenuButtonAccelerator(RibbonControlAdv ribbon)
Parameters
Type Name Description
RibbonControlAdv ribbon

The RibbonConrolAdv with MenuButton which tooltip should be get.
Returns
Type Description
System.String

String concatenating accelerator text.

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

ResetAppearance()

To Reset the Appearance

Declaration
public void ResetAppearance()

ResetEnableSuperAcceleratorOnF10()

To reset EnableSuperAcceleratorOnF10

Declaration
public void ResetEnableSuperAcceleratorOnF10()

SetAccelerator(Control, String)

Sets accelerator associated with a component

Declaration
public void SetAccelerator(Control component, string value)
Parameters
Type Name Description
System.Windows.Forms.Control component
System.String value

SetAccelerator(ToolStripItem, String)

Sets accelerator associated with a component

Declaration
public void SetAccelerator(ToolStripItem component, string value)
Parameters
Type Name Description
System.Windows.Forms.ToolStripItem component
System.String value

SetCollapsedDropDownAccelerator(ToolStripEx, String)

Assigns the accelerator to a CollapsedDropDownButton instance on ToolStripEx.

Declaration
public void SetCollapsedDropDownAccelerator(ToolStripEx toolStrip, string value)
Parameters
Type Name Description
ToolStripEx toolStrip

The ToolStripEx with CollapsedDropDownButton to which the accelerator should be assigned.
System.String value

The accelerator string.

SetMenuButtonAccelerator(RibbonControlAdv, String)

Assigns the accelerator to a MenuButton instance on RibbonControlAdv.

Declaration
public void SetMenuButtonAccelerator(RibbonControlAdv ribbon, string value)
Parameters
Type Name Description
RibbonControlAdv ribbon

The RibbonConrolAdv with MenuButton to which the tooltip should be assigned.
System.String value

The accelerator string.

ShouldSerializeAppearance()

Indicate whether to serialize Appearance

Declaration
public bool ShouldSerializeAppearance()
Returns
Type
System.Boolean

ShouldSerializeEnableSuperAcceleratorOnF10()

To Specify EnableSuperAcceleratorOnF10 to be serialized or not

Declaration
public bool ShouldSerializeEnableSuperAcceleratorOnF10()
Returns
Type
System.Boolean

Implements

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