Merge "Fix some bugs: (1)Change the return type of Window.IsVisible() form void to...
[platform/core/csapi/nui.git] / Tizen.NUI / src / public / TextLabel.cs
1 /** Copyright (c) 2017 Samsung Electronics Co., Ltd.
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 *
15 */
16 // This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
17 //------------------------------------------------------------------------------
18 // <auto-generated />
19 //
20 // This file was automatically generated by SWIG (http://www.swig.org).
21 // Version 3.0.9
22 //
23 // Do not make changes to this file unless you know what you are doing--modify
24 // the SWIG interface file instead.
25 //------------------------------------------------------------------------------
26
27 namespace Tizen.NUI
28 {
29
30     /// <summary>
31     /// A control which renders a short text string.<br>
32     /// Text labels are lightweight, non-editable and do not respond to user input.<br>
33     /// </summary>
34     public class TextLabel : View
35     {
36         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
37
38         internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TextLabel_SWIGUpcast(cPtr), cMemoryOwn)
39         {
40             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
41         }
42
43         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TextLabel obj)
44         {
45             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
46         }
47
48         ~TextLabel()
49         {
50             DisposeQueue.Instance.Add(this);
51         }
52
53         /// <summary>
54         /// Dispose
55         /// </summary>
56         public override void Dispose()
57         {
58             if (!Stage.IsInstalled())
59             {
60                 DisposeQueue.Instance.Add(this);
61                 return;
62             }
63
64             lock (this)
65             {
66                 if (swigCPtr.Handle != global::System.IntPtr.Zero)
67                 {
68                     if (swigCMemOwn)
69                     {
70                         swigCMemOwn = false;
71                         NDalicPINVOKE.delete_TextLabel(swigCPtr);
72                     }
73                     swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
74                 }
75                 global::System.GC.SuppressFinalize(this);
76                 base.Dispose();
77             }
78         }
79
80
81         internal class Property : global::System.IDisposable
82         {
83             private global::System.Runtime.InteropServices.HandleRef swigCPtr;
84             protected bool swigCMemOwn;
85
86             internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
87             {
88                 swigCMemOwn = cMemoryOwn;
89                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
90             }
91
92             internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Property obj)
93             {
94                 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
95             }
96
97             ~Property()
98             {
99                 Dispose();
100             }
101
102             public virtual void Dispose()
103             {
104                 lock (this)
105                 {
106                     if (swigCPtr.Handle != global::System.IntPtr.Zero)
107                     {
108                         if (swigCMemOwn)
109                         {
110                             swigCMemOwn = false;
111                             NDalicPINVOKE.delete_TextLabel_Property(swigCPtr);
112                         }
113                         swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
114                     }
115                     global::System.GC.SuppressFinalize(this);
116                 }
117             }
118
119             internal Property() : this(NDalicPINVOKE.new_TextLabel_Property(), true)
120             {
121                 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
122             }
123
124             internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
125             internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
126             internal static readonly int FONT_FAMILY = NDalicPINVOKE.TextLabel_Property_FONT_FAMILY_get();
127             internal static readonly int FONT_STYLE = NDalicPINVOKE.TextLabel_Property_FONT_STYLE_get();
128             internal static readonly int POINT_SIZE = NDalicPINVOKE.TextLabel_Property_POINT_SIZE_get();
129             internal static readonly int MULTI_LINE = NDalicPINVOKE.TextLabel_Property_MULTI_LINE_get();
130             internal static readonly int HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_HORIZONTAL_ALIGNMENT_get();
131             internal static readonly int VERTICAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_VERTICAL_ALIGNMENT_get();
132             internal static readonly int TEXT_COLOR = NDalicPINVOKE.TextLabel_Property_TEXT_COLOR_get();
133             internal static readonly int SHADOW_OFFSET = NDalicPINVOKE.TextLabel_Property_SHADOW_OFFSET_get();
134             internal static readonly int SHADOW_COLOR = NDalicPINVOKE.TextLabel_Property_SHADOW_COLOR_get();
135             internal static readonly int UNDERLINE_ENABLED = NDalicPINVOKE.TextLabel_Property_UNDERLINE_ENABLED_get();
136             internal static readonly int UNDERLINE_COLOR = NDalicPINVOKE.TextLabel_Property_UNDERLINE_COLOR_get();
137             internal static readonly int UNDERLINE_HEIGHT = NDalicPINVOKE.TextLabel_Property_UNDERLINE_HEIGHT_get();
138             internal static readonly int ENABLE_MARKUP = NDalicPINVOKE.TextLabel_Property_ENABLE_MARKUP_get();
139             internal static readonly int ENABLE_AUTO_SCROLL = NDalicPINVOKE.TextLabel_Property_ENABLE_AUTO_SCROLL_get();
140             internal static readonly int AUTO_SCROLL_SPEED = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_SPEED_get();
141             internal static readonly int AUTO_SCROLL_LOOP_COUNT = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_COUNT_get();
142             internal static readonly int AUTO_SCROLL_GAP = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_GAP_get();
143             internal static readonly int LINE_SPACING = NDalicPINVOKE.TextLabel_Property_LINE_SPACING_get();
144             internal static readonly int UNDERLINE = NDalicPINVOKE.TextLabel_Property_UNDERLINE_get();
145             internal static readonly int SHADOW = NDalicPINVOKE.TextLabel_Property_SHADOW_get();
146             internal static readonly int EMBOSS = NDalicPINVOKE.TextLabel_Property_EMBOSS_get();
147             internal static readonly int OUTLINE = NDalicPINVOKE.TextLabel_Property_OUTLINE_get();
148
149         }
150
151         /// <summary>
152         /// Creates the TextLabel control.
153         /// </summary>
154         public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
155         {
156             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
157
158         }
159
160         /// <summary>
161         /// Creates the TextLabel control.
162         /// </summary>
163         /// <param name="text">The text to display</param>
164         public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
165         {
166             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
167
168         }
169         internal TextLabel(TextLabel handle) : this(NDalicPINVOKE.new_TextLabel__SWIG_1(TextLabel.getCPtr(handle)), true)
170         {
171             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
172         }
173
174         internal TextLabel Assign(TextLabel handle)
175         {
176             TextLabel ret = new TextLabel(NDalicPINVOKE.TextLabel_Assign(swigCPtr, TextLabel.getCPtr(handle)), false);
177             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
178             return ret;
179         }
180
181         /// <summary>
182         /// Downcasts a handle to TextLabel.
183         /// </summary>
184         /// <param name="handle">Handle to an object</param>
185         public new static TextLabel DownCast(BaseHandle handle)
186         {
187             TextLabel ret = new TextLabel(NDalicPINVOKE.TextLabel_DownCast(BaseHandle.getCPtr(handle)), true);
188             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
189             return ret;
190         }
191
192         internal enum PropertyRange
193         {
194             PROPERTY_START_INDEX = PropertyRanges.PROPERTY_REGISTRATION_START_INDEX,
195             PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000
196         }
197
198         /// <summary>
199         /// RenderingBackend property.<br>
200         /// The type of rendering e.g. bitmap-based.
201         /// </summary>
202         public int RenderingBackend
203         {
204             get
205             {
206                 int temp = 0;
207                 GetProperty(TextLabel.Property.RENDERING_BACKEND).Get(ref temp);
208                 return temp;
209             }
210             set
211             {
212                 SetProperty(TextLabel.Property.RENDERING_BACKEND, new Tizen.NUI.PropertyValue(value));
213             }
214         }
215
216         /// <summary>
217         /// Text property.<br>
218         /// The text to display in UTF-8 format.<br>
219         /// </summary>
220         public string Text
221         {
222             get
223             {
224                 string temp;
225                 GetProperty(TextLabel.Property.TEXT).Get(out temp);
226                 return temp;
227             }
228             set
229             {
230                 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
231             }
232         }
233
234         /// <summary>
235         /// FontFamily property.<br>
236         /// The requested font family to use.<br>
237         /// </summary>
238         public string FontFamily
239         {
240             get
241             {
242                 string temp;
243                 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
244                 return temp;
245             }
246             set
247             {
248                 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
249             }
250         }
251
252         /// <summary>
253         /// FontStyle property.<br>
254         /// The requested font style to use.<br>
255         /// </summary>
256         public PropertyMap FontStyle
257         {
258             get
259             {
260                 PropertyMap temp = new PropertyMap();
261                 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
262                 return temp;
263             }
264             set
265             {
266                 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
267             }
268         }
269
270         /// <summary>
271         /// PointSize property.<br>
272         /// The size of font in points.<br>
273         /// </summary>
274         public float PointSize
275         {
276             get
277             {
278                 float temp = 0.0f;
279                 GetProperty(TextLabel.Property.POINT_SIZE).Get(ref temp);
280                 return temp;
281             }
282             set
283             {
284                 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
285             }
286         }
287
288         /// <summary>
289         /// MultiLine property.<br>
290         /// The single-line or multi-line layout option.<br>
291         /// </summary>
292         public bool MultiLine
293         {
294             get
295             {
296                 bool temp = false;
297                 GetProperty(TextLabel.Property.MULTI_LINE).Get(ref temp);
298                 return temp;
299             }
300             set
301             {
302                 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
303             }
304         }
305
306         /// <summary>
307         /// HorizontalAlignment property.<br>
308         /// The line horizontal alignment.<br>
309         /// </summary>
310         public HorizontalAlignment HorizontalAlignment
311         {
312             get
313             {
314                 string temp;
315                 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
316                 {
317                     //Tizen.Log.Error("NUI", "HorizontalAlignment get error!");
318                 }
319                 switch (temp)
320                 {
321                     case "BEGIN":
322                         return HorizontalAlignment.HorizontalAlignBegin;
323                     case "CENTER":
324                         return HorizontalAlignment.HorizontalAlignCenter;
325                     case "END":
326                         return HorizontalAlignment.HorizontalAlignEnd;
327                     default:
328                         return HorizontalAlignment.HorizontalAlignBegin;
329                 }
330             }
331             set
332             {
333                 string valueToString = "";
334                 switch (value)
335                 {
336                     case HorizontalAlignment.HorizontalAlignBegin:
337                     {
338                         valueToString = "BEGIN";
339                         break;
340                     }
341                     case HorizontalAlignment.HorizontalAlignCenter:
342                     {
343                         valueToString = "CENTER";
344                         break;
345                     }
346                     case HorizontalAlignment.HorizontalAlignEnd:
347                     {
348                         valueToString = "END";
349                         break;
350                     }
351                     default:
352                     {
353                         valueToString = "BEGIN";
354                         break;
355                     }
356                 }
357                 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
358             }
359         }
360
361         /// <summary>
362         /// VerticalAlignment property.<br>
363         /// The line vertical alignment.<br>
364         /// </summary>
365         public VerticalAlignment VerticalAlignment
366         {
367             get
368             {
369                 string temp;
370                 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
371                 {
372                     //Tizen.Log.Error("NUI", "VerticalAlignment get error!");
373                 }
374
375                 switch (temp)
376                 {
377                     case "TOP":
378                         return VerticalAlignment.VerticalAlignTop;
379                     case "CENTER":
380                         return VerticalAlignment.VerticalAlignCenter;
381                     case "BOTTOM":
382                         return VerticalAlignment.VerticalAlignBottom;
383                     default:
384                         return VerticalAlignment.VerticalAlignBottom;
385                 }
386             }
387             set
388             {
389                 string valueToString = "";
390                 switch (value)
391                 {
392                     case VerticalAlignment.VerticalAlignTop:
393                     {
394                         valueToString = "TOP";
395                         break;
396                     }
397                     case VerticalAlignment.VerticalAlignCenter:
398                     {
399                         valueToString = "CENTER";
400                         break;
401                     }
402                     case VerticalAlignment.VerticalAlignBottom:
403                     {
404                         valueToString = "BOTTOM";
405                         break;
406                     }
407                     default:
408                     {
409                         valueToString = "BOTTOM";
410                         break;
411                     }
412                 }
413                 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
414             }
415         }
416
417         /// <summary>
418         /// TextColor property.<br>
419         /// The color of the text.<br>
420         /// </summary>
421         public Color TextColor
422         {
423             get
424             {
425                 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
426                 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
427                 return temp;
428             }
429             set
430             {
431                 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
432             }
433         }
434
435         /// <summary>
436         /// ShadowOffset property.<br>
437         /// The drop shadow offset 0 indicates no shadow.<br>
438         /// </summary>
439         public Vector2 ShadowOffset
440         {
441             get
442             {
443                 Vector2 temp = new Vector2(0.0f, 0.0f);
444                 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
445                 return temp;
446             }
447             set
448             {
449                 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
450             }
451         }
452
453         /// <summary>
454         /// ShadowColor property.<br>
455         /// The color of a drop shadow.<br>
456         /// </summary>
457         public Vector4 ShadowColor
458         {
459             get
460             {
461                 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
462                 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
463                 return temp;
464             }
465             set
466             {
467                 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
468             }
469         }
470
471         /// <summary>
472         /// UnderlineEnabled property.<br>
473         /// The underline enabled flag.<br>
474         /// </summary>
475         public bool UnderlineEnabled
476         {
477             get
478             {
479                 bool temp = false;
480                 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(ref temp);
481                 return temp;
482             }
483             set
484             {
485                 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
486             }
487         }
488
489         /// <summary>
490         /// UnderlineColor property.<br>
491         /// Overrides the underline height from font metrics.<br>
492         /// </summary>
493         public Vector4 UnderlineColor
494         {
495             get
496             {
497                 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
498                 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
499                 return temp;
500             }
501             set
502             {
503                 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
504             }
505         }
506
507         /// <summary>
508         /// UnderlineHeight property.<br>
509         /// Overrides the underline height from font metrics.<br>
510         /// </summary>
511         public float UnderlineHeight
512         {
513             get
514             {
515                 float temp = 0.0f;
516                 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(ref temp);
517                 return temp;
518             }
519             set
520             {
521                 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
522             }
523         }
524
525         /// <summary>
526         /// EnableMarkup property.<br>
527         /// Whether the mark-up processing is enabled.<br>
528         /// </summary>
529         public bool EnableMarkup
530         {
531             get
532             {
533                 bool temp = false;
534                 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(ref temp);
535                 return temp;
536             }
537             set
538             {
539                 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
540             }
541         }
542
543         /// <summary>
544         /// EnableAutoScroll property.<br>
545         /// Starts or stops auto scrolling.<br>
546         /// </summary>
547         public bool EnableAutoScroll
548         {
549             get
550             {
551                 bool temp = false;
552                 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(ref temp);
553                 return temp;
554             }
555             set
556             {
557                 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
558             }
559         }
560
561         /// <summary>
562         /// AutoScrollSpeed property.<br>
563         /// Sets the speed of scrolling in pixels per second.<br>
564         /// </summary>
565         public int AutoScrollSpeed
566         {
567             get
568             {
569                 int temp = 0;
570                 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(ref temp);
571                 return temp;
572             }
573             set
574             {
575                 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
576             }
577         }
578
579         /// <summary>
580         /// AutoScrollLoopCount property.<br>
581         /// Number of complete loops when scrolling enabled.<br>
582         /// </summary>
583         public int AutoScrollLoopCount
584         {
585             get
586             {
587                 int temp = 0;
588                 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(ref temp);
589                 return temp;
590             }
591             set
592             {
593                 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
594             }
595         }
596
597         /// <summary>
598         /// AutoScrollGap property.<br>
599         /// Gap before scrolling wraps.<br>
600         /// </summary>
601         public float AutoScrollGap
602         {
603             get
604             {
605                 float temp = 0.0f;
606                 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(ref temp);
607                 return temp;
608             }
609             set
610             {
611                 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
612             }
613         }
614
615         /// <summary>
616         /// LineSpacing property.<br>
617         /// The default extra space between lines in points.<br>
618         /// </summary>
619         public float LineSpacing
620         {
621             get
622             {
623                 float temp = 0.0f;
624                 GetProperty(TextLabel.Property.LINE_SPACING).Get(ref temp);
625                 return temp;
626             }
627             set
628             {
629                 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
630             }
631         }
632
633         /// <summary>
634         /// Underline property.<br>
635         /// The default underline parameters.<br>
636         /// </summary>
637         public PropertyMap Underline
638         {
639             get
640             {
641                 PropertyMap temp = new PropertyMap();
642                 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
643                 return temp;
644             }
645             set
646             {
647                 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
648             }
649         }
650
651         /// <summary>
652         /// Shadow property.<br>
653         /// The default shadow parameters.<br>
654         /// </summary>
655         public PropertyMap Shadow
656         {
657             get
658             {
659                 PropertyMap temp = new PropertyMap();
660                 GetProperty(TextLabel.Property.SHADOW).Get(temp);
661                 return temp;
662             }
663             set
664             {
665                 SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value));
666             }
667         }
668
669         /// <summary>
670         /// Emboss property.<br>
671         /// The default emboss parameters.<br>
672         /// </summary>
673         public string Emboss
674         {
675             get
676             {
677                 string temp;
678                 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
679                 return temp;
680             }
681             set
682             {
683                 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
684             }
685         }
686
687         /// <summary>
688         /// Outline property.<br>
689         /// The default outline parameters.<br>
690         /// </summary>
691         public string Outline
692         {
693             get
694             {
695                 string temp;
696                 GetProperty(TextLabel.Property.OUTLINE).Get(out temp);
697                 return temp;
698             }
699             set
700             {
701                 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
702             }
703         }
704
705     }
706
707     /// <summary>
708     /// Enumeration for the text horizontal aligning.
709     /// </summary>
710     public enum HorizontalAlignment
711     {
712         /// <summary>
713         /// Texts place at the begin of horizontal direction.
714         /// </summary>
715         HorizontalAlignBegin,
716         /// <summary>
717         /// Texts place at the center of horizontal direction.
718         /// </summary>
719         HorizontalAlignCenter,
720         /// <summary>
721         /// Texts place at the end of horizontal direction.
722         /// </summary>
723         HorizontalAlignEnd
724     }
725
726     /// <summary>
727     /// Enumeration for the text horizontal aligning.
728     /// </summary>
729     public enum VerticalAlignment
730     {
731         /// <summary>
732         /// Texts place at the top of vertical direction.
733         /// </summary>
734         VerticalAlignTop,
735         /// <summary>
736         /// Texts place at the center of vertical direction.
737         /// </summary>
738         VerticalAlignCenter,
739         /// <summary>
740         /// Texts place at the bottom of vertical direction.
741         /// </summary>
742         VerticalAlignBottom
743     }
744
745 }