menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridRecordNavigationControl - API Reference

    Show / Hide Table of Contents

    Class GridRecordNavigationControl

    Provides a RecordNavigationControl with support for a GridControlBase.

    Inheritance
    System.Object
    SplitterControl
    RecordNavigationControl
    GridRecordNavigationControl
    Implements
    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    IThemeProvider
    IVisualStyle
    ISplitterPaneFactory
    Inherited Members
    RecordNavigationControl.OnArrowButtonClicked(ArrowButtonEventArgs)
    RecordNavigationControl.OnCurrentRecordChanged(CurrentRecordEventArgs)
    RecordNavigationControl.OnFontChanged(EventArgs)
    RecordNavigationControl.CreateScrollBarContainer(ScrollBars, Int32)
    RecordNavigationControl.OnControlGotFocus()
    RecordNavigationControl.OnValidatingLostFocus()
    RecordNavigationControl.Refresh()
    RecordNavigationControl.ResetMinRecord()
    RecordNavigationControl.ResetMaxRecord()
    RecordNavigationControl.ResetAllowAddNew()
    RecordNavigationControl.ResetNavigationBarBackColor()
    RecordNavigationControl.ResetEnabledArrowColor()
    RecordNavigationControl.ResetDisabledArrowColor()
    RecordNavigationControl.OnButtonLookChanged(EventArgs)
    RecordNavigationControl.OnShowToolTipsChanged(EventArgs)
    RecordNavigationControl.OnMoveSplitter(Object, Int32, Int32)
    RecordNavigationControl.NavigationBar
    RecordNavigationControl.CurrentRecord
    RecordNavigationControl.ThemeStyle
    RecordNavigationControl.CurrentRecordChanged
    RecordNavigationControl.CurrentRecordChanging
    RecordNavigationControl.ArrowButtonClicked
    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.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.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.SplitterLayout
    SplitterControl.ShowSizeGrip
    SplitterControl.SupportsFlatScrollBars
    SplitterControl.ScrollBarAppearance
    SplitterControl.SizeFactor
    SplitterControl.ScrollBarColor
    SplitterControl.IVisualStyle.VisualTheme
    SplitterControl.Office2016ScrollBarsColorScheme
    SplitterControl.Style
    SplitterControl.SplitterPaneFactory
    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.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridRecordNavigationControl : RecordNavigationControl, IControlToolTipProvider, IInternalSplitterParent, IScrollBarFrame, IDynamicSplitterFrame, IThemedControl, IContainerControl, IThemeProvider, IVisualStyle, ISplitterPaneFactory

    Constructors

    GridRecordNavigationControl()

    Initializes a new instance of GridRecordNavigationControlclass.

    Declaration
    public GridRecordNavigationControl()

    GridRecordNavigationControl(GridControlBase)

    Initializes a GridRecordNavigationControl and associates it with a grid.

    Declaration
    public GridRecordNavigationControl(GridControlBase gridControl)
    Parameters
    Type Name Description
    GridControlBase gridControl

    The grid to be displayed in this record navigation control.

    Properties

    AllowAddNew

    Indicates whether adding new records is enabled.

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

    AllowDrop

    Gets or sets a value indicating whether the control can accept data that the user drags onto it.

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

    ButtonLook

    Gets or sets the button look for the arrow buttons.

    Declaration
    public override ButtonLook ButtonLook { get; set; }
    Property Value
    Type Description
    ButtonLook
    Overrides
    SplitterControl.ButtonLook

    DisabledArrowColor

    Gets or sets the color of arrows in disabled buttons.

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

    EnabledArrowColor

    Gets or sets the color of arrows in enabled buttons.

    Declaration
    public override Color EnabledArrowColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color
    Overrides
    RecordNavigationControl.EnabledArrowColor

    GridControl

    Gets the GridControlBase that is displayed in the record navigation pane.

    Declaration
    public GridControlBase GridControl { get; }
    Property Value
    Type Description
    GridControlBase

    GridOfficeScrollBars

    Gets or sets the Office like scrollbars.

    Declaration
    public override OfficeScrollBars GridOfficeScrollBars { get; set; }
    Property Value
    Type Description
    OfficeScrollBars
    Overrides
    SplitterControl.GridOfficeScrollBars
    Examples

    This example shows how to use the GridOfficeScrollBars property.

    // Sets the style theme for scroll bars. Make sure the property �ThemesEnabled = true;�
    this.gridDataBoundGrid1.GridOfficeScrollBars = OfficeScrollBars.Metro;
    ' Sets the style theme for scroll bars. Make sure the property �ThemesEnabled = true;�
     e.gridDataBoundGrid1.GridOfficeScrollBars = OfficeScrollBars.Metro

    HSplitPos

    Gets or sets the horizontal splitter position in percentages of the splitter control's width.

    Declaration
    public override int HSplitPos { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    SplitterControl.HSplitPos

    Label

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

    Declaration
    public override string Label { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    RecordNavigationControl.Label

    MaxLabel

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

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

    MaxRecord

    Gets or sets the maximum record position.

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

    MinRecord

    Gets or sets the minimum record position.

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

    MinRepeatClickDelay

    Gets / sets the shortest interval for firing scroll event.

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

    NavigationBarBackColor

    Gets or sets the back color of the navigation bar.

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

    NavigationBarWidth

    Gets or sets the width of the navigation bar.

    Declaration
    public override int NavigationBarWidth { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    RecordNavigationControl.NavigationBarWidth

    NavigationButtons

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

    Declaration
    public override DisplayArrowButtons NavigationButtons { get; set; }
    Property Value
    Type Description
    DisplayArrowButtons
    Overrides
    RecordNavigationControl.NavigationButtons

    Office2007ScrollBars

    Toggles between standard and Office2007 scrollbars.

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

    Office2007ScrollBarsColorScheme

    Gets or sets the style of Office2007 scroll bars

    Declaration
    public override Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    Office2007ColorScheme
    Overrides
    SplitterControl.Office2007ScrollBarsColorScheme
    Examples

    This example shows how to use the Office2007ScrollBarsColorScheme property.

    // Enables the Office2007 scroll bars.
    this.gridDataBoundGrid1.Office2007ScrollBars = true;
    // Sets the color schemes for the Office2007 scroll bars.
    this.gridDataBoundGrid1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black;
    ' Enables the Office2007 scroll bars.
    Me.gridDataBoundGrid1.Office2007ScrollBars = True
    ' Sets the color schemes for the Office2007 scroll bars.
    Me.gridDataBoundGrid1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black

    Office2010ScrollBarsColorScheme

    Gets or sets the style of Office2010 scroll bars.

    Declaration
    public override Office2010ColorScheme Office2010ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    Office2010ColorScheme
    Overrides
    SplitterControl.Office2010ScrollBarsColorScheme

    RepeatClickDelay

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

    Declaration
    public override int RepeatClickDelay { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    RecordNavigationControl.RepeatClickDelay

    ShowHorizontalScrollBar

    Toggles visibility of the Horizontal scrollbar.

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

    ShowToolTips

    Indicates whether ToolTips are being shown for tabs that have ToolTips set on them.

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

    ShowVerticalScrollBar

    Toggles visibility of the vertical scrollbar.

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

    Site

    Gets or sets the site of the control.

    Declaration
    public override ISite Site { get; set; }
    Property Value
    Type Description
    System.ComponentModel.ISite

    SplitBars

    Gets or sets a value indicating what split behavior is supported. Rows, Columns or Both.

    Declaration
    public override DynamicSplitBars SplitBars { get; set; }
    Property Value
    Type Description
    DynamicSplitBars
    Overrides
    SplitterControl.SplitBars

    ThemesEnabled

    Gets / sets whether the control should be drawn using Windows XP Themes if available.

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

    VSplitPos

    Gets or sets the vertical splitter position in percentages of the splitter control's height.

    Declaration
    public override int VSplitPos { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    SplitterControl.VSplitPos

    Methods

    CreateNewControl(Int32, Int32, Control, Control)

    Creates a new control for the specified splitter pane.

    Declaration
    public Control CreateNewControl(int row, int column, Control mainControl, Control parent)
    Parameters
    Type Name Description
    System.Int32 row

    The row in a SplitterControl.

    System.Int32 column

    The column in a SplitterControl.

    System.Windows.Forms.Control mainControl

    The control in the first splitter pane.

    System.Windows.Forms.Control parent

    A parent control. Can be a SplitterControl.

    Returns
    Type Description
    System.Windows.Forms.Control

    A new instance of GridControlBase.

    Dispose(Boolean)

    Releases all resources used by the System.ComponentModel.Component.

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

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    Overrides
    RecordNavigationControl.Dispose(Boolean)
    Remarks

    See the documentation for the System.ComponentModel.Component class and its Dispose member.

    DisposeControl(Int32, Int32, Control, Control)

    Hides or disposes the control for the specified splitter pane.

    Declaration
    public void DisposeControl(int row, int column, Control control, Control parent)
    Parameters
    Type Name Description
    System.Int32 row

    The row in a SplitterControl.

    System.Int32 column

    The column in a SplitterControl.

    System.Windows.Forms.Control control

    The control in the splitter pane that should be hidden.

    System.Windows.Forms.Control parent

    A parent control. Can be a SplitterControl.

    OnControlAdded(ControlEventArgs)

    Raises the System.Windows.Forms.Control.GotFocus event. This method is called when the control or any child control gets focus and this control did not have focus before.

    Declaration
    protected override void OnControlAdded(ControlEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.ControlEventArgs e

    The System.Windows.Forms.ControlEventArgs that contains event data.

    Overrides
    SplitterControl.OnControlAdded(ControlEventArgs)

    OnCurrentRecordChanging(CurrentRecordEventArgs)

    Raises the Syncfusion.Windows.Forms.RecordNavigationControl.CurrentRecordChanging event.

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

    The CurrentRecordEventArgsthat contains event data.

    Overrides
    RecordNavigationControl.OnCurrentRecordChanging(CurrentRecordEventArgs)

    RecordToRowIndex(GridControlBase, Int32)

    Calculates the first row in the grid for a one-based record index.

    Declaration
    public int RecordToRowIndex(GridControlBase grid, int record)
    Parameters
    Type Name Description
    GridControlBase grid

    A reference to the grid.

    System.Int32 record

    The one-based record. When the grid has more than one hierarchy level, only the record for the root level can be specified.

    Returns
    Type Description
    System.Int32

    Row index.

    Remarks

    The first row index for the specified record.

    RowIndexToRecord(GridControlBase, Int32)

    Calculates the one-based record displayed at a specific row.

    Declaration
    public int RowIndexToRecord(GridControlBase grid, int rowIndex)
    Parameters
    Type Name Description
    GridControlBase grid

    A reference to the grid.

    System.Int32 rowIndex

    The row index.

    Returns
    Type Description
    System.Int32

    The one-based record (as displayed in the record navigation bar) for the given row index.

    Remarks

    When the grid has more than one hierarchy level, the record in the root level will be returned.

    UnwireGrid(GridControlBase)

    Reset hooks with the specified GridControlBase.

    Declaration
    public void UnwireGrid(GridControlBase gridControl)
    Parameters
    Type Name Description
    GridControlBase gridControl

    The grid control to listen to.

    WireGrid(GridControlBase)

    Implements hooks with the specified GridControlBase for current cell movement.

    Declaration
    public void WireGrid(GridControlBase gridControl)
    Parameters
    Type Name Description
    GridControlBase gridControl

    The grid control to listen to.

    Implements

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