Class RadBindingNavigatorElement

Represents the core element implementation of a binding navigator control that provides data navigation functionality through a command bar interface. This element manages the creation and behavior of navigation buttons, position display, and data binding operations for traversing and manipulating data source records.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadCommandBarVisualElement
RadCommandBarElement
RadBindingNavigatorElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadBindingNavigatorElement : RadCommandBarElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadBindingNavigatorElement()

Declaration
public RadBindingNavigatorElement()

Fields

AddNewButtonImageProperty

Identifies the AddNewButtonImage dependency property used for storing the image displayed on the add new item button.

Declaration
public static RadProperty AddNewButtonImageProperty
Field Value
RadProperty

AddNewButtonSvgImageProperty

Identifies the AddNewButtonSvgImage dependency property used for storing the SVG image displayed on the add new item button.

Declaration
public static RadProperty AddNewButtonSvgImageProperty
Field Value
RadProperty

ButtonDisplayStyleProperty

Identifies the ButtonDisplayStyle dependency property used for controlling how navigation buttons display their content.

Declaration
public static RadProperty ButtonDisplayStyleProperty
Field Value
RadProperty

ButtonGlyphSizeProperty

Identifies the ButtonGlyphSize dependency property used for controlling the size of button glyphs and icons.

Declaration
public static RadProperty ButtonGlyphSizeProperty
Field Value
RadProperty

DeleteButtonImageProperty

Identifies the DeleteButtonImage dependency property used for storing the image displayed on the delete item button.

Declaration
public static RadProperty DeleteButtonImageProperty
Field Value
RadProperty

DeleteButtonSvgImageProperty

Identifies the DeleteButtonSvgImage dependency property used for storing the SVG image displayed on the delete item button.

Declaration
public static RadProperty DeleteButtonSvgImageProperty
Field Value
RadProperty

MoveFirstItemButtonImageProperty

Identifies the MoveFirstItemButtonImage dependency property used for storing the image displayed on the move first item button.

Declaration
public static RadProperty MoveFirstItemButtonImageProperty
Field Value
RadProperty

MoveFirstItemButtonSvgImageProperty

Identifies the MoveFirstItemButtonSvgImage dependency property used for storing the SVG image displayed on the move first item button.

Declaration
public static RadProperty MoveFirstItemButtonSvgImageProperty
Field Value
RadProperty

MoveLastItemButtonImageProperty

Identifies the MoveLastItemButtonImage dependency property used for storing the image displayed on the move last item button.

Declaration
public static RadProperty MoveLastItemButtonImageProperty
Field Value
RadProperty

MoveLastItemButtonSvgImageProperty

Identifies the MoveLastItemButtonSvgImage dependency property used for storing the SVG image displayed on the move last item button.

Declaration
public static RadProperty MoveLastItemButtonSvgImageProperty
Field Value
RadProperty

MoveNextItemButtonImageProperty

Identifies the MoveNextItemButtonImage dependency property used for storing the image displayed on the move next item button.

Declaration
public static RadProperty MoveNextItemButtonImageProperty
Field Value
RadProperty

MoveNextItemButtonSvgImageProperty

Identifies the MoveNextItemButtonSvgImage dependency property used for storing the SVG image displayed on the move next item button.

Declaration
public static RadProperty MoveNextItemButtonSvgImageProperty
Field Value
RadProperty

MovePreviousItemButtonImageProperty

Identifies the MovePreviousItemButtonImage dependency property used for storing the image displayed on the move previous item button.

Declaration
public static RadProperty MovePreviousItemButtonImageProperty
Field Value
RadProperty

MovePreviousItemButtonSvgImageProperty

Identifies the MovePreviousItemButtonSvgImage dependency property used for storing the SVG image displayed on the move previous item button.

Declaration
public static RadProperty MovePreviousItemButtonSvgImageProperty
Field Value
RadProperty

Properties

AddNewButton

Gets or sets the command bar button that creates a new record in the data source when clicked, typically displaying an "add" or "plus" icon or glyph.

Declaration
public CommandBarButton AddNewButton { get; set; }
Property Value
CommandBarButton

AddNewButtonImage

Gets or sets the image displayed on the button that adds a new item to the data source, providing visual indication of the add new record function.

Declaration
public Image AddNewButtonImage { get; set; }
Property Value
System.Drawing.Image

AddNewButtonSvgImage

Gets or sets the vector SVG image displayed on the button that adds a new item to the data source, providing scalable visual indication of the add new record function.

Declaration
public RadSvgImage AddNewButtonSvgImage { get; set; }
Property Value
RadSvgImage

AddNewButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string AddNewButtonSvgImageXml { get; set; }
Property Value
System.String

AutoHandleAddNew

Gets or sets a value indicating whether the control automatically handles the creation of new items when the add new button is clicked, managing the add new operation internally when enabled.

Declaration
public bool AutoHandleAddNew { get; set; }
Property Value
System.Boolean

BindingSource

Gets or sets the BindingSource that provides the data for navigation operations. When set, this property establishes data binding connections and manages list change and position change event subscriptions for automatic UI updates.

Declaration
public BindingSource BindingSource { get; set; }
Property Value
System.Windows.Forms.BindingSource

ButtonDisplayStyle

Gets or sets a value indicating whether the navigation buttons display images, SVG images, or glyph characters, controlling the visual style of all navigation and action buttons.

Declaration
public BindingNavigatorButtonDisplayStyle ButtonDisplayStyle { get; set; }
Property Value
BindingNavigatorButtonDisplayStyle

ButtonGlyphSize

Gets or sets the font size of button glyphs when the ButtonDisplayStyle property is set to Glyph, allowing customization of glyph visual size.

Declaration
public float ButtonGlyphSize { get; set; }
Property Value
System.Single

CommandBarRowElement

Gets or sets the main command bar row element that serves as the container for all navigation strips and provides the structural foundation for the binding navigator layout.

Declaration
public CommandBarRowElement CommandBarRowElement { get; set; }
Property Value
CommandBarRowElement

CountItemFormat

Gets or sets the format string used for displaying the total count of items in the data source, where placeholders like "{0}" are replaced with the actual count value.

Declaration
public string CountItemFormat { get; set; }
Property Value
System.String

CurrentNumberTextBox

Gets or sets the command bar textbox that displays the current record position and allows direct navigation to a specific record number when a value is entered and confirmed.

Declaration
public CommandBarTextBox CurrentNumberTextBox { get; set; }
Property Value
CommandBarTextBox

DeleteButton

Gets or sets the command bar button that deletes the current record from the data source when clicked, typically displaying a "delete" or "trash" icon or glyph.

Declaration
public CommandBarButton DeleteButton { get; set; }
Property Value
CommandBarButton

DeleteButtonImage

Gets or sets the image displayed on the button that deletes the current item from the data source, providing visual indication of the delete record function.

Declaration
public Image DeleteButtonImage { get; set; }
Property Value
System.Drawing.Image

DeleteButtonSvgImage

Gets or sets the vector SVG image displayed on the button that deletes the current item from the data source, providing scalable visual indication of the delete record function.

Declaration
public RadSvgImage DeleteButtonSvgImage { get; set; }
Property Value
RadSvgImage

DeleteButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string DeleteButtonSvgImageXml { get; set; }
Property Value
System.String

FirstButton

Gets or sets the command bar button that navigates to the first record in the data source when clicked, typically displaying a "move to first" icon or glyph.

Declaration
public CommandBarButton FirstButton { get; set; }
Property Value
CommandBarButton

FirstTopStripElement

Gets or sets the primary command bar strip element that contains the main navigation controls including first, previous, next, last buttons and position display elements.

Declaration
public CommandBarStripElement FirstTopStripElement { get; set; }
Property Value
CommandBarStripElement

LastButton

Gets or sets the command bar button that navigates to the last record in the data source when clicked, typically displaying a "move to last" icon or glyph.

Declaration
public CommandBarButton LastButton { get; set; }
Property Value
CommandBarButton

MoveFirstItemButtonImage

Gets or sets the image displayed on the button that navigates to the first item in the data source, providing visual indication of the first record navigation function.

Declaration
public Image MoveFirstItemButtonImage { get; set; }
Property Value
System.Drawing.Image

MoveFirstItemButtonSvgImage

Gets or sets the vector SVG image displayed on the button that navigates to the first item in the data source, providing scalable visual indication of the first record navigation function.

Declaration
public RadSvgImage MoveFirstItemButtonSvgImage { get; set; }
Property Value
RadSvgImage

MoveFirstItemButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string MoveFirstItemButtonSvgImageXml { get; set; }
Property Value
System.String

MoveLastItemButtonImage

Gets or sets the image displayed on the button that navigates to the last item in the data source, providing visual indication of the last record navigation function.

Declaration
public Image MoveLastItemButtonImage { get; set; }
Property Value
System.Drawing.Image

MoveLastItemButtonSvgImage

Gets or sets the vector SVG image displayed on the button that navigates to the last item in the data source, providing scalable visual indication of the last record navigation function.

