Class RadToolBar

A toolbar control.

Inheritance
System.Object
RadToolBar
QuickAccessToolBar
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadToolBar : ItemsControl, IThemable

Constructors

RadToolBar()

Initializes a new instance of the RadToolBar class.

Declaration
public RadToolBar()

Fields

AutoHideOverflowButtonProperty

Identifies the property.

Declaration
public static readonly DependencyProperty AutoHideOverflowButtonProperty
Field Value
System.Windows.DependencyProperty

BandIndexProperty

Identifies the property.

Declaration
public static readonly DependencyProperty BandIndexProperty
Field Value
System.Windows.DependencyProperty

BandProperty

Identifies the property.

Declaration
public static readonly DependencyProperty BandProperty
Field Value
System.Windows.DependencyProperty

GripVisibilityProperty

Identifies the property.

Declaration
public static readonly DependencyProperty GripVisibilityProperty
Field Value
System.Windows.DependencyProperty

HasOverflowItemsProperty

Identifies the property.

Declaration
public static readonly DependencyProperty HasOverflowItemsProperty
Field Value
System.Windows.DependencyProperty

IsOverflowOpenProperty

Identifies the property.

Declaration
public static readonly DependencyProperty IsOverflowOpenProperty
Field Value
System.Windows.DependencyProperty

ItemAlignmentProperty

Registers the ItemAlignment attached property.

Declaration
public static readonly DependencyProperty ItemAlignmentProperty
Field Value
System.Windows.DependencyProperty

OrientationProperty

Identifies the property.

Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
System.Windows.DependencyProperty

OverflowAreaClosedEvent

Identifies the routed event.

Declaration
public static readonly RoutedEvent OverflowAreaClosedEvent
Field Value
System.Windows.RoutedEvent

OverflowAreaOpenedEvent

Identifies the routed event.

Declaration
public static readonly RoutedEvent OverflowAreaOpenedEvent
Field Value
System.Windows.RoutedEvent

OverflowButtonVisibilityProperty

Identifies the property.

Declaration
public static readonly DependencyProperty OverflowButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty

OverflowItemsProperty

DependencyProperty for the OverflowItems property.

Declaration
public static readonly DependencyProperty OverflowItemsProperty
Field Value
System.Windows.DependencyProperty

OverflowModeProperty

Identifies the property.

Declaration
public static readonly DependencyProperty OverflowModeProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoHideOverflowButton

Gets or sets a value indicating whether the OverflowButton will be automatically hidden, depending on the presence of OverflowItems.

The default value is false.

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

Band

Gets or sets a value indicating on which Tray's Band the toolbar should be positioned. This is a dependency property.

Declaration
public int Band { get; set; }
Property Value
System.Int32

BandIndex

Gets or sets a value indicating the order in a Tray's Band. This is a dependency property.

Declaration
public int BandIndex { get; set; }
Property Value
System.Int32

GripVisibility

Gets or sets the visibility of the grip visual.

Declaration
public Visibility GripVisibility { get; set; }
Property Value
System.Windows.Visibility

HasOverflowItems

Gets a value indicating whether the Overflow area contains items. This is a dependency property.

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

IsOverflowOpen

Gets or sets a value indicating whether the Overflow area is opened or not. This is a dependency property.

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

Remarks

The default value is false.

Orientation

Gets or sets a value indicating whether the control is vertical or horizontal. This is a dependency property.

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Controls.Orientation

Remarks

The default value is Orientation.Horizontal.

OverflowButtonVisibility

Gets or sets the visibility of the overflow visual.

Declaration
public Visibility OverflowButtonVisibility { get; set; }
Property Value
System.Windows.Visibility

OverflowItems

Gets a collection of items that are in the overflow area.

Declaration
public IList OverflowItems { get; }
Property Value
System.Collections.IList

Methods

ChangeVisualState(Boolean)

Updates the visual state of the control.

Declaration
protected void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean useTransitions

Indicates whether transitions should be used.

GetContainerForItemOverride()

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject

GetItemAlignment(DependencyObject)

Returns the value of the ItemAlignment property related to the specified object.

Declaration
public static ItemAlignment GetItemAlignment(DependencyObject obj)
Parameters
System.Windows.DependencyObject obj

Returns
ItemAlignment

GetOverflowMode(DependencyObject)

Returns the value of the OverflowMode property related to the specified object.

Declaration
public static OverflowMode GetOverflowMode(DependencyObject element)
Parameters
System.Windows.DependencyObject element

The item to check.
Returns
OverflowMode

MeasureOverride(Size)

Provides the behavior for the "measure" layout pass.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

The available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available.
Returns
System.Windows.Size

The size that this object determines it needs during layout.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Creates an appropriate ToolBarAutomationPeer for this control as part of the WPF/Silverlight infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnIsOverflowOpened(Boolean, Boolean)

Called when IsOverflowOpen property changes.

Declaration
protected virtual void OnIsOverflowOpened(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

The old value of the property.
System.Boolean newValue

The new value of the property.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the System.Windows.Controls.ItemsControl.Items property changes.

Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

Information about the change.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this System.Windows.FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

The event data that describes the property that changed, as well as old and new values.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.
System.Object item

Specified item.

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

SetItemAlignment(DependencyObject, ItemAlignment)

Sets the value of the ItemAlignment property related to the specified object. Use this property to align items in the toolbar left(top) or right(bottom).

Declaration
public static void SetItemAlignment(DependencyObject obj, ItemAlignment value)
Parameters
System.Windows.DependencyObject obj

ItemAlignment value

SetOverflowMode(DependencyObject, OverflowMode)

Set the value of the OverflowMode property related to the specified object.

Declaration
public static void SetOverflowMode(DependencyObject element, OverflowMode mode)
Parameters
System.Windows.DependencyObject element

The item to be initialized.
OverflowMode mode

The supplied value.

Events

OverflowAreaClosed

Fired when a Overflow area is closed. This is a routed event.

Declaration
public event RoutedEventHandler OverflowAreaClosed
Event Type
System.Windows.RoutedEventHandler

OverflowAreaOpened

Fired when a Overflow area is opened. This is a routed event.

Declaration
public event RoutedEventHandler OverflowAreaOpened
Event Type
System.Windows.RoutedEventHandler

Extension Methods