/
DbLimitExpression.xml
185 lines (181 loc) · 13.7 KB
/
DbLimitExpression.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
<Type Name="DbLimitExpression" FullName="System.Data.Common.CommandTrees.DbLimitExpression">
<TypeSignature Language="C#" Value="public sealed class DbLimitExpression : System.Data.Common.CommandTrees.DbExpression" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DbLimitExpression extends System.Data.Common.CommandTrees.DbExpression" />
<TypeSignature Language="DocId" Value="T:System.Data.Common.CommandTrees.DbLimitExpression" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DbLimitExpression
Inherits DbExpression" />
<TypeSignature Language="F#" Value="type DbLimitExpression = class
 inherit DbExpression" />
<TypeSignature Language="C++ CLI" Value="public ref class DbLimitExpression sealed : System::Data::Common::CommandTrees::DbExpression" />
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Data.Common.CommandTrees.DbExpression</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the restriction of the number of elements in the argument collection to the specified limit value.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A <xref:System.Data.Common.CommandTrees.DbLimitExpression> can be applied to any <xref:System.Data.Common.CommandTrees.DbExpression> with a collection result type, including <xref:System.Data.Common.CommandTrees.DbSkipExpression>. <xref:System.Data.Common.CommandTrees.DbLimitExpression> provides the equivalent of the Top operation. It does not require an ordering operation to have been performed on its input. It has two `Expression` properties, <xref:System.Data.Common.CommandTrees.DbLimitExpression.Argument%2A> and <xref:System.Data.Common.CommandTrees.DbLimitExpression.Limit%2A>, that specify the collection and the number of rows to return respectively. <xref:System.Data.Common.CommandTrees.DbLimitExpression> also has a `Boolean` <xref:System.Data.Common.CommandTrees.DbLimitExpression.WithTies%2A> property that controls whether rows equal in rank to the final row are returned. <xref:System.Data.Common.CommandTrees.DbLimitExpression.WithTies%2A> defaults to `false`.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Accept">
<MemberSignature Language="C#" Value="public override void Accept (System.Data.Common.CommandTrees.DbExpressionVisitor visitor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Accept(class System.Data.Common.CommandTrees.DbExpressionVisitor visitor) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Common.CommandTrees.DbLimitExpression.Accept(System.Data.Common.CommandTrees.DbExpressionVisitor)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Accept (visitor As DbExpressionVisitor)" />
<MemberSignature Language="F#" Value="override this.Accept : System.Data.Common.CommandTrees.DbExpressionVisitor -> unit" Usage="dbLimitExpression.Accept visitor" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Accept(System::Data::Common::CommandTrees::DbExpressionVisitor ^ visitor);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="visitor" Type="System.Data.Common.CommandTrees.DbExpressionVisitor" />
</Parameters>
<Docs>
<param name="visitor">An instance of <see cref="T:System.Data.Common.CommandTrees.DbExpressionVisitor" />.</param>
<summary>Implements the visitor pattern for expressions that do not produce a result value.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="visitor" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Accept<TResultType>">
<MemberSignature Language="C#" Value="public override TResultType Accept<TResultType> (System.Data.Common.CommandTrees.DbExpressionVisitor<TResultType> visitor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance !!TResultType Accept<TResultType>(class System.Data.Common.CommandTrees.DbExpressionVisitor`1<!!TResultType> visitor) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Common.CommandTrees.DbLimitExpression.Accept``1(System.Data.Common.CommandTrees.DbExpressionVisitor{``0})" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Accept(Of TResultType) (visitor As DbExpressionVisitor(Of TResultType)) As TResultType" />
<MemberSignature Language="F#" Value="override this.Accept : System.Data.Common.CommandTrees.DbExpressionVisitor<'ResultType> -> 'ResultType" Usage="dbLimitExpression.Accept visitor" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TResultType>
 override TResultType Accept(System::Data::Common::CommandTrees::DbExpressionVisitor<TResultType> ^ visitor);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TResultType</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TResultType" />
