Class Control

Definition

Namespace:
Tizen.NUI.Components
Assembly:
Tizen.NUI.Components.dll
API Level:
6

The control component is base class of tv nui components. It's abstract class, so can't instantiate and can only be inherited.

C#
Copy
public class Control : VisualView, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
Inheritance
Derived
Implements

Constructors

View Source

Control()

Construct an empty Control.

Declaration
C#
Copy
public Control()
API Level: 6
View Source

Control(String)

Construct with style name

Declaration
C#
Copy
public Control(string styleName)
Parameters
Type Name Description
String styleName

The name of style in the current theme to be applied

API Level: 6
View Source

Control(ControlStyle)

Construct with style.

Declaration
C#
Copy
public Control(ControlStyle style)
Parameters
Type Name Description
ControlStyle style

Create control with style.

API Level: 6

Fields

View Source

CommandParameterProperty

Declaration
C#
Copy
public static readonly BindableProperty CommandParameterProperty
Field Value
Type Description
BindableProperty
View Source

CommandProperty

Declaration
C#
Copy
public static readonly BindableProperty CommandProperty
Field Value
Type Description
BindableProperty
View Source

FeedbackProperty

FeedbackProperty

Declaration
C#
Copy
public static readonly BindableProperty FeedbackProperty
Field Value
Type Description
BindableProperty

Properties

View Source

Command

Declaration
C#
Copy
public ICommand Command { get; set; }
Property Value
Type Description
ICommand
View Source

CommandParameter

Declaration
C#
Copy
public object CommandParameter { get; set; }
Property Value
Type Description
Object
View Source

Feedback

Enable/Disable a sound feedback when tap gesture detected.

Declaration
C#
Copy
public bool Feedback { get; set; }
Property Value
Type Description
Boolean

Methods

View Source

CreateViewStyle()

Declaration
C#
Copy
protected override ViewStyle CreateViewStyle()
Returns
Type Description
ViewStyle
Overrides
View Source

Dispose(DisposeTypes)

Dispose Control and all children on it.

Declaration
C#
Copy
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

Dispose type.

Overrides
API Level: 6
View Source

OnFocusGained()

Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is gained.

Declaration
C#
Copy
public override void OnFocusGained()
Overrides
API Level: 6
View Source

OnFocusLost()

Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when the focus is lost.

Declaration
C#
Copy
public override void OnFocusLost()
Overrides
API Level: 6
View Source

OnInitialize()

Overrides the parent method.

Declaration
C#
Copy
public override void OnInitialize()
Overrides
View Source

OnKey(Key)

Called after a key event is received by the view that has had its focus set.

Declaration
C#
Copy
public override bool OnKey(Key key)
Parameters
Type Name Description
Key key

The key event.

Returns
Type Description
Boolean

True if the key event should be consumed.

Overrides
API Level: 6
View Source

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
C#
Copy
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
API Level: 6
View Source

OnThemeChanged(Object, ThemeChangedEventArgs)

Declaration
C#
Copy
protected override void OnThemeChanged(object sender, ThemeChangedEventArgs e)
Parameters
Type Name Description
Object sender
ThemeChangedEventArgs e
Overrides
View Source

OnThemeChangedEvent(Object, StyleManager.ThemeChangeEventArgs)

Theme change callback when theme is changed, this callback will be trigger. Note that it is deprecated API.Please use OnThemeChanged instead.

Declaration
C#
Copy
protected virtual void OnThemeChangedEvent(object sender, StyleManager.ThemeChangeEventArgs e)
Parameters
Type Name Description
Object sender

The sender

StyleManager.ThemeChangeEventArgs e

The event data

API Level: 6
View Source

OnUpdate()

Update by style.

Declaration
C#
Copy
protected virtual void OnUpdate()
API Level: 6
View Source

PassFocusableViewInsideIfNeeded()

when the derived class of Control is used as container and itself is not Focusable, this can be used when calling SetCurrentFocusView() this can return Focusable View inside of itself. this can be utilized when default algorithm is enabled and when the case of setting first key focus in container.

Declaration
C#
Copy
protected virtual View PassFocusableViewInsideIfNeeded()
Returns
Type Description
View

Focusable View inside of container

View Source

Preload()

This is used to improve theme performance.

Declaration
C#
Copy
public static void Preload()

Implements

Extension Methods