BindingNavigator

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ScrollableControl
    • Panel
      • FlowLayoutPanel
        • BindingNavigator

Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.

C#

public class BindingNavigator : FlowLayoutPanel, ISupportInitialize

VB.NET

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.

BindingSource

BindingSource: Returns or sets the BindingSource component that is the source of data. (Default: null)

CountItem

Label: Returns or sets the control 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.

DeleteItem

Button: Returns or sets the "Delete" button.

MoveFirstItem

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

MoveLastItem

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

MoveNextItem

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

MovePreviousItem

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

Orientation

Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the BindingNavigator control.

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.

Text

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

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.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnRefreshItems(e)

Fires the RefreshItems event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnTextChanged(e)

Fires the TextChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

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.