</TypeParameters>
<Parameters>
<Parameter Name="visitor" Type="System.Data.Common.CommandTrees.DbExpressionVisitor<TResultType>" />
</Parameters>
<Docs>
<typeparam name="TResultType">The type of the result produced by <paramref name="visitor" />.</typeparam>
<param name="visitor">An instance of a typed <see cref="T:System.Data.Common.CommandTrees.DbExpressionVisitor" /> that produces a result value of a specific type.</param>
<summary>Implements the visitor pattern for expressions that produce a result value of a specific type.</summary>
<returns>A result value of a specific type produced by <see cref="T:System.Data.Common.CommandTrees.DbExpressionVisitor" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="visitor" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Argument">
<MemberSignature Language="C#" Value="public System.Data.Common.CommandTrees.DbExpression Argument { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Data.Common.CommandTrees.DbExpression Argument" />
<MemberSignature Language="DocId" Value="P:System.Data.Common.CommandTrees.DbLimitExpression.Argument" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Argument As DbExpression" />
<MemberSignature Language="F#" Value="member this.Argument : System.Data.Common.CommandTrees.DbExpression" Usage="System.Data.Common.CommandTrees.DbLimitExpression.Argument" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Data::Common::CommandTrees::DbExpression ^ Argument { System::Data::Common::CommandTrees::DbExpression ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.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.Data.Common.CommandTrees.DbExpression</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an expression that specifies the input collection.</summary>
<value>An expression that specifies the input collection.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The expression is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The expression is not associated with the command tree of the <see cref="T:System.Data.Common.CommandTrees.DbLimitExpression" />, or its result type is not a collection type.</exception>
</Docs>
</Member>
<Member MemberName="Limit">
<MemberSignature Language="C#" Value="public System.Data.Common.CommandTrees.DbExpression Limit { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Data.Common.CommandTrees.DbExpression Limit" />
<MemberSignature Language="DocId" Value="P:System.Data.Common.CommandTrees.DbLimitExpression.Limit" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Limit As DbExpression" />
<MemberSignature Language="F#" Value="member this.Limit : System.Data.Common.CommandTrees.DbExpression" Usage="System.Data.Common.CommandTrees.DbLimitExpression.Limit" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Data::Common::CommandTrees::DbExpression ^ Limit { System::Data::Common::CommandTrees::DbExpression ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.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.Data.Common.CommandTrees.DbExpression</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an expression that specifies the limit on the number of elements returned from the input collection.</summary>
<value>An expression that specifies the limit on the number of elements returned from the input collection.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The expression is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The expression is not associated with the command tree of the <see cref="T:System.Data.Common.CommandTrees.DbLimitExpression" />, or is not one of <see cref="T:System.Data.Common.CommandTrees.DbConstantExpression" /> or <see cref="T:System.Data.Common.CommandTrees.DbParameterReferenceExpression" />, or its result type is not equal or promotable to a 64-bit integer type.</exception>
</Docs>
</Member>
<Member MemberName="WithTies">
<MemberSignature Language="C#" Value="public bool WithTies { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool WithTies" />
<MemberSignature Language="DocId" Value="P:System.Data.Common.CommandTrees.DbLimitExpression.WithTies" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property WithTies As Boolean" />
<MemberSignature Language="F#" Value="member this.WithTies : bool" Usage="System.Data.Common.CommandTrees.DbLimitExpression.WithTies" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool WithTies { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets whether the limit operation will include tied results. Including tied results might produce more results than specified by the <see cref="P:System.Data.Common.CommandTrees.DbLimitExpression.Limit" /> value.</summary>
<value>
<see langword="true" /> if the limit operation will include tied results; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Data.Common.CommandTrees.DbLimitExpression.WithTies%2A> property controls whether rows equal in rank to the final row are returned.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>