-
Notifications
You must be signed in to change notification settings - Fork 112
/
ViewComponentDescriptor.xml
357 lines (357 loc) · 19.3 KB
/
ViewComponentDescriptor.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
<Type Name="ViewComponentDescriptor" FullName="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor">
<TypeSignature Language="C++ CLI" Value="public ref class ViewComponentDescriptor" />
<TypeSignature Language="C#" Value="public class ViewComponentDescriptor" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ViewComponentDescriptor extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor" />
<TypeSignature Language="VB.NET" Value="Public Class ViewComponentDescriptor" />
<TypeSignature Language="F#" Value="type ViewComponentDescriptor = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("{DisplayName}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("{DisplayName}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A descriptor for a view component.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 ViewComponentDescriptor();" />
<MemberSignature Language="C#" Value="public ViewComponentDescriptor ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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 />
<Docs>
<summary>
Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DisplayName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.DisplayName" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
<MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.DisplayName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the display name of the view component.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FullName">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ FullName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string FullName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FullName" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.FullName" />
<MemberSignature Language="VB.NET" Value="Public Property FullName As String" />
<MemberSignature Language="F#" Value="member this.FullName : string with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.FullName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the full name.
</summary>
<value>To be added.</value>
<remarks>
<para>
The full name is defaulted to the full namespace of the view component class, prepended to
the class name with a '.' character as the separator. If the view component class uses
<c>ViewComponent</c> as a suffix, the suffix will be omitted from the <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.FullName" />.
</para>
<example>
Class Name: Contoso.Products.LoginViewComponent
View Component FullName: Contoso.Products.Login
</example>
<example>
Class Name: Contoso.Blog.Tags
View Component FullName: Contoso.Blog.Tags
</example>
<para>
If <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponentAttribute.Name" /> is used to set a name, then this will be used as
the <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.FullName" />.
</para>
<example>
[ViewComponent(Name = "Contoso.Forum.UsersOnline")]
public class OnlineUsersViewComponent
{
}
View Component FullName: Contoso.Forum.UsersOnline
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Id { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string Id { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.Id" />
<MemberSignature Language="VB.NET" Value="Public Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or set the generated unique identifier for this <see cref="T:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MethodInfo">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Reflection::MethodInfo ^ MethodInfo { System::Reflection::MethodInfo ^ get(); void set(System::Reflection::MethodInfo ^ value); };" />
<MemberSignature Language="C#" Value="public System.Reflection.MethodInfo MethodInfo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Reflection.MethodInfo MethodInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.MethodInfo" />
<MemberSignature Language="VB.NET" Value="Public Property MethodInfo As MethodInfo" />
<MemberSignature Language="F#" Value="member this.MethodInfo : System.Reflection.MethodInfo with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.MethodInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.Reflection.MethodInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.Reflection.MethodInfo" /> to invoke.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IReadOnlyList<System::Reflection::ParameterInfo ^> ^ Parameters { System::Collections::Generic::IReadOnlyList<System::Reflection::ParameterInfo ^> ^ get(); void set(System::Collections::Generic::IReadOnlyList<System::Reflection::ParameterInfo ^> ^ value); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<System.Reflection.ParameterInfo> Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class System.Reflection.ParameterInfo> Parameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As IReadOnlyList(Of ParameterInfo)" />
<MemberSignature Language="F#" Value="member this.Parameters : System.Collections.Generic.IReadOnlyList<System.Reflection.ParameterInfo> with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.Parameters" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<System.Reflection.ParameterInfo></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the parameters associated with the method described by <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.MethodInfo" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShortName">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ShortName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string ShortName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ShortName" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.ShortName" />
<MemberSignature Language="VB.NET" Value="Public Property ShortName As String" />
<MemberSignature Language="F#" Value="member this.ShortName : string with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.ShortName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the short name.
</summary>
<value>To be added.</value>
<remarks>
<para>
The short name is defaulted to the name of the view component class. If the view component class uses
<c>ViewComponent</c> as a suffix, the suffix will be omitted from the <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.ShortName" />.
</para>
<example>
Class Name: Contoso.Products.LoginViewComponent
View Component ShortName: Login
</example>
<example>
Class Name: Contoso.Blog.Tags
View Component ShortName: Tags
</example>
<para>
If <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponentAttribute.Name" /> is used to set a name, then the last segment of the
value (using '.' as a separate) will be used as the <see cref="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.ShortName" />.
</para>
<example>
[ViewComponent(Name = "Contoso.Forum.UsersOnline")]
public class OnlineUsersViewComponent
{
}
View Component ShortName: UsersOnline
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="TypeInfo">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Reflection::TypeInfo ^ TypeInfo { System::Reflection::TypeInfo ^ get(); void set(System::Reflection::TypeInfo ^ value); };" />
<MemberSignature Language="C#" Value="public System.Reflection.TypeInfo TypeInfo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Reflection.TypeInfo TypeInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.TypeInfo" />
<MemberSignature Language="VB.NET" Value="Public Property TypeInfo As TypeInfo" />
<MemberSignature Language="F#" Value="member this.TypeInfo : System.Reflection.TypeInfo with get, set" Usage="Microsoft.AspNetCore.Mvc.ViewComponents.ViewComponentDescriptor.TypeInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.ViewFeatures</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.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>
<ReturnValue>
<ReturnType>System.Reflection.TypeInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.Reflection.TypeInfo" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>