Class RadWaitingBarElement

Represents a waiting bar element. It may be included in other telerik controls. All graphical and logical functionality is implemented in RadWaitingBarElement.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadWaitingBarElement
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

[ComVisible(false)]
public class RadWaitingBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadWaitingBarElement()

Initializes a new instance of the RadWaitingBarElement class.

Declaration
public RadWaitingBarElement()

Fields

continueWaiting

Indicates whether waiting should continue when conditions allow

Declaration
protected bool continueWaiting
Field Value
System.Boolean

IsVerticalProperty

Identifies the IsVertical dependency property for controlling vertical orientation of the waiting bar element.

Declaration
public static RadProperty IsVerticalProperty
Field Value
RadProperty

IsWaitingProperty

Identifies the IsWaiting dependency property for indicating the current waiting state of the element.

Declaration
public static RadProperty IsWaitingProperty
Field Value
RadProperty

StretchIndicatorsHorizontallyProperty

Identifies the StretchIndicatorsHorizontally dependency property for controlling horizontal stretching of indicators.

Declaration
public static RadProperty StretchIndicatorsHorizontallyProperty
Field Value
RadProperty

StretchIndicatorsVerticallyProperty

Identifies the StretchIndicatorsVertically dependency property for controlling vertical stretching of indicators.

Declaration
public static RadProperty StretchIndicatorsVerticallyProperty
Field Value
RadProperty

timer

The timer used for controlling the waiting animation

Declaration
protected Timer timer
Field Value
System.Windows.Forms.Timer

WaitingBarOrientationProperty

Identifies the WaitingBarOrientation dependency property for controlling the orientation of the waiting bar.

Declaration
public static RadProperty WaitingBarOrientationProperty
Field Value
RadProperty

WaitingDirectionProperty

Identifies the WaitingDirection dependency property for controlling the direction of the waiting animation.

Declaration
public static RadProperty WaitingDirectionProperty
Field Value
RadProperty

WaitingIndicatorSizeProperty

Identifies the WaitingIndicatorSize dependency property for controlling the size of waiting indicators.

Declaration
public static RadProperty WaitingIndicatorSizeProperty
Field Value
RadProperty

WaitingSpeedProperty

Identifies the WaitingSpeed dependency property for controlling the speed of the waiting animation.

Declaration
public static RadProperty WaitingSpeedProperty
Field Value
RadProperty

WaitingStepProperty

Identifies the WaitingStep dependency property for controlling the step size of the waiting animation.

Declaration
public static RadProperty WaitingStepProperty
Field Value
RadProperty

Properties

ContentElement

Gets an instance of the WaitingBarContentElement class that represents the waiting bar content element

Declaration
public WaitingBarContentElement ContentElement { get; }
Property Value
WaitingBarContentElement

IndicatorImage

Gets and sets the Image of the element's indicator

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

IndicatorImageIndex

Gets and sets the ImageIndex of the element's indicator

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

IndicatorImageKey

Gets and sets the ImageKey of the element's indicator

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

IsWaiting

Indicates whether the element is currently waiting

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

SeparatorElement

Gets an instance of the WaitingBarSeparatorElement class that represents the waiting bar separator element

Declaration
public WaitingBarSeparatorElement SeparatorElement { get; }
Property Value
WaitingBarSeparatorElement

ShowText

Shows text in RadWaitingBarElement.

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

TextElement

Gets an instance of the WaitingBarTextElement class that represents the waiting bar text element

Declaration
public WaitingBarTextElement TextElement { get; }
Property Value
WaitingBarTextElement

WaitingBarOrientation

When set to vertical the RadWaitingBar WaitingDirection property is set to Bottom When set to horizontal the RadWaitingBar WaitingDirection is property is set to Right

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

WaitingDirection

Gets and sets the direction of waiting, e.g. the Right value moves the indicator from left to right Range: Bottom, Left, Right, Top

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 indicator Greater value results in faster indicator Range: [0, 100]

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

WaitingStep

Gets and sets the step in pixels which moves the indicator

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

WaitingStyle

Sets the style of the WaitingBarElement

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

Methods

ArrangeOverride(SizeF)

Arranges the content of the waiting bar element within the specified final size.

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

CreateChildElements()

Creates the child elements of the waiting bar element.

Declaration
protected override void CreateChildElements()
Overrides

DisposeManagedResources()

Releases the managed resources used by the RadWaitingBarElement.

Declaration
protected override void DisposeManagedResources()
Overrides

GetTransformAngle(ProgressOrientation)

Gets the transform angle for the specified progress orientation.

Declaration
protected virtual float GetTransformAngle(ProgressOrientation direction)
Parameters
ProgressOrientation direction

The progress orientation direction.
Returns
System.Single

The transform angle in degrees.

InitializeFields()

Initializes the fields and default values for the waiting bar element.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the desired size of the waiting bar element within the specified available size.

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

The available size that can be given to child elements.
Returns
System.Drawing.SizeF

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

OnPropertyChanged(RadPropertyChangedEventArgs)

Called when a property value changes.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs instance containing the event data.
Overrides

OnStartWaiting(EventArgs)

Raises the WaitingStarted event.

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

The System.EventArgs instance containing the event data.

OnStopWaiting(EventArgs)

Raises the WaitingStopped event.

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

The System.EventArgs instance containing the event data.

OnWaitingStep()

Handles the waiting step animation by incrementing the indicator offset or animating individual indicators.

Declaration
protected virtual void OnWaitingStep()

ResetWaiting()

Sets the indicator to its starting position depending on the WaitingDirection

Declaration
public void ResetWaiting()

StartWaiting()

Starts the waiting process

Declaration
public virtual void StartWaiting()

StopWaiting()

Stops the waiting process

Declaration
public virtual void StopWaiting()

TransformElements()

Transforms the elements according to the current waiting direction.

Declaration
protected virtual void TransformElements()

UpdateElementsState(ProgressOrientation)

Updates the state of elements based on the specified progress orientation.

Declaration
protected virtual void UpdateElementsState(ProgressOrientation direction)
Parameters
ProgressOrientation direction

The progress orientation direction.

Events

WaitingStarted

Occurs when waiting is started.

Declaration
public event EventHandler WaitingStarted
Event Type
System.EventHandler

WaitingStopped

Occurs when waiting is stopped.

Declaration
public event EventHandler WaitingStopped
Event Type
System.EventHandler

Extension Methods