Class 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.

Inheritance
System.Object
RadControl
RadWaitingBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadWaitingBar : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

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.

Declaration
public Control AssociatedControl { get; set; }
Property Value
System.Windows.Forms.Control

AssociatedControlCoverPanel

Gets the associated panel.

Declaration
public RadPanel AssociatedControlCoverPanel { get; }
Property Value
RadPanel

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

DefaultSize

Sets the DefaultSize of RadWaitingBar

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Image

Gets and sets the image property of the indicator

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

ImageIndex

Gets and sets the image index property of the indicator

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

ImageKey

Gets and sets the image key property of the indicator

Declaration
public string ImageKey { get; set; }
Property Value
System.String

IsWaiting

Indicates whether the control is currently waiting

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

Orientation

Indicates the orientation of the RadWaitingBar

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

ShowText

Shows text in RadWaitingBar.

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

StretchIndicatorsHorizontally

Indicates whether the indicators are stretched horizontally

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

StretchIndicatorsVertically

Indicates whether the indicators are stretched vertically

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

Text

Gets and sets the text of the control's textElement

Declaration
public override string Text { get; set; }
Property Value
System.String

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
public RadWaitingBarElement WaitingBarElement { get; }
Property Value
RadWaitingBarElement

WaitingDirection

Gets and sets the WaitingDirection of the RadWaitingBarElement

Declaration
public ProgressOrientation WaitingDirection { get; set; }
Property Value
ProgressOrientation

WaitingIndicators

Gets a collection of BaseWaitingBarIndicatorElement elements which contains all waiting indicators of RadWaitingBar

Declaration
public WaitingBarIndicatorCollection WaitingIndicators { get; }
Property Value
WaitingBarIndicatorCollection

WaitingIndicatorSize

Gets and sets the size of the indicator in pixels

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

WaitingSpeed

Gets and sets the speed of the animation. Higher value moves the indicator more quickly across the bar

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

WaitingStep

Gets and sets the number of pixels the indicator moves each step

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

WaitingStyle

Sets the style of RadWaitingBar

Declaration
public WaitingBarStyles WaitingStyle { get; set; }
Property Value
WaitingBarStyles

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
RadElement parent

The parent element to add child items to.
Overrides

CreateWaitingBarElement()

Creates the waiting bar element.

Declaration
protected virtual RadWaitingBarElement CreateWaitingBarElement()
Returns
RadWaitingBarElement

A new instance of RadWaitingBarElement.

Dispose(Boolean)

Releases the unmanaged resources used by the RadWaitingBar and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean 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
System.Drawing.Size 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
System.Object sender

The source of the event.
ToolTipTextNeededEventArgs 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

ShouldSerializeWaitingBarElement()

exclude WaitingBarElement from Serialization

Declaration
public bool ShouldSerializeWaitingBarElement()
Returns
System.Boolean

should serialize

StartWaiting()

Starts the waiting animation.

Declaration
public void StartWaiting()

StopWaiting()

Stops the waiting animation.

Declaration
public void StopWaiting()

Events

WaitingStarted

Occurs when the waiting animation starts.

Declaration
public event EventHandler WaitingStarted
Event Type
System.EventHandler

WaitingStopped

Occurs when the waiting animation stops.

Declaration
public event EventHandler WaitingStopped
Event Type
System.EventHandler

Extension Methods