RadWaitingBar
The RadWaitingBar class is a simple wrapper for the RadWaitingBarElement class. The latter implements all UI and logic functionality. The RadWaitingBar class acts to transfer events to and from the RadWaitingBarElement class. RadWaitingBarElement can be nested in other telerik controls.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadWaitingBar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadWaitingBar...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadWaitingBar class.
public RadWaitingBar()
Properties
Gets/Sets the control to associated it. RadWaitingBar will be shown in the middle of the associated control when started.
public Control AssociatedControl { get; set; }
Gets the associated panel.
[Browsable(false)]
public RadPanel AssociatedControlCoverPanel { get; }
Sets the DefaultSize of RadWaitingBar
protected override Size DefaultSize { get; }
Overrides:
Gets and sets the image property of the indicator
[Browsable(true)]
public Image Image { get; set; }
Gets and sets the image index property of the indicator
[Browsable(true)]
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.2.702.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public int ImageIndex { get; set; }
Gets and sets the image key property of the indicator
[Browsable(true)]
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.2.702.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }
Indicates whether the control is currently waiting
[Browsable(false)]
public bool IsWaiting { get; }
Indicates the orientation of the RadWaitingBar
[Browsable(true)]
public Orientation Orientation { get; set; }
Indicates whether the indicators are stretched horizontally
[Browsable(true)]
public bool StretchIndicatorsHorizontally { get; set; }
Indicates whether the indicators are stretched vertically
[Browsable(true)]
public bool StretchIndicatorsVertically { get; set; }
Gets and sets the text of the control's textElement
[Browsable(true)]
public override string Text { get; set; }
Overrides:
Gets the instance of RadWaitingBarElement wrapped by this control. RadWaitingBarElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadWaitingBar.
[Browsable(false)]
public RadWaitingBarElement WaitingBarElement { get; }
Gets and sets the WaitingDirection of the RadWaitingBarElement
[Browsable(true)]
public ProgressOrientation WaitingDirection { get; set; }
Gets a collection of BaseWaitingBarIndicatorElement elements which contains all waiting indicators of RadWaitingBar
[Browsable(false)]
public WaitingBarIndicatorCollection WaitingIndicators { get; }
Gets and sets the size of the indicator in pixels
[Browsable(true)]
public Size WaitingIndicatorSize { get; set; }
Gets and sets the speed of the animation. Higher value moves the indicator more quickly across the bar
[Browsable(true)]
public int WaitingSpeed { get; set; }
Gets and sets the number of pixels the indicator moves each step
[Browsable(true)]
public int WaitingStep { get; set; }
Sets the style of RadWaitingBar
[Browsable(true)]
public WaitingBarStyles WaitingStyle { get; set; }
Methods
Adds a background image to the associated control cover panel to create a visual overlay effect.
protected virtual void AddBackgroundImageToAssociatedControlCoverPanel()
Creates the associated cover panel that will overlay the associated control during waiting operations.
protected virtual void CreateAssociatedCoverPanel()
Creates the child items for the waiting bar control.
protected override void CreateChildItems(RadElement parent)
The parent element to add child items to.
Overrides:
Creates the waiting bar element.
protected virtual RadWaitingBarElement CreateWaitingBarElement()
A new instance of RadWaitingBarElement.
Releases the unmanaged resources used by the RadWaitingBar and optionally releases the managed resources.
protected override void Dispose(bool disposing)
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Called when the control is loaded with the specified desired size.
protected override void OnLoad(Size desiredSize)
The desired size for the control.
Overrides:
Called when a tooltip text is needed for an element.
protected override void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
The source of the event.
eToolTipTextNeededEventArgsAn ToolTipTextNeededEventArgs that contains the event data.
Overrides:
Resets the background color theme overrides for the waiting bar elements.
protected override void ResetBackColorThemeOverrides()
Overrides:
Resets the foreground color theme overrides for the waiting bar elements.
protected override void ResetForeColorThemeOverrides()
Overrides:
Resets the waiting indicator to initial position.
public void ResetWaiting()
Sets the background color theme overrides for the waiting bar elements.
protected override void SetBackColorThemeOverrides()
Overrides:
Sets the foreground color theme overrides for the waiting bar elements.
protected override void SetForeColorThemeOverrides()
Overrides:
Starts the waiting animation.
public void StartWaiting()
Stops the waiting animation.
public void StopWaiting()
Events
Occurs when the waiting animation starts.
public event EventHandler WaitingStarted
Occurs when the waiting animation stops.
public event EventHandler WaitingStopped