Skip to content

Restored more enumeration member remarks #2572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 13, 2019
Merged

Restored more enumeration member remarks #2572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17b2360
Restored more enumeration member remarks
Jun 7, 2019
68a8d9d
Apply suggestions from code review
Jun 11, 2019
236a0a2
Added omitted text
Jun 11, 2019
87106f8
fixed broken link
Jun 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions xml/System.Web.UI.WebControls.WebParts/PersonalizationScope.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

]]></format>
</remarks>
<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>
</Docs>
</Member>
<Member MemberName="User">
Expand All @@ -85,15 +77,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

]]></format>
</remarks>
<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>
</Docs>
</Member>
</Members>
Expand Down
13 changes: 3 additions & 10 deletions xml/System.Web.UI.WebControls/DataControlRowState.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,8 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Indicates that the data control row is an alternate row.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

]]></format>
</remarks>
<summary><para>Indicates that the data control row is an alternate row.</para>
<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>
</Docs>
</Member>
<Member MemberName="Edit">
Expand Down Expand Up @@ -157,4 +150,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
234 changes: 101 additions & 133 deletions xml/System.Web.UI.WebControls/RepeatLayout.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,106 @@
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Web.UI.WebControls.RepeatLayout> enumeration represents the different layout options for a list control.
## Remarks

The <xref:System.Web.UI.WebControls.RepeatLayout> enumeration represents the different layout options for a list control.


## Examples

The following example shows a list control whose layout is defined by the `Table` enumeration value.

## Examples
[!code-aspx-csharp[DataListLayout#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataListLayout/CS/datalistlayoutcs.aspx#1)]
[!code-aspx-vb[DataListLayout#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataListLayout/VB/datalistlayoutvb.aspx#1)]
[!code-aspx-csharp[DataListLayout#1](~/samples/snippets/csharp/VS_Snippets_WebNet/DataListLayout/CS/datalistlayoutcs.aspx#1)]
[!code-aspx-vb[DataListLayout#1](~/samples/snippets/visualbasic/VS_Snippets_WebNet/DataListLayout/VB/datalistlayoutvb.aspx#1)]

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`.

```xaml
<span id="ctl00_MainContent_CheckBoxList1">
<input id="ctl00_MainContent_CheckBoxList1_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList1_0">Item 1</label>
<br />
<input id="ctl00_MainContent_CheckBoxList1_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$1" value="Item 2"/>
<label for="ctl00_MainContent_CheckBoxList1_1">Item 2</label>
<br />
<input id="ctl00_MainContent_CheckBoxList1_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList1_2">Item 2</label>
</span>
```

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`.

```xaml
<ol id="ctl00_MainContent_CheckBoxList3">
<li>
<input id="ctl00_MainContent_CheckBoxList3_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList3_0">Item 1</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList3_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList3_1">Item 2</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList3_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList3_2">Item 2</label>
</li>
</ol>
```

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`.

```xaml
<table id="ctl00_MainContent_CheckBoxList2">
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList2_0">Item 1</label>
</td>
</tr>
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList2_1">Item 2</label>
</td>
</tr>
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$2" value="Item 3" />
<label for="ctl00_MainContent_CheckBoxList2_2">Item 3</label>
</td>
</tr>
</table>
```
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`.

```xaml
<ul id="ctl00_MainContent_CheckBoxList4">
<li>
<input id="ctl00_MainContent_CheckBoxList4_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList4_0">Item 1</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList4_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList4_1">Item 2</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList4_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList4_2">Item 2</label>
</li>
</ul>
```

]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.CheckBoxList" />
Expand Down Expand Up @@ -61,30 +152,6 @@
<MemberValue>1</MemberValue>
<Docs>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

```
<span id="ctl00_MainContent_CheckBoxList1">
<input id="ctl00_MainContent_CheckBoxList1_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList1_0">Item 1</label>
<br />
<input id="ctl00_MainContent_CheckBoxList1_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$1" value="Item 2"/>
<label for="ctl00_MainContent_CheckBoxList1_1">Item 2</label>
<br />
<input id="ctl00_MainContent_CheckBoxList1_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList1$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList1_2">Item 2</label>
</span>
```

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OrderedList">
Expand All @@ -104,38 +171,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Items are displayed without a table structure. Rendered markup consists of an <see langword="ol" /> element that contains <see langword="li" /> elements.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

```
<ol id="ctl00_MainContent_CheckBoxList3">
<li>
<input id="ctl00_MainContent_CheckBoxList3_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList3_0">Item 1</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList3_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList3_1">Item 2</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList3_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList3$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList3_2">Item 2</label>
</li>
</ol>
```

> [!NOTE]
> 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.

]]></format>
</remarks>
<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>
</Docs>
</Member>
<Member MemberName="Table">
Expand All @@ -157,44 +193,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Items are displayed in a table.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

> [!NOTE]
> 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).

```
<table id="ctl00_MainContent_CheckBoxList2">
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList2_0">Item 1</label>
</td>
</tr>
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList2_1">Item 2</label>
</td>
</tr>
<tr>
<td>
<input id="ctl00_MainContent_CheckBoxList2_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList2$2" value="Item 3" />
<label for="ctl00_MainContent_CheckBoxList2_2">Item 3</label>
</td>
</tr>
</table>
```

]]></format>
</remarks>
<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>
</Docs>
</Member>
<Member MemberName="UnorderedList">
Expand All @@ -214,39 +213,8 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Items are displayed without a table structure. Rendered markup consists of a <see langword="ul" /> element that contains <see langword="li" /> elements.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

```
<ul id="ctl00_MainContent_CheckBoxList4">
<li>
<input id="ctl00_MainContent_CheckBoxList4_0" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$0" value="Item 1" />
<label for="ctl00_MainContent_CheckBoxList4_0">Item 1</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList4_1" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$1" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList4_1">Item 2</label>
</li>
<li>
<input id="ctl00_MainContent_CheckBoxList4_2" type="checkbox"
name="ctl00$MainContent$CheckBoxList4$2" value="Item 2" />
<label for="ctl00_MainContent_CheckBoxList4_2">Item 2</label>
</li>
</ul>
```

> [!NOTE]
> 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.

]]></format>
</remarks>
<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>
</Docs>
</Member>
</Members>
</Type>
</Type>
Loading