Class TextLabel

Definition

Namespace:

Tizen.NUI.BaseComponents

Assembly:

Tizen.NUI.dll

API Level:

3

A control which renders a short text string.
Text labels are lightweight, non-editable, and do not respond to the user input.

public class TextLabel : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider

Inheritance

Object

Tizen.NUI.Binding.BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animatable

Container

View

TextLabel

Implements

INotifyPropertyChanged

IDisposable

Constructors

TextLabel()

Creates the TextLabel control.

Declaration

public TextLabel()

API Level: 3

TextLabel(String)

Creates the TextLabel control.

Declaration

public TextLabel(string text)

Parameters

Type	Name	Description
String	text	The text to display

API Level: 3

Properties

AutoScrollGap

The AutoScrollGap property.
Gap before scrolling wraps.

Declaration

public float AutoScrollGap { get; set; }

Property Value

Type	Description
Single

API Level: 3

AutoScrollLoopCount

The AutoScrollLoopCount property.
Number of complete loops when scrolling enabled.

Declaration

public int AutoScrollLoopCount { get; set; }

Property Value

Type	Description
Int32

API Level: 3

AutoScrollLoopDelay

The AutoScrollLoopDelay property.
Do something.

Declaration

public float AutoScrollLoopDelay { get; set; }

Property Value

Type	Description
Single

API Level: 3

AutoScrollSpeed

The AutoScrollSpeed property.
Sets the speed of scrolling in pixels per second.

Declaration

public int AutoScrollSpeed { get; set; }

Property Value

Type	Description
Int32

API Level: 3

AutoScrollStopMode

The AutoScrollStopMode property.
Do something.

Declaration

public AutoScrollStopMode AutoScrollStopMode { get; set; }

Property Value

Type	Description
AutoScrollStopMode

API Level: 3

Ellipsis

The Ellipsis property.
Enable or disable the ellipsis.

Declaration

