/
FormViewRow.xml
320 lines (291 loc) · 21.9 KB
/
FormViewRow.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
<Type Name="FormViewRow" FullName="System.Web.UI.WebControls.FormViewRow">
<TypeSignature Language="C#" Value="public class FormViewRow : System.Web.UI.WebControls.TableRow" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FormViewRow extends System.Web.UI.WebControls.TableRow" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.FormViewRow" />
<TypeSignature Language="VB.NET" Value="Public Class FormViewRow
Inherits TableRow" />
<TypeSignature Language="F#" Value="type FormViewRow = class
 inherit TableRow" />
<TypeSignature Language="C++ CLI" Value="public ref class FormViewRow : System::Web::UI::WebControls::TableRow" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.TableRow</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a row within a <see cref="T:System.Web.UI.WebControls.FormView" /> control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.FormViewRow> class is used to represent an individual row in a <xref:System.Web.UI.WebControls.FormView> control. Each row in the <xref:System.Web.UI.WebControls.FormView> control has a designated row type. The following table lists the different row types.
|Row type|Description|
|--------------|-----------------|
|`DataControlRowType.DataRow`|The data row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.EmptyDataRow`|The empty data row in the <xref:System.Web.UI.WebControls.FormView> control. The empty data row is displayed in a <xref:System.Web.UI.WebControls.FormView> control when there are no records to display.|
|`DataControlRowType.Footer`|The footer row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.Header`|The header row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.Pager`|A pager row in the <xref:System.Web.UI.WebControls.FormView> control.|
To determine the row type of a <xref:System.Web.UI.WebControls.FormViewRow> object, use the <xref:System.Web.UI.WebControls.FormViewRow.RowType%2A> property. A <xref:System.Web.UI.WebControls.FormViewRow> object also has a state associated with it. The state can be a bitwise combination of the values in the following table.
|State value|Description|
|-----------------|-----------------|
|`DataControlRowState.Edit`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in edit mode.|
|`DataControlRowState.Insert`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in insert mode.|
|`DataControlRowState.Normal`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in its normal (default) state.|
|`DataControlRowState.Selected`|The <xref:System.Web.UI.WebControls.FormViewRow> object is selected.|
To determine the state of a <xref:System.Web.UI.WebControls.FormViewRow> object, use the <xref:System.Web.UI.WebControls.FormViewRow.RowState%2A> property.
The <xref:System.Web.UI.WebControls.FormView> control displays the contents of its <xref:System.Web.UI.WebControls.FormView.ItemTemplate%2A> property in a data row. To access the data row, use the <xref:System.Web.UI.WebControls.FormView.Row%2A> property. To determine the index of the current data item in the data source, use the <xref:System.Web.UI.WebControls.FormViewRow.ItemIndex%2A> property.
You can access the individual cells of the <xref:System.Web.UI.WebControls.FormViewRow> object by using the <xref:System.Web.UI.WebControls.TableRow.Cells%2A> property. If a cell contains controls, you can retrieve a control from the cell by using one of the following methods:
- Use the <xref:System.Web.UI.Control.Controls%2A> collection of the cell to retrieve the control at a specific index.
- Use the <xref:System.Web.UI.Control.FindControl%2A> method of the cell to retrieve the control, if the control has its <xref:System.Web.UI.Control.ID%2A> property set. This is the preferred method to retrieve a control from a cell.
For a list of initial property values for an instance of the <xref:System.Web.UI.WebControls.FormViewRow> class, see the <xref:System.Web.UI.WebControls.FormViewRow.%23ctor%2A> constructor.
## Examples
The following example demonstrates how to retrieve an <xref:System.Web.UI.WebControls.Image> control from the <xref:System.Web.UI.WebControls.FormViewRow> object that represents the item row. The <xref:System.Web.UI.WebControls.Image> controls are declared in the edit and item templates.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/FormViewRowClass/CS/formviewrowcs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/FormViewRowClass/VB/formviewrowvb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
<altmember cref="P:System.Web.UI.WebControls.FormView.BottomPagerRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.FooterRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.HeaderRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.Row" />
<altmember cref="P:System.Web.UI.WebControls.FormView.TopPagerRow" />
<altmember cref="T:System.Web.UI.DataBoundLiteralControl" />
<altmember cref="T:System.Web.UI.WebControls.TableCell" />
<altmember cref="P:System.Web.UI.Control.Controls" />
<altmember cref="M:System.Web.UI.Control.FindControl(System.String)" />
<altmember cref="T:System.Web.UI.WebControls.TableRow" />
<altmember cref="P:System.Web.UI.WebControls.TableRow.Cells" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.ItemIndex" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowState" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowType" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormViewRow (int itemIndex, System.Web.UI.WebControls.DataControlRowType rowType, System.Web.UI.WebControls.DataControlRowState rowState);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 itemIndex, valuetype System.Web.UI.WebControls.DataControlRowType rowType, valuetype System.Web.UI.WebControls.DataControlRowState rowState) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.FormViewRow.#ctor(System.Int32,System.Web.UI.WebControls.DataControlRowType,System.Web.UI.WebControls.DataControlRowState)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (itemIndex As Integer, rowType As DataControlRowType, rowState As DataControlRowState)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.FormViewRow : int * System.Web.UI.WebControls.DataControlRowType * System.Web.UI.WebControls.DataControlRowState -> System.Web.UI.WebControls.FormViewRow" Usage="new System.Web.UI.WebControls.FormViewRow (itemIndex, rowType, rowState)" />
<MemberSignature Language="C++ CLI" Value="public:
 FormViewRow(int itemIndex, System::Web::UI::WebControls::DataControlRowType rowType, System::Web::UI::WebControls::DataControlRowState rowState);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="itemIndex" Type="System.Int32" />
<Parameter Name="rowType" Type="System.Web.UI.WebControls.DataControlRowType" />
<Parameter Name="rowState" Type="System.Web.UI.WebControls.DataControlRowState" />
</Parameters>
<Docs>
<param name="itemIndex">The index of the data item in the data source.</param>
<param name="rowType">One of the <see cref="T:System.Web.UI.WebControls.DataControlRowType" /> enumeration values.</param>
<param name="rowState">One of the <see cref="T:System.Web.UI.WebControls.DataControlRowState" /> enumeration values.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewRow" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to initialize a new instance of the <xref:System.Web.UI.WebControls.FormViewRow> class.
The following table shows initial property values for an instance of the <xref:System.Web.UI.WebControls.FormViewRow> class.
|Property|Initial Value|
|--------------|-------------------|
|<xref:System.Web.UI.WebControls.FormViewRow.ItemIndex%2A>|The value specified by the `itemIndex` parameter.|
|<xref:System.Web.UI.WebControls.FormViewRow.RowType%2A>|The value specified by the `rowType` parameter.|
|<xref:System.Web.UI.WebControls.FormViewRow.RowState%2A>|The value specified by the `rowState` parameter.|
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
<altmember cref="T:System.Web.UI.WebControls.DataControlRowState" />
<altmember cref="T:System.Web.UI.WebControls.DataControlRowType" />
<altmember cref="P:System.Web.UI.WebControls.FormView.BottomPagerRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.FooterRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.HeaderRow" />
<altmember cref="P:System.Web.UI.WebControls.FormView.Row" />
<altmember cref="P:System.Web.UI.WebControls.FormView.TopPagerRow" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.ItemIndex" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowType" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowState" />
</Docs>
</Member>
<Member MemberName="ItemIndex">
<MemberSignature Language="C#" Value="public virtual int ItemIndex { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ItemIndex" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.FormViewRow.ItemIndex" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ItemIndex As Integer" />
<MemberSignature Language="F#" Value="member this.ItemIndex : int" Usage="System.Web.UI.WebControls.FormViewRow.ItemIndex" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property int ItemIndex { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the index of the data item displayed from the data source.</summary>
<value>The index of the data item displayed from the data source.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.FormViewRow.ItemIndex%2A> property to determine the index of the data item.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
</Docs>
</Member>
<Member MemberName="OnBubbleEvent">
<MemberSignature Language="C#" Value="protected override bool OnBubbleEvent (object source, EventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool OnBubbleEvent(object source, class System.EventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.FormViewRow.OnBubbleEvent(System.Object,System.EventArgs)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBubbleEvent (source As Object, e As EventArgs) As Boolean" />
<MemberSignature Language="F#" Value="override this.OnBubbleEvent : obj * EventArgs -> bool" Usage="formViewRow.OnBubbleEvent (source, e)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool OnBubbleEvent(System::Object ^ source, EventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.Object" />
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<param name="source">The source of the event.</param>
<param name="e">The event data.</param>
<summary>Determines whether to pass an event up the page's ASP.NET server control hierarchy.</summary>
<returns>
<see langword="true" /> if the event has been canceled; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.EventArgs" />
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="protected internal override void Render (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void Render(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.FormViewRow.Render(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub Render (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="override this.Render : System.Web.UI.HtmlTextWriter -> unit" Usage="formViewRow.Render writer" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Render(System::Web::UI::HtmlTextWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" Index="0" FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</Parameters>
<Docs>
<param name="writer">The HTML text writer object that receives the control content.</param>
<summary>Renders the control to the specified HTML writer.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RowState">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.DataControlRowState RowState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.DataControlRowState RowState" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.FormViewRow.RowState" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property RowState As DataControlRowState" />
<MemberSignature Language="F#" Value="member this.RowState : System.Web.UI.WebControls.DataControlRowState" Usage="System.Web.UI.WebControls.FormViewRow.RowState" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::DataControlRowState RowState { System::Web::UI::WebControls::DataControlRowState 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.Web.UI.WebControls.DataControlRowState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the state of the <see cref="T:System.Web.UI.WebControls.FormViewRow" /> object.</summary>
<value>A bitwise combination of the <see cref="T:System.Web.UI.WebControls.DataControlRowState" /> enumeration values.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.FormViewRow.RowState%2A> property to determine the state of the row. The state can be a bitwise combination of the values in the following table.
|State value|Description|
|-----------------|-----------------|
|`DataControlRowState.Edit`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in edit mode.|
|`DataControlRowState.Insert`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in insert mode.|
|`DataControlRowState.Normal`|The <xref:System.Web.UI.WebControls.FormViewRow> object is in its normal, read-only state.|
|`DataControlRowState.Selected`|The <xref:System.Web.UI.WebControls.FormViewRow> object is selected.|
This property is commonly used to determine the state of a row before performing an operation.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
<altmember cref="T:System.Web.UI.WebControls.DataControlRowState" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowType" />
</Docs>
</Member>
<Member MemberName="RowType">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.DataControlRowType RowType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.DataControlRowType RowType" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.FormViewRow.RowType" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property RowType As DataControlRowType" />
<MemberSignature Language="F#" Value="member this.RowType : System.Web.UI.WebControls.DataControlRowType" Usage="System.Web.UI.WebControls.FormViewRow.RowType" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::DataControlRowType RowType { System::Web::UI::WebControls::DataControlRowType 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.Web.UI.WebControls.DataControlRowType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the row type of the <see cref="T:System.Web.UI.WebControls.FormViewRow" /> object.</summary>
<value>One of the <see cref="T:System.Web.UI.WebControls.DataControlRowType" /> values.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.FormViewRow.RowType%2A> property to determine the type of row that the <xref:System.Web.UI.WebControls.FormViewRow> object represents. The following table lists the different row type values.
|Row type|Description|
|--------------|-----------------|
|`DataControlRowType.DataRow`|The data row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.EmptyDataRow`|The empty data row in the <xref:System.Web.UI.WebControls.FormView> control. The empty data row is displayed in a <xref:System.Web.UI.WebControls.FormView> control when there are no records to display.|
|`DataControlRowType.Footer`|The footer row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.Header`|The header row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.Pager`|A pager row in the <xref:System.Web.UI.WebControls.FormView> control.|
|`DataControlRowType.Separator`|A separator row in the <xref:System.Web.UI.WebControls.FormView> control.|
This property is commonly used to determine a row's type before performing an operation.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
<altmember cref="T:System.Web.UI.WebControls.DataControlRowType" />
<altmember cref="P:System.Web.UI.WebControls.FormViewRow.RowState" />
</Docs>
</Member>
</Members>
</Type>