[NUI] remove "_" and refactoring naming to pascal case.
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Xaml / ViewExtensions.cs
1 //
2 // ViewExtensions.cs
3 //
4 // Author:
5 //       Stephane Delcroix <stephane@mi8.be>
6 //
7 // Copyright (c) 2013 Mobile Inception
8 // Copyright (c) 2013 Xamarin, Inc
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining a copy
11 // of this software and associated documentation files (the "Software"), to deal
12 // in the Software without restriction, including without limitation the rights
13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 // copies of the Software, and to permit persons to whom the Software is
15 // furnished to do so, subject to the following conditions:
16 //
17 // The above copyright notice and this permission notice shall be included in
18 // all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 // THE SOFTWARE.
27
28 using System;
29 using System.Reflection;
30 using System.ComponentModel;
31 using Tizen.NUI.Binding;
32
33 namespace Tizen.NUI.Xaml
34 {
35     /// <summary>
36     /// Extension class for View defining Tizen.NUI.Xaml.Extensions.LoadFromXaml{TView} method.
37     /// </summary>
38     [EditorBrowsable(EditorBrowsableState.Never)]
39     public static class Extensions
40     {
41         /// <summary>
42         /// Returns an initialized view by loading the specified xaml.
43         /// </summary>
44         /// <typeparam name="TXaml">The type of view to initialize with state from XAML.</typeparam>
45         /// <param name="view">The view on which this method operates.</param>
46         /// <param name="callingType">The type of the caller.</param>
47         /// <returns>A TXaml with the properties that are defined in the application manifest for callingType.</returns>
48         /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
49         [EditorBrowsable(EditorBrowsableState.Never)]
50         public static TXaml LoadFromXaml<TXaml>(this TXaml view, Type callingType)
51         {
52             XamlLoader.Load(view, callingType);
53             return view;
54         }
55
56         /// <summary>
57         /// Returns a TXaml with the properties that are defined in the application manifest for callingType.
58         /// </summary>
59         /// <typeparam name="TXaml">The type of view to initialize with state from XAML.</typeparam>
60         /// <param name="view">The view on which this method operates.</param>
61         /// <param name="xaml">The XAML that encodes the view state.</param>
62         /// <returns>A TXaml with the properties that are defined in the application manifest for callingType.</returns>
63         /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
64         [EditorBrowsable(EditorBrowsableState.Never)]
65         public static TXaml LoadFromXaml<TXaml>(this TXaml view, string xaml)
66         {
67             XamlLoader.Load(view, xaml);
68             return view;
69         }
70
71         /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
72         [EditorBrowsable(EditorBrowsableState.Never)]
73         public static T LoadObject<T>(string path)
74         {
75             return XamlLoader.LoadObject<T>(path);
76         }
77
78         /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
79         [EditorBrowsable(EditorBrowsableState.Never)]
80         public static TXaml LoadFromXamlFile<TXaml>(this TXaml view, string nameOfXamlFile)
81         {
82             NUILog.Debug($"LoadFromXamlFile(nameOfXamlFile={nameOfXamlFile})");
83
84             string xamlScript = XamlLoader.GetXamlForName(nameOfXamlFile);
85             XamlLoader.Load(view, xamlScript);
86             return view;
87         }
88
89     }
90 }