Class RadCommandBarElement

Represents the main element of the RadCommandBar control. Contains a collection of CommandBarRowElement element.

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 RadCommandBarElement : RadCommandBarVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadCommandBarElement()

Declaration
public RadCommandBarElement()

Fields

layoutPanel

Declaration
protected StackLayoutPanel layoutPanel
Field Value
StackLayoutPanel

lines

Declaration
protected RadCommandBarLinesElementCollection lines
Field Value
RadCommandBarLinesElementCollection

Properties

DragSize

Gets or sets the size in pixels when current strip is being Drag and Drop in next or previous row

Declaration
public Size DragSize { get; set; }
Property Value
System.Drawing.Size

Orientation

Gets or sets the orientation of the RadCommandBarElement.

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

Overrides

Rows

Gets the rows of the RadCommandBarElement.

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

StripInfoHolder

Gets the CommandBarStripInfoHolder object that provides information about strips owned by the RadCommandBarElement.

Declaration
public CommandBarStripInfoHolder StripInfoHolder { get; set; }
Property Value
CommandBarStripInfoHolder

Methods

ArrangeOverride(SizeF)

Arranges the command bar element and its children within their allocated space.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final area within the parent that this element should use to arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used after the element is arranged.
Overrides

CreateChildElements()

Creates and initializes the child elements of the command bar, including layout panel and command bar lines collection.

Declaration
protected override void CreateChildElements()
Overrides

CreateFloatingStrip(CommandBarStripElement, CommandBarRowElement, Point)

Creates a floating form of a specified .

Declaration
public void CreateFloatingStrip(CommandBarStripElement stripElement, CommandBarRowElement currentRow, Point initialLocation)
Parameters
CommandBarStripElement stripElement

The strip element of which the floating form should be created.
CommandBarRowElement currentRow

The that contains the strip element.
System.Drawing.Point initialLocation

The initial location of the floating form.

DisposeManagedResources()

Releases the managed resources used by the command bar element.

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeFields()

Initializes the fields of the command bar element.

Declaration
protected override void InitializeFields()
Overrides

ItemsChanged(RadCommandBarLinesElementCollection, CommandBarRowElement, ItemsChangeOperation)

Declaration
protected virtual void ItemsChanged(RadCommandBarLinesElementCollection changed, CommandBarRowElement target, ItemsChangeOperation operation)
Parameters
RadCommandBarLinesElementCollection changed

CommandBarRowElement target

ItemsChangeOperation operation

LoadLayout(Stream)

Loads the visual state of the RadCommandBarElement from a specified stream.

Declaration
public void LoadLayout(Stream source)
Parameters
System.IO.Stream source

The source stream.

LoadLayout(String)

Loads the visual state of the RadCommandBarElement from a specified file.

Declaration
public void LoadLayout(string filename)
Parameters
System.String filename

The name of the file containing the visual state data.

LoadLayout(XmlReader)

Loads the visual state of the RadCommandBarElement from a specified XmlReader.

Declaration
public void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

The XmlReader to read the visual state data.

LoadLayoutCore(XmlDocument)

Restores the visual state of the RadCommandBarElement from the specified XmlDocument.

Declaration
protected virtual void LoadLayoutCore(XmlDocument doc)
Parameters
System.Xml.XmlDocument doc

The document containing the visual state data.

MeasureOverride(SizeF)

Performs the measure pass of the command bar element's layout process.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size that this element can use.
Returns
System.Drawing.SizeF

The size that this element determines it needs during layout.
Overrides

MoveToDownerLine(CommandBarStripElement, CommandBarRowElement)

Moves a specific CommandBarStripElement to the lower CommandBarRowElement.

Declaration
public void MoveToDownerLine(CommandBarStripElement element, CommandBarRowElement currentHolder)
Parameters
CommandBarStripElement element

The element to move.
CommandBarRowElement currentHolder

The CommandBarRowElement that contains the element to move.

MoveToUpperLine(CommandBarStripElement, CommandBarRowElement)

Moves a specific CommandBarStripElement to the upper CommandBarRowElement.

Declaration
public void MoveToUpperLine(CommandBarStripElement element, CommandBarRowElement currentHolder)
Parameters
CommandBarStripElement element

The element to move.
CommandBarRowElement currentHolder

The CommandBarRowElement that contains the element to move.

OnBeginDragging(Object, CancelEventArgs)

Raises the RadCommandBarElement.BeginDragging event

Declaration
protected virtual void OnBeginDragging(object sender, CancelEventArgs args)
Parameters
System.Object sender

The element that is responsible for firing the event.
System.ComponentModel.CancelEventArgs args

A System.ComponentModel.CancelEventArgs that contains the event data.

OnBubbleEvent(RadElement, RoutedEventArgs)

Handles the bubbling of events from child elements, particularly drag-related events.

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The RadElement that initiated the event.
RoutedEventArgs args

The event data.
Overrides

OnDragging(Object, MouseEventArgs)

Raises the RadCommandBarElement.Dragging event

Declaration
protected virtual void OnDragging(object sender, MouseEventArgs args)
Parameters
System.Object sender

