Class ArrowButtonBar
This control is used by TabBarSplitterControl and RecordNavigationControl to display arrow buttons.
Inherited Members
Namespace: Syncfusion.Windows.Forms
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class ArrowButtonBar : ButtonBar, IControlToolTipProvider, ICancelModeProvider, ISupportUpdating, IInternalArrowButtonParent, IInternalButtonParent, IThemedControl
Constructors
ArrowButtonBar()
Initializes a new ArrowButtonBar.
Declaration
public ArrowButtonBar()
Properties
AllArrowButtons
Returns an array with buttons to show when DisplayArrowButtons is All.
Declaration
protected virtual InternalButton[] AllArrowButtons { get; }
Property Value
| Type |
|---|
| Syncfusion.Windows.Forms.InternalButton[] |
DisabledColor
Gets or sets the color of arrows in disabled buttons.
Declaration
public Color DisabledColor { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Color |
DisplayArrowButtons
Gets or sets the arrow buttons to be shown in an arrow bar.
Declaration
public virtual DisplayArrowButtons DisplayArrowButtons { get; set; }
Property Value
| Type |
|---|
| DisplayArrowButtons |
EnableButtonFlags
Gets or sets the buttons to show enabled. Other buttons are disabled.
Declaration
public ArrowType EnableButtonFlags { get; set; }
Property Value
| Type |
|---|
| ArrowType |
EnabledColor
Gets or sets the color of arrows in enabled buttons.
Declaration
public Color EnabledColor { get; set; }
Property Value
| Type |
|---|
| System.Drawing.Color |
MinRepeatClickDelay
Gets or sets the Shortest interval for firing scroll event.
Declaration
public int MinRepeatClickDelay { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
NoArrowButtons
Returns an array with buttons to show when DisplayArrowButtons is None.
Declaration
protected virtual InternalButton[] NoArrowButtons { get; }
Property Value
| Type |
|---|
| Syncfusion.Windows.Forms.InternalButton[] |
RepeatClickDelay
Gets or sets the number of Milliseconds to wait before firing scroll event.
Declaration
public int RepeatClickDelay { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
SingleArrowButtons
Returns an array with buttons to show when DisplayArrowButtons is Single.
Declaration
protected virtual InternalButton[] SingleArrowButtons { get; }
Property Value
| Type |
|---|
| Syncfusion.Windows.Forms.InternalButton[] |
ThemesEnabled
Indicates whether themes are enabled for this control.
Declaration
public virtual bool ThemesEnabled { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Methods
InitBars()
Initializes the the arrow bar.
Declaration
public virtual void InitBars()
OnArrowButtonClicked(ArrowButtonEventArgs)
Raises the ArrowButtonClicked event.
Declaration
protected virtual void OnArrowButtonClicked(ArrowButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| ArrowButtonEventArgs | e | An ArrowButtonEventArgs that contains the event data. |
OnCreateButtonBarChild()
Declaration
protected override InternalButtonBar OnCreateButtonBarChild()
Returns
| Type |
|---|
| Syncfusion.Windows.Forms.InternalButtonBar |
Overrides
OnThemeChanged(EventArgs)
Raises the ThemeChanged event.
Declaration
protected virtual void OnThemeChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An EventArgs that contains the event data. |
Remarks
The OnThemeChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Note to Inheritors: When overriding OnThemeChanged in a derived class, be sure to call the base class's OnThemeChanged method so that registered delegates receive the event.
ResetDisabledColor()
Resets DisabledColor to default.
Declaration
public void ResetDisabledColor()
ResetEnabledColor()
Resets EnabledColor to default.
Declaration
public void ResetEnabledColor()
WndProc(ref Message)
Declaration
protected override void WndProc(ref Message m)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Message | m |
Overrides
Events
ArrowButtonChanged
Occurs when Arrow button is changed.
Declaration
public event EventHandler ArrowButtonChanged
Event Type
| Type |
|---|
| System.EventHandler |
ArrowButtonClicked
Occurs when the user clicks on an arrow button.
Declaration
public event ArrowButtonEventHandler ArrowButtonClicked
Event Type
| Type |
|---|
| ArrowButtonEventHandler |
ThemeChanged
Fired when the ThemesEnabled property changes.
Declaration
public event EventHandler ThemeChanged
Event Type
| Type |
|---|
| System.EventHandler |