Declaration
public RadSvgImage MoveLastItemButtonSvgImage { get; set; }
Property Value
RadSvgImage

MoveLastItemButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string MoveLastItemButtonSvgImageXml { get; set; }
Property Value
System.String

MoveNextItemButtonImage

Gets or sets the image displayed on the button that navigates to the next item in the data source, providing visual indication of the next record navigation function.

Declaration
public Image MoveNextItemButtonImage { get; set; }
Property Value
System.Drawing.Image

MoveNextItemButtonSvgImage

Gets or sets the vector SVG image displayed on the button that navigates to the next item in the data source, providing scalable visual indication of the next record navigation function.

Declaration
public RadSvgImage MoveNextItemButtonSvgImage { get; set; }
Property Value
RadSvgImage

MoveNextItemButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string MoveNextItemButtonSvgImageXml { get; set; }
Property Value
System.String

MovePreviousItemButtonImage

Gets or sets the image displayed on the button that navigates to the previous item in the data source, providing visual indication of the previous record navigation function.

Declaration
public Image MovePreviousItemButtonImage { get; set; }
Property Value
System.Drawing.Image

MovePreviousItemButtonSvgImage

Gets or sets the vector SVG image displayed on the button that navigates to the previous item in the data source, providing scalable visual indication of the previous record navigation function.

Declaration
public RadSvgImage MovePreviousItemButtonSvgImage { get; set; }
Property Value
RadSvgImage

MovePreviousItemButtonSvgImageXml

This property is not relevant for this class.

Declaration
public string MovePreviousItemButtonSvgImageXml { get; set; }
Property Value
System.String

Navigator

Gets the parent RadBindingNavigator control that contains this element, providing access to the host control for configuration and event handling.

Declaration
public RadBindingNavigator Navigator { get; }
Property Value
RadBindingNavigator

NextButton

Gets or sets the command bar button that navigates to the next record in the data source when clicked, typically displaying a "move to next" icon or glyph.

Declaration
public CommandBarButton NextButton { get; set; }
Property Value
CommandBarButton

PageLabel

Gets or sets the command bar label that displays the total count of records in the data source using the format specified by the CountItemFormat property.

Declaration
public CommandBarLabel PageLabel { get; set; }
Property Value
CommandBarLabel

PreviousButton

Gets or sets the command bar button that navigates to the previous record in the data source when clicked, typically displaying a "move to previous" icon or glyph.

Declaration
public CommandBarButton PreviousButton { get; set; }
Property Value
CommandBarButton

SecondBottomStripElement

Gets or sets the secondary command bar strip element that contains data manipulation controls including add new and delete buttons for record management operations.

Declaration
public CommandBarStripElement SecondBottomStripElement { get; set; }
Property Value
CommandBarStripElement

ThemeEffectiveType

Gets the effective theme type for this element, which returns RadCommandBarElement to ensure consistent theming with command bar controls.

Declaration
protected override Type ThemeEffectiveType { get; }
Property Value
System.Type

Overrides

Methods

AddNewButton_Click(Object, EventArgs)

Handles the click event of the add new button, creating a new record in the BindingSource when auto-handling is enabled and addition is allowed, then updating the navigation state.

Declaration
protected virtual void AddNewButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The add new button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

AddStandardItems()

Creates and configures the standard navigation items including first, previous, next, last buttons, position textbox, and count label, setting up the primary navigation strip with proper design-time or runtime component creation.

Declaration
public virtual void AddStandardItems()

AttachEvents()

Attaches click event handlers to all navigation and action buttons, and key event handlers to the position textbox for user interaction processing.

Declaration
protected virtual void AttachEvents()

bindingSource_ListChanged(Object, ListChangedEventArgs)

Handles list change events from the BindingSource, updating the navigation state and button visibility when the data collection is modified.

Declaration
protected virtual void bindingSource_ListChanged(object sender, ListChangedEventArgs e)
Parameters
System.Object sender

The BindingSource that raised the list changed event.
System.ComponentModel.ListChangedEventArgs e

Event arguments containing information about the list change operation.

bindingSource_PositionChanged(Object, EventArgs)

Handles position change events from the BindingSource, updating the navigation state and current position display when the active record changes.

Declaration
protected virtual void bindingSource_PositionChanged(object sender, EventArgs e)
Parameters
System.Object sender

The BindingSource that raised the position changed event.
System.EventArgs e

Event arguments for the position change notification.

CreateFirstTopStripElementChildElements()

Creates and configures the primary navigation strip containing first, previous, next, and last buttons along with the current position textbox and count label, handling both design-time and runtime component creation scenarios.

