Class

RadBindingNavigator

Initializes a new instance of the RadBindingNavigator class with auto-sizing enabled by default to accommodate the navigation controls.

Declaration

public RadBindingNavigator()

The event key used to identify and manage the OrientationChanged event in the control's event collection.

Declaration

public static readonly object OrientationChangedEventKey

Field Value

The event key used to identify and manage the OrientationChanging event in the control's event collection.

Declaration

public static readonly object OrientationChangingEventKey

Field Value

Gets or sets a value indicating whether the control automatically handles the creation of new items when the add new button is clicked. When set to true, the control manages the add new operation internally.

Declaration

public bool AutoHandleAddNew { get; set; }

Property Value

Gets or sets a value indicating whether the control automatically resizes to fit its contents, ensuring optimal space usage for the navigation elements.

Declaration

public override bool AutoSize { get; set; }

Property Value

Overrides RadControl.AutoSize

Gets the main binding navigator element that contains all the navigation controls and data binding functionality. This element is not accessible through the designer and provides programmatic access to the core navigation features.

Declaration

[Browsable(false)]
public RadBindingNavigatorElement BindingNavigatorElement { get; }

Property Value

Gets or sets the BindingSource that provides the data source for navigation operations. This binding source determines which data collection the navigator controls and enables data manipulation features.

Declaration

[Browsable(true)]
public BindingSource BindingSource { get; set; }

Property Value

Gets or sets the format string used to display the total count of items in the data source. The format string should contain a placeholder like "{0}" which will be replaced with the actual count value.

Declaration

[Browsable(true)]
public string CountItemFormat { get; set; }

Property Value

Gets the RadDropDownMenu that appears when right-clicking on the control, providing customization options for strip visibility and layout configuration.

Declaration

public RadDropDownMenu CustomizeContextMenu { get; }

Property Value

Gets the default size of the control when no explicit size is specified, providing a minimum usable dimension for the navigation interface.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets which edges of the RadBindingNavigator are docked to its parent control and determines how the control is resized with its parent. Setting this property automatically adjusts the Orientation based on the dock position.

Declaration

public override DockStyle Dock { get; set; }

Property Value

Exceptions

Overrides Control.Dock

Gets or sets the size of the rectangle centered on the initial mouse click point within which a drag operation will not begin, providing a tolerance area for click operations versus drag initiation.

Declaration

public Size DragSize { get; set; }

Property Value

Gets or sets the orientation of the RadBindingNavigator which can be horizontal or vertical. This property is automatically controlled by the Dock property to ensure proper layout based on docking position.

Declaration

[Browsable(false)]
public Orientation Orientation { get; set; }

Property Value

Gets the collection of command bar rows that contain the navigation buttons and controls. This collection allows customization of the navigator layout and addition of custom command elements.

Declaration

[RadNewItem("", false, true, true)]
[RadEditItemsAction]
[Browsable(true)]
public RadCommandBarLinesElementCollection Rows { get; }

Property Value

Determines whether this control defines the theme for the specified element, returning true for specific element types that require themed appearance consistent with the binding navigator.

Declaration

public override bool ControlDefinesThemeForElement(RadElement element)

Parameters

Returns

Overrides RadControl.ControlDefinesThemeForElement(RadElement)

Creates the child items for the navigator control, including the main navigator element and context menu infrastructure for customization options.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates the RadBindingNavigatorElement element.

Declaration

protected virtual RadBindingNavigatorElement CreateNavigatorElement()

Returns

Creates the root element for the RadBindingNavigator control, providing the foundational container for all child elements.

Declaration

protected override RootRadElement CreateRootElement()

Returns

Overrides RadControl.CreateRootElement()

Raises the ContextMenuOpening event, allowing derived classes to perform custom processing when the context menu is about to be displayed.

Declaration

protected virtual void OnContextMenuOpening(CancelEventArgs e)

Parameters

