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
-
System.Object
Tizen.NUI.Binding.BindableObject
Tizen.NUI.Binding.Element
TextLabel
- Derived
-
Tizen.NUI.Components.Title
- Implements
-
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Constructors
Declaration
API Level: 3
View Source
TextLabel(String)
Creates the TextLabel control.
Declaration
public TextLabel(string text)
Parameters
| Type |
Name |
Description |
| System.String |
text |
The text to display
|
API Level: 3
Properties
View Source
AutoScrollGap
The AutoScrollGap property.
Gap before scrolling wraps.
Declaration
public float AutoScrollGap { get; set; }
Property Value
API Level: 3
View Source
AutoScrollLoopCount
The AutoScrollLoopCount property.
Number of complete loops when scrolling enabled.
Declaration
public int AutoScrollLoopCount { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
API Level: 3
View Source
AutoScrollLoopDelay
The AutoScrollLoopDelay property.
Do something.
Declaration
public float AutoScrollLoopDelay { get; set; }
Property Value
API Level: 3
View Source
AutoScrollSpeed
The AutoScrollSpeed property.
Sets the speed of scrolling in pixels per second.
Declaration
public int AutoScrollSpeed { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
API Level: 3
View Source
AutoScrollStopMode
The AutoScrollStopMode property.
Do something.
Declaration
public AutoScrollStopMode AutoScrollStopMode { get; set; }
Property Value
API Level: 3
View Source
Ellipsis
The Ellipsis property.
Enable or disable the ellipsis.
Declaration
public bool Ellipsis { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
API Level: 3
View Source
Emboss
The Emboss property.
The default emboss parameters.
Declaration
public string Emboss { get; set; }
Property Value
| Type |
Description |
| System.String |
|
API Level: 3
View Source
EnableAutoScroll
The EnableAutoScroll property.
Starts or stops auto scrolling.
Declaration
public bool EnableAutoScroll { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
API Level: 3
View Source
EnableMarkup
The EnableMarkup property.
Whether the mark-up processing is enabled.
Declaration
public bool EnableMarkup { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
API Level: 3
View Source
FontFamily
The FontFamily property.
The requested font family to use.
Declaration
public string FontFamily { get; set; }
Property Value
| Type |
Description |
| System.String |
|
API Level: 3
View Source
FontStyle
The FontStyle property.
The requested font style to use.
Declaration
public PropertyMap FontStyle { get; set; }
Property Value
API Level: 3
View Source
HorizontalAlignment
The HorizontalAlignment property.
The line horizontal alignment.
Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
API Level: 3
Declaration
public int LineCount { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
API Level: 3
View Source
LineSpacing
The LineSpacing property.
The default extra space between lines in points.
Declaration
public float LineSpacing { get; set; }
Property Value
API Level: 3
View Source
LineWrapMode
The LineWrapMode property.
line wrap mode when the text lines over layout width.
Declaration
public LineWrapMode LineWrapMode { get; set; }
Property Value
API Level: 4
View Source
MatchSystemLanguageDirection
The text alignment to match the direction of the system language.
Declaration
public bool MatchSystemLanguageDirection { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
API Level: 6
View Source
MultiLine
The MultiLine property.
The single-line or multi-line layout option.
Declaration
public bool MultiLine { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
API Level: 3
View Source
Outline
The Outline property.
The default outline parameters.
Declaration
public PropertyMap Outline { get; set; }
Property Value
API Level: 3
View Source
PixelSize
The PixelSize property.
The size of font in pixels.
Declaration
public float PixelSize { get; set; }
Property Value
API Level: 3
View Source
PointSize
The PointSize property.
The size of font in points.
Declaration
public float PointSize { get; set; }
Property Value
API Level: 3
View Source
Shadow
The Shadow property.
The default shadow parameters.
Declaration
public PropertyMap Shadow { get; set; }
Property Value
API Level: 3
View Source
ShadowColor
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
Remarks
API Level: 3
View Source
ShadowOffset
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
Remarks
API Level: 3
View Source
Text
The Text property.
The text to display in the UTF-8 format.
Declaration
public string Text { get; set; }
Property Value
| Type |
Description |
| System.String |
|
API Level: 3
View Source
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
API Level: 3
View Source
TranslatableText
The TranslatableText property.
The text can set the SID value.
Declaration
public string TranslatableText { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Exceptions
API Level: 4
View Source
Underline
The Underline property.
The default underline parameters.
Declaration
public PropertyMap Underline { get; set; }
Property Value
API Level: 3
View Source
UnderlineColor
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
API Level: 3
View Source
UnderlineEnabled
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 |
| System.Boolean |
|
API Level: 3
View Source
UnderlineHeight
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
API Level: 3
View Source
VerticalAlignment
The VerticalAlignment property.
The line vertical alignment.
Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
API Level: 3
Methods
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Overrides
API Level: 3
View Source
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