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.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
| Type |
Description |
| System.Single |
|
API Level: 3
View Source
AutoScrollLoopCount
The AutoScrollLoopCount property.
Number of complete loops when scrolling enabled.
Declaration
public int AutoScrollLoopCount { get; set; }
Property Value
API Level: 3
View Source
AutoScrollLoopDelay
The AutoScrollLoopDelay property.
The amount of time to delay the starting time of auto scrolling and further loops.
Declaration
public float AutoScrollLoopDelay { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
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
API Level: 3
View Source
AutoScrollStopMode
The AutoScrollStopMode property.
The auto scrolling stop behaviour.
The default value is AutoScrollStopMode.FinishLoop.
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
API Level: 3
View Source
EllipsisPosition
The ellipsis position of the text.
Specifies which portion of the text should be replaced with an ellipsis when the text size exceeds the layout size.
Declaration
public EllipsisPosition EllipsisPosition { get; set; }
Property Value
API Level: 9
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
API Level: 3
View Source
EnableMarkup
The EnableMarkup property.
Whether the mark-up processing is enabled.
Declaration
public bool EnableMarkup { get; set; }
Property Value
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
FontSizeScale
The FontSizeScale property for scaling the specified font size up or down.
The default value is 1.0.
The given font size scale value is used for multiplying the specified font size before querying fonts.
If FontSizeScale.UseSystemSetting, will use the SystemSettings.FontSize internally.
Declaration
public float FontSizeScale { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
API Level: 9
View Source
FontStyle
The FontStyle property.
The requested font style to use.
The fontStyle map contains the following keys :
| width (string) | The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) |
| weight (string) | The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) |
| slant (string) | The slant key defines whether to use italics. (values: normal, roman, italic, oblique) |
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
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
| Type |
Description |
| System.Single |
|
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
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
API Level: 3
View Source
Outline
The Outline property.
The default outline parameters.
The outline map contains the following keys :
| color (Color) | The color of the outline (the default color is Color.White) |
| width (float) | The width in pixels of the outline (If not provided then the outline is not enabled) |
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
| Type |
Description |
| System.Single |
|
API Level: 3
View Source
PointSize
The PointSize property.
The size of font in points.
Declaration
public float PointSize { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
API Level: 3
View Source
Shadow
The Shadow property.
The default shadow parameters.
The shadow map contains the following keys :
| color (Color) | The color of the shadow (the default color is Color.Black) |
| offset (Vector2) | The offset in pixels of the shadow (If not provided then the shadow is not enabled) |
| blurRadius (float) | The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled) |
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("Do not use this ShadowColor(Deprecated). 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("Do not use this ShadowOffset(Deprecated). 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
| Type |
Condition |
| System.ArgumentNullException |
ResourceManager about multilingual is null.
|
API Level: 4
View Source
Underline
The Underline property.
The default underline parameters.
The underline map contains the following keys :
| enable (bool) | Whether the underline is enabled (the default value is false) |
| color (Color) | The color of the underline (If not provided then the color of the text is used) |
| height (float) | The height in pixels of the underline (the default value is 1.f) |
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("Do not use this UnderlineColor(Deprecated). 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("Do not use this UnderlineEnabled(Deprecated). Use Underline instead.")]
public bool UnderlineEnabled { get; set; }
Property Value
API Level: 3
View Source
UnderlineHeight
The UnderlineHeight property.
Overrides the underline height from font metrics.
Declaration
[Obsolete("Do not use this UnderlineHeight(Deprecated). Use Underline instead.")]
public float UnderlineHeight { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
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
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.Container.OnBindingContextChanged()
Events
View Source
AnchorClicked
The AnchorClicked signal is emitted when the anchor is clicked.
Declaration
public event EventHandler<AnchorClickedEventArgs> AnchorClicked
Event Type
API Level: 9
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable