BindingNavigator
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
- C#
- VB.NET
public class BindingNavigator : FlowLayoutPanel, ISupportInitialize
Public Class BindingNavigator
Inherits FlowLayoutPanel
Implements ISupportInitialize
Constructors
BindingNavigator(bindingSource)
Initializes a new instance of the BindingNavigator class with the specified BindingSource as the data source.
| Name | Type | Description |
|---|---|---|
| bindingSource | BindingSource | The BindingSource used as a data source. |
BindingNavigator(addStandardItems)
Initializes a new instance of the BindingNavigator class, indicating whether to display the standard navigation user interface (UI).
| Name | Type | Description |
|---|---|---|
| addStandardItems | Boolean | true to show the standard navigational UI; otherwise, false. |
Properties
AddNewItem
Button: Returns or sets the "Add New" button.
Value: A Button that represents the "Add New" button for the BindingSource.
BindingSource
BindingSource: Returns or sets the BindingSource component that is the source of data. (Default: null)
Value: The BindingSource component associated with this BindingNavigator. The default is null.
CountItem
Label: Returns or sets the control that displays the total number of items in the associated BindingSource.
Value: A Label that displays the total number of items in the associated BindingSource.
CountItemFormat
String: Gets or sets a string used to format the information displayed in the CountItem control.
Value: The format String used to format the item count. The default is the string "of {0}".
DeleteItem
Button: Returns or sets the "Delete" button.
Value: A Button that represents the "Delete" button for the BindingSource.
MoveFirstItem
Button: Returns or sets the "Move First" button.
Value: A Button that represents the "Move First" button for the BindingSource.
MoveLastItem
Button: Returns or sets the "Move Last" button.
Value: A Button that represents the "Move Last" button for the BindingSource.
MoveNextItem
Button: Returns or sets the "Move Next" button.
Value: A Button that represents the "Move Next" button for the BindingSource.
MovePreviousItem
Button: Returns or sets the "Move Previous" button.
Value: A Button that represents the "Move Previous" button for the BindingSource.
Orientation
Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the BindingNavigator control.
Value: One of the Orientation values.
When the control is docked, this property is managed automatically.
PositionItem
TextBox: Returns or sets the TextBox control that displays the current position within the associated BindingSource.
Value: The TextBox that displays the current position.
Text
String: Returns or sets the text to display on the tab. (Default: "")
Value: The text to display on the tab.
Methods
AddStandardItems()
Adds the standard set of navigation items to the BindingNavigator control.
BeginInit()
Disables updates to the controls of during the component's initialization.
Dispose(disposing)
Clean up any resources being used.
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean | true if managed resources should be disposed; otherwise, false. |
EndInit()
Enables updates to the controls after the component's initialization has completed.
OnDockChanged(e)
Fires the DockChanged event.
OnRefreshItems(e)
Fires the RefreshItems event.
OnTextChanged(e)
Fires the TextChanged event.
RefreshItemsCore()
Refreshes the state of the standard items to reflect the current state of the data source.
Validate()
Causes validation to occur and returns whether validation was successful.
Returns: Boolean. true if validation was successful and focus can shift to the BindingNavigator; otherwise, false.
Events
RefreshItems
EventHandler Fired when the state of the navigational user interface (UI) needs to be refreshed to reflect the current state of the underlying data source.
TextChanged
EventHandler Fired when the value of the Text property changes.
Implements
| Name | Description |
|---|---|
| IUserData | Provides access to the UserData and Tag properties associated to the component implementing this interface. |
| IBindableComponent | Bindable components implement this interface. |
| IDropTarget | Controls that support drag & drop operations implement this interface. |
| IImage | Provides access to common image properties across the controls that implement this interface. |
| IWisejComponent | All wisej components implement this interface. |
| IWisejControl | All wisej controls derived from the Control class must implement this interface. |
| IWisejSerializable | Allows an object to serialize itself. |