Class RecordNavigationControl

A RecordNavigationControl is a splitter frame with a RecordNavigationBar on the bottom left scrollbar.

Inheritance
System.Object
SplitterControl
RecordNavigationControl
GridRecordNavigationControl
Inherited Members
Namespace: Syncfusion.Windows.Forms
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class RecordNavigationControl : SplitterControl, IControlToolTipProvider, IInternalSplitterParent, IScrollBarFrame, IDynamicSplitterFrame, IThemedControl, IContainerControl, IThemeProvider, IVisualStyle

Constructors

RecordNavigationControl()

Initializes a new RecordNavigationControl.

Declaration
public RecordNavigationControl()

Properties

AllowAddNew

Indicates whether adding new records is enabled.

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

CurrentRecord

Gets / sets the current record position.

Declaration
public int CurrentRecord { get; set; }
Property Value
Type
System.Int32

DisabledArrowColor

Gets or sets the color of arrows in disabled buttons.

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

EnabledArrowColor

Gets or sets the color of arrows in enabled buttons.

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

Label

Gets or sets the label to be displayed before the record field textbox.

Declaration
public virtual string Label { get; set; }
Property Value
Type
System.String

MaxLabel

Gets or sets an optional maximum label (e.g. "of 1000").

Declaration
public virtual string MaxLabel { get; set; }
Property Value
Type
System.String

MaxRecord

Gets or sets the maximum record position.

Declaration
public virtual int MaxRecord { get; set; }
Property Value
Type
System.Int32

MinRecord

Gets or sets the minimum record position.

Declaration
public virtual int MinRecord { get; set; }
Property Value
Type
System.Int32

MinRepeatClickDelay

Gets / sets the shortest interval for firing scroll event.

Declaration
public virtual int MinRepeatClickDelay { get; set; }
Property Value
Type
System.Int32

NavigationBar

Returns the RecordNavigationScrollBar with record information and scroll buttons.

Declaration
public RecordNavigationScrollBar NavigationBar { get; }
Property Value
Type
RecordNavigationScrollBar

NavigationBarBackColor

Gets or sets the backcolor of the navigation bar.

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

NavigationBarWidth

Gets or sets the width of the navigation bar.

Declaration
public virtual int NavigationBarWidth { get; set; }
Property Value
Type
System.Int32

NavigationButtons

Gets or sets the arrow button that should be shown in an arrow bar.

Declaration
public virtual DisplayArrowButtons NavigationButtons { get; set; }
Property Value
Type
DisplayArrowButtons

RepeatClickDelay

Gets / sets the number of Milliseconds to wait before repeatedly firing scroll event.

Declaration
public virtual int RepeatClickDelay { get; set; }
Property Value
Type
System.Int32

ThemesEnabled

Declaration
public override bool ThemesEnabled { get; set; }
Property Value
Type
System.Boolean
Overrides

ThemeStyle

Gets or sets the RecordNavigateVisualStyle value used to customize the appearance of the RecordNavigationControl.

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

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

Methods

CreateScrollBarContainer(ScrollBars, Int32)

Declaration
protected override Control CreateScrollBarContainer(ScrollBars sbType, int index)
Parameters
Type Name Description
System.Windows.Forms.ScrollBars sbType
System.Int32 index
Returns
Type
System.Windows.Forms.Control
Overrides

Dispose(Boolean)

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

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.

OnButtonLookChanged(EventArgs)

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

OnControlGotFocus()

Declaration
protected override void OnControlGotFocus()
Overrides

OnCurrentRecordChanged(CurrentRecordEventArgs)

Raises the CurrentRecordChanged event.

Declaration
protected virtual void OnCurrentRecordChanged(CurrentRecordEventArgs e)
Parameters
Type Name Description
CurrentRecordEventArgs e

A CurrentRecordEventArgs that contains the event data.

OnCurrentRecordChanging(CurrentRecordEventArgs)

Raises the CurrentRecordChanging event.

Declaration
protected virtual void OnCurrentRecordChanging(CurrentRecordEventArgs e)
Parameters
Type Name Description
CurrentRecordEventArgs e

A CurrentRecordEventArgs that contains the event data.

OnFontChanged(EventArgs)

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

OnMoveSplitter(Object, Int32, Int32)

Occurs when the user drags the splitter bar.

Declaration
public override void OnMoveSplitter(object sender, int x, int y)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Int32 x

The current horizontal position in pixels.
System.Int32 y

The current vertical position in pixels.
Overrides

OnShowToolTipsChanged(EventArgs)

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

OnValidatingLostFocus()

Declaration
protected override void OnValidatingLostFocus()
Overrides

Refresh()

Forces the control to invalidate its client area and immediately redraw itself and any child controls.

Declaration
public override void Refresh()
Overrides

ResetAllowAddNew()

Resets AllowAddNew to default.

Declaration
public void ResetAllowAddNew()

ResetDisabledArrowColor()

Resets the DisabledArrowColor property to its default value.

Declaration
public void ResetDisabledArrowColor()

ResetEnabledArrowColor()

Resets the EnabledArrowColor property to its default value.

Declaration
public void ResetEnabledArrowColor()

ResetMaxRecord()

Resets MaxRecord to default.

Declaration
public void ResetMaxRecord()

ResetMinRecord()

Resets MinRecord to default.

Declaration
public void ResetMinRecord()

ResetNavigationBarBackColor()

Resets the NavigationBarBackColor property to its default value.

Declaration
public void ResetNavigationBarBackColor()

Events

ArrowButtonClicked

Occurs when the user clicks an arrow button.

Declaration
public event ArrowButtonEventHandler ArrowButtonClicked
Event Type
Type
ArrowButtonEventHandler

CurrentRecordChanged

Occurs when the current record is changed.

Declaration
public event CurrentRecordChangedEventHandler CurrentRecordChanged
Event Type
Type
CurrentRecordChangedEventHandler

CurrentRecordChanging

Occurs when the current record is changing.

Declaration
public event CurrentRecordChangedEventHandler CurrentRecordChanging
Event Type
Type
CurrentRecordChangedEventHandler

Implements

System.Windows.Forms.IContainerControl