Declaration
protected virtual void CreateFirstTopStripElementChildElements()

CreateSecondBottomStripElementChildElements()

Creates and configures the secondary strip containing add new and delete buttons for data manipulation operations, handling both design-time and runtime component creation scenarios.

Declaration
protected virtual void CreateSecondBottomStripElementChildElements()

currentNumberTextBox_KeyDown(Object, KeyEventArgs)

Handles the key down event of the current number textbox, processing Enter key presses to navigate to a specific record position when a valid number is entered.

Declaration
protected virtual void currentNumberTextBox_KeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

The current number textbox where the key was pressed.
System.Windows.Forms.KeyEventArgs e

Event arguments containing information about the key that was pressed.

DeleteButton_Click(Object, EventArgs)

Handles the click event of the delete button, removing the current record from the BindingSource when deletion is allowed and updating the navigation state.

Declaration
protected virtual void DeleteButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The delete button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

DetachEvents()

Detaches all event handlers from navigation buttons and textbox controls to prevent memory leaks and ensure proper cleanup during disposal.

Declaration
protected virtual void DetachEvents()

DisposeManagedResources()

Releases managed resources including event handler detachment when the binding navigator element is being disposed.

Declaration
protected override void DisposeManagedResources()
Overrides

FirstButton_Click(Object, EventArgs)

Handles the click event of the first button, navigating to the first record in the BindingSource and updating the navigation state.

Declaration
protected virtual void FirstButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The first button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

InitializeFields()

Initializes the default field values for the binding navigator element, setting up default glyph characters for navigation and action buttons.

Declaration
protected override void InitializeFields()
Overrides

LastButton_Click(Object, EventArgs)

Handles the click event of the last button, navigating to the last record in the BindingSource and updating the navigation state.

Declaration
protected virtual void LastButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The last button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

LoadCore()

Performs the core loading logic for the binding navigator element, mapping existing controls and attaching event handlers for navigation functionality.

Declaration
protected override void LoadCore()
Overrides

MapControls()

Maps and identifies the various navigation control elements within the command bar structure based on their names or command roles, establishing references for programmatic access.

Declaration
protected virtual void MapControls()

NextButton_Click(Object, EventArgs)

Handles the click event of the next button, navigating to the next record in the BindingSource and updating the navigation state.

Declaration
protected virtual void NextButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The next button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

OnLoaded()

Called when the element and all its children have been successfully loaded, triggering an initial update of the navigation state and button visibility.

Declaration
protected override void OnLoaded()
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property change notifications and updates the visual appearance of navigation buttons based on image, SVG, or display style property changes, ensuring the UI reflects current property values.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Event arguments containing information about the changed property and its values.
Overrides

PreviousButton_Click(Object, EventArgs)

Handles the click event of the previous button, navigating to the previous record in the BindingSource and updating the navigation state.

Declaration
protected virtual void PreviousButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The previous button that was clicked.
System.EventArgs e

Event arguments containing information about the click event.

UpdateAddNewButtonVisibility()

Updates the enabled state of the add new button based on whether the data source allows new item creation and whether the data type has a parameterless constructor.

Declaration
protected virtual void UpdateAddNewButtonVisibility()

UpdateButton(CommandBarButton, String)

Updates the specified button's visual appearance based on the current ButtonDisplayStyle setting, configuring the button to display either images or glyph characters with appropriate styling.

Declaration
protected virtual void UpdateButton(CommandBarButton button, string glyph)
Parameters
CommandBarButton button

The CommandBarButton to update with the specified glyph or image display.
System.String glyph

The glyph character to display when ButtonDisplayStyle is set to Glyph mode.

UpdateDeleteButtonVisibility()

Updates the enabled state of the delete button based on whether there are records in the data source that can be deleted.

Declaration
protected virtual void UpdateDeleteButtonVisibility()

UpdateLabelText()

Updates the count label text using the CountItemFormat to display the total number of records in the data source.

Declaration
protected virtual void UpdateLabelText()

UpdateNavigationButtons()

Updates the enabled state of the first, previous, next, and last navigation buttons based on the current position within the data source to prevent invalid navigation operations.

Declaration
protected virtual void UpdateNavigationButtons()

UpdateTextBox()

Updates the current position textbox to display the current record number, showing the 1-based position of the active record in the data source.

Declaration
protected virtual void UpdateTextBox()

UpdateVisibility()

Updates the visibility and enabled state of all navigation controls based on the current data source state, ensuring the UI accurately reflects the available navigation operations.

Declaration
public virtual void UpdateVisibility()

Extension Methods