2 * Copyright(c) 2017 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;
21 using System.Globalization;
22 using System.ComponentModel;
23 namespace Tizen.NUI.BaseComponents
27 /// A control which renders a short text string.<br />
28 /// Text labels are lightweight, non-editable, and do not respond to the user input.<br />
30 /// <since_tizen> 3 </since_tizen>
31 public class TextLabel : View
33 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
34 private string textLabelSid = null;
35 private bool systemlangTextFlag = false;
36 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TextLabel_SWIGUpcast(cPtr), cMemoryOwn)
38 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
41 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TextLabel obj)
43 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
49 /// <since_tizen> 3 </since_tizen>
50 protected override void Dispose(DisposeTypes type)
57 if(type == DisposeTypes.Explicit)
60 //Release your own managed resources here.
61 //You should release all of your own disposable objects here.
64 //Release your own unmanaged resources here.
65 //You should not access any managed member here except static instance.
66 //because the execution order of Finalizes is non-deterministic.
68 if (swigCPtr.Handle != global::System.IntPtr.Zero)
73 NDalicPINVOKE.delete_TextLabel(swigCPtr);
75 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
81 internal new class Property
83 internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
84 internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
85 internal static readonly int FONT_FAMILY = NDalicPINVOKE.TextLabel_Property_FONT_FAMILY_get();
86 internal static readonly int FONT_STYLE = NDalicPINVOKE.TextLabel_Property_FONT_STYLE_get();
87 internal static readonly int POINT_SIZE = NDalicPINVOKE.TextLabel_Property_POINT_SIZE_get();
88 internal static readonly int MULTI_LINE = NDalicPINVOKE.TextLabel_Property_MULTI_LINE_get();
89 internal static readonly int HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_HORIZONTAL_ALIGNMENT_get();
90 internal static readonly int VERTICAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_VERTICAL_ALIGNMENT_get();
91 internal static readonly int TEXT_COLOR = NDalicPINVOKE.TextLabel_Property_TEXT_COLOR_get();
92 internal static readonly int SHADOW_OFFSET = NDalicPINVOKE.TextLabel_Property_SHADOW_OFFSET_get();
93 internal static readonly int SHADOW_COLOR = NDalicPINVOKE.TextLabel_Property_SHADOW_COLOR_get();
94 internal static readonly int UNDERLINE_ENABLED = NDalicPINVOKE.TextLabel_Property_UNDERLINE_ENABLED_get();
95 internal static readonly int UNDERLINE_COLOR = NDalicPINVOKE.TextLabel_Property_UNDERLINE_COLOR_get();
96 internal static readonly int UNDERLINE_HEIGHT = NDalicPINVOKE.TextLabel_Property_UNDERLINE_HEIGHT_get();
97 internal static readonly int ENABLE_MARKUP = NDalicPINVOKE.TextLabel_Property_ENABLE_MARKUP_get();
98 internal static readonly int ENABLE_AUTO_SCROLL = NDalicPINVOKE.TextLabel_Property_ENABLE_AUTO_SCROLL_get();
99 internal static readonly int AUTO_SCROLL_SPEED = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_SPEED_get();
100 internal static readonly int AUTO_SCROLL_LOOP_COUNT = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_COUNT_get();
101 internal static readonly int AUTO_SCROLL_GAP = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_GAP_get();
102 internal static readonly int LINE_SPACING = NDalicPINVOKE.TextLabel_Property_LINE_SPACING_get();
103 internal static readonly int UNDERLINE = NDalicPINVOKE.TextLabel_Property_UNDERLINE_get();
104 internal static readonly int SHADOW = NDalicPINVOKE.TextLabel_Property_SHADOW_get();
105 internal static readonly int EMBOSS = NDalicPINVOKE.TextLabel_Property_EMBOSS_get();
106 internal static readonly int OUTLINE = NDalicPINVOKE.TextLabel_Property_OUTLINE_get();
107 internal static readonly int PIXEL_SIZE = NDalicManualPINVOKE.TextLabel_Property_PIXEL_SIZE_get();
108 internal static readonly int ELLIPSIS = NDalicManualPINVOKE.TextLabel_Property_ELLIPSIS_get();
109 internal static readonly int AUTO_SCROLL_STOP_MODE = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_STOP_MODE_get();
110 internal static readonly int AUTO_SCROLL_LOOP_DELAY = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_DELAY_get();
111 internal static readonly int LINE_COUNT = NDalicManualPINVOKE.TextLabel_Property_LINE_COUNT_get();
112 internal static readonly int LINE_WRAP_MODE = NDalicManualPINVOKE.TextLabel_Property_LINE_WRAP_MODE_get();
117 /// Creates the TextLabel control.
119 /// <since_tizen> 3 </since_tizen>
120 public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
122 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
127 /// Creates the TextLabel control.
129 /// <param name="text">The text to display</param>
130 /// <since_tizen> 3 </since_tizen>
131 public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
133 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
136 internal TextLabel(TextLabel handle) : this(NDalicPINVOKE.new_TextLabel__SWIG_1(TextLabel.getCPtr(handle)), true)
138 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
142 /// Downcasts a handle to textLabel handle
144 /// <param name="handle"></param>
145 /// <returns></returns>
146 /// <since_tizen> 3 </since_tizen>
147 /// Please do not use! this will be deprecated!
148 /// Instead please use as keyword.
149 [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead! " +
151 "BaseHandle handle = new TextLabel(\"Hello World!\"); " +
152 "TextLabel label = handle as TextLabel")]
153 [EditorBrowsable(EditorBrowsableState.Never)]
154 public new static TextLabel DownCast(BaseHandle handle)
156 TextLabel ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextLabel;
158 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
162 /// The TranslatableText property.<br />
163 /// The text can set the SID value.<br />
165 /// <exception cref='ArgumentNullException'>
166 /// ResourceManager about multilingual is null.
168 /// <since_tizen> 4 </since_tizen>
169 public string TranslatableText
177 if (NUIApplication.MultilingualResourceManager == null)
179 throw new ArgumentNullException("ResourceManager about multilingual is null");
181 string translatableText = null;
182 textLabelSid = value;
183 translatableText = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(SystemSettings.LocaleLanguage.Replace("_", "-")));
184 if (translatableText != null)
186 Text = translatableText;
187 if (systemlangTextFlag == false)
189 SystemSettings.LocaleLanguageChanged += new WeakEventHandler<LocaleLanguageChangedEventArgs>(SystemSettings_LocaleLanguageChanged).Handler;
190 systemlangTextFlag = true;
199 private void SystemSettings_LocaleLanguageChanged(object sender, LocaleLanguageChangedEventArgs e)
201 Text = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(e.Value.Replace("_", "-")));
205 /// The Text property.<br />
206 /// The text to display in the UTF-8 format.<br />
208 /// <since_tizen> 3 </since_tizen>
214 GetProperty(TextLabel.Property.TEXT).Get(out temp);
219 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
224 /// The FontFamily property.<br />
225 /// The requested font family to use.<br />
227 /// <since_tizen> 3 </since_tizen>
228 public string FontFamily
233 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
238 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
243 /// The FontStyle property.<br />
244 /// The requested font style to use.<br />
246 /// <since_tizen> 3 </since_tizen>
247 public PropertyMap FontStyle
251 PropertyMap temp = new PropertyMap();
252 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
257 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
262 /// The PointSize property.<br />
263 /// The size of font in points.<br />
265 /// <since_tizen> 3 </since_tizen>
266 public float PointSize
271 GetProperty(TextLabel.Property.POINT_SIZE).Get(out temp);
276 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
281 /// The MultiLine property.<br />
282 /// The single-line or multi-line layout option.<br />
284 /// <since_tizen> 3 </since_tizen>
285 public bool MultiLine
290 GetProperty(TextLabel.Property.MULTI_LINE).Get(out temp);
295 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
300 /// The HorizontalAlignment property.<br />
301 /// The line horizontal alignment.<br />
303 /// <since_tizen> 3 </since_tizen>
304 public HorizontalAlignment HorizontalAlignment
309 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
311 NUILog.Error("HorizontalAlignment get error!");
316 return HorizontalAlignment.Begin;
318 return HorizontalAlignment.Center;
320 return HorizontalAlignment.End;
322 return HorizontalAlignment.Begin;
327 string valueToString = "";
330 case HorizontalAlignment.Begin:
332 valueToString = "BEGIN";
335 case HorizontalAlignment.Center:
337 valueToString = "CENTER";
340 case HorizontalAlignment.End:
342 valueToString = "END";
347 valueToString = "BEGIN";
351 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
356 /// The VerticalAlignment property.<br />
357 /// The line vertical alignment.<br />
359 /// <since_tizen> 3 </since_tizen>
360 public VerticalAlignment VerticalAlignment
365 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
367 NUILog.Error("VerticalAlignment get error!");
373 return VerticalAlignment.Top;
375 return VerticalAlignment.Center;
377 return VerticalAlignment.Bottom;
379 return VerticalAlignment.Bottom;
384 string valueToString = "";
387 case VerticalAlignment.Top:
389 valueToString = "TOP";
392 case VerticalAlignment.Center:
394 valueToString = "CENTER";
397 case VerticalAlignment.Bottom:
399 valueToString = "BOTTOM";
404 valueToString = "BOTTOM";
408 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
413 /// The TextColor property.<br />
414 /// The color of the text.<br />
415 /// Animation framework can be used to change the color of the text when not using mark up.<br />
416 /// Cannot animate the color when text is auto scrolling.<br />
418 /// <since_tizen> 3 </since_tizen>
419 public Color TextColor
423 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
424 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
429 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
434 /// The ShadowOffset property.<br />
435 /// The drop shadow offset 0 indicates no shadow.<br />
437 /// <since_tizen> 3 </since_tizen>
438 public Vector2 ShadowOffset
442 Vector2 temp = new Vector2(0.0f, 0.0f);
443 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
448 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
453 /// The ShadowColor property.<br />
454 /// The color of a drop shadow.<br />
456 /// <since_tizen> 3 </since_tizen>
457 public Vector4 ShadowColor
461 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
462 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
467 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
472 /// The UnderlineEnabled property.<br />
473 /// The underline enabled flag.<br />
475 /// <since_tizen> 3 </since_tizen>
476 public bool UnderlineEnabled
481 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(out temp);
486 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
491 /// The UnderlineColor property.<br />
492 /// Overrides the underline height from font metrics.<br />
494 /// <since_tizen> 3 </since_tizen>
495 public Vector4 UnderlineColor
499 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
500 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
505 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
510 /// The UnderlineHeight property.<br />
511 /// Overrides the underline height from font metrics.<br />
513 /// <since_tizen> 3 </since_tizen>
514 public float UnderlineHeight
519 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(out temp);
524 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
529 /// The EnableMarkup property.<br />
530 /// Whether the mark-up processing is enabled.<br />
532 /// <since_tizen> 3 </since_tizen>
533 public bool EnableMarkup
538 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(out temp);
543 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
548 /// The EnableAutoScroll property.<br />
549 /// Starts or stops auto scrolling.<br />
551 /// <since_tizen> 3 </since_tizen>
552 public bool EnableAutoScroll
557 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(out temp);
562 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
567 /// The AutoScrollSpeed property.<br />
568 /// Sets the speed of scrolling in pixels per second.<br />
570 /// <since_tizen> 3 </since_tizen>
571 public int AutoScrollSpeed
576 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(out temp);
581 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
586 /// The AutoScrollLoopCount property.<br />
587 /// Number of complete loops when scrolling enabled.<br />
589 /// <since_tizen> 3 </since_tizen>
590 public int AutoScrollLoopCount
595 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(out temp);
600 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
605 /// The AutoScrollGap property.<br />
606 /// Gap before scrolling wraps.<br />
608 /// <since_tizen> 3 </since_tizen>
609 public float AutoScrollGap
614 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(out temp);
619 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
624 /// The LineSpacing property.<br />
625 /// The default extra space between lines in points.<br />
627 /// <since_tizen> 3 </since_tizen>
628 public float LineSpacing
633 GetProperty(TextLabel.Property.LINE_SPACING).Get(out temp);
638 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
643 /// The Underline property.<br />
644 /// The default underline parameters.<br />
646 /// <since_tizen> 3 </since_tizen>
647 public PropertyMap Underline
651 PropertyMap temp = new PropertyMap();
652 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
657 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
662 /// The Shadow property.<br />
663 /// The default shadow parameters.<br />
665 /// <since_tizen> 3 </since_tizen>
666 public PropertyMap Shadow
670 PropertyMap temp = new PropertyMap();
671 GetProperty(TextLabel.Property.SHADOW).Get(temp);
676 SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value));
681 /// The Emboss property.<br />
682 /// The default emboss parameters.<br />
684 /// <since_tizen> 3 </since_tizen>
690 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
695 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
700 /// The Outline property.<br />
701 /// The default outline parameters.<br />
703 /// <since_tizen> 3 </since_tizen>
704 public PropertyMap Outline
708 PropertyMap temp = new PropertyMap();
709 GetProperty(TextLabel.Property.OUTLINE).Get(temp);
714 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
719 /// The PixelSize property.<br />
720 /// The size of font in pixels.<br />
722 /// <since_tizen> 3 </since_tizen>
723 public float PixelSize
728 GetProperty(TextLabel.Property.PIXEL_SIZE).Get(out temp);
733 SetProperty(TextLabel.Property.PIXEL_SIZE, new Tizen.NUI.PropertyValue(value));
738 /// The Ellipsis property.<br />
739 /// Enable or disable the ellipsis.<br />
741 /// <since_tizen> 3 </since_tizen>
747 GetProperty(TextLabel.Property.ELLIPSIS).Get(out temp);
752 SetProperty(TextLabel.Property.ELLIPSIS, new Tizen.NUI.PropertyValue(value));
757 /// The AutoScrollLoopDelay property.<br />
758 /// Do something.<br />
760 /// <since_tizen> 3 </since_tizen>
761 public float AutoScrollLoopDelay
766 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY).Get(out temp);
771 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY, new Tizen.NUI.PropertyValue(value));
776 /// The AutoScrollStopMode property.<br />
777 /// Do something.<br />
779 /// <since_tizen> 3 </since_tizen>
780 public AutoScrollStopMode AutoScrollStopMode
785 if(GetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE).Get(out temp) == false)
787 NUILog.Error("AutoScrollStopMode get error!");
792 return AutoScrollStopMode.FinishLoop;
794 return AutoScrollStopMode.Immediate;
796 return AutoScrollStopMode.FinishLoop;
801 SetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE, new Tizen.NUI.PropertyValue((int)value));
806 /// The line count of the text.
808 /// <since_tizen> 3 </since_tizen>
814 GetProperty(TextLabel.Property.LINE_COUNT).Get(out temp);
820 /// The LineWrapMode property.<br />
821 /// line wrap mode when the text lines over layout width.<br />
823 /// <since_tizen> 4 </since_tizen>
824 public LineWrapMode LineWrapMode
829 if(GetProperty(TextLabel.Property.LINE_WRAP_MODE).Get(out temp) == false)
831 NUILog.Error("LineWrapMode get error!");
835 case "WRAP_MODE_WORD":
836 return LineWrapMode.Word;
837 case "WRAP_MODE_CHARACTER":
838 return LineWrapMode.Character;
840 return LineWrapMode.Word;
848 case LineWrapMode.Word:
850 temp = "WRAP_MODE_WORD";
853 case LineWrapMode.Character:
855 temp = "WRAP_MODE_CHARACTER";
859 SetProperty(TextLabel.Property.LINE_WRAP_MODE, new Tizen.NUI.PropertyValue(temp));