Called when the control is loaded with the specified desired size, enabling gesture support for pan operations on the navigation interface.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Handles mouse down events, specifically processing right-click operations to display the context menu for strip customization when clicking on appropriate areas of the control.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Raises the OrientationChanged event to notify subscribers that the orientation change has been completed successfully.

Declaration

protected virtual void OnOrientationChanged(EventArgs args)

Parameters

Raises the OrientationChanging event and determines whether the orientation change should be cancelled based on subscriber responses.

Declaration

protected virtual bool OnOrientationChanging(CancelEventArgs args)

Parameters

Returns

Called when the parent of the control changes, managing the attachment and detachment of event handlers for the parent form's size changes to handle floating strip visibility properly.

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Overrides RadControl.OnParentChanged(EventArgs)

Called when the theme of the control changes, ensuring that theme settings are properly propagated to all child elements and context menu components.

Declaration

protected override void OnThemeChanged()

Overrides RadControl.OnThemeChanged()

Overrides the auto-size change processing to prevent default behavior, allowing the control to manage its own sizing logic for the navigation interface.

Declaration

protected override void ProcessAutoSizeChanged(bool value)

Parameters

Overrides RadControl.ProcessAutoSizeChanged(bool)

Processes CodedUI automation messages, handling specific property requests such as "Lines" count for automated testing scenarios and delegating other requests to the base implementation.

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Resets the background color theme overrides to their default values, removing custom background color settings and reapplying the default theme to the element tree.

Declaration

protected override void ResetBackColorThemeOverrides()

Overrides RadControl.ResetBackColorThemeOverrides()

Resets the foreground color theme overrides to their default values, removing custom foreground color settings from the binding navigator element.

Declaration

protected override void ResetForeColorThemeOverrides()

Overrides RadControl.ResetForeColorThemeOverrides()

Sets theme overrides for the background color properties, applying the control's background color and solid gradient style to the binding navigator element and command bar rows.

Declaration

protected override void SetBackColorThemeOverrides()

Overrides RadControl.SetBackColorThemeOverrides()

Sets theme overrides for the foreground color property, applying the control's foreground color to the binding navigator element for consistent text appearance.

Declaration

protected override void SetForeColorThemeOverrides()

Overrides RadControl.SetForeColorThemeOverrides()

Applies the specified orientation to the control and its child elements, managing the layout transition and event firing based on the parameters provided.

Declaration

protected virtual void SetOrientationCore(Orientation value, bool fireEvents)

Parameters

Propagates the current theme name to child command bar elements and their overflow buttons, ensuring consistent visual appearance across all navigation components.

Declaration

protected virtual void SetThemeCore()

Occurs when the context menu is about to be opened, allowing the menu display to be cancelled or customized through the event arguments.

Declaration

public event CancelEventHandler ContextMenuOpening

Event Value

Occurs after a floating toolbar strip has been successfully created, providing notification that the floating form is now available for user interaction.

Declaration

public event EventHandler FloatingStripCreated

Event Value

Occurs before a floating toolbar strip is created, allowing the operation to be cancelled. This event provides control over the floating strip creation process.

Declaration

public event CancelEventHandler FloatingStripCreating

Event Value

Occurs after a floating toolbar strip has been successfully docked back to the main control, confirming that the docking operation has been completed.

Declaration

public event EventHandler FloatingStripDocked

Event Value

Occurs before a floating toolbar strip is docked back to the main control, allowing the docking operation to be cancelled through the event arguments.

Declaration

public event CancelEventHandler FloatingStripDocking

Event Value

Occurs after the Orientation property has been changed, notifying subscribers that the layout orientation transition has been completed.

Declaration

public event EventHandler OrientationChanged

Event Value

Occurs before the Orientation property changes, allowing the change to be cancelled through the event arguments. This event provides an opportunity to validate or prevent orientation changes.

Declaration

public event CancelEventHandler OrientationChanging

Event Value