WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RecordNavigationControl - WindowsForms API Reference | Syncfusion RecordNavigationBar on the bottom left scrollbar. ">

    Show / Hide Table of Contents

    Class RecordNavigationControl

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

    Inheritance
    System.Object
    SplitterControl
    RecordNavigationControl
    GridRecordNavigationControl
    Implements
    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    IThemeProvider
    IVisualStyle
    Inherited Members
    SplitterControl.ApplyScaleToControl(Single)
    SplitterControl.OnSizeChanged(EventArgs)
    SplitterControl.SplitRow(Int32)
    SplitterControl.SplitColumn(Int32)
    SplitterControl.DeleteRow(Int32)
    SplitterControl.DeleteColumn(Int32)
    SplitterControl.GetPane(Int32, Int32)
    SplitterControl.DisposePane(Int32, Int32)
    SplitterControl.OnCreateNewControl(Int32, Int32, Control)
    SplitterControl.OnControlAdded(ControlEventArgs)
    SplitterControl.OnPaneCreated(SplitterPaneEventArgs)
    SplitterControl.OnPaneClosing(SplitterPaneEventArgs)
    SplitterControl.FindPane(Control, Int32, Int32)
    SplitterControl.SetActivePane(Int32, Int32)
    SplitterControl.CanActivateNext(Boolean)
    SplitterControl.ProcessDialogKey(Keys)
    SplitterControl.ActivateNext(Boolean)
    SplitterControl.ToString()
    SplitterControl.IsActive(Control, ScrollBars)
    SplitterControl.GetHScrollBar(Control)
    SplitterControl.GetVScrollBar(Control)
    SplitterControl.OnSetCursor(Message)
    SplitterControl.OnCancelMode(EventArgs)
    SplitterControl.WndProc(Message)
    SplitterControl.OnThemeChanged(EventArgs)
    SplitterControl.IControlToolTipProvider.GetControlToolTip()
    SplitterControl.OnHandleDestroyed(EventArgs)
    SplitterControl.ResetToolTips()
    SplitterControl.OnMouseDown(MouseEventArgs)
    SplitterControl.OnMouseUp(MouseEventArgs)
    SplitterControl.CreateScrollBar(ScrollBars, Int32)
    SplitterControl.OnLayout(LayoutEventArgs)
    SplitterControl.OnParentChanged(EventArgs)
    SplitterControl.ActivateControl(Control)
    SplitterControl.OnEnter(EventArgs)
    SplitterControl.OnLeave(EventArgs)
    SplitterControl.OnValidating(CancelEventArgs)
    SplitterControl.OnValidated(EventArgs)
    SplitterControl.OnLostFocus(EventArgs)
    SplitterControl.OnGotFocus(EventArgs)
    SplitterControl.OnDeactivated(EventArgs)
    SplitterControl.QueryFocusInside()
    SplitterControl.CancelUpdate()
    SplitterControl.OnControlLostFocus()
    SplitterControl.OnControlRemoved(ControlEventArgs)
    SplitterControl.OnSplitBarsChanged(EventArgs)
    SplitterControl.OnHSplitPosChanged(EventArgs)
    SplitterControl.OnVSplitPosChanged(EventArgs)
    SplitterControl.OnHandleCreated(EventArgs)
    SplitterControl.OnSplitterLayoutChanged(EventArgs)
    SplitterControl.OnMovedSplitter(Object)
    SplitterControl.OnPaint(PaintEventArgs)
    SplitterControl.OnShowSizeGripChanged(EventArgs)
    SplitterControl.OnSupportsFlatScrollBarsChanged(EventArgs)
    SplitterControl.OnScrollBarAppearanceChanged(EventArgs)
    SplitterControl.OnScrollBarColorChanged(EventArgs)
    SplitterControl.ResetScrollBarColor()
    SplitterControl.OnOffice2007ScrollBarsChanged(EventArgs)
    SplitterControl.OnOffice2007ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOffice2010ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOffice2016ScrollBarsColorSchemeChanged(EventArgs)
    SplitterControl.OnOfficeScrollBarsChanged(SplitterControl.OfficeScrollBarsEventArgs)
    SplitterControl.OnVisibleChanged(EventArgs)
    SplitterControl.OnShowVerticalScrollBarChanged(EventArgs)
    SplitterControl.OnShowHorizontalScrollBarChanged(EventArgs)
    SplitterControl.GetActiveThemeName()
    SplitterControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    SplitterControl.BeforeTouchSize
    SplitterControl.EnableTouchMode
    SplitterControl.RowCount
    SplitterControl.ColumnCount
    SplitterControl.ActivePane
    SplitterControl.DefaultSize
    SplitterControl.CreateParams
    SplitterControl.BorderStyle
    SplitterControl.ShowToolTips
    SplitterControl.ButtonLook
    SplitterControl.CurrentLayout
    SplitterControl.ActiveControl
    SplitterControl.IsValidating
    SplitterControl.IsValidated
    SplitterControl.IsActiveControl
    SplitterControl.IsDeactivated
    SplitterControl.HasControlFocus
    SplitterControl.IDynamicSplitterFrame.SplitBars
    SplitterControl.IDynamicSplitterFrame.RowCount
    SplitterControl.IDynamicSplitterFrame.ColumnCount
    SplitterControl.IDynamicSplitterFrame.ActivePane
    SplitterControl.SplitBars
    SplitterControl.HSplitPos
    SplitterControl.VSplitPos
    SplitterControl.SplitterLayout
    SplitterControl.ShowSizeGrip
    SplitterControl.SupportsFlatScrollBars
    SplitterControl.ScrollBarAppearance
    SplitterControl.SizeFactor
    SplitterControl.ScrollBarColor
    SplitterControl.Office2007ScrollBars
    SplitterControl.IVisualStyle.VisualTheme
    SplitterControl.Office2007ScrollBarsColorScheme
    SplitterControl.GridOfficeScrollBars
    SplitterControl.Office2010ScrollBarsColorScheme
    SplitterControl.Office2016ScrollBarsColorScheme
    SplitterControl.Style
    SplitterControl.SplitterPaneFactory
    SplitterControl.ShowVerticalScrollBar
    SplitterControl.ShowHorizontalScrollBar
    SplitterControl.IThemeProvider.BaseThemeName
    SplitterControl.CanApplyTheme
    SplitterControl.CanOverrideStyle
    SplitterControl.IThemeProvider.ControlName
    SplitterControl.ThemeName
    SplitterControl.IsVisualStyleEnabled
    SplitterControl.CancelMode
    SplitterControl.SplitBarsChanged
    SplitterControl.VSplitPosChanged
    SplitterControl.HSplitPosChanged
    SplitterControl.SplitterLayoutChanged
    SplitterControl.ButtonLookChanged
    SplitterControl.ScrollBarAppearanceChanged
    SplitterControl.Office2007ScrollBarsColorSchemeChanged
    SplitterControl.ScrollBarColorChanged
    SplitterControl.ShowToolTipsChanged
    SplitterControl.SupportsFlatScrollBarsChanged
    SplitterControl.Office2007ScrollBarsChanged
    SplitterControl.ThemeChanged
    SplitterControl.PaneCreated
    SplitterControl.PaneClosing
    SplitterControl.Deactivated
    SplitterControl.ShowSizeGripChanged
    SplitterControl.Office2010ScrollBarsColorSchemeChanged
    SplitterControl.Office2016ScrollBarsColorSchemeChanged
    SplitterControl.OfficeScrollBarsChanged
    SplitterControl.ShowVerticalScrollBarChanged
    SplitterControl.ShowHorizontalScrollBarChanged
    SplitterControl.ThemeNameChanged
    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 Description
    System.Boolean

    CurrentRecord

    Gets / sets the current record position.

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

    DisabledArrowColor

    Gets or sets the color of arrows in disabled buttons.

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

    EnabledArrowColor

    Gets or sets the color of arrows in enabled buttons.

    Declaration
    public virtual Color EnabledArrowColor { get; set; }
    Property Value
    Type Description
    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 Description
    System.String

    MaxLabel

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

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

    MaxRecord

    Gets or sets the maximum record position.

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

    MinRecord

    Gets or sets the minimum record position.

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

    MinRepeatClickDelay

    Gets / sets the shortest interval for firing scroll event.

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

    NavigationBar

    Returns the RecordNavigationScrollBar with record information and scroll buttons.

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

    NavigationBarBackColor

    Gets or sets the backcolor of the navigation bar.

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

    NavigationBarWidth

    Gets or sets the width of the navigation bar.

    Declaration
    public virtual int NavigationBarWidth { get; set; }
    Property Value
    Type Description
    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 Description
    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 Description
    System.Int32

    ThemesEnabled

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

    ThemeStyle

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

    Declaration
    public RecordNavigateVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    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 Description
    System.Windows.Forms.Control
    Overrides
    SplitterControl.CreateScrollBarContainer(ScrollBars, Int32)

    Dispose(Boolean)

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

    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
    SplitterControl.OnButtonLookChanged(EventArgs)

    OnControlGotFocus()

    Declaration
    protected override void OnControlGotFocus()
    Overrides
    SplitterControl.OnControlGotFocus()

    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
    SplitterControl.OnFontChanged(EventArgs)

    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
    SplitterControl.OnMoveSplitter(Object, Int32, Int32)

    OnShowToolTipsChanged(EventArgs)

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

    OnValidatingLostFocus()

    Declaration
    protected override void OnValidatingLostFocus()
    Overrides
    SplitterControl.OnValidatingLostFocus()

    Refresh()

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

    Declaration
    public override void Refresh()
    Overrides
    SplitterControl.Refresh()

    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 Description
    ArrowButtonEventHandler

    CurrentRecordChanged

    Occurs when the current record is changed.

    Declaration
    public event CurrentRecordChangedEventHandler CurrentRecordChanged
    Event Type
    Type Description
    CurrentRecordChangedEventHandler

    CurrentRecordChanging

    Occurs when the current record is changing.

    Declaration
    public event CurrentRecordChangedEventHandler CurrentRecordChanging
    Event Type
    Type Description
    CurrentRecordChangedEventHandler

    Implements

    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved