BindingNavigator Class
Represents the navigation and manipulation user interface (UI) for controls on a form that are bound to data.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The BindingNavigator control represents a standardized way to navigate and manipulate data on a form. In most cases, a BindingNavigator is paired with a BindingSource control to move through data records on a form and interact with them. In these cases, the BindingSource property is set to the associated System.Windows.Forms.BindingSource component that acts as a data source.
By default, the BindingNavigator control's user interface (UI) is composed of a series of ToolStrip buttons, text boxes, and static text elements for most common data-related actions, such as adding data, deleting data, and navigating through data. Each of these controls can be retrieved or set through an associated member of the BindingNavigator control. Likewise, there is also a one-to-one correspondence to members within the BindingSource class that programmatically perform the same functionality, as shown in the following table.
UI Control | BindingNavigator member | BindingSource member |
|---|---|---|
Move First | ||
Move Previous | ||
Current Position | ||
Count | ||
Move Next | ||
Move Last | ||
Add New | ||
Delete |
Adding a BindingNavigator control to a form and binding it to a data source, such as a BindingSource, will automatically establish the relationships in this table.
You can use one of the following techniques to customize this toolbar:
Create the BindingNavigator with the BindingNavigator(Boolean) constructor, which accepts a Boolean addStandardItems parameter, and set this parameter to false. Then add the desired ToolStripItem objects to the Items collection.
If a great deal of customization is desired, or the custom design will be reused, derive a class from BindingNavigator and override the AddStandardItems method to define additional or alternate standard items.
The following code example demonstrates how to use a BindingNavigator control to move through a data set. The set is contained in a DataView, which is bound to a TextBox control with a BindingSource component.
Imports System Imports System.Collections.Generic Imports System.ComponentModel Imports System.Data Imports System.Drawing Imports System.Data.SqlClient Imports System.Windows.Forms ' This form demonstrates using a BindingNavigator to display ' rows from a database query sequentially. Public Class Form1 Inherits Form ' This is the BindingNavigator that allows the user ' to navigate through the rows in a DataSet. Private customersBindingNavigator As New BindingNavigator(True) ' This is the BindingSource that provides data for ' the Textbox control. Private customersBindingSource As New BindingSource() ' This is the TextBox control that displays the CompanyName ' field from the the DataSet. Private companyNameTextBox As New TextBox() Public Sub New() ' Set up the BindingSource component. Me.customersBindingNavigator.BindingSource = Me.customersBindingSource Me.customersBindingNavigator.Dock = DockStyle.Top Me.Controls.Add(Me.customersBindingNavigator) ' Set up the TextBox control for displaying company names. Me.companyNameTextBox.Dock = DockStyle.Bottom Me.Controls.Add(Me.companyNameTextBox) ' Set up the form. Me.Size = New Size(800, 200) AddHandler Me.Load, AddressOf Form1_Load End Sub 'New Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) ' Open a connection to the database. ' Replace the value of connectString with a valid ' connection string to a Northwind database accessible ' to your system. Dim connectString As String = _ "Integrated Security=SSPI;Persist Security Info=False;" & _ "Initial Catalog=Northwind;Data Source=localhost" Dim connection As New SqlConnection(connectString) Try Dim dataAdapter1 As New SqlDataAdapter( _ New SqlCommand("Select * From Customers", connection)) Dim ds As New DataSet("Northwind Customers") ds.Tables.Add("Customers") dataAdapter1.Fill(ds.Tables("Customers")) ' Assign the DataSet as the DataSource for the BindingSource. Me.customersBindingSource.DataSource = ds.Tables("Customers") ' Bind the CompanyName field to the TextBox control. Me.companyNameTextBox.DataBindings.Add(New Binding("Text", _ Me.customersBindingSource, "CompanyName", True)) Finally connection.Dispose() End Try End Sub 'Form1_Load <STAThread()> _ Public Shared Sub Main() Application.EnableVisualStyles() Application.Run(New Form1()) End Sub End Class
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.Control
System.Windows.Forms.ScrollableControl
System.Windows.Forms.ToolStrip
System.Windows.Forms.BindingNavigator
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.