Class

RadBindingNavigatorElement

Declaration

public RadBindingNavigatorElement()

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

Declaration

public static RadProperty AddNewButtonImageProperty

Field Value

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

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

Declaration

public static RadProperty ButtonDisplayStyleProperty

Field Value

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

Declaration

public static RadProperty ButtonGlyphSizeProperty

Field Value

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

Declaration

public static RadProperty DeleteButtonImageProperty

Field Value

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

Declaration

public static RadProperty DeleteButtonSvgImageProperty

Field Value

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

Declaration

public static RadProperty MoveFirstItemButtonImageProperty

Field Value

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

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

Declaration

public static RadProperty MoveLastItemButtonImageProperty

Field Value

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

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

Declaration

public static RadProperty MoveNextItemButtonImageProperty

Field Value

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

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

Declaration

public static RadProperty MovePreviousItemButtonImageProperty

Field Value

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

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image AddNewButtonImage { get; set; }

Property Value

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

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

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

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

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

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

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

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

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image DeleteButtonImage { get; set; }

Property Value

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

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

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

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image MoveFirstItemButtonImage { get; set; }

Property Value

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image MoveLastItemButtonImage { get; set; }

Property Value

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image MoveNextItemButtonImage { get; set; }

Property Value

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

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

[TypeConverter(typeof(ImageTypeConverter))]
public Image MovePreviousItemButtonImage { get; set; }

Property Value

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

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

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

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

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

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

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

Overrides RadElement.ThemeEffectiveType

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

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()

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()

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()

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()

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

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()

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

Declaration

protected override void DisposeManagedResources()

Overrides RadCommandBarElement.DisposeManagedResources()

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

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 RadCommandBarElement.InitializeFields()

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

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 RadElement.LoadCore()

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()

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

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 LightVisualElement.OnLoaded()

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

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

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

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()

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

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()

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

Declaration

protected virtual void UpdateLabelText()

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()

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()

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()

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

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

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