/
PersonalizationStateQuery.xml
202 lines (184 loc) · 13.1 KB
/
PersonalizationStateQuery.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
<Type Name="PersonalizationStateQuery" FullName="System.Web.UI.WebControls.WebParts.PersonalizationStateQuery">
<TypeSignature Language="C#" Value="public sealed class PersonalizationStateQuery" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed PersonalizationStateQuery extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PersonalizationStateQuery" />
<TypeSignature Language="F#" Value="type PersonalizationStateQuery = class" />
<TypeSignature Language="C++ CLI" Value="public ref class PersonalizationStateQuery sealed" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a set of query parameters that can be passed to a personalization provider using the various get and find methods. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is used as a parameter value for various get and find methods of a personalization provider, such as <xref:System.Web.UI.WebControls.WebParts.PersonalizationProvider.FindState%2A> and <xref:System.Web.UI.WebControls.WebParts.PersonalizationProvider.GetCountOfState%2A>. The default indexer allows generic access to the query parameters maintained by this object. The three properties that are explicitly exposed by this class, <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.PathToMatch%2A>, <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UserInactiveSinceDate%2A>, and <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UsernameToMatch%2A>, are stored using query key values that are the same as the property names of this class. For more information, see <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.Item%2A>.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.WebParts.PersonalizationState" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/e0s9t4ck(v=vs.100)">ASP.NET Web Parts Controls</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/z36h8be9(v=vs.100)">Web Parts Personalization Overview</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/784d8z92(v=vs.100)">Walkthrough: Implementing Web Parts Personalization with a User Control</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178182(v=vs.100)">Web Parts Personalization</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PersonalizationStateQuery ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 PersonalizationStateQuery();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A instance of this class is used as a parameter value for various get and find methods of a personalization provider, such as <xref:System.Web.UI.WebControls.WebParts.PersonalizationProvider.FindState%2A> and <xref:System.Web.UI.WebControls.WebParts.PersonalizationProvider.GetCountOfState%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public object this[string queryKey] { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Item(string)" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.Item(System.String)" />
<MemberSignature Language="VB.NET" Value="Default Public Property Item(queryKey As String) As Object" />
<MemberSignature Language="F#" Value="member this.Item(string) : obj with get, set" Usage="System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.Item" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ default[System::String ^] { System::Object ^ get(System::String ^ queryKey); void set(System::String ^ queryKey, System::Object ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="queryKey" Type="System.String" />
</Parameters>
<Docs>
<param name="queryKey">A case-insensitive query string. The value should be one of the following: "PathToMatch", "UserInactiveSinceDate", or "UsernameToMatch".</param>
<summary>Gets or sets the value of the query parameter.</summary>
<value>The value of the query parameter indicated by the <paramref name="queryKey" /> parameter.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is the default indexer for the <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery> class. It returns the value of the query parameter indicated by `queryKey`. You can use `PersonalizationStateQuery.this["UsernameToMatch"]`, `PersonalizationStateQuery.this["PathToMatch"]` and `PersonalizationStateQuery.this["UserInactiveSinceDate"]` to set the <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UsernameToMatch%2A>, <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.PathToMatch%2A>, and <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UserInactiveSinceDate%2A> properties, respectively. When these three properties are set in the indexer, they are validated against the proper type.
This property returns `null` if `queryKey` does not exist.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="queryKey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="queryKey" /> is an empty string ("").
-or-
When trimmed, <paramref name="queryKey" /> results in an empty string.
-or-
A value provided for one of the three properties on <see cref="T:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery" /> was of the wrong type.</exception>
</Docs>
</Member>
<Member MemberName="PathToMatch">
<MemberSignature Language="C#" Value="public string PathToMatch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PathToMatch" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.PathToMatch" />
<MemberSignature Language="VB.NET" Value="Public Property PathToMatch As String" />
<MemberSignature Language="F#" Value="member this.PathToMatch : string with get, set" Usage="System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.PathToMatch" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ PathToMatch { 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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the path to be used for a query.</summary>
<value>The path to be used for a query.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property contains a path to match when executing queries. If <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.PathToMatch%2A> contains wildcard characters, they are passed through to the underlying data store. This property can be set to `null`, indicating that a query should not filter based on path. If this property is non-`null`, its value is trimmed.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="UserInactiveSinceDate">
<MemberSignature Language="C#" Value="public DateTime UserInactiveSinceDate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime UserInactiveSinceDate" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UserInactiveSinceDate" />
<MemberSignature Language="VB.NET" Value="Public Property UserInactiveSinceDate As DateTime" />
<MemberSignature Language="F#" Value="member this.UserInactiveSinceDate : DateTime with get, set" Usage="System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UserInactiveSinceDate" />
<MemberSignature Language="C++ CLI" Value="public:
 property DateTime UserInactiveSinceDate { DateTime get(); void set(DateTime value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the last active date used in a query.</summary>
<value>The last active date to be used in a query.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property indicates the value of the <xref:System.Web.UI.WebControls.WebParts.UserPersonalizationStateInfo.LastActivityDate%2A> property to filter against. The exact comparison is to include records where the value of <xref:System.Web.UI.WebControls.WebParts.UserPersonalizationStateInfo.LastActivityDate%2A> is less than or equal to the value of the <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UserInactiveSinceDate%2A> property.
This property can be set to <xref:System.DateTime.MaxValue>, indicating that a query should not filter based on the last activity date.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="UsernameToMatch">
<MemberSignature Language="C#" Value="public string UsernameToMatch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UsernameToMatch" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UsernameToMatch" />
<MemberSignature Language="VB.NET" Value="Public Property UsernameToMatch As String" />
<MemberSignature Language="F#" Value="member this.UsernameToMatch : string with get, set" Usage="System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UsernameToMatch" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ UsernameToMatch { 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>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the user name in a query.</summary>
<value>The user name to be used in a query.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property represents the user name to filter against when executing a query. If <xref:System.Web.UI.WebControls.WebParts.PersonalizationStateQuery.UsernameToMatch%2A> contains wildcard characters, they are passed through to the underlying data store. This property can be set to `null`, indicating that a query should not filter based on the user name. If this property is non-`null`, its value is trimmed.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>