Skip to main content
Version: 4.1

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.

public class BindingNavigator : FlowLayoutPanel, ISupportInitialize

Constructors​

Instance member BindingNavigator(bindingSource)​

Initializes a new instance of the BindingNavigator class with the specified BindingSource as the data source.

NameTypeDescription
bindingSourceBindingSourceThe BindingSource used as a data source.

Instance member BindingNavigator(addStandardItems)​

Initializes a new instance of the BindingNavigator class, indicating whether to display the standard navigation user interface (UI).

NameTypeDescription
addStandardItemsBooleantrue to show the standard navigational UI; otherwise, false.

Properties​

Instance member AddNewItem​

Button: Returns or sets the "Add New" button.

Value: A Button that represents the "Add New" button for the BindingSource.

Instance member 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.

Instance member 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.

Instance member 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}".

Instance member DeleteItem​

Button: Returns or sets the "Delete" button.

Value: A Button that represents the "Delete" button for the BindingSource.

Instance member MoveFirstItem​

Button: Returns or sets the "Move First" button.

Value: A Button that represents the "Move First" button for the BindingSource.

Instance member MoveLastItem​

Button: Returns or sets the "Move Last" button.

Value: A Button that represents the "Move Last" button for the BindingSource.

Instance member MoveNextItem​

Button: Returns or sets the "Move Next" button.

Value: A Button that represents the "Move Next" button for the BindingSource.

Instance member MovePreviousItem​

Button: Returns or sets the "Move Previous" button.

Value: A Button that represents the "Move Previous" button for the BindingSource.

Instance member 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.

Instance member 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.

Instance member Text​

String: Returns or sets the text to display on the tab. (Default: "")

Value: The text to display on the tab.

Methods​

Instance member AddStandardItems()​

Adds the standard set of navigation items to the BindingNavigator control.

Instance member BeginInit()​

Disables updates to the controls of during the component's initialization.

Protected member Dispose(disposing)​

Clean up any resources being used.

ParameterTypeDescription
disposingBooleantrue if managed resources should be disposed; otherwise, false.

Instance member EndInit()​

Enables updates to the controls after the component's initialization has completed.

Protected member OnDockChanged(e)​

Fires the DockChanged event.

ParameterTypeDescription
eEventArgsAn EventArgs that contains the event data.

Protected member OnRefreshItems(e)​

Fires the RefreshItems event.

ParameterTypeDescription
eEventArgsA EventArgs that contains the event data.

Protected member OnTextChanged(e)​

Fires the TextChanged event.

ParameterTypeDescription
eEventArgsA EventArgs that contains the event data.

Protected member RefreshItemsCore()​

Refreshes the state of the standard items to reflect the current state of the data source.

Instance member 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​

Instance member 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.

Instance member TextChanged​

EventHandler Fired when the value of the Text property changes.

Implements​

NameDescription
IUserDataProvides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponentBindable components implement this interface.
IDropTargetControls that support drag & drop operations implement this interface.
IImageProvides access to common image properties across the controls that implement this interface.
IWisejComponentAll wisej components implement this interface.
IWisejControlAll wisej controls derived from the Control class must implement this interface.
IWisejSerializableAllows an object to serialize itself.