2 * Copyright(c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 extern alias TizenSystemSettings;
19 using TizenSystemSettings.Tizen.System;
22 using System.Globalization;
23 using System.ComponentModel;
26 namespace Tizen.NUI.BaseComponents
29 /// A control which renders a short text string.<br />
30 /// Text labels are lightweight, non-editable, and do not respond to the user input.<br />
32 /// <since_tizen> 3 </since_tizen>
33 public partial class TextLabel : View
35 private class TextLayout : LayoutItem
37 protected override void OnMeasure(MeasureSpecification widthMeasureSpec, MeasureSpecification heightMeasureSpec)
39 // Padding will be automatically applied by DALi TextLabel.
40 float totalWidth = widthMeasureSpec.Size.AsDecimal();
41 float totalHeight = heightMeasureSpec.Size.AsDecimal();
43 if (widthMeasureSpec.Mode == MeasureSpecification.ModeType.Exactly)
45 if (heightMeasureSpec.Mode != MeasureSpecification.ModeType.Exactly)
47 totalHeight = Owner.GetHeightForWidth(totalWidth);
48 heightMeasureSpec = new MeasureSpecification(new LayoutLength(totalHeight), MeasureSpecification.ModeType.Exactly);
53 var minSize = Owner.MinimumSize;
54 var maxSize = Owner.MaximumSize;
55 var naturalSize = Owner.GetNaturalSize();
57 if (heightMeasureSpec.Mode == MeasureSpecification.ModeType.Exactly)
59 // GetWidthForHeight is not implemented.
60 totalWidth = Math.Min(Math.Max(naturalSize.Width, minSize.Width), (maxSize.Width < 0 ? Int32.MaxValue : maxSize.Width));
61 widthMeasureSpec = new MeasureSpecification(new LayoutLength(totalWidth), MeasureSpecification.ModeType.Exactly);
65 totalWidth = Math.Min(Math.Max(naturalSize.Width, minSize.Width), (maxSize.Width < 0 ? Int32.MaxValue : maxSize.Width));
66 totalHeight = Math.Min(Math.Max(naturalSize.Height, minSize.Height), (maxSize.Height < 0 ? Int32.MaxValue : maxSize.Height));
68 heightMeasureSpec = new MeasureSpecification(new LayoutLength(totalHeight), MeasureSpecification.ModeType.Exactly);
69 widthMeasureSpec = new MeasureSpecification(new LayoutLength(totalWidth), MeasureSpecification.ModeType.Exactly);
73 MeasuredSize.StateType childWidthState = MeasuredSize.StateType.MeasuredSizeOK;
74 MeasuredSize.StateType childHeightState = MeasuredSize.StateType.MeasuredSizeOK;
76 SetMeasuredDimensions(ResolveSizeAndState(new LayoutLength(totalWidth), widthMeasureSpec, childWidthState),
77 ResolveSizeAndState(new LayoutLength(totalHeight), heightMeasureSpec, childHeightState));
81 static TextLabel() { }
83 private string textLabelSid = null;
84 private bool systemlangTextFlag = false;
85 private TextLabelSelectorData selectorData;
86 private float fontSizeScale = 1.0f;
87 private bool hasFontSizeChangedCallback = false;
90 /// Creates the TextLabel control.
92 /// <since_tizen> 3 </since_tizen>
93 public TextLabel() : this(Interop.TextLabel.New(), true)
95 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
98 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
99 [EditorBrowsable(EditorBrowsableState.Never)]
100 public TextLabel(TextLabelStyle viewStyle) : this(Interop.TextLabel.New(), true, viewStyle)
105 /// Creates the TextLabel with setting the status of shown or hidden.
107 /// <param name="shown">false : Not displayed (hidden), true : displayed (shown)</param>
108 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
109 [EditorBrowsable(EditorBrowsableState.Never)]
110 public TextLabel(bool shown) : this(Interop.TextLabel.New(), true)
112 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
117 /// Creates the TextLabel control.
119 /// <param name="text">The text to display</param>
120 /// <since_tizen> 3 </since_tizen>
121 public TextLabel(string text) : this(Interop.TextLabel.New(text), true)
123 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
127 /// Creates the TextLabel with setting the status of shown or hidden.
129 /// <param name="text">The text to display</param>
130 /// <param name="shown">false : Not displayed (hidden), true : displayed (shown)</param>
131 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
132 [EditorBrowsable(EditorBrowsableState.Never)]
133 public TextLabel(string text, bool shown) : this(Interop.TextLabel.New(text), true)
135 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
139 internal TextLabel(TextLabel handle, bool shown = true) : this(Interop.TextLabel.NewTextLabel(TextLabel.getCPtr(handle)), true)
141 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
149 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn, ViewStyle viewStyle, bool shown = true) : base(cPtr, cMemoryOwn, viewStyle)
157 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn, bool shown = true) : base(cPtr, cMemoryOwn, null)
166 /// The TranslatableText property.<br />
167 /// The text can set the SID value.<br />
169 /// <exception cref='ArgumentNullException'>
170 /// ResourceManager about multilingual is null.
172 /// <since_tizen> 4 </since_tizen>
173 public string TranslatableText
177 return (string)GetValue(TranslatableTextProperty);
181 SetValue(TranslatableTextProperty, value);
184 private string translatableText
192 if (NUIApplication.MultilingualResourceManager == null)
194 throw new ArgumentNullException(null, "ResourceManager about multilingual is null");
196 string translatableText = null;
197 textLabelSid = value;
198 translatableText = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(SystemSettings.LocaleLanguage.Replace("_", "-")));
199 if (translatableText != null)
201 Text = translatableText;
202 if (systemlangTextFlag == false)
204 SystemSettings.LocaleLanguageChanged += SystemSettings_LocaleLanguageChanged;
205 systemlangTextFlag = true;
212 NotifyPropertyChanged();
217 /// The Text property.<br />
218 /// The text to display in the UTF-8 format.<br />
220 /// <since_tizen> 3 </since_tizen>
225 return (string)GetValue(TextProperty);
229 SetValue(TextProperty, value);
230 NotifyPropertyChanged();
235 /// The FontFamily property.<br />
236 /// The requested font family to use.<br />
238 /// <since_tizen> 3 </since_tizen>
239 public string FontFamily
243 return (string)GetValue(FontFamilyProperty);
247 SetValue(FontFamilyProperty, value);
248 NotifyPropertyChanged();
253 /// The FontStyle property.<br />
254 /// The requested font style to use.<br />
255 /// The fontStyle map contains the following keys :<br />
256 /// <list type="table">
257 /// <item><term>width (string)</term><description>The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded)</description></item>
258 /// <item><term>weight (string)</term><description>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)</description></item>
259 /// <item><term>slant (string)</term><description>The slant key defines whether to use italics. (values: normal, roman, italic, oblique)</description></item>
262 /// <since_tizen> 3 </since_tizen>
263 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")]
264 public PropertyMap FontStyle
268 return (PropertyMap)GetValue(FontStyleProperty);
272 SetValue(FontStyleProperty, value);
273 NotifyPropertyChanged();
278 /// Set FontStyle to TextLabel. <br />
280 /// <param name="fontStyle">The FontStyle</param>
282 /// SetFontStyle specifies the requested font style through <see cref="Tizen.NUI.Text.FontStyle"/>. <br />
285 /// The following example demonstrates how to use the SetFontStyle method.
287 /// var fontStyle = new Tizen.NUI.Text.FontStyle();
288 /// fontStyle.Width = FontWidthType.Expanded;
289 /// fontStyle.Weight = FontWeightType.Bold;
290 /// fontStyle.Slant = FontSlantType.Italic;
291 /// label.SetFontStyle(fontStyle);
294 [EditorBrowsable(EditorBrowsableState.Never)]
295 public void SetFontStyle(FontStyle fontStyle)
297 using (var fontStyleMap = TextMapHelper.GetFontStyleMap(fontStyle))
299 SetValue(FontStyleProperty, fontStyleMap);
304 /// Get FontStyle from TextLabel. <br />
306 /// <returns>The FontStyle</returns>
308 /// <see cref="Tizen.NUI.Text.FontStyle"/>
310 [EditorBrowsable(EditorBrowsableState.Never)]
311 public FontStyle GetFontStyle()
314 using (var fontStyleMap = (PropertyMap)GetValue(FontStyleProperty))
316 fontStyle = TextMapHelper.GetFontStyleStruct(fontStyleMap);
322 /// The PointSize property.<br />
323 /// The size of font in points.<br />
325 /// <since_tizen> 3 </since_tizen>
326 public float PointSize
330 return (float)GetValue(PointSizeProperty);
334 SetValue(PointSizeProperty, value);
335 NotifyPropertyChanged();
340 /// The MultiLine property.<br />
341 /// The single-line or multi-line layout option.<br />
343 /// <since_tizen> 3 </since_tizen>
344 public bool MultiLine
348 return (bool)GetValue(MultiLineProperty);
352 SetValue(MultiLineProperty, value);
353 NotifyPropertyChanged();
358 /// The HorizontalAlignment property.<br />
359 /// The line horizontal alignment.<br />
361 /// <since_tizen> 3 </since_tizen>
362 public HorizontalAlignment HorizontalAlignment
366 return (HorizontalAlignment)GetValue(HorizontalAlignmentProperty);
370 SetValue(HorizontalAlignmentProperty, value);
371 NotifyPropertyChanged();
376 /// The VerticalAlignment property.<br />
377 /// The line vertical alignment.<br />
379 /// <since_tizen> 3 </since_tizen>
380 public VerticalAlignment VerticalAlignment
384 return (VerticalAlignment)GetValue(VerticalAlignmentProperty);
388 SetValue(VerticalAlignmentProperty, value);
389 NotifyPropertyChanged();
394 /// The TextColor property.<br />
395 /// The color of the text.<br />
396 /// Animation framework can be used to change the color of the text when not using mark up.<br />
397 /// Cannot animate the color when text is auto scrolling.<br />
400 /// The property cascade chaining set is possible. For example, this (textLabel.TextColor.X = 0.1f;) is possible.
402 /// <since_tizen> 3 </since_tizen>
403 public Color TextColor
407 Color temp = (Color)GetValue(TextColorProperty);
408 return new Color(OnTextColorChanged, temp.R, temp.G, temp.B, temp.A);
412 SetValue(TextColorProperty, value);
413 NotifyPropertyChanged();
418 /// The ShadowOffset property.<br />
419 /// The drop shadow offset 0 indicates no shadow.<br />
421 /// <since_tizen> 3 </since_tizen>
423 /// Deprecated.(API Level 6) Use Shadow instead.
424 /// The property cascade chaining set is possible. For example, this (textLabel.ShadowOffset.X = 0.1f;) is possible.
426 [Obsolete("Please do not use this ShadowOffset(Deprecated). Please use Shadow instead.")]
427 public Vector2 ShadowOffset
431 return GetValue(ShadowOffsetProperty) as Vector2;
435 SetValue(ShadowOffsetProperty, value);
439 private Vector2 InternalShadowOffset
443 Vector2 shadowOffset = new Vector2();
444 Shadow.Find(TextLabel.Property.SHADOW, "offset")?.Get(shadowOffset);
445 return new Vector2(OnShadowOffsetChanged, shadowOffset.X, shadowOffset.Y);
449 PropertyMap temp = new PropertyMap();
450 temp.Insert("offset", new PropertyValue(value));
452 PropertyMap shadowMap = Shadow;
453 shadowMap.Merge(temp);
455 SetValue(ShadowProperty, shadowMap);
456 NotifyPropertyChanged();
461 /// The ShadowColor property.<br />
462 /// The color of a drop shadow.<br />
464 /// <since_tizen> 3 </since_tizen>
466 /// Deprecated.(API Level 6) Use Shadow instead.
467 /// The property cascade chaining set is possible. For example, this (textLabel.ShadowColor.X = 0.1f;) is possible.
469 [Obsolete("Please do not use this ShadowColor(Deprecated). Please use Shadow instead.")]
470 public Vector4 ShadowColor
474 return GetValue(ShadowColorProperty) as Vector4;
478 SetValue(ShadowColorProperty, value);
482 private Vector4 InternalShadowColor
486 Vector4 shadowColor = new Vector4();
487 Shadow.Find(TextLabel.Property.SHADOW, "color")?.Get(shadowColor);
488 return new Vector4(OnShadowColorChanged, shadowColor.X, shadowColor.Y, shadowColor.Z, shadowColor.W);
492 PropertyMap temp = new PropertyMap();
493 temp.Insert("color", new PropertyValue(value));
495 PropertyMap shadowMap = Shadow;
496 shadowMap.Merge(temp);
498 SetValue(ShadowProperty, shadowMap);
499 NotifyPropertyChanged();
504 /// The UnderlineEnabled property.<br />
505 /// The underline enabled flag.<br />
507 /// <since_tizen> 3 </since_tizen>
509 /// Deprecated.(API Level 6) Use Underline instead.
511 [Obsolete("Please do not use this UnderlineEnabled(Deprecated). Please use Underline instead.")]
512 public bool UnderlineEnabled
516 return (bool)GetValue(UnderlineEnabledProperty);
520 SetValue(UnderlineEnabledProperty, value);
524 private bool InternalUnderlineEnabled
528 bool underlineEnabled = false;
529 Underline.Find(TextLabel.Property.UNDERLINE, "enable")?.Get(out underlineEnabled);
530 return underlineEnabled;
534 PropertyMap temp = new PropertyMap();
535 temp.Add("enable", new PropertyValue(value));
537 PropertyMap undelineMap = Underline;
538 undelineMap.Merge(temp);
540 SetValue(UnderlineProperty, undelineMap);
541 NotifyPropertyChanged();
547 /// The UnderlineColor property.<br />
548 /// Overrides the underline height from font metrics.<br />
550 /// <since_tizen> 3 </since_tizen>
552 /// Deprecated.(API Level 6) Use Underline instead.
553 /// The property cascade chaining set is possible. For example, this (textLabel.UnderlineColor.X = 0.1f;) is possible.
555 [Obsolete("Please do not use this UnderlineColor(Deprecated). Please use Underline instead.")]
556 public Vector4 UnderlineColor
560 return GetValue(UnderlineColorProperty) as Vector4;
564 SetValue(UnderlineColorProperty, value);
568 private Vector4 InternalUnderlineColor
572 Vector4 underlineColor = new Vector4();
573 Underline.Find(TextLabel.Property.UNDERLINE, "color")?.Get(underlineColor);
574 return new Vector4(OnUnderlineColorChanged, underlineColor.X, underlineColor.Y, underlineColor.Z, underlineColor.W);
578 PropertyMap temp = new PropertyMap();
579 temp.Insert("color", new PropertyValue(value));
581 PropertyMap undelineMap = Underline;
582 undelineMap.Merge(temp);
584 SetValue(UnderlineProperty, undelineMap);
585 NotifyPropertyChanged();
590 /// The UnderlineHeight property.<br />
591 /// Overrides the underline height from font metrics.<br />
593 /// <since_tizen> 3 </since_tizen>
595 /// Deprecated.(API Level 6) Use Underline instead.
597 [Obsolete("Please do not use this UnderlineHeight(Deprecated). Please use Underline instead.")]
598 public float UnderlineHeight
602 return (float)GetValue(UnderlineHeightProperty);
606 SetValue(UnderlineHeightProperty, value);
610 private float InternalUnderlineHeight
614 float underlineHeight = 0.0f;
615 Underline.Find(TextLabel.Property.UNDERLINE, "height")?.Get(out underlineHeight);
616 return underlineHeight;
620 PropertyMap temp = new PropertyMap();
621 temp.Insert("height", new PropertyValue(value));
623 PropertyMap undelineMap = Underline;
624 undelineMap.Merge(temp);
626 SetValue(UnderlineProperty, undelineMap);
627 NotifyPropertyChanged();
632 /// The EnableMarkup property.<br />
633 /// Whether the mark-up processing is enabled.<br />
635 /// <since_tizen> 3 </since_tizen>
636 public bool EnableMarkup
640 return (bool)GetValue(EnableMarkupProperty);
644 SetValue(EnableMarkupProperty, value);
645 NotifyPropertyChanged();
650 /// The EnableAutoScroll property.<br />
651 /// Starts or stops auto scrolling.<br />
653 /// <since_tizen> 3 </since_tizen>
654 public bool EnableAutoScroll
658 return (bool)GetValue(EnableAutoScrollProperty);
662 SetValue(EnableAutoScrollProperty, value);
663 NotifyPropertyChanged();
668 /// The AutoScrollSpeed property.<br />
669 /// Sets the speed of scrolling in pixels per second.<br />
671 /// <since_tizen> 3 </since_tizen>
672 public int AutoScrollSpeed
676 return (int)GetValue(AutoScrollSpeedProperty);
680 SetValue(AutoScrollSpeedProperty, value);
681 NotifyPropertyChanged();
686 /// The AutoScrollLoopCount property.<br />
687 /// Number of complete loops when scrolling enabled.<br />
689 /// <since_tizen> 3 </since_tizen>
690 public int AutoScrollLoopCount
694 return (int)GetValue(AutoScrollLoopCountProperty);
698 SetValue(AutoScrollLoopCountProperty, value);
699 NotifyPropertyChanged();
704 /// The AutoScrollGap property.<br />
705 /// Gap before scrolling wraps.<br />
707 /// <since_tizen> 3 </since_tizen>
708 public float AutoScrollGap
712 return (float)GetValue(AutoScrollGapProperty);
716 SetValue(AutoScrollGapProperty, value);
717 NotifyPropertyChanged();
722 /// The LineSpacing property.<br />
723 /// The default extra space between lines in points.<br />
725 /// <since_tizen> 3 </since_tizen>
726 public float LineSpacing
730 return (float)GetValue(LineSpacingProperty);
734 SetValue(LineSpacingProperty, value);
735 NotifyPropertyChanged();
740 /// The Underline property.<br />
741 /// The default underline parameters.<br />
742 /// The underline map contains the following keys :<br />
743 /// <list type="table">
744 /// <item><term>enable (bool)</term><description>Whether the underline is enabled (the default value is false)</description></item>
745 /// <item><term>color (Color)</term><description>The color of the underline (If not provided then the color of the text is used)</description></item>
746 /// <item><term>height (float)</term><description>The height in pixels of the underline (the default value is 1.f)</description></item>
749 /// <since_tizen> 3 </since_tizen>
750 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")]
751 public PropertyMap Underline
755 return (PropertyMap)GetValue(UnderlineProperty);
759 SetValue(UnderlineProperty, value);
760 NotifyPropertyChanged();
765 /// Set Underline to TextLabel. <br />
767 /// <param name="underline">The Underline</param>
769 /// SetUnderline specifies the underline of the text through <see cref="Tizen.NUI.Text.Underline"/>. <br />
772 /// The following example demonstrates how to use the SetUnderline method.
774 /// var underline = new Tizen.NUI.Text.Underline();
775 /// underline.Enable = true;
776 /// underline.Color = new Color("#3498DB");
777 /// underline.Height = 2.0f;
778 /// label.SetUnderline(underline);
781 [EditorBrowsable(EditorBrowsableState.Never)]
782 public void SetUnderline(Underline underline)
784 using (var underlineMap = TextMapHelper.GetUnderlineMap(underline))
786 SetValue(UnderlineProperty, underlineMap);
791 /// Get Underline from TextLabel. <br />
793 /// <returns>The Underline</returns>
795 /// <see cref="Tizen.NUI.Text.Underline"/>
797 [EditorBrowsable(EditorBrowsableState.Never)]
798 public Underline GetUnderline()
801 using (var underlineMap = (PropertyMap)GetValue(UnderlineProperty))
803 underline = TextMapHelper.GetUnderlineStruct(underlineMap);
809 /// The Shadow property.<br />
810 /// The default shadow parameters.<br />
811 /// The shadow map contains the following keys :<br />
812 /// <list type="table">
813 /// <item><term>color (Color)</term><description>The color of the shadow (the default color is Color.Black)</description></item>
814 /// <item><term>offset (Vector2)</term><description>The offset in pixels of the shadow (If not provided then the shadow is not enabled)</description></item>
815 /// <item><term>blurRadius (float)</term><description>The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled)</description></item>
818 /// <since_tizen> 3 </since_tizen>
819 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")]
820 public PropertyMap Shadow
824 return (PropertyMap)GetValue(ShadowProperty);
828 SetValue(ShadowProperty, value);
829 NotifyPropertyChanged();
834 /// Set Shadow to TextLabel. <br />
836 /// <param name="shadow">The Shadow</param>
838 /// SetShadow specifies the shadow of the text through <see cref="Tizen.NUI.Text.Shadow"/>. <br />
841 /// The following example demonstrates how to use the SetShadow method.
843 /// var shadow = new Tizen.NUI.Text.Shadow();
844 /// shadow.Offset = new Vector2(3, 3);
845 /// shadow.Color = new Color("#F1C40F");
846 /// shadow.BlurRadius = 4.0f;
847 /// label.SetShadow(shadow);
850 [EditorBrowsable(EditorBrowsableState.Never)]
851 public void SetShadow(Tizen.NUI.Text.Shadow shadow)
853 using (var shadowMap = TextMapHelper.GetShadowMap(shadow))
855 SetValue(ShadowProperty, shadowMap);
860 /// Get Shadow from TextLabel. <br />
862 /// <returns>The Shadow</returns>
864 /// <see cref="Tizen.NUI.Text.Shadow"/>
866 [EditorBrowsable(EditorBrowsableState.Never)]
867 public Tizen.NUI.Text.Shadow GetShadow()
869 Tizen.NUI.Text.Shadow shadow;
870 using (var shadowMap = (PropertyMap)GetValue(ShadowProperty))
872 shadow = TextMapHelper.GetShadowStruct(shadowMap);
878 /// Describes a text shadow for a TextLabel.
879 /// It is null by default.
881 [EditorBrowsable(EditorBrowsableState.Never)]
882 public TextShadow TextShadow
886 return (TextShadow)GetValue(TextShadowProperty);
890 SetValue(TextShadowProperty, value);
891 NotifyPropertyChanged();
896 /// The Emboss property.<br />
897 /// The default emboss parameters.<br />
899 /// <since_tizen> 3 </since_tizen>
904 return (string)GetValue(EmbossProperty);
908 SetValue(EmbossProperty, value);
909 NotifyPropertyChanged();
914 /// The Outline property.<br />
915 /// The default outline parameters.<br />
916 /// The outline map contains the following keys :<br />
917 /// <list type="table">
918 /// <item><term>color (Color)</term><description>The color of the outline (the default color is Color.White)</description></item>
919 /// <item><term>width (float)</term><description>The width in pixels of the outline (If not provided then the outline is not enabled)</description></item>
922 /// <since_tizen> 3 </since_tizen>
923 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")]
924 public PropertyMap Outline
928 return (PropertyMap)GetValue(OutlineProperty);
932 SetValue(OutlineProperty, value);
933 NotifyPropertyChanged();
938 /// Set Outline to TextLabel. <br />
940 /// <param name="outline">The Outline</param>
942 /// SetOutline specifies the outline of the text through <see cref="Tizen.NUI.Text.Outline"/>. <br />
945 /// The following example demonstrates how to use the SetOutline method.
947 /// var outline = new Tizen.NUI.Text.Outline();
948 /// outline.Width = 2.0f;
949 /// outline.Color = new Color("#45B39D");
950 /// label.SetOutline(outline);
953 [EditorBrowsable(EditorBrowsableState.Never)]
954 public void SetOutline(Outline outline)
956 using (var outlineMap = TextMapHelper.GetOutlineMap(outline))
958 SetValue(OutlineProperty, outlineMap);
963 /// Get Outline from TextLabel. <br />
965 /// <returns>The Outline</returns>
967 /// <see cref="Tizen.NUI.Text.Outline"/>
969 [EditorBrowsable(EditorBrowsableState.Never)]
970 public Outline GetOutline()
973 using (var outlineMap = (PropertyMap)GetValue(OutlineProperty))
975 outline = TextMapHelper.GetOutlineStruct(outlineMap);
981 /// The PixelSize property.<br />
982 /// The size of font in pixels.<br />
984 /// <since_tizen> 3 </since_tizen>
985 public float PixelSize
989 return (float)GetValue(PixelSizeProperty);
993 SetValue(PixelSizeProperty, value);
994 NotifyPropertyChanged();
999 /// The Ellipsis property.<br />
1000 /// Enable or disable the ellipsis.<br />
1002 /// <since_tizen> 3 </since_tizen>
1003 public bool Ellipsis
1007 return (bool)GetValue(EllipsisProperty);
1011 SetValue(EllipsisProperty, value);
1012 NotifyPropertyChanged();
1017 /// The ellipsis position of the text.
1018 /// Specifies which portion of the text should be replaced with an ellipsis when the text size exceeds the layout size.<br />
1020 /// <since_tizen> 9 </since_tizen>
1021 public EllipsisPosition EllipsisPosition
1025 return (EllipsisPosition)GetValue(EllipsisPositionProperty);
1029 SetValue(EllipsisPositionProperty, value);
1030 NotifyPropertyChanged();
1035 /// The AutoScrollLoopDelay property.<br />
1036 /// The amount of time to delay the starting time of auto scrolling and further loops.<br />
1038 /// <since_tizen> 3 </since_tizen>
1039 public float AutoScrollLoopDelay
1043 return (float)GetValue(AutoScrollLoopDelayProperty);
1047 SetValue(AutoScrollLoopDelayProperty, value);
1048 NotifyPropertyChanged();
1053 /// The AutoScrollStopMode property.<br />
1054 /// The auto scrolling stop behaviour.<br />
1055 /// The default value is AutoScrollStopMode.FinishLoop. <br />
1057 /// <since_tizen> 3 </since_tizen>
1058 public AutoScrollStopMode AutoScrollStopMode
1062 return (AutoScrollStopMode)GetValue(AutoScrollStopModeProperty);
1066 SetValue(AutoScrollStopModeProperty, value);
1067 NotifyPropertyChanged();
1072 /// The line count of the text.
1074 /// <since_tizen> 3 </since_tizen>
1075 public int LineCount
1080 using (var propertyValue = GetProperty(TextLabel.Property.LineCount))
1082 propertyValue.Get(out lineCount);
1089 /// The LineWrapMode property.<br />
1090 /// line wrap mode when the text lines over layout width.<br />
1092 /// <since_tizen> 4 </since_tizen>
1093 public LineWrapMode LineWrapMode
1097 return (LineWrapMode)GetValue(LineWrapModeProperty);
1101 SetValue(LineWrapModeProperty, value);
1102 NotifyPropertyChanged();
1107 /// The direction of the text such as left to right or right to left.
1109 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
1110 [EditorBrowsable(EditorBrowsableState.Never)]
1111 public TextDirection TextDirection
1115 int textDirection = 0;
1116 using (var propertyValue = GetProperty(TextLabel.Property.TextDirection))
1118 propertyValue.Get(out textDirection);
1120 return (TextDirection)textDirection;
1125 /// The vertical line alignment of the text.
1127 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
1128 [EditorBrowsable(EditorBrowsableState.Never)]
1129 public VerticalLineAlignment VerticalLineAlignment
1133 return (VerticalLineAlignment)GetValue(VerticalLineAlignmentProperty);
1137 SetValue(VerticalLineAlignmentProperty, value);
1138 NotifyPropertyChanged();
1143 /// The text alignment to match the direction of the system language.
1145 /// <since_tizen> 6 </since_tizen>
1146 public bool MatchSystemLanguageDirection
1150 return (bool)GetValue(MatchSystemLanguageDirectionProperty);
1154 SetValue(MatchSystemLanguageDirectionProperty, value);
1155 NotifyPropertyChanged();
1160 /// The text fit parameters.<br />
1161 /// The textFit map contains the following keys :<br />
1162 /// <list type="table">
1163 /// <item><term>enable (bool)</term><description>True to enable the text fit or false to disable (the default value is false)</description></item>
1164 /// <item><term>minSize (float)</term><description>Minimum Size for text fit (the default value is 10.f)</description></item>
1165 /// <item><term>maxSize (float)</term><description>Maximum Size for text fit (the default value is 100.f)</description></item>
1166 /// <item><term>stepSize (float)</term><description>Step Size for font increase (the default value is 1.f)</description></item>
1167 /// <item><term>fontSize (string)</term><description>The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize")</description></item>
1170 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
1171 [EditorBrowsable(EditorBrowsableState.Never)]
1172 [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1721: Property names should not match get methods")]
1173 public PropertyMap TextFit
1177 return (PropertyMap)GetValue(TextFitProperty);
1181 SetValue(TextFitProperty, value);
1182 NotifyPropertyChanged();
1187 /// Set TextFit to TextLabel. <br />
1189 /// <param name="textFit">The TextFit</param>
1191 /// SetTextFit specifies the textFit of the text through <see cref="Tizen.NUI.Text.TextFit"/>. <br />
1194 /// The following example demonstrates how to use the SetTextFit method.
1196 /// var textFit = new Tizen.NUI.Text.TextFit();
1197 /// textFit.Enable = true;
1198 /// textFit.MinSize = 10.0f;
1199 /// textFit.MaxSize = 100.0f;
1200 /// textFit.StepSize = 5.0f;
1201 /// textFit.FontSizeType = FontSizeType.PointSize;
1202 /// label.SetTextFit(textFit);
1205 [EditorBrowsable(EditorBrowsableState.Never)]
1206 public void SetTextFit(TextFit textFit)
1208 using (var textFitMap = TextMapHelper.GetTextFitMap(textFit))
1210 SetValue(TextFitProperty, textFitMap);
1215 /// Get TextFit from TextLabel. <br />
1217 /// <returns>The TextFit</returns>
1219 /// TextFit is always returned based on PointSize. <br />
1220 /// If the user sets FontSizeType to PixelSize, then MinSize, MaxSize, and StepSize are converted based on PointSize and returned. <br />
1221 /// <see cref="Tizen.NUI.Text.TextFit"/>
1223 [EditorBrowsable(EditorBrowsableState.Never)]
1224 public TextFit GetTextFit()
1227 using (var textFitMap = (PropertyMap)GetValue(TextFitProperty))
1229 textFit = TextMapHelper.GetTextFitStruct(textFitMap);
1235 /// The MinLineSize property.<br />
1236 /// The height of the line in points. <br />
1237 /// If the font size is larger than the line size, it works with the font size. <br />
1239 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
1240 [EditorBrowsable(EditorBrowsableState.Never)]
1241 public float MinLineSize
1245 return (float)GetValue(MinLineSizeProperty);
1249 SetValue(MinLineSizeProperty, value);
1250 NotifyPropertyChanged();
1255 /// The FontSizeScale property for scaling the specified font size up or down. <br />
1256 /// The default value is 1.0. <br />
1257 /// The given font size scale value is used for multiplying the specified font size before querying fonts. <br />
1258 /// If FontSizeScale.UseSystemSetting, will use the SystemSettings.FontSize internally. <br />
1260 /// <since_tizen> 9 </since_tizen>
1261 public float FontSizeScale
1265 return fontSizeScale;
1269 float newFontSizeScale;
1271 if (fontSizeScale == value) return;
1273 fontSizeScale = value;
1274 if (fontSizeScale == Tizen.NUI.FontSizeScale.UseSystemSetting)
1276 SystemSettingsFontSize systemSettingsFontSize;
1280 systemSettingsFontSize = SystemSettings.FontSize;
1284 Console.WriteLine("{0} Exception caught.", e);
1285 systemSettingsFontSize = SystemSettingsFontSize.Normal;
1287 newFontSizeScale = TextUtils.GetFontSizeScale(systemSettingsFontSize);
1288 addFontSizeChangedCallback();
1292 newFontSizeScale = fontSizeScale;
1293 removeFontSizeChangedCallback();
1296 SetValue(FontSizeScaleProperty, newFontSizeScale);
1297 NotifyPropertyChanged();
1301 private TextLabelSelectorData EnsureSelectorData() => selectorData ?? (selectorData = new TextLabelSelectorData());
1304 /// Downcasts a handle to textLabel handle
1306 /// <param name="handle"></param>
1307 /// <returns></returns>
1308 /// <exception cref="ArgumentNullException"> Thrown when handle is null. </exception>
1309 /// <since_tizen> 3 </since_tizen>
1310 /// Please do not use! this will be deprecated!
1311 /// Instead please use as keyword.
1312 [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
1314 "BaseHandle handle = new TextLabel(\"Hello World!\"); " +
1315 "TextLabel label = handle as TextLabel")]
1316 [EditorBrowsable(EditorBrowsableState.Never)]
1317 public static TextLabel DownCast(BaseHandle handle)
1321 throw new ArgumentNullException(nameof(handle));
1323 TextLabel ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextLabel;
1324 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1329 [EditorBrowsable(EditorBrowsableState.Never)]
1330 protected override void Dispose(DisposeTypes type)
1337 if (systemlangTextFlag)
1339 SystemSettings.LocaleLanguageChanged -= SystemSettings_LocaleLanguageChanged;
1342 removeFontSizeChangedCallback();
1344 if (type == DisposeTypes.Explicit)
1347 //Release your own managed resources here.
1348 //You should release all of your own disposable objects here.
1349 selectorData?.Reset(this);
1354 if (textLabelTextFitChangedCallbackDelegate != null)
1356 TextFitChangedSignal().Disconnect(textLabelTextFitChangedCallbackDelegate);
1363 /// This will not be public opened.
1364 [EditorBrowsable(EditorBrowsableState.Never)]
1365 protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
1367 Interop.TextLabel.DeleteTextLabel(swigCPtr);
1371 /// Get attribues, it is abstract function and must be override.
1373 [EditorBrowsable(EditorBrowsableState.Never)]
1374 protected override ViewStyle CreateViewStyle()
1376 return new TextLabelStyle();
1379 internal override LayoutItem CreateDefaultLayout()
1381 return new TextLayout();
1385 /// Invoked whenever the binding context of the textlabel changes. Implement this method to add class handling for this event.
1387 protected override void OnBindingContextChanged()
1389 base.OnBindingContextChanged();
1392 private void SystemSettings_LocaleLanguageChanged(object sender, LocaleLanguageChangedEventArgs e)
1394 Text = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(e.Value.Replace("_", "-")));
1397 private void SystemSettingsFontSizeChanged(object sender, FontSizeChangedEventArgs e)
1399 float newFontSizeScale = TextUtils.GetFontSizeScale(e.Value);
1400 SetValue(FontSizeScaleProperty, newFontSizeScale);
1403 private void addFontSizeChangedCallback()
1405 if (hasFontSizeChangedCallback != true)
1409 SystemSettings.FontSizeChanged += SystemSettingsFontSizeChanged;
1410 hasFontSizeChangedCallback = true;
1414 Console.WriteLine("{0} Exception caught.", e);
1415 hasFontSizeChangedCallback = false;
1420 private void removeFontSizeChangedCallback()
1422 if (hasFontSizeChangedCallback == true)
1426 SystemSettings.FontSizeChanged -= SystemSettingsFontSizeChanged;
1427 hasFontSizeChangedCallback = false;
1431 Console.WriteLine("{0} Exception caught.", e);
1432 hasFontSizeChangedCallback = true;
1437 private void RequestLayout()
1439 Layout?.RequestLayout();
1442 internal new class Property
1444 internal static readonly int TEXT = Interop.TextLabel.TextGet();
1445 internal static readonly int FontFamily = Interop.TextLabel.FontFamilyGet();
1446 internal static readonly int FontStyle = Interop.TextLabel.FontStyleGet();
1447 internal static readonly int PointSize = Interop.TextLabel.PointSizeGet();
1448 internal static readonly int MultiLine = Interop.TextLabel.MultiLineGet();
1449 internal static readonly int HorizontalAlignment = Interop.TextLabel.HorizontalAlignmentGet();
1450 internal static readonly int VerticalAlignment = Interop.TextLabel.VerticalAlignmentGet();
1451 internal static readonly int TextColor = Interop.TextLabel.TextColorGet();
1452 internal static readonly int EnableMarkup = Interop.TextLabel.EnableMarkupGet();
1453 internal static readonly int EnableAutoScroll = Interop.TextLabel.EnableAutoScrollGet();
1454 internal static readonly int AutoScrollSpeed = Interop.TextLabel.AutoScrollSpeedGet();
1455 internal static readonly int AutoScrollLoopCount = Interop.TextLabel.AutoScrollLoopCountGet();
1456 internal static readonly int AutoScrollGap = Interop.TextLabel.AutoScrollGapGet();
1457 internal static readonly int LineSpacing = Interop.TextLabel.LineSpacingGet();
1458 internal static readonly int UNDERLINE = Interop.TextLabel.UnderlineGet();
1459 internal static readonly int SHADOW = Interop.TextLabel.ShadowGet();
1460 internal static readonly int EMBOSS = Interop.TextLabel.EmbossGet();
1461 internal static readonly int OUTLINE = Interop.TextLabel.OutlineGet();
1462 internal static readonly int PixelSize = Interop.TextLabel.PixelSizeGet();
1463 internal static readonly int ELLIPSIS = Interop.TextLabel.EllipsisGet();
1464 internal static readonly int AutoScrollStopMode = Interop.TextLabel.AutoScrollStopModeGet();
1465 internal static readonly int AutoScrollLoopDelay = Interop.TextLabel.AutoScrollLoopDelayGet();
1466 internal static readonly int LineCount = Interop.TextLabel.LineCountGet();
1467 internal static readonly int LineWrapMode = Interop.TextLabel.LineWrapModeGet();
1468 internal static readonly int TextDirection = Interop.TextLabel.TextDirectionGet();
1469 internal static readonly int VerticalLineAlignment = Interop.TextLabel.VerticalLineAlignmentGet();
1470 internal static readonly int MatchSystemLanguageDirection = Interop.TextLabel.MatchSystemLanguageDirectionGet();
1471 internal static readonly int TextFit = Interop.TextLabel.TextFitGet();
1472 internal static readonly int MinLineSize = Interop.TextLabel.MinLineSizeGet();
1473 internal static readonly int FontSizeScale = Interop.TextLabel.FontSizeScaleGet();
1474 internal static readonly int EllipsisPosition = Interop.TextLabel.EllipsisPositionGet();
1477 private void OnShadowColorChanged(float x, float y, float z, float w)
1479 ShadowColor = new Vector4(x, y, z, w);
1481 private void OnShadowOffsetChanged(float x, float y)
1483 ShadowOffset = new Vector2(x, y);
1485 private void OnTextColorChanged(float r, float g, float b, float a)
1487 TextColor = new Color(r, g, b, a);
1489 private void OnUnderlineColorChanged(float x, float y, float z, float w)
1491 UnderlineColor = new Vector4(x, y, z, w);