-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
DataControlFieldHeaderCell.xml
166 lines (150 loc) · 12.1 KB
/
DataControlFieldHeaderCell.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
<Type Name="DataControlFieldHeaderCell" FullName="System.Web.UI.WebControls.DataControlFieldHeaderCell">
<TypeSignature Language="C#" Value="public class DataControlFieldHeaderCell : System.Web.UI.WebControls.DataControlFieldCell" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataControlFieldHeaderCell extends System.Web.UI.WebControls.DataControlFieldCell" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.DataControlFieldHeaderCell" />
<TypeSignature Language="VB.NET" Value="Public Class DataControlFieldHeaderCell
Inherits DataControlFieldCell" />
<TypeSignature Language="F#" Value="type DataControlFieldHeaderCell = class
 inherit DataControlFieldCell" />
<TypeSignature Language="C++ CLI" Value="public ref class DataControlFieldHeaderCell : System::Web::UI::WebControls::DataControlFieldCell" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.DataControlFieldCell</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>In accessibility scenarios, represents a header cell in the rendered table of a tabular ASP.NET data-bound control, such as <see cref="T:System.Web.UI.WebControls.GridView" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> class is used by data tables (such as the <xref:System.Web.UI.WebControls.GridView> control) to represent accessible headers. Tabular controls such as <xref:System.Web.UI.WebControls.DetailsView> and <xref:System.Web.UI.WebControls.FormView> are considered layout tables, and therefore do not require accessible headers and do not use the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> class.
The <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> class is used in two cases:
- The <xref:System.Web.UI.WebControls.GridView.UseAccessibleHeader%2A> property is `true`.
- The field is a <xref:System.Web.UI.WebControls.BoundField> object whose <xref:System.Web.UI.WebControls.BoundField.DataField%2A> property is set as the <xref:System.Web.UI.WebControls.GridView.RowHeaderColumn%2A> property.
If neither is the case, a regular <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> object is used, which renders a `<td>` instead of a `<th>` element.
Because the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> class supports the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.AbbreviatedText%2A> property, it is used by the <xref:System.Web.UI.WebControls.GridView> control whenever the <xref:System.Web.UI.WebControls.GridView.UseAccessibleHeader%2A> property is `true`.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.DataControlField" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DataControlFieldHeaderCell (System.Web.UI.WebControls.DataControlField containingField);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.UI.WebControls.DataControlField containingField) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.DataControlFieldHeaderCell.#ctor(System.Web.UI.WebControls.DataControlField)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (containingField As DataControlField)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.DataControlFieldHeaderCell : System.Web.UI.WebControls.DataControlField -> System.Web.UI.WebControls.DataControlFieldHeaderCell" Usage="new System.Web.UI.WebControls.DataControlFieldHeaderCell containingField" />
<MemberSignature Language="C++ CLI" Value="public:
 DataControlFieldHeaderCell(System::Web::UI::WebControls::DataControlField ^ containingField);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="containingField" Type="System.Web.UI.WebControls.DataControlField" />
</Parameters>
<Docs>
<param name="containingField">The <see cref="T:System.Web.UI.WebControls.DataControlField" /> that contains the current cell.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.DataControlFieldHeaderCell" /> class, setting the specified <see cref="T:System.Web.UI.WebControls.DataControlField" /> object as the cell's container.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.%23ctor%2A> constructor passes the <xref:System.Web.UI.HtmlTextWriterTag.Th?displayProperty=nameWithType> element as its `tagKey` parameter, which is the representation of the HTML tag it is rendered with. The <xref:System.Web.UI.WebControls.DataControlField> passed in the `containingField` parameter is used to determine whether to show headers and what styles to apply to the cell when it is rendered.
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.WebControls.DataControlFieldCell.#ctor(System.Web.UI.HtmlTextWriterTag,System.Web.UI.WebControls.DataControlField)" />
</Docs>
</Member>
<Member MemberName="AbbreviatedText">
<MemberSignature Language="C#" Value="public virtual string AbbreviatedText { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AbbreviatedText" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.DataControlFieldHeaderCell.AbbreviatedText" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property AbbreviatedText As String" />
<MemberSignature Language="F#" Value="member this.AbbreviatedText : string with get, set" Usage="System.Web.UI.WebControls.DataControlFieldHeaderCell.AbbreviatedText" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ AbbreviatedText { 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 abbreviated text, which is rendered in an HTML <see langword="abbr" /> attribute and is used by screen readers.</summary>
<value>A shortened version of the table header text, which is read by screen readers. The default value is <see cref="F:System.String.Empty" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.AbbreviatedText%2A> property is stored in view state.
]]></format>
</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/ff7b5021-48b3-46bf-921f-9fe1e0e32202">Walkthrough: Creating an Accessible Web Application</related>
</Docs>
</Member>
<Member MemberName="AddAttributesToRender">
<MemberSignature Language="C#" Value="protected override void AddAttributesToRender (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void AddAttributesToRender(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.DataControlFieldHeaderCell.AddAttributesToRender(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub AddAttributesToRender (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="override this.AddAttributesToRender : System.Web.UI.HtmlTextWriter -> unit" Usage="dataControlFieldHeaderCell.AddAttributesToRender writer" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void AddAttributesToRender(System::Web::UI::HtmlTextWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<param name="writer">An <see cref="T:System.Web.UI.HtmlTextWriter" /> that represents the output stream that renders HTML content to the client.</param>
<summary>Adds information about the table cell to the list of attributes to render.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.AddAttributesToRender%2A> method adds the <xref:System.Web.UI.HtmlTextWriterAttribute.Scope> or <xref:System.Web.UI.HtmlTextWriterAttribute.Abbr> attributes if the respective <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope%2A> or <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.AbbreviatedText%2A> properties are set.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.HtmlTextWriterAttribute" />
</Docs>
</Member>
<Member MemberName="Scope">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.TableHeaderScope Scope { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.TableHeaderScope Scope" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Scope As TableHeaderScope" />
<MemberSignature Language="F#" Value="member this.Scope : System.Web.UI.WebControls.TableHeaderScope with get, set" Usage="System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::TableHeaderScope Scope { System::Web::UI::WebControls::TableHeaderScope get(); void set(System::Web::UI::WebControls::TableHeaderScope 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.Web.UI.WebControls.TableHeaderScope</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the header cell's scope within an HTML table.</summary>
<value>One of the <see cref="T:System.Web.UI.WebControls.TableHeaderScope" /> values. The default is <see cref="F:System.Web.UI.WebControls.TableHeaderScope.NotSet" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope%2A> property is rendered as an HTML `scope` attribute by the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell> object. Although the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope%2A> property is initialized to <xref:System.Web.UI.WebControls.TableHeaderScope.NotSet>, you should set it to either <xref:System.Web.UI.WebControls.TableHeaderScope.Column> or <xref:System.Web.UI.WebControls.TableHeaderScope.Row>, depending on the cells that the header represents.
The value of the <xref:System.Web.UI.WebControls.DataControlFieldHeaderCell.Scope%2A> property is stored in view state.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.TableHeaderScope" />
</Docs>
</Member>
</Members>
</Type>