ClassRadWaitingBarElement
Represents a waiting bar element. It may be included in other telerik controls. All graphical and logical functionality is implemented in RadWaitingBarElement.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[ComVisible(false)]
public class RadWaitingBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadWaitingBarElement
Implements:
Inherited Members
Constructors
RadWaitingBarElement()
Initializes a new instance of the RadWaitingBarElement class.
Declaration
public RadWaitingBarElement()
Fields
IsVerticalProperty
Identifies the IsVertical dependency property for controlling vertical orientation of the waiting bar element.
IsWaitingProperty
Identifies the IsWaiting dependency property for indicating the current waiting state of the element.
StretchIndicatorsHorizontallyProperty
Identifies the StretchIndicatorsHorizontally dependency property for controlling horizontal stretching of indicators.
Declaration
public static RadProperty StretchIndicatorsHorizontallyProperty
Field Value
StretchIndicatorsVerticallyProperty
Identifies the StretchIndicatorsVertically dependency property for controlling vertical stretching of indicators.
Declaration
public static RadProperty StretchIndicatorsVerticallyProperty
Field Value
WaitingBarOrientationProperty
Identifies the WaitingBarOrientation dependency property for controlling the orientation of the waiting bar.
Declaration
public static RadProperty WaitingBarOrientationProperty
Field Value
WaitingDirectionProperty
Identifies the WaitingDirection dependency property for controlling the direction of the waiting animation.
Declaration
public static RadProperty WaitingDirectionProperty
Field Value
WaitingIndicatorSizeProperty
Identifies the WaitingIndicatorSize dependency property for controlling the size of waiting indicators.
Declaration
public static RadProperty WaitingIndicatorSizeProperty
Field Value
WaitingSpeedProperty
Identifies the WaitingSpeed dependency property for controlling the speed of the waiting animation.
Declaration
public static RadProperty WaitingSpeedProperty
Field Value
WaitingStepProperty
Identifies the WaitingStep dependency property for controlling the step size of the waiting animation.
continueWaiting
Indicates whether waiting should continue when conditions allow
Properties
ContentElement
Gets an instance of the WaitingBarContentElement class that represents the waiting bar content element
Declaration
[Browsable(false)]
public WaitingBarContentElement ContentElement { get; }
Property Value
IndicatorImage
Gets and sets the Image of the element's indicator
Declaration
[Browsable(true)]
public Image IndicatorImage { get; set; }
Property Value
IndicatorImageIndex
Gets and sets the ImageIndex of the element's indicator
Declaration
[Browsable(true)]
public int IndicatorImageIndex { get; set; }
Property Value
IndicatorImageKey
Gets and sets the ImageKey of the element's indicator
Declaration
[Browsable(true)]
public string IndicatorImageKey { get; set; }
Property Value
IsWaiting
Indicates whether the element is currently waiting
SeparatorElement
Gets an instance of the WaitingBarSeparatorElement class that represents the waiting bar separator element
Declaration
[Browsable(false)]
public WaitingBarSeparatorElement SeparatorElement { get; }
Property Value
ShowText
Shows text in RadWaitingBarElement.
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
TextElement
Gets an instance of the WaitingBarTextElement class that represents the waiting bar text element
Declaration
[Browsable(false)]
public WaitingBarTextElement TextElement { get; }
Property Value
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
[Browsable(true)]
public virtual Orientation WaitingBarOrientation { get; set; }
Property Value
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
[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
public WaitingBarIndicatorCollection WaitingIndicators { get; }
Property Value
WaitingSpeed
Gets and sets the speed of the indicator Greater value results in faster indicator Range: [0, 100]
Declaration
[Browsable(true)]
public int WaitingSpeed { get; set; }
Property Value
WaitingStep
Gets and sets the step in pixels which moves the indicator
Declaration
[Browsable(true)]
public int WaitingStep { get; set; }
Property Value
WaitingStyle
Sets the style of the WaitingBarElement
Declaration
[Browsable(true)]
public WaitingBarStyles WaitingStyle { get; set; }
Property Value
Methods
ArrangeOverride(SizeF)
Arranges the content of the waiting bar element within the specified final size.
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
direction
The progress orientation direction.
Returns
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.
OnPropertyChanged(RadPropertyChangedEventArgs)
Called when a property value changes.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
The RadPropertyChangedEventArgs instance containing the event data.
Overrides
OnStartWaiting(EventArgs)
Raises the WaitingStarted event.
OnStopWaiting(EventArgs)
Raises the WaitingStopped event.
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
direction
The progress orientation direction.
Events
WaitingStarted
Occurs when waiting is started.
WaitingStopped
Occurs when waiting is stopped.