RadWaitingBarElement
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
Initializes a new instance of the RadWaitingBarElement class.
public RadWaitingBarElement()
Fields
Indicates whether waiting should continue when conditions allow
protected bool continueWaiting
Identifies the IsVertical dependency property for controlling vertical orientation of the waiting bar element.
public static RadProperty IsVerticalProperty
Identifies the IsWaiting dependency property for indicating the current waiting state of the element.
public static RadProperty IsWaitingProperty
Identifies the StretchIndicatorsHorizontally dependency property for controlling horizontal stretching of indicators.
public static RadProperty StretchIndicatorsHorizontallyProperty
Identifies the StretchIndicatorsVertically dependency property for controlling vertical stretching of indicators.
public static RadProperty StretchIndicatorsVerticallyProperty
Identifies the WaitingBarOrientation dependency property for controlling the orientation of the waiting bar.
public static RadProperty WaitingBarOrientationProperty
Identifies the WaitingDirection dependency property for controlling the direction of the waiting animation.
public static RadProperty WaitingDirectionProperty
Identifies the WaitingIndicatorSize dependency property for controlling the size of waiting indicators.
public static RadProperty WaitingIndicatorSizeProperty
Identifies the WaitingSpeed dependency property for controlling the speed of the waiting animation.
public static RadProperty WaitingSpeedProperty
Identifies the WaitingStep dependency property for controlling the step size of the waiting animation.
public static RadProperty WaitingStepProperty
Properties
Gets an instance of the WaitingBarContentElement class that represents the waiting bar content element
[Browsable(false)]
public WaitingBarContentElement ContentElement { get; }
Gets and sets the Image of the element's indicator
[Browsable(true)]
public Image IndicatorImage { get; set; }
Gets and sets the ImageIndex of the element's indicator
[Browsable(true)]
public int IndicatorImageIndex { get; set; }
Gets and sets the ImageKey of the element's indicator
[Browsable(true)]
public string IndicatorImageKey { get; set; }
Indicates whether the element is currently waiting
[Browsable(false)]
public bool IsWaiting { get; }
Gets an instance of the WaitingBarSeparatorElement class that represents the waiting bar separator element
[Browsable(false)]
public WaitingBarSeparatorElement SeparatorElement { get; }
Shows text in RadWaitingBarElement.
[Browsable(true)]
public bool ShowText { 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 an instance of the WaitingBarTextElement class that represents the waiting bar text element
[Browsable(false)]
public WaitingBarTextElement TextElement { get; }
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
[Browsable(true)]
public virtual Orientation WaitingBarOrientation { get; set; }
Gets and sets the direction of waiting, e.g. the Right value moves the indicator from left to right Range: Bottom, Left, Right, Top
[Browsable(true)]
public ProgressOrientation WaitingDirection { get; set; }
Gets a collection of BaseWaitingBarIndicatorElement elements which contains all waiting indicators of RadWaitingBar
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 indicator Greater value results in faster indicator Range: [0, 100]
[Browsable(true)]
public int WaitingSpeed { get; set; }
Gets and sets the step in pixels which moves the indicator
[Browsable(true)]
public int WaitingStep { get; set; }
Sets the style of the WaitingBarElement
[Browsable(true)]
public WaitingBarStyles WaitingStyle { get; set; }
Methods
Arranges the content of the waiting bar element within the specified final size.
Creates the child elements of the waiting bar element.
protected override void CreateChildElements()
Overrides:
Releases the managed resources used by the RadWaitingBarElement.
protected override void DisposeManagedResources()
Overrides:
Gets the transform angle for the specified progress orientation.
protected virtual float GetTransformAngle(ProgressOrientation direction)
The progress orientation direction.
Returns:The transform angle in degrees.
Initializes the fields and default values for the waiting bar element.
protected override void InitializeFields()
Overrides:
Measures the desired size of the waiting bar element within the specified available size.
Called when a property value changes.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
The RadPropertyChangedEventArgs instance containing the event data.
Overrides:
Raises the WaitingStarted event.
Raises the WaitingStopped event.
Handles the waiting step animation by incrementing the indicator offset or animating individual indicators.
protected virtual void OnWaitingStep()
Sets the indicator to its starting position depending on the WaitingDirection
public void ResetWaiting()
Starts the waiting process
public virtual void StartWaiting()
Stops the waiting process
public virtual void StopWaiting()
Transforms the elements according to the current waiting direction.
protected virtual void TransformElements()
Updates the state of elements based on the specified progress orientation.
protected virtual void UpdateElementsState(ProgressOrientation direction)
The progress orientation direction.
Events
Occurs when waiting is started.
public event EventHandler WaitingStarted
Occurs when waiting is stopped.
public event EventHandler WaitingStopped