Class GridRecordNavigationControl

Provides a RecordNavigationControl with support for a GridControlBase.

Inheritance
System.Object
SplitterControl
RecordNavigationControl
GridRecordNavigationControl
Inherited Members
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

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

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

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

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

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

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

MaxRecord

Gets or sets the maximum record position.

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

MinRecord

Gets or sets the minimum record position.

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

MinRepeatClickDelay

Gets / sets the shortest interval for firing scroll event.

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

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

NavigationBarWidth

Gets or sets the width of the navigation bar.

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

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

Office2007ScrollBars

Toggles between standard and Office2007 scrollbars.

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

Office2007ScrollBarsColorScheme

Gets or sets the style of Office2007 scroll bars

Declaration
public override Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }
Property Value
Type Description
Office2007ColorScheme
Overrides
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

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

ShowHorizontalScrollBar

Toggles visibility of the Horizontal scrollbar.

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

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

ShowVerticalScrollBar

Toggles visibility of the vertical scrollbar.

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

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

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

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

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

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

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

System.Windows.Forms.IContainerControl