ClassRadWaitingBar
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
RadWaitingBar()
Initializes a new instance of the RadWaitingBar class.
Declaration
public RadWaitingBar()
Properties
AssociatedControl
Gets/Sets the control to associated it. RadWaitingBar will be shown in the middle of the associated control when started.
AssociatedControlCoverPanel
Gets the associated panel.
Declaration
[Browsable(false)]
public RadPanel AssociatedControlCoverPanel { get; }
Property Value
DefaultSize
Sets the DefaultSize of RadWaitingBar
Declaration
protected override Size DefaultSize { get; }
Property Value
Overrides
Image
Gets and sets the image property of the indicator
Declaration
[Browsable(true)]
public Image Image { get; set; }
Property Value
ImageIndex
Gets and sets the image index property of the indicator
Declaration
[Browsable(true)]
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public int ImageIndex { get; set; }
Property Value
ImageKey
Gets and sets the image key property of the indicator
Declaration
[Browsable(true)]
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }
Property Value
IsWaiting
Indicates whether the control is currently waiting
Orientation
Indicates the orientation of the RadWaitingBar
Declaration
[Browsable(true)]
public Orientation Orientation { get; set; }
Property Value
ShowText
Shows text in RadWaitingBar.
Declaration
[Browsable(true)]
public bool ShowText { get; set; }
Property Value
StretchIndicatorsHorizontally
Indicates whether the indicators are stretched horizontally
Declaration
[Browsable(true)]
public bool StretchIndicatorsHorizontally { get; set; }
Property Value
StretchIndicatorsVertically
Indicates whether the indicators are stretched vertically
Declaration
[Browsable(true)]
public bool StretchIndicatorsVertically { get; set; }
Property Value
Text
Gets and sets the text of the control's textElement
Declaration
[Browsable(true)]
public override string Text { get; set; }
Property Value
Overrides
WaitingBarElement
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.
Declaration
[Browsable(false)]
public RadWaitingBarElement WaitingBarElement { get; }
Property Value
WaitingDirection
Gets and sets the WaitingDirection of the RadWaitingBarElement
Declaration
[Browsable(true)]
public ProgressOrientation WaitingDirection { get; set; }
Property Value
WaitingIndicatorSize
Gets and sets the size of the indicator in pixels
Declaration
[Browsable(true)]
public Size WaitingIndicatorSize { get; set; }
Property Value
WaitingIndicators
Gets a collection of BaseWaitingBarIndicatorElement elements which contains all waiting indicators of RadWaitingBar
Declaration
[Browsable(false)]
public WaitingBarIndicatorCollection WaitingIndicators { get; }
Property Value
WaitingSpeed
Gets and sets the speed of the animation. Higher value moves the indicator more quickly across the bar
Declaration
[Browsable(true)]
public int WaitingSpeed { get; set; }
Property Value
WaitingStep
Gets and sets the number of pixels the indicator moves each step
Declaration
[Browsable(true)]
public int WaitingStep { get; set; }
Property Value
WaitingStyle
Sets the style of RadWaitingBar
Declaration
[Browsable(true)]
public WaitingBarStyles WaitingStyle { get; set; }
Property Value
Methods
AddBackgroundImageToAssociatedControlCoverPanel()
Adds a background image to the associated control cover panel to create a visual overlay effect.
Declaration
protected virtual void AddBackgroundImageToAssociatedControlCoverPanel()
CreateAssociatedCoverPanel()
Creates the associated cover panel that will overlay the associated control during waiting operations.
Declaration
protected virtual void CreateAssociatedCoverPanel()
CreateChildItems(RadElement)
Creates the child items for the waiting bar control.
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
The parent element to add child items to.
Overrides
CreateWaitingBarElement()
Creates the waiting bar element.
Declaration
protected virtual RadWaitingBarElement CreateWaitingBarElement()
Returns
A new instance of RadWaitingBarElement.
Dispose(bool)
Releases the unmanaged resources used by the RadWaitingBar and optionally releases the managed resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
disposing
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
OnLoad(Size)
Called when the control is loaded with the specified desired size.
Declaration
protected override void OnLoad(Size desiredSize)
Parameters
desiredSize
The desired size for the control.
Overrides
OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)
Called when a tooltip text is needed for an element.
Declaration
protected override void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
sender
The source of the event.
e
An ToolTipTextNeededEventArgs that contains the event data.
Overrides
ResetBackColorThemeOverrides()
Resets the background color theme overrides for the waiting bar elements.
Declaration
protected override void ResetBackColorThemeOverrides()
Overrides
ResetForeColorThemeOverrides()
Resets the foreground color theme overrides for the waiting bar elements.
Declaration
protected override void ResetForeColorThemeOverrides()
Overrides
ResetWaiting()
Resets the waiting indicator to initial position.
Declaration
public void ResetWaiting()
SetBackColorThemeOverrides()
Sets the background color theme overrides for the waiting bar elements.
Declaration
protected override void SetBackColorThemeOverrides()
Overrides
SetForeColorThemeOverrides()
Sets the foreground color theme overrides for the waiting bar elements.
Declaration
protected override void SetForeColorThemeOverrides()
Overrides
Events
WaitingStarted
Occurs when the waiting animation starts.
WaitingStopped
Occurs when the waiting animation stops.