/
LocalizabilityAttribute.xml
247 lines (223 loc) · 15.1 KB
/
LocalizabilityAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<Type Name="LocalizabilityAttribute" FullName="System.Windows.LocalizabilityAttribute">
<TypeSignature Language="C#" Value="public sealed class LocalizabilityAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LocalizabilityAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Windows.LocalizabilityAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class LocalizabilityAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type LocalizabilityAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class LocalizabilityAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Field | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=true)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Field | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies the localization attributes for a binary XAML (BAML) class or class member.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This attribute can be applied to a class, property, or method.
For more information on how to use localization attributes, see [Localization Attributes and Comments](/dotnet/framework/wpf/advanced/localization-attributes-and-comments).
]]></format>
</remarks>
<altmember cref="T:System.Windows.Localization" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LocalizabilityAttribute (System.Windows.LocalizationCategory category);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Windows.LocalizationCategory category) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.LocalizabilityAttribute.#ctor(System.Windows.LocalizationCategory)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (category As LocalizationCategory)" />
<MemberSignature Language="F#" Value="new System.Windows.LocalizabilityAttribute : System.Windows.LocalizationCategory -> System.Windows.LocalizabilityAttribute" Usage="new System.Windows.LocalizabilityAttribute category" />
<MemberSignature Language="C++ CLI" Value="public:
 LocalizabilityAttribute(System::Windows::LocalizationCategory category);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="category" Type="System.Windows.LocalizationCategory" />
