/
WebPartsPersonalization.xml
265 lines (235 loc) · 16.1 KB
/
WebPartsPersonalization.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
<Type Name="WebPartsPersonalization" FullName="System.Web.Configuration.WebPartsPersonalization">
<TypeSignature Language="C#" Value="public sealed class WebPartsPersonalization : System.Configuration.ConfigurationElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed WebPartsPersonalization extends System.Configuration.ConfigurationElement" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.WebPartsPersonalization" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class WebPartsPersonalization
Inherits ConfigurationElement" />
<TypeSignature Language="F#" Value="type WebPartsPersonalization = class
 inherit ConfigurationElement" />
<TypeSignature Language="C++ CLI" Value="public ref class WebPartsPersonalization sealed : System::Configuration::ConfigurationElement" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Allows you to specify the personalization provider and set personalization authorizations. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.Configuration.WebPartsPersonalization> provides configuration support for personalization options for Web Parts, such as the personalization provider and personalization authorizations.
## Examples
This example demonstrates how to specify values declaratively for several attributes of the `webParts` section, which can also be accessed as members of the <xref:System.Web.Configuration.WebPartsPersonalization> class.
The following configuration file example shows how to specify values declaratively for the `webParts` section.
```
<system.web>
<webParts>
<personalization
defaultProvider="AspNetSqlPersonalizationProvider">
<!-- Providers may only be defined at the
application level -->
<providers>
<add name="AspNetSqlPersonalizationProvider"
type="System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider"
connectionStringName="LocalSqlServer"
applicationName="/" />
</providers>
<authorization>
<deny users="*" verbs="enterSharedScope" />
<allow users="*" verbs="modifyState" />
</authorization>
</personalization>
</webParts>
</system.web>
```
The following code example demonstrates how to use the <xref:System.Web.Configuration.WebPartsPersonalization> class.
This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ConfigurationElement" />
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/z36h8be9(v=vs.100)">Web Parts Personalization Overview</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebPartsPersonalization ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.WebPartsPersonalization.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 WebPartsPersonalization();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.WebPartsPersonalization" /> class using default settings.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. An instance of this class is available from the <xref:System.Web.Configuration.WebPartsSection.Personalization%2A> property.
]]></format>
</remarks>
<altmember cref="P:System.Web.Configuration.WebPartsSection.Personalization" />
</Docs>
</Member>
<Member MemberName="Authorization">
<MemberSignature Language="C#" Value="public System.Web.Configuration.WebPartsPersonalizationAuthorization Authorization { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.WebPartsPersonalizationAuthorization Authorization" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.WebPartsPersonalization.Authorization" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Authorization As WebPartsPersonalizationAuthorization" />
<MemberSignature Language="F#" Value="member this.Authorization : System.Web.Configuration.WebPartsPersonalizationAuthorization" Usage="System.Web.Configuration.WebPartsPersonalization.Authorization" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::WebPartsPersonalizationAuthorization ^ Authorization { System::Web::Configuration::WebPartsPersonalizationAuthorization ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("authorization")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("authorization")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.WebPartsPersonalizationAuthorization</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an <see cref="T:System.Web.Configuration.AuthorizationSection" /> object containing the Web Parts personalization authorizations for the current Web application.</summary>
<value>An <see cref="T:System.Web.Configuration.AuthorizationSection" /> object containing the Web Parts personalization authorizations for the current Web application.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
There must be at least one valid verb associated with each <xref:System.Web.Configuration.AuthorizationRule> object in the collection.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.WebPartsPersonalization.Authorization%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet15":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet15":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultProvider">
<MemberSignature Language="C#" Value="public string DefaultProvider { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DefaultProvider" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.WebPartsPersonalization.DefaultProvider" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultProvider As String" />
<MemberSignature Language="F#" Value="member this.DefaultProvider : string with get, set" Usage="System.Web.Configuration.WebPartsPersonalization.DefaultProvider" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DefaultProvider { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("defaultProvider", DefaultValue="AspNetSqlPersonalizationProvider")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("defaultProvider", DefaultValue="AspNetSqlPersonalizationProvider")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.StringValidator(MinLength=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.StringValidator(MinLength=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the name of the default Web Parts personalization provider.</summary>
<value>The name of the default Web Parts personalization provider.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.WebPartsPersonalization.Providers%2A> property contains the Web Parts personalization providers for the current Web application.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.WebPartsPersonalization.DefaultProvider%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet13":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet13":::
]]></format>
</remarks>
<altmember cref="P:System.Web.Configuration.WebPartsPersonalization.Providers" />
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.WebPartsPersonalization.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.Web.Configuration.WebPartsPersonalization.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.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.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Providers">
<MemberSignature Language="C#" Value="public System.Configuration.ProviderSettingsCollection Providers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ProviderSettingsCollection Providers" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.WebPartsPersonalization.Providers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Providers As ProviderSettingsCollection" />
<MemberSignature Language="F#" Value="member this.Providers : System.Configuration.ProviderSettingsCollection" Usage="System.Web.Configuration.WebPartsPersonalization.Providers" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Configuration::ProviderSettingsCollection ^ Providers { System::Configuration::ProviderSettingsCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("providers")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("providers")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.ProviderSettingsCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Configuration.ProviderSettingsCollection" /> collection that contains the Web Parts personalization providers for the current Web application.</summary>
<value>A <see cref="T:System.Configuration.ProviderSettingsCollection" /> collection that contains the Web Parts personalization providers for the current Web application.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Web Parts personalization providers can only be defined at the Web-application level (in a Web.config file).
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.WebPartsPersonalization.Providers%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet14":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet14":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ProviderSettingsCollection" />
<altmember cref="P:System.Web.Configuration.WebPartsPersonalization.Providers" />
</Docs>
</Member>
</Members>
</Type>