public bool Ellipsis { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

Emboss

The Emboss property.
The default emboss parameters.

Declaration

public string Emboss { get; set; }

Property Value

Type	Description
String

API Level: 3

EnableAutoScroll

The EnableAutoScroll property.
Starts or stops auto scrolling.

Declaration

public bool EnableAutoScroll { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

EnableMarkup

The EnableMarkup property.
Whether the mark-up processing is enabled.

Declaration

public bool EnableMarkup { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

FontFamily

The FontFamily property.
The requested font family to use.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
String

API Level: 3

FontStyle

The FontStyle property.
The requested font style to use.

Declaration

public PropertyMap FontStyle { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

HorizontalAlignment

The HorizontalAlignment property.
The line horizontal alignment.

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

API Level: 3

LineCount

The line count of the text.

Declaration

public int LineCount { get; }

Property Value

Type	Description
Int32

API Level: 3

LineSpacing

The LineSpacing property.
The default extra space between lines in points.

Declaration

public float LineSpacing { get; set; }

Property Value

Type	Description
Single

API Level: 3

LineWrapMode

The LineWrapMode property.
line wrap mode when the text lines over layout width.

Declaration

public LineWrapMode LineWrapMode { get; set; }

Property Value

Type	Description
LineWrapMode

API Level: 4

MatchSystemLanguageDirection

The text alignment to match the direction of the system language.

Declaration

public bool MatchSystemLanguageDirection { get; set; }

Property Value

Type	Description
Boolean

API Level: 6

MultiLine

The MultiLine property.
The single-line or multi-line layout option.

Declaration

public bool MultiLine { get; set; }

Property Value

Type	Description
Boolean

API Level: 3

Outline

The Outline property.
The default outline parameters.

Declaration

public PropertyMap Outline { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

PixelSize

The PixelSize property.
The size of font in pixels.

Declaration

public float PixelSize { get; set; }

Property Value

Type	Description
Single

API Level: 3

PointSize

The PointSize property.
The size of font in points.

Declaration

public float PointSize { get; set; }

Property Value

Type	Description
Single

API Level: 3

Shadow

The Shadow property.
The default shadow parameters.

Declaration

public PropertyMap Shadow { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

ShadowColor

Please do not use this ShadowColor(Deprecated). Please use Shadow instead.

The ShadowColor property.
The color of a drop shadow.

Declaration

[Obsolete("Please do not use this ShadowColor(Deprecated). Please use Shadow instead.")]
public Vector4 ShadowColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

Deprecated.(API Level 6) Use Shadow instead. The property cascade chaining set is possible. For example, this (textLabel.ShadowColor.X = 0.1f;) is possible.

API Level: 3

ShadowOffset

Please do not use this ShadowOffset(Deprecated). Please use Shadow instead.

The ShadowOffset property.
The drop shadow offset 0 indicates no shadow.

Declaration

[Obsolete("Please do not use this ShadowOffset(Deprecated). Please use Shadow instead.")]
public Vector2 ShadowOffset { get; set; }

Property Value

Type	Description
Vector2

Remarks

Deprecated.(API Level 6) Use Shadow instead. The property cascade chaining set is possible. For example, this (textLabel.ShadowOffset.X = 0.1f;) is possible.

API Level: 3

Text

The Text property.
The text to display in the UTF-8 format.

Declaration

public string Text { get; set; }

Property Value

Type	Description
String

API Level: 3

TextColor

The TextColor property.
The color of the text.
Animation framework can be used to change the color of the text when not using mark up.
Cannot animate the color when text is auto scrolling.

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
Color

Remarks

The property cascade chaining set is possible. For example, this (textLabel.TextColor.X = 0.1f;) is possible.

API Level: 3

TranslatableText

The TranslatableText property.
The text can set the SID value.

Declaration

public string TranslatableText { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
ArgumentNullException	ResourceManager about multilingual is null.

API Level: 4

Underline

The Underline property.
The default underline parameters.

Declaration

public PropertyMap Underline { get; set; }

Property Value

Type	Description
PropertyMap

API Level: 3

UnderlineColor

Please do not use this UnderlineColor(Deprecated). Please use Underline instead.

The UnderlineColor property.
Overrides the underline height from font metrics.

Declaration

[Obsolete("Please do not use this UnderlineColor(Deprecated). Please use Underline instead.")]
public Vector4 UnderlineColor { get; set; }

Property Value

Type	Description
Vector4

Remarks

Deprecated.(API Level 6) Use Underline instead. The property cascade chaining set is possible. For example, this (textLabel.UnderlineColor.X = 0.1f;) is possible.

API Level: 3

UnderlineEnabled

Please do not use this UnderlineEnabled(Deprecated). Please use Underline instead.

The UnderlineEnabled property.
The underline enabled flag.

Declaration

[Obsolete("Please do not use this UnderlineEnabled(Deprecated). Please use Underline instead.")]
public bool UnderlineEnabled { get; set; }

Property Value

Type	Description
Boolean

Remarks

Deprecated.(API Level 6) Use Underline instead.

API Level: 3

UnderlineHeight

Please do not use this UnderlineHeight(Deprecated). Please use Underline instead.

The UnderlineHeight property.
Overrides the underline height from font metrics.

Declaration

[Obsolete("Please do not use this UnderlineHeight(Deprecated). Please use Underline instead.")]
public float UnderlineHeight { get; set; }

Property Value

Type	Description
Single

Remarks

Deprecated.(API Level 6) Use Underline instead.

API Level: 3

VerticalAlignment

The VerticalAlignment property.
The line vertical alignment.

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment

API Level: 3

Methods

OnBindingContextChanged()

Invoked whenever the binding context of the textlabel changes. Implement this method to add class handling for this event.

Declaration

protected override void OnBindingContextChanged()

Overrides

Tizen.NUI.Binding.Element.OnBindingContextChanged()

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable