ILocalizer.cs
1 //
2 // Copyright (c) Microsoft. All rights reserved.
3 // Licensed under the MIT license.
4 //
5 // Microsoft Bot Framework: http://botframework.com
6 //
7 // Bot Builder SDK GitHub:
8 // https://github.com/Microsoft/BotBuilder
9 //
10 // Copyright (c) Microsoft Corporation
11 // All rights reserved.
12 //
13 // MIT License:
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
21 //
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
24 //
25 // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 //
33 
34 using System.Collections;
35 using System.Collections.Generic;
36 using System.Globalization;
37 using System.Resources;
38 
39 namespace Microsoft.Bot.Builder.FormFlow.Advanced
40 {
41  #region Documentation
42  #endregion
44  public interface ILocalizer
45  {
50  CultureInfo Culture { get; set; }
51 
57  void Add(string key, string translation);
58 
64  void Add(string key, IEnumerable<string> list);
65 
66  #region Documentation
67  #endregion
71  void Add(string prefix, IReadOnlyDictionary<object, DescribeAttribute> dictionary);
72 
73  #region Documentation
74  #endregion
78  void Add(string prefix, IReadOnlyDictionary<object, TermsAttribute> dictionary);
79 
80  #region Documentation
81  #endregion
85  void Add(string prefix, IReadOnlyDictionary<TemplateUsage, TemplateAttribute> templates);
86 
87  #region Documentation
88  #endregion
92  void Add(string prefix, TemplateAttribute template);
93 
100  bool Lookup(string key, out string value);
101 
108  bool LookupValues(string key, out string[] values);
109 
110  #region Documentation
111  #endregion
115  void LookupDictionary(string prefix, IDictionary<object, DescribeAttribute> dictionary);
116 
117  #region Documentation
118  #endregion
122  void LookupDictionary(string prefix, IDictionary<object, TermsAttribute> dictionary);
123 
124  #region Documentation
125  #endregion
129  void LookupTemplates(string prefix, IDictionary<TemplateUsage, TemplateAttribute> templates);
130 
135  void Remove(string key);
136 
149  void Save(IResourceWriter writer);
150 
161  ILocalizer Load(IDictionaryEnumerator reader, out IEnumerable<string> missing, out IEnumerable<string> extra);
162  }
163 }
Define a template for generating strings.
Definition: Attributes.cs:571
Interface for localizing string resources.
Definition: ILocalizer.cs:44