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, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
- Inheritance
-
- Derived
-
- Implements
-
Constructors
Declaration
API Level: 3
View Source
TextLabel(Boolean)
Creates the TextLabel with setting the status of shown or hidden.
Declaration
public TextLabel(bool shown)
Parameters
| Type |
Name |
Description |
| Boolean |
shown |
false : Not displayed (hidden), true : displayed (shown)
|
View Source
TextLabel(String)
Creates the TextLabel control.
Declaration
public TextLabel(string text)
Parameters
| Type |
Name |
Description |
| String |
text |
The text to display
|
API Level: 3
View Source
TextLabel(String, Boolean)
Creates the TextLabel with setting the status of shown or hidden.
Declaration
public TextLabel(string text, bool shown)
Parameters
| Type |
Name |
Description |
| String |
text |
The text to display
|
| Boolean |
shown |
false : Not displayed (hidden), true : displayed (shown)
|
Declaration
public TextLabel(TextLabelStyle viewStyle)
Parameters
Fields
Declaration
public static readonly BindableProperty AutoScrollGapProperty
Field Value
Declaration
public static readonly BindableProperty AutoScrollLoopCountProperty
Field Value
Declaration
public static readonly BindableProperty AutoScrollLoopDelayProperty
Field Value
Declaration
public static readonly BindableProperty AutoScrollSpeedProperty
Field Value
Declaration
public static readonly BindableProperty AutoScrollStopModeProperty
Field Value
Declaration
public static readonly BindableProperty CharacterSpacingProperty
Field Value
Declaration
public static readonly BindableProperty EllipsisPositionProperty
Field Value
Declaration
public static readonly BindableProperty EllipsisProperty
Field Value
Declaration
public static readonly BindableProperty EmbossProperty
Field Value
Declaration
public static readonly BindableProperty EnableAutoScrollProperty
Field Value
Declaration
public static readonly BindableProperty EnableFontSizeScaleProperty
Field Value
Declaration
public static readonly BindableProperty EnableMarkupProperty
Field Value
Declaration
public static readonly BindableProperty FontFamilyProperty
Field Value
Declaration
public static readonly BindableProperty FontSizeScaleProperty
Field Value
Declaration
public static readonly BindableProperty FontStyleProperty
Field Value
Declaration
public static readonly BindableProperty HorizontalAlignmentProperty
Field Value
Declaration
public static readonly BindableProperty LineSpacingProperty
Field Value
Declaration
public static readonly BindableProperty LineWrapModeProperty
Field Value
Declaration
public static readonly BindableProperty MatchSystemLanguageDirectionProperty
Field Value
Declaration
public static readonly BindableProperty MinLineSizeProperty
Field Value
Declaration
public static readonly BindableProperty MultiLineProperty
Field Value
Declaration
public static readonly BindableProperty OutlineProperty
Field Value
Declaration
public static readonly BindableProperty PixelSizeProperty
Field Value
Declaration
public static readonly BindableProperty PointSizeProperty
Field Value
Declaration
public static readonly BindableProperty RelativeLineHeightProperty
Field Value
Declaration
public static readonly BindableProperty ShadowColorProperty
Field Value
Declaration
public static readonly BindableProperty ShadowOffsetProperty
Field Value
Declaration
public static readonly BindableProperty ShadowProperty
Field Value
Declaration
public static readonly BindableProperty TextColorProperty
Field Value
Declaration
public static readonly BindableProperty TextFitProperty
Field Value
Declaration
public static readonly BindableProperty TextProperty
Field Value
Declaration
public static readonly BindableProperty TextShadowProperty
Field Value
Declaration
public static readonly BindableProperty TranslatableTextProperty
Field Value
Declaration
public static readonly BindableProperty UnderlineColorProperty
Field Value
Declaration
public static readonly BindableProperty UnderlineEnabledProperty
Field Value
Declaration
public static readonly BindableProperty UnderlineHeightProperty
Field Value
Declaration
public static readonly BindableProperty UnderlineProperty
Field Value
Declaration
public static readonly BindableProperty VerticalAlignmentProperty
Field Value
Declaration
public static readonly BindableProperty VerticalLineAlignmentProperty
Field Value
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
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
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
CharacterSpacing
The spaces between characters in Pixels.
A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
The default value is 0.f which does nothing.
Declaration
public float CharacterSpacing { get; set; }
Property Value
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
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
EnableFontSizeScale
The EnableFontSizeScale property.
Whether the font size scale is enabled. (The default value is true)
Declaration
public bool EnableFontSizeScale { get; set; }
Property Value
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
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
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
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
MinLineSize
The MinLineSize property.
The height of the line in points.
If the font size is larger than the line size, it works with the font size.
Declaration
public float MinLineSize { get; set; }
Property Value
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
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
RelativeLineHeight
The relative height of the line (a factor that will be multiplied by text height).
If the value is less than 1, the lines could to be overlapped.
Declaration
public float RelativeLineHeight { get; set; }
Property Value
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
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
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
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
TextDirection
The direction of the text such as left to right or right to left.
Declaration
public TextDirection TextDirection { get; }
Property Value
View Source
TextFit
The text fit parameters.
The textFit map contains the following keys :
| enable (bool) | True to enable the text fit or false to disable (the default value is false) |
| minSize (float) | Minimum Size for text fit (the default value is 10.f) |
| maxSize (float) | Maximum Size for text fit (the default value is 100.f) |
| stepSize (float) | Step Size for font increase (the default value is 1.f) |
| fontSize (string) | The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize") |
Declaration
public PropertyMap TextFit { get; set; }
Property Value
View Source
TextShadow
Describes a text shadow for a TextLabel.
It is null by default.
Declaration
public TextShadow TextShadow { get; set; }
Property Value
View Source
TranslatableText
The TranslatableText property.
The text can set the SID value.
Declaration
public string TranslatableText { get; set; }
Property Value
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
public Vector4 UnderlineColor { get; set; }
Property Value
API Level: 3
View Source
UnderlineEnabled
The UnderlineEnabled property.
The underline enabled flag.
Declaration
public bool UnderlineEnabled { get; set; }
Property Value
API Level: 3
View Source
UnderlineHeight
The UnderlineHeight property.
Overrides the underline height from font metrics.
Declaration
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
View Source
VerticalLineAlignment
The vertical line alignment of the text.
Declaration
public VerticalLineAlignment VerticalLineAlignment { get; set; }
Property Value
Methods
View Source
CreateViewStyle()
Get attribues, it is abstract function and must be override.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
Overrides
View Source
Dispose(DisposeTypes)
you can override it to clean-up your own resources.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Overrides
View Source
DownCast(BaseHandle)
Downcasts a handle to textLabel handle
Declaration
public static TextLabel DownCast(BaseHandle handle)
Parameters
Returns
API Level: 3
View Source
GetFontStyle()
Get FontStyle from TextLabel.
Declaration
public FontStyle GetFontStyle()
Returns
Declaration
public Outline GetOutline()
Returns
| Type |
Description |
| Outline |
The Outline
|
Declaration
public Shadow GetShadow()
Returns
| Type |
Description |
| Shadow |
The Shadow
|
Remarks
View Source
GetStrikethrough()
Get Strikethrough from TextLabel.
Declaration
public Strikethrough GetStrikethrough()
Returns
Declaration
public TextFit GetTextFit()
Returns
| Type |
Description |
| TextFit |
The TextFit
|
View Source
GetTextFitArray()
Get TextFitArray from TextLabel.
Declaration
public TextFitArray GetTextFitArray()
Returns
Examples
The following example demonstrates how to use the GetTextFitArray method.
Tizen.NUI.Text.TextFitArray textFitArray = label.GetTextFitArray();
bool enable = textFitArray.Enable;
var optionList = textFitArray.OptionList;
foreach(Tizen.NUI.Text.TextFitArrayOption option in optionList)
{
float pointSize = option.PointSize;
float minLinesize = option.MinLineSize;
}
View Source
GetUnderline()
Get Underline from TextLabel.
Declaration
public Underline GetUnderline()
Returns
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
View Source
ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
| Type |
Name |
Description |
| Tizen.System.Runtime.InteropServices.HandleRef |
swigCPtr |
|
Overrides
View Source
SetFontStyle(FontStyle)
Set FontStyle to TextLabel.
Declaration
public void SetFontStyle(FontStyle fontStyle)
Parameters
| Type |
Name |
Description |
| FontStyle |
fontStyle |
The FontStyle
|
Examples
The following example demonstrates how to use the SetFontStyle method.
var fontStyle = new Tizen.NUI.Text.FontStyle();
fontStyle.Width = FontWidthType.Expanded;
fontStyle.Weight = FontWeightType.Bold;
fontStyle.Slant = FontSlantType.Italic;
label.SetFontStyle(fontStyle);
View Source
SetOutline(Outline)
Set Outline to TextLabel.
Declaration
public void SetOutline(Outline outline)
Parameters
| Type |
Name |
Description |
| Outline |
outline |
The Outline
|
Examples
The following example demonstrates how to use the SetOutline method.
var outline = new Tizen.NUI.Text.Outline();
outline.Width = 2.0f;
outline.Color = new Color("#45B39D");
label.SetOutline(outline);
Declaration
public void SetShadow(Shadow shadow)
Parameters
| Type |
Name |
Description |
| Shadow |
shadow |
The Shadow
|
Remarks
Examples
The following example demonstrates how to use the SetShadow method.
var shadow = new Tizen.NUI.Text.Shadow();
shadow.Offset = new Vector2(3, 3);
shadow.Color = new Color("#F1C40F");
shadow.BlurRadius = 4.0f;
label.SetShadow(shadow);
View Source
SetStrikethrough(Strikethrough)
Set Strikethrough to TextLabel.
Declaration
public void SetStrikethrough(Strikethrough strikethrough)
Parameters
| Type |
Name |
Description |
| Strikethrough |
strikethrough |
The Strikethrough
|
Examples
The following example demonstrates how to use the SetStrikethrough method.
var strikethrough = new Tizen.NUI.Text.Strikethrough();
strikethrough.Enable = true;
strikethrough.Color = new Color("#3498DB");
strikethrough.Height = 2.0f;
label.SetStrikethrough(strikethrough);
View Source
SetTextFit(TextFit)
Set TextFit to TextLabel.
Declaration
public void SetTextFit(TextFit textFit)
Parameters
| Type |
Name |
Description |
| TextFit |
textFit |
The TextFit
|
Examples
The following example demonstrates how to use the SetTextFit method.
var textFit = new Tizen.NUI.Text.TextFit();
textFit.Enable = true;
textFit.MinSize = 10.0f;
textFit.MaxSize = 100.0f;
textFit.StepSize = 5.0f;
textFit.FontSizeType = FontSizeType.PointSize;
label.SetTextFit(textFit);
View Source
SetTextFitArray(TextFitArray)
Set TextFitArray to TextLabel.
TextFitArray finds and applies the largest PointSize that fits among OptionList.
Declaration
public void SetTextFitArray(TextFitArray textFitArray)
Parameters
| Type |
Name |
Description |
| TextFitArray |
textFitArray |
The TextFitArray
|
Examples
The following example demonstrates how to use the SetTextFitArray method.
var textFitArray = new Tizen.NUI.Text.TextFitArray();
textFitArray.Enable = true;
textFitArray.OptionList = new List<Tizen.NUI.Text.TextFitArrayOption>()
{
new Tizen.NUI.Text.TextFitArrayOption(12, 18),
new Tizen.NUI.Text.TextFitArrayOption(24, 40),
new Tizen.NUI.Text.TextFitArrayOption(28, 48),
new Tizen.NUI.Text.TextFitArrayOption(32, 56),
new Tizen.NUI.Text.TextFitArrayOption(50, 72),
};
label.SetTextFitArray(textFitArray);
The table below shows cases where binary search is possible and where it is not possible.
[Binary search possible]
| | List index | 0 | 1 | 2 | 3 |
| OptionList | PointSize | 24 | 28 | 32 | 48 |
| | MinLineSize | 40 | 48 | 48 | 62 | << MinLineSize sorted in ascending order
^ ^
same values are not a problem
[Binary search not possible]
| | List index | 0 | 1 | 2 | 3 |
| OptionList | PointSize | 24 | 28 | 32 | 48 |
| | MinLineSize | 40 | 48 | 38 | 62 | << MinLineSize is not sorted in ascending order
^
View Source
SetUnderline(Underline)
Set Underline to TextLabel.
Declaration
public void SetUnderline(Underline underline)
Parameters
| Type |
Name |
Description |
| Underline |
underline |
The Underline
|
Examples
The following example demonstrates how to use the SetUnderline method.
var underline = new Tizen.NUI.Text.Underline();
underline.Enable = true;
underline.Color = new Color("#3498DB");
underline.Height = 2.0f;
label.SetUnderline(underline);
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
View Source
TextFitChanged
An event for the TextFitChanged signal which can be used to subscribe or unsubscribe the event handler
provided by the user. The TextFitChanged signal is emitted when the text fit properties changes.
Declaration
public event EventHandler TextFitChanged
Event Type
| Type |
Description |
| EventHandler |
|
Implements
Extension Methods