Class Progress

Definition

Namespace:

Tizen.NUI.Components

Assembly:

Tizen.NUI.Components.dll

The Progress class is used to show the ongoing status with a long narrow bar.

public class Progress : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider, IAtspiValue

Inheritance

object

BindableObject

Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Control

Progress

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

IAtspiValue

Constructors

Progress()

The constructor of Progress

Declaration

public Progress()

Progress(string)

The constructor of the Progress class with specific style.

Declaration

public Progress(string style)

Parameters

Type	Name	Description
string	style	style name

Progress(ProgressStyle)

The constructor of the Progress class with specific style.

Declaration

public Progress(ProgressStyle progressStyle)

Parameters

Type	Name	Description
ProgressStyle	progressStyle	The style object to initialize the Progress.

Fields

BufferColorProperty

BufferColorProperty

Declaration

public static readonly BindableProperty BufferColorProperty

Field Value

Type	Description
BindableProperty

BufferImageURLProperty

BufferImageURLProperty

Declaration

public static readonly BindableProperty BufferImageURLProperty

Field Value

Type	Description
BindableProperty

BufferValueProperty

BufferValueProperty

Declaration

public static readonly BindableProperty BufferValueProperty

Field Value

Type	Description
BindableProperty

CurrentValueProperty

CurrentValueProperty

Declaration

public static readonly BindableProperty CurrentValueProperty

Field Value

Type	Description
BindableProperty

IndeterminateImageUrlProperty

IndeterminateImageUrlProperty

Declaration

public static readonly BindableProperty IndeterminateImageUrlProperty

Field Value

Type	Description
BindableProperty

MaxValueProperty

MaxValueProperty

Declaration

public static readonly BindableProperty MaxValueProperty

Field Value

Type	Description
BindableProperty

MinValueProperty

MinValueProperty

Declaration

public static readonly BindableProperty MinValueProperty

Field Value

Type	Description
BindableProperty

ProgressColorProperty

ProgressColorProperty

Declaration

public static readonly BindableProperty ProgressColorProperty

Field Value

Type	Description
BindableProperty

ProgressImageURLProperty

ProgressImageURLProperty

Declaration

public static readonly BindableProperty ProgressImageURLProperty

Field Value

Type	Description
BindableProperty

ProgressStateProperty

ProgressStateProperty

Declaration

public static readonly BindableProperty ProgressStateProperty

Field Value

Type	Description
BindableProperty

TrackColorProperty

TrackColorProperty

Declaration

public static readonly BindableProperty TrackColorProperty

Field Value

Type	Description
BindableProperty

TrackImageURLProperty

TrackImageURLProperty

Declaration

public static readonly BindableProperty TrackImageURLProperty

Field Value

Type	Description
BindableProperty

Properties

BufferColor

The property to get/set Buffer object color of the Progress.

Declaration

public Color BufferColor { get; set; }

Property Value

Type	Description
Color

BufferImageURL

The property to get/set Buffer object image resource URL of the Progress.

Declaration

public string BufferImageURL { get; set; }

Property Value

Type	Description
string

BufferValue

The property to get/set the buffer value of the Progress.

Declaration

public float BufferValue { get; set; }

Property Value

Type	Description
float

CurrentValue

The property to get/set the current value of the Progress.

Declaration

public float CurrentValue { get; set; }

Property Value

Type	Description
float

IndeterminateImageUrl

The property to get/set the indeterminate image.

Declaration

public string IndeterminateImageUrl { get; set; }

Property Value

Type	Description
string

MaxValue

The property to get/set the maximum value of the Progress.

Declaration

public float MaxValue { get; set; }

Property Value

Type	Description
float

MinValue

The property to get/set the minim value of the Progress.

Declaration

public float MinValue { get; set; }

Property Value

Type	Description
float

ProgressColor

The property to get/set Progress object color of the Progress.

Declaration

public Color ProgressColor { get; set; }

Property Value

Type	Description
Color

ProgressImageURL

The property to get/set Progress object image URL of the Progress.

Declaration

public string ProgressImageURL { get; set; }

Property Value

Type	Description
string

ProgressState

Gets or sets state of progress.

Declaration

public Progress.ProgressStatusType ProgressState { get; set; }

Property Value

Type	Description
Progress.ProgressStatusType

Style

Return currently applied style.

Declaration

public ProgressStyle Style { get; }

Property Value

Type	Description
ProgressStyle

Remarks

Modifying contents in style may cause unexpected behaviour.

TrackColor

The property to get/set Track object color of the Progress.

Declaration

public Color TrackColor { get; set; }

Property Value

Type	Description
Color

TrackImageURL

The property to get/set Track image object URL of the Progress.

Declaration

public string TrackImageURL { get; set; }

Property Value

Type	Description
string

Methods

ApplyStyle(ViewStyle)

Apply style instance to the view. Basically it sets the bindable property to the value of the bindable property with same name in the style.

Declaration

public override void ApplyStyle(ViewStyle style)

Parameters

Type	Name	Description
ViewStyle	style

Overrides

View.ApplyStyle(ViewStyle)

ChangeImageState(ProgressStatusType)

Change Image status

Declaration

protected void ChangeImageState(Progress.ProgressStatusType statusType)

Parameters

Type	Name	Description
Progress.ProgressStatusType	statusType	New status type

CreateViewStyle()

Get Progress style.

Declaration

protected override ViewStyle CreateViewStyle()

Returns

Type	Description
ViewStyle	The default progress style.

Overrides

Control.CreateViewStyle()

Dispose(DisposeTypes)

Dispose Progress and all children on it.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	Dispose type.

Overrides

Control.Dispose(DisposeTypes)

OnEnabled(bool)

Internal callback of enabled property changes. Inherited view can override this method to implements enabled property changes.

Declaration

protected override void OnEnabled(bool enabled)

Parameters

Type	Name	Description
bool	enabled

Overrides

View.OnEnabled(bool)

OnInitialize()

Overrides the parent method. This method is called by the framework when the instance is created.

Declaration

public override void OnInitialize()

Overrides

Control.OnInitialize()

OnRelayout(Vector2, RelayoutContainer)

Called after the size negotiation has been finished for this control.
The control is expected to assign this given size to itself or its children.
Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize, or after changing specific properties.
As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).

Declaration

public override void OnRelayout(Vector2 size, RelayoutContainer container)

Parameters

Type	Name	Description
Vector2	size	The allocated size.
RelayoutContainer	container	The control should add views to this container that it is not able to allocate a size for.

Overrides

Control.OnRelayout(Vector2, RelayoutContainer)

Explicit Interface Implementations

IAtspiValue.AccessibilityGetCurrent()

Gets the current value for Accessibility.

Declaration

double IAtspiValue.AccessibilityGetCurrent()

Returns

Type	Description
double

IAtspiValue.AccessibilityGetMaximum()

Gets maximum value for Accessibility.

Declaration

double IAtspiValue.AccessibilityGetMaximum()

Returns

Type	Description
double

IAtspiValue.AccessibilityGetMinimum()

Gets minimum value for Accessibility.

Declaration

double IAtspiValue.AccessibilityGetMinimum()

Returns

Type	Description
double

IAtspiValue.AccessibilityGetMinimumIncrement()

Declaration

double IAtspiValue.AccessibilityGetMinimumIncrement()

Returns

Type	Description
double

IAtspiValue.AccessibilityGetValueText()

Formatted current value.

Declaration

string IAtspiValue.AccessibilityGetValueText()

Returns

Type	Description
string

IAtspiValue.AccessibilitySetCurrent(double)

Declaration

bool IAtspiValue.AccessibilitySetCurrent(double value)

Parameters

Type	Name	Description
double	value

Returns

Type	Description
bool

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

IAtspiValue

Extension Methods

ViewExtensions.BackgroundColor(View)

ViewExtensions.BorderlineColor(View)

ViewExtensions.BoxShadow(View)

ViewExtensions.Color(View)

ViewExtensions.CornerRadius(View)

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

ViewExtensions.BackgroundColor<T>(T, float, float, float, float)

ViewExtensions.BackgroundColor<T>(T, uint, float)

ViewExtensions.BackgroundColor<T>(T, UIColor)

ViewExtensions.BackgroundImage<T>(T, string)

ViewExtensions.Borderline<T>(T, float, UIColor, float)

ViewExtensions.BorderlineColor<T>(T, float, float, float, float)

ViewExtensions.BorderlineColor<T>(T, uint, float)

ViewExtensions.BorderlineColor<T>(T, UIColor)

ViewExtensions.BorderlineOffset<T>(T, float)

ViewExtensions.BorderlineWidth<T>(T, float)

ViewExtensions.BoxShadow<T>(T, float, float, float)

ViewExtensions.BoxShadow<T>(T, float, UIColor, float, float)

ViewExtensions.BoxShadow<T>(T, UIShadow)

ViewExtensions.ClippingMode<T>(T, ClippingModeType)

ViewExtensions.Color<T>(T, float, float, float, float)

ViewExtensions.Color<T>(T, uint, float)

ViewExtensions.Color<T>(T, UIColor)

ViewExtensions.CornerRadius<T>(T, float, bool)

ViewExtensions.CornerRadius<T>(T, float, float, float, float, bool)

ViewExtensions.CornerRadius<T>(T, UICorner)

ViewExtensions.Focusable<T>(T, bool)

ViewExtensions.FocusableChildren<T>(T, bool)

ViewExtensions.FocusableInTouch<T>(T, bool)

ViewExtensions.ImageShadow<T>(T, ImageShadow)

ViewExtensions.IsEnabled<T>(T, bool)

ViewExtensions.Layout<T>(T, LayoutItem)

ViewExtensions.Opacity<T>(T, float)

ViewExtensions.Position<T>(T, float, float)

ViewExtensions.PositionX<T>(T, float)

ViewExtensions.PositionY<T>(T, float)

ViewExtensions.Scale<T>(T, float, float)

ViewExtensions.ScaleX<T>(T, float)

ViewExtensions.ScaleY<T>(T, float)

ViewExtensions.Sensitive<T>(T, bool)

ViewExtensions.Size<T>(T, float, float)

ViewExtensions.SizeHeight<T>(T, float)

ViewExtensions.SizeWidth<T>(T, float)

ViewExtensions.Visibility<T>(T, bool)

ViewExtensions.VoiceInteractionName<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)