ClassRadCommandBarElement
Represents the main element of the RadCommandBar control. Contains a collection of CommandBarRowElement element.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadCommandBarElement : RadCommandBarVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadCommandBarVisualElementRadCommandBarElement
Derived Classes:
Implements:
Inherited Members
Constructors
RadCommandBarElement()
Declaration
public RadCommandBarElement()Fields
lines
Declaration
protected RadCommandBarLinesElementCollection linesField Value
Properties
DragSize
Gets or sets the size in pixels when current strip is being Drag and Drop in next or previous row
Orientation
Gets or sets the orientation of the RadCommandBarElement.
Declaration
[Browsable(false)]
public override Orientation Orientation { get; set; }Property Value
Overrides
Rows
Gets the rows of the RadCommandBarElement.
Declaration
[RadEditItemsAction]
[RadNewItem("", false, true, true)]
public RadCommandBarLinesElementCollection Rows { get; }Property Value
StripInfoHolder
Gets the CommandBarStripInfoHolder object that provides information about strips owned by the RadCommandBarElement.
Declaration
public CommandBarStripInfoHolder StripInfoHolder { get; set; }Property Value
Methods
ArrangeOverride(SizeF)
Arranges the command bar element and its children within their allocated space.
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
stripElement
The strip element of which the floating form should be created.
currentRow
The that contains the strip element.
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
changed
RadCommandBarLinesElementCollection
target
operation
LoadLayout(Stream)
Loads the visual state of the RadCommandBarElement from a specified stream.
Declaration
public void LoadLayout(Stream source)Parameters
source
The source stream.
LoadLayout(XmlReader)
Loads the visual state of the RadCommandBarElement from a specified XmlReader.
Declaration
public void LoadLayout(XmlReader xmlReader)Parameters
xmlReader
The XmlReader to read the visual state data.
LoadLayout(string)
Loads the visual state of the RadCommandBarElement from a specified file.
Declaration
public void LoadLayout(string filename)Parameters
filename
The name of the file containing 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
doc
The document containing the visual state data.
MeasureOverride(SizeF)
Performs the measure pass of the command bar element's layout process.
MoveToDownerLine(CommandBarStripElement, CommandBarRowElement)
Moves a specific CommandBarStripElement to the lower CommandBarRowElement.
Declaration
public void MoveToDownerLine(CommandBarStripElement element, CommandBarRowElement currentHolder)Parameters
element
The element to move.
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
element
The element to move.
currentHolder
The CommandBarRowElement that contains the element to move.
OnBeginDragging(object, CancelEventArgs)
Raises the event
Declaration
protected virtual void OnBeginDragging(object sender, CancelEventArgs args)Parameters
sender
The element that is responsible for firing the event.
args
A 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
sender
The RadElement that initiated the event.
args
The event data.
Overrides
OnDragging(object, MouseEventArgs)
Raises the event
Declaration
protected virtual void OnDragging(object sender, MouseEventArgs args)Parameters
sender
The element that is responsible for firing the event.
args
A MouseEventArgs that contains the event data.
OnEndDragging(object, EventArgs)
Raises the event
OnFloatingStripCreated(object)
Raises the event.
Declaration
protected virtual void OnFloatingStripCreated(object sender)Parameters
sender
The element that is responsible for firing the event - usually this is the strip that is made floating.
OnFloatingStripCreating(object)
Raises the event.
Declaration
protected virtual bool OnFloatingStripCreating(object sender)Parameters
sender
The element that is responsible for firing the event - usually this is the strip that is going to be floating.
Returns
True if the creating of a floating form should be canceled, False otherwise.
OnFloatingStripDocked(object)
Raises the event.
Declaration
protected virtual void OnFloatingStripDocked(object sender)Parameters
sender
The element that is responsible for firing the event - usually this is the strip that was docked.
OnFloatingStripDocking(object)
Raises the event.
Declaration
protected virtual bool OnFloatingStripDocking(object sender)Parameters
sender
The element that is responsible for firing the event - usually this is the strip that is going to be docked.
Returns
True if the docking of a floating form should be canceled, False otherwise.
OnOrientationChanged(EventArgs)
Raises the event
OnOrientationChanging(CancelEventArgs)
Raises the event.
Declaration
protected virtual bool OnOrientationChanging(CancelEventArgs e)Parameters
e
A CancelEventArgs that contains the event data.
Returns
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
sender
The RadElement that initiated the event.
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
destination
The destination stream.
SaveLayout(XmlWriter)
Saves the visual state of the RadCommandBarElement to a specified XmlWriter.
Declaration
public void SaveLayout(XmlWriter writer)Parameters
writer
The XmlWriter to save the visual state data.
SaveLayout(string)
Saves the visual state of the RadCommandBarElement to a specified file.
Declaration
public void SaveLayout(string filename)Parameters
filename
The name of the destination file.
SaveLayoutCore()
Creates an XmlDocument containing the current visual state data of the RadCommandBarElement.
Declaration
protected virtual XmlDocument SaveLayoutCore()Returns
The created document.
SetOrientationCore(Orientation)
Declaration
protected void SetOrientationCore(Orientation newOrientation)Parameters
newOrientation
UnwireEvents()
Declaration
protected virtual void UnwireEvents()WireEvents()
Declaration
protected virtual void WireEvents()Events
BeginDragging
Occurs before dragging is started.
Declaration
public event CancelEventHandler BeginDraggingEvent Value
Dragging
Occurs when item is being dragged.
EndDragging
Occurs when item is released and dragging is stopped.
FloatingStripCreated
Occurs when a floating strip is created.
Declaration
public event EventHandler FloatingStripCreatedEvent Value
FloatingStripCreating
Occurs before a floating form is created.
Declaration
public event CancelEventHandler FloatingStripCreatingEvent Value
FloatingStripDocked
Occurs when a floating strip is docked.
Declaration
public event EventHandler FloatingStripDockedEvent Value
FloatingStripDocking
Occurs before a floating strip is docked.
Declaration
public event CancelEventHandler FloatingStripDockingEvent Value
OrientationChanged
Occurs when Orientation property is changed.
OrientationChanging
Occurs before Orientation property is changed.
Declaration
public event CancelEventHandler OrientationChangingEvent Value