Class Loading

Definition

Namespace:

Tizen.NUI.Components

Assembly:

Tizen.NUI.Components.dll

The Loading class of nui component. It's used to indicate informs users of the ongoing operation.

public class Loading : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider

Inheritance

object

BindableObject

Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Control

Loading

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Constructors

Loading()

The constructor of Loading.

Declaration

public Loading()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Loading(string)

Constructor of the Loading class with special style.

Declaration

public Loading(string style)

Parameters

Type	Name	Description
string	style	The string to initialize the Loading.

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Loading(LoadingStyle)

The constructor of the Loading class with specific style.

Declaration

public Loading(LoadingStyle loadingStyle)

Parameters

Type	Name	Description
LoadingStyle	loadingStyle	The style object to initialize the Loading.

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Fields

FrameRateProperty

The FrameRate bindable property.

Declaration

public static readonly BindableProperty FrameRateProperty

Field Value

Type	Description
BindableProperty

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

ImageArrayProperty

ImageArrayProperty

Declaration

public static readonly BindableProperty ImageArrayProperty

Field Value

Type	Description
BindableProperty

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

ImageListProperty

The ImageList bindable property.

Declaration

public static readonly BindableProperty ImageListProperty

Field Value

Type	Description
BindableProperty

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

LottieResourceUrlProperty

The lottie resource url bindable property.

Declaration

public static readonly BindableProperty LottieResourceUrlProperty

Field Value

Type	Description
BindableProperty

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

SizeProperty

The Size bindable property.

Declaration

public static readonly BindableProperty SizeProperty

Field Value

Type	Description
BindableProperty

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Properties

FrameRate

Gets or sets frame rate of loading.

Declaration

public int FrameRate { get; set; }

Property Value

Type	Description
int

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

ImageArray

Gets or sets loading image resource array. The mutually exclusive with "LottieResourceUrl".

Declaration

public string[] ImageArray { get; set; }

Property Value

Type	Description
string[]

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

ImageList

Gets loading image resource array.

Declaration

public IList<string> ImageList { get; }

Property Value

Type	Description
IList<><string>

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

LottieResourceUrl

Gets or sets an lottie resource url. The mutually exclusive with "ImageArray".

Declaration

public string LottieResourceUrl { get; set; }

Property Value

Type	Description
string

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Size

Gets or sets loading size.

Declaration

public Size Size { get; set; }

Property Value

Type	Description
Size

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Style

Return currently applied style.

Declaration

public LoadingStyle Style { get; }

Property Value

Type	Description
LoadingStyle

Remarks

Modifying contents in style may cause unexpected behaviour.

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 viewStyle)

Parameters

Type	Name	Description
ViewStyle	viewStyle

Overrides

View.ApplyStyle(ViewStyle)

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

CreateViewStyle()

Get Loading style.

Declaration

protected override ViewStyle CreateViewStyle()

Returns

Type	Description
ViewStyle	The default loading style.

Overrides

Control.CreateViewStyle()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Dispose(DisposeTypes)

Dispose Loading.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	Dispose type.

Overrides

Control.Dispose(DisposeTypes)

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

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()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Pause()

Pause Loading Animation.

Declaration

public void Pause()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Play()

Play Loading Animation.

Declaration

public void Play()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Stop()

Stop Loading Animation.

Declaration

public void Stop()

Remarks

The Loading is created as LottieAnimationView first. When the user sets ImageArray separately, the image is changed to ImageVisual.

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

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)