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();
113 internal static readonly int TEXT_DIRECTION = NDalicManualPINVOKE.TextLabel_Property_TEXT_DIRECTION_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();
163 /// The TranslatableText property.<br />
164 /// The text can set the SID value.<br />
166 /// <exception cref='ArgumentNullException'>
167 /// ResourceManager about multilingual is null.
169 /// <since_tizen> 4 </since_tizen>
170 public string TranslatableText
178 if (NUIApplication.MultilingualResourceManager == null)
180 throw new ArgumentNullException("ResourceManager about multilingual is null");
182 string translatableText = null;
183 textLabelSid = value;
184 translatableText = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(SystemSettings.LocaleLanguage.Replace("_", "-")));
185 if (translatableText != null)
187 Text = translatableText;
188 if (systemlangTextFlag == false)
190 SystemSettings.LocaleLanguageChanged += new WeakEventHandler<LocaleLanguageChangedEventArgs>(SystemSettings_LocaleLanguageChanged).Handler;
191 systemlangTextFlag = true;
200 private void SystemSettings_LocaleLanguageChanged(object sender, LocaleLanguageChangedEventArgs e)
202 Text = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(e.Value.Replace("_", "-")));
206 /// The Text property.<br />
207 /// The text to display in the UTF-8 format.<br />
209 /// <since_tizen> 3 </since_tizen>
215 GetProperty(TextLabel.Property.TEXT).Get(out temp);
220 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
225 /// The FontFamily property.<br />
226 /// The requested font family to use.<br />
228 /// <since_tizen> 3 </since_tizen>
229 public string FontFamily
234 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
239 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
244 /// The FontStyle property.<br />
245 /// The requested font style to use.<br />
247 /// <since_tizen> 3 </since_tizen>
248 public PropertyMap FontStyle
252 PropertyMap temp = new PropertyMap();
253 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
258 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
263 /// The PointSize property.<br />
264 /// The size of font in points.<br />
266 /// <since_tizen> 3 </since_tizen>
267 public float PointSize
272 GetProperty(TextLabel.Property.POINT_SIZE).Get(out temp);
277 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
282 /// The MultiLine property.<br />
283 /// The single-line or multi-line layout option.<br />
285 /// <since_tizen> 3 </since_tizen>
286 public bool MultiLine
291 GetProperty(TextLabel.Property.MULTI_LINE).Get(out temp);
296 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
301 /// The HorizontalAlignment property.<br />
302 /// The line horizontal alignment.<br />
304 /// <since_tizen> 3 </since_tizen>
305 public HorizontalAlignment HorizontalAlignment
310 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
312 NUILog.Error("HorizontalAlignment get error!");
317 return HorizontalAlignment.Begin;
319 return HorizontalAlignment.Center;
321 return HorizontalAlignment.End;
323 return HorizontalAlignment.Begin;
328 string valueToString = "";
331 case HorizontalAlignment.Begin:
333 valueToString = "BEGIN";
336 case HorizontalAlignment.Center:
338 valueToString = "CENTER";
341 case HorizontalAlignment.End:
343 valueToString = "END";
348 valueToString = "BEGIN";
352 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
357 /// The VerticalAlignment property.<br />
358 /// The line vertical alignment.<br />
360 /// <since_tizen> 3 </since_tizen>
361 public VerticalAlignment VerticalAlignment
366 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
368 NUILog.Error("VerticalAlignment get error!");
374 return VerticalAlignment.Top;
376 return VerticalAlignment.Center;
378 return VerticalAlignment.Bottom;
380 return VerticalAlignment.Bottom;
385 string valueToString = "";
388 case VerticalAlignment.Top:
390 valueToString = "TOP";
393 case VerticalAlignment.Center:
395 valueToString = "CENTER";
398 case VerticalAlignment.Bottom:
400 valueToString = "BOTTOM";
405 valueToString = "BOTTOM";
409 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
414 /// The TextColor property.<br />
415 /// The color of the text.<br />
416 /// Animation framework can be used to change the color of the text when not using mark up.<br />
417 /// Cannot animate the color when text is auto scrolling.<br />
419 /// <since_tizen> 3 </since_tizen>
420 public Color TextColor
424 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
425 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
430 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
435 /// The ShadowOffset property.<br />
436 /// The drop shadow offset 0 indicates no shadow.<br />
438 /// <since_tizen> 3 </since_tizen>
439 public Vector2 ShadowOffset
443 Vector2 temp = new Vector2(0.0f, 0.0f);
444 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
449 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
454 /// The ShadowColor property.<br />
455 /// The color of a drop shadow.<br />
457 /// <since_tizen> 3 </since_tizen>
458 public Vector4 ShadowColor
462 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
463 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
468 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
473 /// The UnderlineEnabled property.<br />
474 /// The underline enabled flag.<br />
476 /// <since_tizen> 3 </since_tizen>
477 public bool UnderlineEnabled
482 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(out temp);
487 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
492 /// The UnderlineColor property.<br />
493 /// Overrides the underline height from font metrics.<br />
495 /// <since_tizen> 3 </since_tizen>
496 public Vector4 UnderlineColor
500 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
501 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
506 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
511 /// The UnderlineHeight property.<br />
512 /// Overrides the underline height from font metrics.<br />
514 /// <since_tizen> 3 </since_tizen>
515 public float UnderlineHeight
520 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(out temp);
525 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
530 /// The EnableMarkup property.<br />
531 /// Whether the mark-up processing is enabled.<br />
533 /// <since_tizen> 3 </since_tizen>
534 public bool EnableMarkup
539 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(out temp);
544 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
549 /// The EnableAutoScroll property.<br />
550 /// Starts or stops auto scrolling.<br />
552 /// <since_tizen> 3 </since_tizen>
553 public bool EnableAutoScroll
558 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(out temp);
563 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
568 /// The AutoScrollSpeed property.<br />
569 /// Sets the speed of scrolling in pixels per second.<br />
571 /// <since_tizen> 3 </since_tizen>
572 public int AutoScrollSpeed
577 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(out temp);
582 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
587 /// The AutoScrollLoopCount property.<br />
588 /// Number of complete loops when scrolling enabled.<br />
590 /// <since_tizen> 3 </since_tizen>
591 public int AutoScrollLoopCount
596 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(out temp);
601 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
606 /// The AutoScrollGap property.<br />
607 /// Gap before scrolling wraps.<br />
609 /// <since_tizen> 3 </since_tizen>
610 public float AutoScrollGap
615 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(out temp);
620 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
625 /// The LineSpacing property.<br />
626 /// The default extra space between lines in points.<br />
628 /// <since_tizen> 3 </since_tizen>
629 public float LineSpacing
634 GetProperty(TextLabel.Property.LINE_SPACING).Get(out temp);
639 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
644 /// The Underline property.<br />
645 /// The default underline parameters.<br />
647 /// <since_tizen> 3 </since_tizen>
648 public PropertyMap Underline
652 PropertyMap temp = new PropertyMap();
653 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
658 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
663 /// The Shadow property.<br />
664 /// The default shadow parameters.<br />
666 /// <since_tizen> 3 </since_tizen>
667 public PropertyMap Shadow
671 PropertyMap temp = new PropertyMap();
672 GetProperty(TextLabel.Property.SHADOW).Get(temp);
677 SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value));
682 /// The Emboss property.<br />
683 /// The default emboss parameters.<br />
685 /// <since_tizen> 3 </since_tizen>
691 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
696 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
701 /// The Outline property.<br />
702 /// The default outline parameters.<br />
704 /// <since_tizen> 3 </since_tizen>
705 public PropertyMap Outline
709 PropertyMap temp = new PropertyMap();
710 GetProperty(TextLabel.Property.OUTLINE).Get(temp);
715 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
720 /// The PixelSize property.<br />
721 /// The size of font in pixels.<br />
723 /// <since_tizen> 3 </since_tizen>
724 public float PixelSize
729 GetProperty(TextLabel.Property.PIXEL_SIZE).Get(out temp);
734 SetProperty(TextLabel.Property.PIXEL_SIZE, new Tizen.NUI.PropertyValue(value));
739 /// The Ellipsis property.<br />
740 /// Enable or disable the ellipsis.<br />
742 /// <since_tizen> 3 </since_tizen>
748 GetProperty(TextLabel.Property.ELLIPSIS).Get(out temp);
753 SetProperty(TextLabel.Property.ELLIPSIS, new Tizen.NUI.PropertyValue(value));
758 /// The AutoScrollLoopDelay property.<br />
759 /// Do something.<br />
761 /// <since_tizen> 3 </since_tizen>
762 public float AutoScrollLoopDelay
767 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY).Get(out temp);
772 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY, new Tizen.NUI.PropertyValue(value));
777 /// The AutoScrollStopMode property.<br />
778 /// Do something.<br />
780 /// <since_tizen> 3 </since_tizen>
781 public AutoScrollStopMode AutoScrollStopMode
786 if(GetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE).Get(out temp) == false)
788 NUILog.Error("AutoScrollStopMode get error!");
793 return AutoScrollStopMode.FinishLoop;
795 return AutoScrollStopMode.Immediate;
797 return AutoScrollStopMode.FinishLoop;
802 SetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE, new Tizen.NUI.PropertyValue((int)value));
807 /// The line count of the text.
809 /// <since_tizen> 3 </since_tizen>
815 GetProperty(TextLabel.Property.LINE_COUNT).Get(out temp);
821 /// The LineWrapMode property.<br />
822 /// line wrap mode when the text lines over layout width.<br />
824 /// <since_tizen> 4 </since_tizen>
825 public LineWrapMode LineWrapMode
830 if(GetProperty(TextLabel.Property.LINE_WRAP_MODE).Get(out temp) == false)
832 NUILog.Error("LineWrapMode get error!");
834 return (LineWrapMode)temp;
838 SetProperty(TextLabel.Property.LINE_WRAP_MODE, new Tizen.NUI.PropertyValue((int)value));
843 /// The text direction.
845 /// <since_tizen> 5 </since_tizen>
846 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
847 [EditorBrowsable(EditorBrowsableState.Never)]
848 public TextDirection TextDirection
853 GetProperty(TextLabel.Property.TEXT_DIRECTION).Get(out temp);
854 return (TextDirection)temp;