The element that is responsible for firing the event.
System.Windows.Forms.MouseEventArgs args

A System.Windows.Forms.MouseEventArgs that contains the event data.

OnEndDragging(Object, EventArgs)

Raises the RadCommandBarElement.EndDragging event

Declaration
protected virtual void OnEndDragging(object sender, EventArgs args)
Parameters
System.Object sender

The element that is responsible for firing the event.
System.EventArgs args

A System.EventArgs that contains the event data.

OnFloatingStripCreated(Object)

Raises the RadCommandBarElement.FloatinStripCreated event.

Declaration
protected virtual void OnFloatingStripCreated(object sender)
Parameters
System.Object sender

The element that is responsible for firing the event - usually this is the strip that is made floating.

OnFloatingStripCreating(Object)

Raises the RadCommandBarElement.FloatinStripCreating event.

Declaration
protected virtual bool OnFloatingStripCreating(object sender)
Parameters
System.Object sender

The element that is responsible for firing the event - usually this is the strip that is going to be floating.
Returns
System.Boolean

True if the creating of a floating form should be canceled, False otherwise.

OnFloatingStripDocked(Object)

Raises the RadCommandBarElement.FloatingStripDocked event.

Declaration
protected virtual void OnFloatingStripDocked(object sender)
Parameters
System.Object sender

The element that is responsible for firing the event - usually this is the strip that was docked.

OnFloatingStripDocking(Object)

Raises the RadCommandBarElement.FloatingStripDocking event.

Declaration
protected virtual bool OnFloatingStripDocking(object sender)
Parameters
System.Object sender

The element that is responsible for firing the event - usually this is the strip that is going to be docked.
Returns
System.Boolean

True if the docking of a floating form should be canceled, False otherwise.

OnOrientationChanged(EventArgs)

Raises the RadCommandBarElement.OrientationChanged event

Declaration
protected virtual void OnOrientationChanged(EventArgs e)
Parameters
System.EventArgs e

A System.EventArgs that contains the event data.

OnOrientationChanging(CancelEventArgs)

Raises the RadCommandBarElement.OrientationChanging event.

Declaration
protected virtual bool OnOrientationChanging(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

A System.ComponentModel.CancelEventArgs that contains the event data.
Returns
System.Boolean

True if the change of orientation should be canceled, false otherwise.

OnTunnelEvent(RadElement, RoutedEventArgs)

Handles the tunneling of events, particularly image list changes for floating forms.

Declaration
protected override void OnTunnelEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The RadElement that initiated the event.
RoutedEventArgs args

The event data.
Overrides

SaveLayout(Stream)

Saves the visual state of the RadCommandBarElement to a specified stream.

Declaration
public void SaveLayout(Stream destination)
Parameters
System.IO.Stream destination

The destination stream.

SaveLayout(String)

Saves the visual state of the RadCommandBarElement to a specified file.

Declaration
public void SaveLayout(string filename)
Parameters
System.String filename

The name of the destination file.

SaveLayout(XmlWriter)

Saves the visual state of the RadCommandBarElement to a specified XmlWriter.

Declaration
public void SaveLayout(XmlWriter writer)
Parameters
System.Xml.XmlWriter writer

The XmlWriter to save the visual state data.

SaveLayoutCore()

Creates an XmlDocument containing the current visual state data of the RadCommandBarElement.

Declaration
protected virtual XmlDocument SaveLayoutCore()
Returns
System.Xml.XmlDocument

The created document.

SetOrientationCore(Orientation)

Declaration
protected void SetOrientationCore(Orientation newOrientation)
Parameters
System.Windows.Forms.Orientation newOrientation

UnwireEvents()

Declaration
protected virtual void UnwireEvents()

WireEvents()

Declaration
protected virtual void WireEvents()

Events

BeginDragging

Occurs before dragging is started.

Declaration
public event CancelEventHandler BeginDragging
Event Type
System.ComponentModel.CancelEventHandler

Dragging

Occurs when item is being dragged.

Declaration
public event MouseEventHandler Dragging
Event Type
System.Windows.Forms.MouseEventHandler

EndDragging

Occurs when item is released and dragging is stopped.

Declaration
public event EventHandler EndDragging
Event Type
System.EventHandler

FloatingStripCreated

Occurs when a floating strip is created.

Declaration
public event EventHandler FloatingStripCreated
Event Type
System.EventHandler

FloatingStripCreating

Occurs before a floating form is created.

Declaration
public event CancelEventHandler FloatingStripCreating
Event Type
System.ComponentModel.CancelEventHandler

FloatingStripDocked

Occurs when a floating strip is docked.

Declaration
public event EventHandler FloatingStripDocked
Event Type
System.EventHandler

FloatingStripDocking

Occurs before a floating strip is docked.

Declaration
public event CancelEventHandler FloatingStripDocking
Event Type
System.ComponentModel.CancelEventHandler

OrientationChanged

Occurs when Orientation property is changed.

Declaration
public event EventHandler OrientationChanged
Event Type
System.EventHandler

OrientationChanging

Occurs before Orientation property is changed.

Declaration
public event CancelEventHandler OrientationChanging
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods