Skip to content

Commit 752ea35

Browse files
author
Ron Petrusha
authored
Restored more enumeration member remarks (#2572)
* Restored more enumeration member remarks * Apply suggestions from code review Thanks for the careful review, @mairaw! Co-Authored-By: Maira Wenzel <[email protected]> * Added omitted text * fixed broken link
1 parent 64c8615 commit 752ea35

File tree

12 files changed

+195
-386
lines changed

12 files changed

+195
-386
lines changed

‎xml/System.Web.UI.WebControls.WebParts/PersonalizationScope.xml

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,7 @@
5656
</ReturnValue>
5757
<MemberValue>1</MemberValue>
5858
<Docs>
59-
<summary>When referring to the scope on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control, <see langword="Shared" /> scope means that personalization data applies to all users for all personalizable controls on a page and is also available to be saved on the page.</summary>
60-
<remarks>
61-
<format type="text/markdown"><![CDATA[
62-
63-
## Remarks
64-
When referring to the scope associated with a Web Parts control property, `Shared` scope indicates that the property normally only allows loading or saving of data associated with all users.
65-
66-
]]></format>
67-
</remarks>
59+
<summary>When referring to the scope on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control, <see langword="Shared" /> scope means that personalization data applies to all users for all personalizable controls on a page and is also available to be saved on the page. <br/>When referring to the scope associated with a Web Parts control property, <see langword="Shared" /> scope indicates that the property normally only allows loading or saving of data associated with all users. </summary>
6860
</Docs>
6961
</Member>
7062
<Member MemberName="User">
@@ -85,15 +77,7 @@
8577
</ReturnValue>
8678
<MemberValue>0</MemberValue>
8779
<Docs>
88-
<summary>When referring to the scope on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control, <see langword="User" /> scope means that personalization data that is user-specific, as well as personalization data that applies to all users, is loaded for all personalizable controls on a page. Only personalization data that is user-specific can be saved on the page.</summary>
89-
<remarks>
90-
<format type="text/markdown"><![CDATA[
91-
92-
## Remarks
93-
When referring to the scope associated with a Web Parts control property, `User` scope indicates that the property can only load and store data applicable to all users when running on a page in `Shared` scope. However, when the property's control is running on a page in `User` scope, the property's per-user and all-user data will be loaded and merged. In this case, though, only per-user data will be saved when a page is running in `User` scope.
94-
95-
]]></format>
96-
</remarks>
80+
<summary>When referring to the scope on the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" /> control, <see langword="User" /> scope means that personalization data that is user-specific, as well as personalization data that applies to all users, is loaded for all personalizable controls on a page. Only personalization data that is user-specific can be saved on the page.<br/>When referring to the scope associated with a Web Parts control property, <see langword="User" /> scope indicates that the property can only load and store data applicable to all users when running on a page in <see langword="Shared" /> scope. However, when the property's control is running on a page in <see langword="User" /> scope, the property's per-user and all-user data will be loaded and merged. In this case, though, only per-user data will be saved when a page is running in <see langword="User" /> scope scope.</summary>
9781
</Docs>
9882
</Member>
9983
</Members>

‎xml/System.Web.UI.WebControls/DataControlRowState.xml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,8 @@
6161
</ReturnValue>
6262
<MemberValue>1</MemberValue>
6363
<Docs>
64-
<summary>Indicates that the data control row is an alternate row.</summary>
65-
<remarks>
66-
<format type="text/markdown"><![CDATA[
67-
68-
## Remarks
69-
The Alternate state can be combined with other states, such as Normal, Edit, or Insert, at any time. These rows might be affected by the `AlternateRowStyle` property of the data control, if set.
70-
71-
]]></format>
72-
</remarks>
64+
<summary><para>Indicates that the data control row is an alternate row.</para>
65+
<para>The <see langword="Alternate" /> state can be combined with other states, such as <see langword="Normal" />, <see langword="Edit" />, or <see langword="Insert" />, at any time. These rows might be affected by the <see langword="AlternateRowStyle" /> property of the data control, if set.</para></summary>
7366
</Docs>
7467
</Member>
7568
<Member MemberName="Edit">
@@ -157,4 +150,4 @@
157150
</Docs>
158151
</Member>
159152
</Members>
160-
</Type>
153+
</Type>

‎xml/System.Web.UI.WebControls/RepeatLayout.xml

Lines changed: 101 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,106 @@
1919
<remarks>
2020
<format type="text/markdown"><![CDATA[
2121
22-
## Remarks
23-
The <xref:System.Web.UI.WebControls.RepeatLayout> enumeration represents the different layout options for a list control.
22+
## Remarks
23+
24+
The <xref:System.Web.UI.WebControls.RepeatLayout> enumeration represents the different layout options for a list control.
2425
25-
26+
## Examples
27+
28+
The following example shows a list control whose layout is defined by the `Table` enumeration value.
2629
27-
## Examples
28-
[!code-aspx-csharp[DataListLayout#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataListLayout/CS/datalistlayoutcs.aspx#1)]
29-
[!code-aspx-vb[DataListLayout#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataListLayout/VB/datalistlayoutvb.aspx#1)]
30+
[!code-aspx-csharp[DataListLayout#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataListLayout/CS/datalistlayoutcs.aspx#1)]
31+
[!code-aspx-vb[DataListLayout#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataListLayout/VB/datalistlayoutvb.aspx#1)]
32+
33+
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to `Flow`.
3034
35+
```xaml
36+
<span id="ctl00_MainContent_CheckBoxList1">
37+
<input id="ctl00_MainContent_CheckBoxList1_0" type="checkbox"
38+
name="ctl00$MainContent$CheckBoxList1$0" value="Item 1" />
39+
<label for="ctl00_MainContent_CheckBoxList1_0">Item 1</label>
40+
<br />
41+
<input id="ctl00_MainContent_CheckBoxList1_1" type="checkbox"
42+
name="ctl00$MainContent$CheckBoxList1$1" value="Item 2"/>
43+
<label for="ctl00_MainContent_CheckBoxList1_1">Item 2</label>
44+
<br />
45+
<input id="ctl00_MainContent_CheckBoxList1_2" type="checkbox"
46+
name="ctl00$MainContent$CheckBoxList1$2" value="Item 2" />
47+
<label for="ctl00_MainContent_CheckBoxList1_2">Item 2</label>
48+
</span>
49+
```
50+
51+
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to `OrderedList`.
52+
53+
```xaml
54+
<ol id="ctl00_MainContent_CheckBoxList3">
55+
<li>
56+
<input id="ctl00_MainContent_CheckBoxList3_0" type="checkbox"
57+
name="ctl00$MainContent$CheckBoxList3$0" value="Item 1" />
58+
<label for="ctl00_MainContent_CheckBoxList3_0">Item 1</label>
59+
</li>
60+
<li>
61+
<input id="ctl00_MainContent_CheckBoxList3_1" type="checkbox"
62+
name="ctl00$MainContent$CheckBoxList3$1" value="Item 2" />
63+
<label for="ctl00_MainContent_CheckBoxList3_1">Item 2</label>
64+
</li>
65+
<li>
66+
<input id="ctl00_MainContent_CheckBoxList3_2" type="checkbox"
67+
name="ctl00$MainContent$CheckBoxList3$2" value="Item 2" />
68+
<label for="ctl00_MainContent_CheckBoxList3_2">Item 2</label>
69+
</li>
70+
</ol>
71+
```
72+
73+
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to `Table`.
74+
75+
```xaml
76+
<table id="ctl00_MainContent_CheckBoxList2">
77+
<tr>
78+
<td>
79+
<input id="ctl00_MainContent_CheckBoxList2_0" type="checkbox"
80+
name="ctl00$MainContent$CheckBoxList2$0" value="Item 1" />
81+
<label for="ctl00_MainContent_CheckBoxList2_0">Item 1</label>
82+
</td>
83+
</tr>
84+
<tr>
85+
<td>
86+
<input id="ctl00_MainContent_CheckBoxList2_1" type="checkbox"
87+
name="ctl00$MainContent$CheckBoxList2$1" value="Item 2" />
88+
<label for="ctl00_MainContent_CheckBoxList2_1">Item 2</label>
89+
</td>
90+
</tr>
91+
<tr>
92+
<td>
93+
<input id="ctl00_MainContent_CheckBoxList2_2" type="checkbox"
94+
name="ctl00$MainContent$CheckBoxList2$2" value="Item 3" />
95+
<label for="ctl00_MainContent_CheckBoxList2_2">Item 3</label>
96+
</td>
97+
</tr>
98+
</table>
99+
```
100+
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to `UnorderedList`.
101+
102+
```xaml
103+
<ul id="ctl00_MainContent_CheckBoxList4">
104+
<li>
105+
<input id="ctl00_MainContent_CheckBoxList4_0" type="checkbox"
106+
name="ctl00$MainContent$CheckBoxList4$0" value="Item 1" />
107+
<label for="ctl00_MainContent_CheckBoxList4_0">Item 1</label>
108+
</li>
109+
<li>
110+
<input id="ctl00_MainContent_CheckBoxList4_1" type="checkbox"
111+
name="ctl00$MainContent$CheckBoxList4$1" value="Item 2" />
112+
<label for="ctl00_MainContent_CheckBoxList4_1">Item 2</label>
113+
</li>
114+
<li>
115+
<input id="ctl00_MainContent_CheckBoxList4_2" type="checkbox"
116+
name="ctl00$MainContent$CheckBoxList4$2" value="Item 2" />
117+
<label for="ctl00_MainContent_CheckBoxList4_2">Item 2</label>
118+
</li>
119+
</ul>
120+
```
121+
31122
]]></format>
32123
</remarks>
33124
<altmember cref="T:System.Web.UI.WebControls.CheckBoxList" />
@@ -61,30 +152,6 @@
61152
<MemberValue>1</MemberValue>
62153
<Docs>
63154
<summary>Items are displayed without a table structure. Rendered markup consists of a <see langword="span" /> element and items are separated by <see langword="br" /> elements.</summary>
64-
<remarks>
65-
<format type="text/markdown"><![CDATA[
66-
67-
## Remarks
68-
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to Flow.
69-
70-
```
71-
<span id="ctl00_MainContent_CheckBoxList1">
72-
<input id="ctl00_MainContent_CheckBoxList1_0" type="checkbox"
73-
name="ctl00$MainContent$CheckBoxList1$0" value="Item 1" />
74-
<label for="ctl00_MainContent_CheckBoxList1_0">Item 1</label>
75-
<br />
76-
<input id="ctl00_MainContent_CheckBoxList1_1" type="checkbox"
77-
name="ctl00$MainContent$CheckBoxList1$1" value="Item 2"/>
78-
<label for="ctl00_MainContent_CheckBoxList1_1">Item 2</label>
79-
<br />
80-
<input id="ctl00_MainContent_CheckBoxList1_2" type="checkbox"
81-
name="ctl00$MainContent$CheckBoxList1$2" value="Item 2" />
82-
<label for="ctl00_MainContent_CheckBoxList1_2">Item 2</label>
83-
</span>
84-
```
85-
86-
]]></format>
87-
</remarks>
88155
</Docs>
89156
</Member>
90157
<Member MemberName="OrderedList">
@@ -104,38 +171,7 @@
104171
</ReturnValue>
105172
<MemberValue>3</MemberValue>
106173
<Docs>
107-
<summary>Items are displayed without a table structure. Rendered markup consists of an <see langword="ol" /> element that contains <see langword="li" /> elements.</summary>
108-
<remarks>
109-
<format type="text/markdown"><![CDATA[
110-
111-
## Remarks
112-
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to OrderedList.
113-
114-
```
115-
<ol id="ctl00_MainContent_CheckBoxList3">
116-
<li>
117-
<input id="ctl00_MainContent_CheckBoxList3_0" type="checkbox"
118-
name="ctl00$MainContent$CheckBoxList3$0" value="Item 1" />
119-
<label for="ctl00_MainContent_CheckBoxList3_0">Item 1</label>
120-
</li>
121-
<li>
122-
<input id="ctl00_MainContent_CheckBoxList3_1" type="checkbox"
123-
name="ctl00$MainContent$CheckBoxList3$1" value="Item 2" />
124-
<label for="ctl00_MainContent_CheckBoxList3_1">Item 2</label>
125-
</li>
126-
<li>
127-
<input id="ctl00_MainContent_CheckBoxList3_2" type="checkbox"
128-
name="ctl00$MainContent$CheckBoxList3$2" value="Item 2" />
129-
<label for="ctl00_MainContent_CheckBoxList3_2">Item 2</label>
130-
</li>
131-
</ol>
132-
```
133-
134-
> [!NOTE]
135-
> This field is new as of ASP.NET 4 and is a valid option only for the <xref:System.Web.UI.WebControls.CheckBoxList> and <xref:System.Web.UI.WebControls.RadioButtonList> controls.
136-
137-
]]></format>
138-
</remarks>
174+
<summary>Items are displayed without a table structure. Rendered markup consists of an <see langword="ol" /> element that contains <see langword="li" /> elements.<br/>This value is new as of ASP.NET 4 and is a valid option only for the <see cref="T:System.Web.UI.WebControls.CheckBoxList" /> and <see cref="T:System.Web.UI.WebControls.RadioButtonList" /> controls.</summary>
139175
</Docs>
140176
</Member>
141177
<Member MemberName="Table">
@@ -157,44 +193,7 @@
157193
</ReturnValue>
158194
<MemberValue>0</MemberValue>
159195
<Docs>
160-
<summary>Items are displayed in a table.</summary>
161-
<remarks>
162-
<format type="text/markdown"><![CDATA[
163-
164-
## Remarks
165-
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to Table.
166-
167-
> [!NOTE]
168-
> This option causes the control to render HTML that might not conform to accessibility standards. For more information, see [Accessibility in Visual Studio and ASP.NET](https://msdn.microsoft.com/library/7e3ce9c4-6b7d-4fb1-94b5-72cf2a44fe13).
169-
170-
```
171-
<table id="ctl00_MainContent_CheckBoxList2">
172-
<tr>
173-
<td>
174-
<input id="ctl00_MainContent_CheckBoxList2_0" type="checkbox"
175-
name="ctl00$MainContent$CheckBoxList2$0" value="Item 1" />
176-
<label for="ctl00_MainContent_CheckBoxList2_0">Item 1</label>
177-
</td>
178-
</tr>
179-
<tr>
180-
<td>
181-
<input id="ctl00_MainContent_CheckBoxList2_1" type="checkbox"
182-
name="ctl00$MainContent$CheckBoxList2$1" value="Item 2" />
183-
<label for="ctl00_MainContent_CheckBoxList2_1">Item 2</label>
184-
</td>
185-
</tr>
186-
<tr>
187-
<td>
188-
<input id="ctl00_MainContent_CheckBoxList2_2" type="checkbox"
189-
name="ctl00$MainContent$CheckBoxList2$2" value="Item 3" />
190-
<label for="ctl00_MainContent_CheckBoxList2_2">Item 3</label>
191-
</td>
192-
</tr>
193-
</table>
194-
```
195-
196-
]]></format>
197-
</remarks>
196+
<summary>Items are displayed in a table. <br/>This option causes the control to render HTML that might not conform to accessibility standards. For more information, see <see href="https://docs.microsoft.com/previous-versions/aspnet/ms228004(v%3dvs.100)">Accessibility in Visual Studio and ASP.NET</see>.</summary>
198197
</Docs>
199198
</Member>
200199
<Member MemberName="UnorderedList">
@@ -214,39 +213,8 @@
214213
</ReturnValue>
215214
<MemberValue>2</MemberValue>
216215
<Docs>
217-
<summary>Items are displayed without a table structure. Rendered markup consists of a <see langword="ul" /> element that contains <see langword="li" /> elements.</summary>
218-
<remarks>
219-
<format type="text/markdown"><![CDATA[
220-
221-
## Remarks
222-
The following example shows markup that is rendered for a <xref:System.Web.UI.WebControls.CheckBoxList> control whose <xref:System.Web.UI.WebControls.CheckBoxList.RepeatLayout%2A> property is set to UnorderedList.
223-
224-
```
225-
<ul id="ctl00_MainContent_CheckBoxList4">
226-
<li>
227-
<input id="ctl00_MainContent_CheckBoxList4_0" type="checkbox"
228-
name="ctl00$MainContent$CheckBoxList4$0" value="Item 1" />
229-
<label for="ctl00_MainContent_CheckBoxList4_0">Item 1</label>
230-
</li>
231-
<li>
232-
<input id="ctl00_MainContent_CheckBoxList4_1" type="checkbox"
233-
name="ctl00$MainContent$CheckBoxList4$1" value="Item 2" />
234-
<label for="ctl00_MainContent_CheckBoxList4_1">Item 2</label>
235-
</li>
236-
<li>
237-
<input id="ctl00_MainContent_CheckBoxList4_2" type="checkbox"
238-
name="ctl00$MainContent$CheckBoxList4$2" value="Item 2" />
239-
<label for="ctl00_MainContent_CheckBoxList4_2">Item 2</label>
240-
</li>
241-
</ul>
242-
```
243-
244-
> [!NOTE]
245-
> This field is new as of ASP.NET 4 and is a valid option only for the <xref:System.Web.UI.WebControls.CheckBoxList> and <xref:System.Web.UI.WebControls.RadioButtonList> controls.
246-
247-
]]></format>
248-
</remarks>
216+
<summary>Items are displayed without a table structure. Rendered markup consists of a <see langword="ul" /> element that contains <see langword="li" /> elements.<br/>This field is new as of ASP.NET 4 and is a valid option only for the <see cref="T:System.Web.UI.WebControls.CheckBoxList" /> and <see cref="T:System.Web.UI.WebControls.RadioButtonList" /> controls.</summary>
249217
</Docs>
250218
</Member>
251219
</Members>
252-
</Type>
220+
</Type>

0 commit comments

Comments
 (0)