</Parameters>
<Docs>
<param name="category">The localization category.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.LocalizabilityAttribute" /> class with a specified localization category.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Category">
<MemberSignature Language="C#" Value="public System.Windows.LocalizationCategory Category { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.LocalizationCategory Category" />
<MemberSignature Language="DocId" Value="P:System.Windows.LocalizabilityAttribute.Category" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Category As LocalizationCategory" />
<MemberSignature Language="F#" Value="member this.Category : System.Windows.LocalizationCategory" Usage="System.Windows.LocalizabilityAttribute.Category" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::LocalizationCategory Category { System::Windows::LocalizationCategory get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.LocalizationCategory</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the category setting of the localization attribute's targeted value.</summary>
<value>The category setting of the localization attribute.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the modifiability settings of the localization attribute.
|Category setting|Meaning|
|----------------------|-------------|
|<xref:System.Windows.LocalizationCategory.None>|Resource does not belong to a standard category.|
|<xref:System.Windows.LocalizationCategory.Text>|A lengthy piece of descriptive text.|
|<xref:System.Windows.LocalizationCategory.Title>|A single line of text, such as a title.|
|<xref:System.Windows.LocalizationCategory.Label>|A short text string, such as a control label.|
|<xref:System.Windows.LocalizationCategory.Button>|A <xref:System.Windows.Controls.Button> or related control.|
|<xref:System.Windows.LocalizationCategory.CheckBox>|A <xref:System.Windows.Controls.CheckBox> or related control.|
|<xref:System.Windows.LocalizationCategory.ComboBox>|A <xref:System.Windows.Controls.ComboBox> or related control, such as <xref:System.Windows.Controls.ComboBoxItem>.|
|<xref:System.Windows.LocalizationCategory.ListBox>|A <xref:System.Windows.Controls.ListBox> or related control, such as <xref:System.Windows.Controls.ListBoxItem>.|
|<xref:System.Windows.LocalizationCategory.Menu>|A <xref:System.Windows.Controls.Menu> or related control, such as <xref:System.Windows.Controls.MenuItem>.|
|<xref:System.Windows.LocalizationCategory.RadioButton>|A <xref:System.Windows.Controls.RadioButton> or related control.|
|<xref:System.Windows.LocalizationCategory.ToolTip>|A <xref:System.Windows.Controls.ToolTip> or related control.|
|<xref:System.Windows.LocalizationCategory.Hyperlink>|A <xref:System.Windows.Documents.Hyperlink> or related control.|
|<xref:System.Windows.LocalizationCategory.TextFlow>|A <xref:System.Windows.Documents.FlowDocument> or other panel that can contain text.|
|<xref:System.Windows.LocalizationCategory.XmlData>|XML data.|
|<xref:System.Windows.LocalizationCategory.Font>|Font-related data such as font family, font style, or font size.|
|<xref:System.Windows.LocalizationCategory.Inherit>|Inherits category from parent node.|
|<xref:System.Windows.LocalizationCategory.Ignore>|Do not localize this resource. This does not apply to any child nodes of the resource.|
|<xref:System.Windows.LocalizationCategory.NeverLocalize>|Do not localize this resource, or any of its child nodes whose category is set to <xref:System.Windows.LocalizationCategory.Inherit>.|
## Examples
The following code example shows the category settings of localization attributes defined for a button.
:::code language="xaml" source="~/snippets/csharp/System.Windows/LocalizabilityAttribute/Category/Attributes.xaml" id="Snippetattributessnippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.LocalizationCategory" />
</Docs>
</Member>
<Member MemberName="Modifiability">
<MemberSignature Language="C#" Value="public System.Windows.Modifiability Modifiability { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Modifiability Modifiability" />
<MemberSignature Language="DocId" Value="P:System.Windows.LocalizabilityAttribute.Modifiability" />
<MemberSignature Language="VB.NET" Value="Public Property Modifiability As Modifiability" />
<MemberSignature Language="F#" Value="member this.Modifiability : System.Windows.Modifiability with get, set" Usage="System.Windows.LocalizabilityAttribute.Modifiability" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Modifiability Modifiability { System::Windows::Modifiability get(); void set(System::Windows::Modifiability value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Modifiability</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the modifiability setting of the localization attribute's targeted value.</summary>
<value>The modifiability setting of the localization attribute.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the modifiability settings of the localization attribute.
|Modifiability setting|Meaning|
|---------------------------|-------------|
|<xref:System.Windows.Modifiability.Modifiable>|Targeted value is modifiable by localizers.|
|<xref:System.Windows.Modifiability.Unmodifiable>|Targeted value is not modifiable by localizers.|
|<xref:System.Windows.Modifiability.Inherit>|Targeted value's modifiability is inherited from its parent node.|
## Examples
The following code example shows the modifiability setting of localization attributes defined for a button.
:::code language="xaml" source="~/snippets/csharp/System.Windows/LocalizabilityAttribute/Category/Attributes.xaml" id="Snippetattributessnippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Readability">
<MemberSignature Language="C#" Value="public System.Windows.Readability Readability { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Readability Readability" />
<MemberSignature Language="DocId" Value="P:System.Windows.LocalizabilityAttribute.Readability" />
<MemberSignature Language="VB.NET" Value="Public Property Readability As Readability" />
<MemberSignature Language="F#" Value="member this.Readability : System.Windows.Readability with get, set" Usage="System.Windows.LocalizabilityAttribute.Readability" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Readability Readability { System::Windows::Readability get(); void set(System::Windows::Readability value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Readability</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the readability setting of the localization attribute's targeted value.</summary>
<value>The readability setting of the localization attribute.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the readability settings of the localization attribute.
|Readability setting|Meaning|
|-------------------------|-------------|
|<xref:System.Windows.Readability.Readable>|Targeted value is readable text.|
|<xref:System.Windows.Readability.Unreadable>|Targeted value is not readable.|
|<xref:System.Windows.Readability.Inherit>|Targeted value's readability is inherited from its parent node.|
## Examples
The following code example shows the readability setting of localization attributes defined for a text block.
:::code language="xaml" source="~/snippets/csharp/System.Windows/LocalizabilityAttribute/Category/Comments.xaml" id="Snippetattributessnippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Readability" />
</Docs>
</Member>
</Members>
</Type>