event.
-
- To add an attribute to the `` tag, first get the object that represents the cell in the control you want to add the attribute to. The collection for the property of the object passed into the event handler can be used to get the desired object. You can then use the method of the collection for the object to add attributes to the `| ` tag.
-
- To add an attribute to the ` | ` tag, first get the object that represents the row in the control you want to add the attribute to. The property of the object passed into the event handler can be used to get the desired object. You can then use the method of the collection for the object to add attributes to the `` tag.
-
-
-## Accessibility
- For information about how to configure this control so that it generates markup that conforms to accessibility standards, see [Accessibility in Visual Studio and ASP.NET](https://learn.microsoft.com/previous-versions/ms228004(v=vs.140)) and [ASP.NET Controls and Accessibility](https://learn.microsoft.com/previous-versions/ms227996(v=vs.140)).
-
-
-## Declarative Syntax
-
-```
-
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-Â Â Â Â Â Â Â Â
-
+> Automatically generated columns are not added to the collection.
+
+ The appearance of the control may be customized by setting the style properties for the different parts of the control. The following table lists the different style properties.
+
+|Style Property|Description|
+|--------------------|-----------------|
+||Specifies the style for alternating items in the control.|
+||Specifies the style for the item being edited in the control.|
+||Specifies the style for the footer section in the control.|
+||Specifies the style for the header section in the control.|
+||Specifies the style for the items in the control.|
+||Specifies the style for the page selection section of the control.|
+||Specifies the style for the selected item in the control.|
+
+ You can also show or hide different parts of the control. The following table lists the properties that control which parts are shown or hidden.
+
+|Property|Description|
+|--------------|-----------------|
+||Shows or hides the footer section of the control.|
+||Shows or hides the header section of the control.|
+
+ You can control the appearance of the control by programmatically adding attributes to the `| ` and ` | ` tags rendered by the control on the browser. Attributes can be programmatically added by providing code in the event handler for the or event.
+
+ To add an attribute to the `` tag, first get the object that represents the cell in the control you want to add the attribute to. The collection for the property of the object passed into the event handler can be used to get the desired object. You can then use the method of the collection for the object to add attributes to the `| ` tag.
+
+ To add an attribute to the ` | ` tag, first get the object that represents the row in the control you want to add the attribute to. The property of the object passed into the event handler can be used to get the desired object. You can then use the method of the collection for the object to add attributes to the `` tag.
+
+
+## Accessibility
+ For information about how to configure this control so that it generates markup that conforms to accessibility standards, see [Accessibility in Visual Studio and ASP.NET](https://learn.microsoft.com/previous-versions/ms228004(v=vs.140)) and [ASP.NET Controls and Accessibility](https://learn.microsoft.com/previous-versions/ms227996(v=vs.140)).
+
+
+## Declarative Syntax
+
```
-
+
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+Â Â Â Â Â Â Â Â
+
+```
+
## Examples
-
- The following code example demonstrates how to use the control to display the items in the data source.
-
+
+ The following code example demonstrates how to use the control to display the items in the data source.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid Example 2/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid Example 2/VB/sourcevb.aspx" id="Snippet1":::
-
- The following code example demonstrates how to use the control for a simple shopping cart.
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid Example 2/VB/sourcevb.aspx" id="Snippet1":::
+
+ The following code example demonstrates how to use the control for a simple shopping cart.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid Example 2/CS/source2cs.aspx" id="Snippet2":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid Example 2/VB/source2vb.aspx" id="Snippet2":::
-
- The following code example demonstrates how to dynamically add attributes to the `| ` and ` | ` tags generated by the control.
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid Example 2/VB/source2vb.aspx" id="Snippet2":::
+
+ The following code example demonstrates how to dynamically add attributes to the `| ` and ` | ` tags generated by the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridTrTdTags/CS/datagridtdtrtagcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridTrTdTags/VB/datagridtdtrtagvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridTrTdTags/VB/datagridtdtrtagvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridExample/CS/datagridcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridExample/VB/datagridvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridExample/VB/datagridvb.aspx" id="Snippet1":::
+
]]>
@@ -376,19 +376,19 @@
Initializes a new instance of the class.
- class.
-
-
-
-## Examples
- The following code example demonstrates how to create and initialize a new instance of the class.
-
+ class.
+
+
+
+## Examples
+ The following code example demonstrates how to create and initialize a new instance of the class.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridCtor/CS/datagridctorcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCtor/VB/datagridctorvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCtor/VB/datagridctorvb.aspx" id="Snippet1":::
+
]]>
@@ -421,37 +421,37 @@
if custom paging is enabled; otherwise, . The default value is .
- control in page segments. The number of items on a page is determined by the property. If no value is specified for the property, the will display 10 items on a page.
-
- Normally, a data source that contains every row in the control is loaded every time the control moves to a different page. This can consume a lot of resources when the data source is very large. Custom paging allows you to load just the segment of data needed to display a single page.
-
- To enable custom paging, set both the and properties to `true`. Next, provide code to handle the event.
-
- The typical logic for the event handler is to first set the property to the index of the page you want to display.
-
+ control in page segments. The number of items on a page is determined by the property. If no value is specified for the property, the will display 10 items on a page.
+
+ Normally, a data source that contains every row in the control is loaded every time the control moves to a different page. This can consume a lot of resources when the data source is very large. Custom paging allows you to load just the segment of data needed to display a single page.
+
+ To enable custom paging, set both the and properties to `true`. Next, provide code to handle the event.
+
+ The typical logic for the event handler is to first set the property to the index of the page you want to display.
+
> [!NOTE]
-> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
-
- Next, create a data source that contains the data to display on a single page and then use the method to bind the data to the control.
-
+> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
+
+ Next, create a data source that contains the data to display on a single page and then use the method to bind the data to the control.
+
> [!NOTE]
-> Because only a segment of the data is loaded, you must set the property to the total number of items in the control. This allows the control to determine the total number of pages needed to display every item in the control. This property is normally programmatically set once the total number of items in the control is determined.
-
- When paging is enabled with the property is set to `false`, the control assumes that the data source contains all the items to be displayed. The control calculates the indexes of the items on the displayed page based on the page index, specified by the property, and the number of items on a page, specified by the property.
-
- When the property is set to `true`, the control assumes that the data source only contains the items as determined by the property. All items up to the number of items specified by the property are displayed.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to enable custom paging.
-
+> Because only a segment of the data is loaded, you must set the property to the total number of items in the control. This allows the control to determine the total number of pages needed to display every item in the control. This property is normally programmatically set once the total number of items in the control is determined.
+
+ When paging is enabled with the property is set to `false`, the control assumes that the data source contains all the items to be displayed. The control calculates the indexes of the items on the displayed page based on the page index, specified by the property, and the number of items on a page, specified by the property.
+
+ When the property is set to `true`, the control assumes that the data source only contains the items as determined by the property. All items up to the number of items specified by the property are displayed.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to enable custom paging.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridCustomPaging/CS/datagridcustompagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCustomPaging/VB/datagridcustompagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCustomPaging/VB/datagridcustompagingvb.aspx" id="Snippet1":::
+
]]>
@@ -487,33 +487,33 @@
if paging is enabled; otherwise, . The default value is .
- control in page segments. The number of items on a page is determined by the property. If no value is specified for the property, the control will display 10 items on a page.
-
- By default, paging is disabled. To enable paging, set this property to `true` and provide code to handle the event.
-
- The typical logic for the event is to set the property to the index of the page you want to display and then use the method to bind the data to the control.
-
+ control in page segments. The number of items on a page is determined by the property. If no value is specified for the property, the control will display 10 items on a page.
+
+ By default, paging is disabled. To enable paging, set this property to `true` and provide code to handle the event.
+
+ The typical logic for the event is to set the property to the index of the page you want to display and then use the method to bind the data to the control.
+
> [!NOTE]
-> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
-
- With standard paging, the control assumes that the data source contains all the items to be displayed. The control calculates the indexes of the items on the displayed page based on the page index, specified by the property, and the number of items of items on a page, specified by the property.
-
- Normally, a data source that contains all items to be displayed is loaded every time the control is paged. This can consume a lot of resources when the data source is very large. Custom paging allows you to load just the segment of data needed to display a single page. For additional information on custom paging, see the property.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to enable paging.
-
+> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
+
+ With standard paging, the control assumes that the data source contains all the items to be displayed. The control calculates the indexes of the items on the displayed page based on the page index, specified by the property, and the number of items of items on a page, specified by the property.
+
+ Normally, a data source that contains all items to be displayed is loaded every time the control is paged. This can consume a lot of resources when the data source is very large. Custom paging allows you to load just the segment of data needed to display a single page. For additional information on custom paging, see the property.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to enable paging.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.AllowPaging Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AllowPaging Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AllowPaging Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowPaging/CS/datagridallowpagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
+
]]>
@@ -550,24 +550,24 @@
if sorting is enabled; otherwise, . The default value is .
- controls are rendered in the heading section of each column where the property is set. These controls allow you to sort the control by the selected column. The only exception is when you use a column type with the property set. In this case, you must provide a control in the of the column.
-
- The event is raised when one of the controls is clicked. It is up to you to provide code for the event handler. The typical logic for the handler is to sort the list, and then rebind the data to the control.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to enable sorting.
-
+ controls are rendered in the heading section of each column where the property is set. These controls allow you to sort the control by the selected column. The only exception is when you use a column type with the property set. In this case, you must provide a control in the of the column.
+
+ The event is raised when one of the controls is clicked. It is up to you to provide code for the event handler. The typical logic for the handler is to sort the list, and then rebind the data to the control.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to enable sorting.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.AllowSorting Example 2/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AllowSorting Example 2/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AllowSorting Example 2/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowSorting/CS/datagridallowsortingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
+
]]>
@@ -612,34 +612,34 @@
Gets the style properties for alternating items in the control.
A object that represents the style properties for alternating items in the . The default value is an empty object.
- property to provide a custom style for the alternating items in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
-
-|Precedence|Style Property|
-|----------------|--------------------|
-|1||
-|2||
-|3||
-|4||
-|5||
-
- To specify a custom style for the alternating items, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to specify a different background color for alternating items in the control.
-
+ property to provide a custom style for the alternating items in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
+
+|Precedence|Style Property|
+|----------------|--------------------|
+|1||
+|2||
+|3||
+|4||
+|5||
+
+ To specify a custom style for the alternating items, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to specify a different background color for alternating items in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAlternatingItemStyle/CS/datagridalternatingitemstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAlternatingItemStyle/VB/datagridalternatingitemstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAlternatingItemStyle/VB/datagridalternatingitemstylevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemStyle/CS/datagriditemstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemStyle/VB/datagriditemstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemStyle/VB/datagriditemstylevb.aspx" id="Snippet1":::
+
]]>
@@ -674,31 +674,31 @@
if objects are automatically created and displayed; otherwise, . The default value is .
- object for each field in the data source. Each field is then rendered as a column in the control in the order that the fields appear in the data source.
-
- Not all data types can be bound to the control. If a field contains an unsupported data type, a column is not created for that field. If the data source only contains one column with an unsupported data type, an exception is thrown. The following table shows the data types that can be bound to the control.
-
-|Data Type|Description|
-|---------------|-----------------|
-|Primitives|A primitive data type, such as , , , and so on. For a complete list, see .|
-|String|A object.|
-|DateTime|A object.|
-|Decimal|A object.|
-
+ object for each field in the data source. Each field is then rendered as a column in the control in the order that the fields appear in the data source.
+
+ Not all data types can be bound to the control. If a field contains an unsupported data type, a column is not created for that field. If the data source only contains one column with an unsupported data type, an exception is thrown. The following table shows the data types that can be bound to the control.
+
+|Data Type|Description|
+|---------------|-----------------|
+|Primitives|A primitive data type, such as , , , and so on. For a complete list, see .|
+|String|A object.|
+|DateTime|A object.|
+|Decimal|A object.|
+
> [!NOTE]
-> Explicitly declared columns may be used in conjunction with auto-generated columns. When using both, explicitly declared columns will be rendered first, followed by the auto-generated columns. Auto-generated columns are not added to the collection.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to automatically create a object for each field in the data source.
-
+> Explicitly declared columns may be used in conjunction with auto-generated columns. When using both, explicitly declared columns will be rendered first, followed by the auto-generated columns. Auto-generated columns are not added to the collection.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to automatically create a object for each field in the data source.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.AutoGenerateColumns Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AutoGenerateColumns Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.AutoGenerateColumns Example/VB/sourcevb.aspx" id="Snippet1":::
+
]]>
@@ -756,25 +756,25 @@
Gets or sets the URL of an image to display in the background of the control.
The URL of an image to display in the background of the control. The default value is .
- property to specify an image to display in the background of the control.
-
+ property to specify an image to display in the background of the control.
+
> [!NOTE]
-> If the specified image is smaller than the control, the image will tile to fill in the background of the control.
-
-
-
-## Examples
- The following code example demonstrates how use the property to specify a background image for the control.
-
+> If the specified image is smaller than the control, the image will tile to fill in the background of the control.
+
+
+
+## Examples
+ The following code example demonstrates how use the property to specify a background image for the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.BackImageUrl Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.BackImageUrl Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.BackImageUrl Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridBackImageUrl/CS/datagridbackimageurlcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridBackImageUrl/VB/datagridbackimageurlvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridBackImageUrl/VB/datagridbackimageurlvb.aspx" id="Snippet1":::
+
]]>
@@ -800,29 +800,29 @@
Occurs when the button is clicked for an item in the control.
- event is raised when the `Cancel` button is clicked for an item in the control.
-
- A typical handler for the event sets the property to `-1` (to deselect the item) and then rebinds the data to the control.
-
+ event is raised when the `Cancel` button is clicked for an item in the control.
+
+ A typical handler for the event sets the property to `-1` (to deselect the item) and then rebinds the data to the control.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to cancel edits made to an item in the control.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to cancel edits made to an item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -850,11 +850,11 @@
Represents the command name. This field is read-only.
- field to represent the `Cancel` command name.
-
+ field to represent the `Cancel` command name.
+
]]>
@@ -914,40 +914,40 @@
Gets a collection of objects that represent the columns of the control.
A object that contains a collection of objects that represent the columns of the control.
- control. The collection contains explicitly declared columns that get rendered in the control.
-
+ control. The collection contains explicitly declared columns that get rendered in the control.
+
> [!NOTE]
-> Explicitly declared columns may be used in conjunction with automatically generated columns. When using both, explicitly declared columns will be rendered first, followed by the automatically generated columns. Automatically generated columns are not added to the collection.
-
- The order that the columns are displayed in the control is controlled by the order that the columns appear in the collection.
-
- The following table shows the different column classes that derive from the class and can be used in the collection.
-
-|Column type|Description|
-|-----------------|-----------------|
-||Displays a column bound to a field in a data source. It displays each item in the field as text. This is the default column type of the control.|
-||Displays a command button for each item in the column. This allows you to create a column of custom button controls, such as the `Add` or `Remove` button.|
-||Displays a column that contains editing commands for each item in the column.|
-||Displays the contents of each item in the column as a hyperlink. The contents of the column can be bound to a field in a data source or static text.|
-||Displays each item in the column following a specified template. This allows you to provide custom controls in the column.|
-
+> Explicitly declared columns may be used in conjunction with automatically generated columns. When using both, explicitly declared columns will be rendered first, followed by the automatically generated columns. Automatically generated columns are not added to the collection.
+
+ The order that the columns are displayed in the control is controlled by the order that the columns appear in the collection.
+
+ The following table shows the different column classes that derive from the class and can be used in the collection.
+
+|Column type|Description|
+|-----------------|-----------------|
+||Displays a column bound to a field in a data source. It displays each item in the field as text. This is the default column type of the control.|
+||Displays a command button for each item in the column. This allows you to create a column of custom button controls, such as the `Add` or `Remove` button.|
+||Displays a column that contains editing commands for each item in the column.|
+||Displays the contents of each item in the column as a hyperlink. The contents of the column can be bound to a field in a data source or static text.|
+||Displays each item in the column following a specified template. This allows you to provide custom controls in the column.|
+
> [!NOTE]
-> Although you can programmatically add columns to the collection, it is easier to list the columns statically and then use the property to show or hide the column.
-
-
-
-## Examples
- The following code example demonstrates how to use the collection to dynamically add a column to the control.
-
+> Although you can programmatically add columns to the collection, it is easier to list the columns statically and then use the property to show or hide the column.
+
+
+
+## Examples
+ The following code example demonstrates how to use the collection to dynamically add a column to the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.Columns Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.Columns Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.Columns Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridColumnVisible/CS/datagridcolumnvisiblecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridColumnVisible/VB/datagridcolumnvisiblevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridColumnVisible/VB/datagridcolumnvisiblevb.aspx" id="Snippet1":::
+
]]>
@@ -1011,18 +1011,18 @@
Whether to use the data source to generate columns automatically or to use saved state.
Creates the control hierarchy that is used to render the .
-
- is , the value of is not set, and the selected data source does not implement the interface.
-
+ is , the value of is not set, and the selected data source does not implement the interface.
+
-or-
-
+
is and the data source has an invalid property.
@@ -1048,16 +1048,16 @@
Creates new control style.
A the represents the new style.
- method in a custom server control so that it always displays the with no in the .
-
+ method in a custom server control so that it always displays the with no in the .
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/CS/custom_datagrid_createcontrolstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/VB/custom_datagrid_createcontrolstylevb.aspx" id="Snippet1":::
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/VB/custom_datagrid_createcontrolstylevb.aspx" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/CS/custom_datagrid_createcontrolstyle.cs" id="Snippet2":::
-:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/VB/custom_datagrid_createcontrolstyle.vb" id="Snippet2":::
-
+:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomDataGridCreateControlStyle/VB/custom_datagrid_createcontrolstyle.vb" id="Snippet2":::
+
]]>
@@ -1092,14 +1092,14 @@
Creates a object.
A object.
- is a helper method used by the class to create its objects.
-
+ is a helper method used by the class to create its objects.
+
> [!NOTE]
-> This method is primarily used by control developers.
-
+> This method is primarily used by control developers.
+
]]>
@@ -1141,24 +1141,24 @@
Gets or sets the index of the currently displayed page.
The zero-based index of the page currently displayed.
- control when paging is enabled. This property is also used to programmatically control which page is displayed.
-
- You can also hide the built in paging controls and create custom controls. To display a specific page, set this property to the page index you want to display and then rebind the data to the control.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to programmatically control the page to display in the control.
-
+ control when paging is enabled. This property is also used to programmatically control which page is displayed.
+
+ You can also hide the built in paging controls and create custom controls. To display a specific page, set this property to the page index you want to display and then rebind the data to the control.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to programmatically control the page to display in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.CurrentPageIndex Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.CurrentPageIndex Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.CurrentPageIndex Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowPaging/CS/datagridallowpagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
+
]]>
The specified page index is a negative value.
@@ -1186,26 +1186,26 @@
Occurs when the Delete button is clicked for an item in the control.
- event is raised when the Delete button is clicked for an item in the control.
-
- A typical handler for the event removes the selected item from the data source and then rebinds the data to the control.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to delete an item from the control.
-
+ event is raised when the Delete button is clicked for an item in the control.
+
+ A typical handler for the event removes the selected item from the data source and then rebinds the data to the control.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to delete an item from the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -1233,11 +1233,11 @@
Represents the Delete command name. This field is read-only.
- field to represent the Delete command name.
-
+ field to represent the Delete command name.
+
]]>
@@ -1270,29 +1270,29 @@
Occurs when the Edit button is clicked for an item in the control.
- event is raised when the Edit button is clicked for an item in the control.
-
- A typical handler for the event sets the property to the selected row and then rebinds the data to the control.
-
+ event is raised when the Edit button is clicked for an item in the control.
+
+ A typical handler for the event sets the property to the selected row and then rebinds the data to the control.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to edit an item in the control.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to edit an item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -1320,11 +1320,11 @@
Represents the Edit command name. This field is read-only.
- field to represent the Edit command name.
-
+ field to represent the Edit command name.
+
]]>
@@ -1364,29 +1364,29 @@
Gets or sets the index of an item in the control to edit.
The index of an item in the control to edit. The default value is -1, which indicates that no item in the control is being edited.
- property when the control contains an to determine the index of the item selected in the control to edit.
-
- This property is also used to programmatically control which item is being edited. Setting this property to an index of an item in the control will enable editing controls for that item in the .
-
+ property when the control contains an to determine the index of the item selected in the control to edit.
+
+ This property is also used to programmatically control which item is being edited. Setting this property to an index of an item in the control will enable editing controls for that item in the .
+
> [!NOTE]
-> The property is zero based.
-
- To cancel editing, programmatically set this property to -1.
-
+> The property is zero based.
+
+ To cancel editing, programmatically set this property to -1.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to determine the item selected for editing in the control.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to determine the item selected for editing in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.EditItemIndex Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.EditItemIndex Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.EditItemIndex Example/VB/sourcevb.aspx" id="Snippet1":::
+
]]>
The specified index is less than -1.
@@ -1429,31 +1429,31 @@
Gets the style properties of the item selected for editing in the control.
A object that contains the style properties of the item selected for editing in the control. The default value is an empty object.
- property to provide a custom style for the item selected for editing in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
-
-|Precedence|Style Property|
-|----------------|--------------------|
-|1||
-|2||
-|3||
-|4||
-|5||
-
- To specify a custom style for the item selected for editing, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to set the background color of the item selected for editing to yellow.
-
+ property to provide a custom style for the item selected for editing in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
+
+|Precedence|Style Property|
+|----------------|--------------------|
+|1||
+|2||
+|3||
+|4||
+|5||
+
+ To specify a custom style for the item selected for editing, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to set the background color of the item selected for editing to yellow.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.EditItemStyle Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.EditItemStyle Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.EditItemStyle Example/VB/sourcevb.aspx" id="Snippet1":::
+
]]>
@@ -1499,29 +1499,29 @@
Gets the style properties of the footer section in the control.
A object that contains the style properties of the footer section of the control. The default value is an empty object.
- control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- The property of the control inherits the style settings of the property. For example, if you specify a red font for the property, the property will also have a red font. This allows you to provide a common appearance for the control by setting a single style property. You can override the inherited style settings by setting the property. For example, you can specify a blue font for the property, overriding the red font specified in the property.
-
- To specify a custom style for the footer section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
+ control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ The property of the control inherits the style settings of the property. For example, if you specify a red font for the property, the property will also have a red font. This allows you to provide a common appearance for the control by setting a single style property. You can override the inherited style settings by setting the property. For example, you can specify a blue font for the property, overriding the red font specified in the property.
+
+ To specify a custom style for the footer section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
> [!NOTE]
-> The property must be set to `true` for this property to be visible.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to set the background color of the footer section.
-
+> The property must be set to `true` for this property to be visible.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to set the background color of the footer section.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridFooterStyle/CS/datagridfooterstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridFooterStyle/VB/datagridfooterstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridFooterStyle/VB/datagridfooterstylevb.aspx" id="Snippet1":::
+
]]>
@@ -1568,29 +1568,29 @@
Gets the style properties of the heading section in the control.
A object that contains the style properties of the heading section in the control. The default value is an empty object.
- control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- The property of the control inherits the style settings of the property. For example, if you specify a red font for the property, the property will also have a red font. This allows you to provide a common appearance for the control by setting a single style property. You can override the inherited style settings by setting the property. For example, you can specify a blue font for the property, overriding the red font specified in the property.
-
- To specify a custom style for the heading section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
+ control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ The property of the control inherits the style settings of the property. For example, if you specify a red font for the property, the property will also have a red font. This allows you to provide a common appearance for the control by setting a single style property. You can override the inherited style settings by setting the property. For example, you can specify a blue font for the property, overriding the red font specified in the property.
+
+ To specify a custom style for the heading section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
> [!NOTE]
-> The property must be set to `true` for this property to be visible.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to set the background color of the heading section.
-
+> The property must be set to `true` for this property to be visible.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to set the background color of the heading section.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.FooterStyle Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridFooterStyle/CS/datagridfooterstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridFooterStyle/VB/datagridfooterstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridFooterStyle/VB/datagridfooterstylevb.aspx" id="Snippet1":::
+
]]>
@@ -1624,14 +1624,14 @@
An array of objects that contains the columns in this control.
Initializes the specified object.
- method is a helper method used by the class to initialize the specified object.
-
+ method is a helper method used by the class to initialize the specified object.
+
> [!NOTE]
-> This method is primarily used by control developers.
-
+> This method is primarily used by control developers.
+
]]>
@@ -1666,14 +1666,14 @@
A that contains the properties for the pager.
Creates a object that contains the paging UI.
- that spans across all columns of a control. The method is a helper method used by the class to create the pager row.
-
+ that spans across all columns of a control. The method is a helper method used by the class to create the pager row.
+
> [!NOTE]
-> This method is primarily used by control developers.
-
+> This method is primarily used by control developers.
+
]]>
@@ -1700,24 +1700,24 @@
Occurs when any button is clicked in the control.
- event is raised when any button is clicked in the control. This event is commonly used to handle buttons controls with a custom CommandName value, such as Add, in the control.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to add or remove an item from a shopping cart.
-
+ event is raised when any button is clicked in the control. This event is commonly used to handle buttons controls with a custom CommandName value, such as Add, in the control.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to add or remove an item from a shopping cart.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -1745,29 +1745,29 @@
Occurs on the server when an item in the control is created.
- event is raised when an item in the control is created, both during round-trips and at the time data is bound to the control.
-
- The event is commonly used to control the content and appearance of a row in the control.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to display the order that items are created in the control.
-
+ event is raised when an item in the control is created, both during round-trips and at the time data is bound to the control.
+
+ The event is commonly used to control the content and appearance of a row in the control.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to display the order that items are created in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemCreated/CS/datagriditemcreatedcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated/VB/datagriditemcreatedvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated/VB/datagriditemcreatedvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemCreated2/CS/datagriditemcreated2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated2/VB/datagriditemcreated2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated2/VB/datagriditemcreated2vb.aspx" id="Snippet1":::
+
]]>
@@ -1795,27 +1795,27 @@
Occurs after an item is data bound to the control.
- event is raised after an item is data bound to the control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to display the order that items in the are data bounded.
-
+ event is raised after an item is data bound to the control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to display the order that items in the are data bounded.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemDataBound/CS/datagriditemdataboundcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound/VB/datagriditemdataboundvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound/VB/datagriditemdataboundvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemDataBound2/CS/datagriditemdatabound2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound2/VB/datagriditemdatabound2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound2/VB/datagriditemdatabound2vb.aspx" id="Snippet1":::
+
]]>
@@ -1854,25 +1854,25 @@
Gets a collection of objects that represent the individual items in the control.
A that contains a collection of objects representing the individual items in the control.
- collection to programmatically control the items in the control. The collection does not provide any methods to add or remove items to the collection. However, you can control the contents of an item by providing a handler for the event.
-
+ collection to programmatically control the items in the control. The collection does not provide any methods to add or remove items to the collection. However, you can control the contents of an item by providing a handler for the event.
+
> [!NOTE]
-> Only items bound to the data source are contained in the collection. The header, footer, and separator are not included in the collection.
-
-
-
-## Examples
- The following code example demonstrates how to use the collection to display the contents of each item in the control.
-
+> Only items bound to the data source are contained in the collection. The header, footer, and separator are not included in the collection.
+
+
+
+## Examples
+ The following code example demonstrates how to use the collection to display the contents of each item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.Items Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.Items Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.Items Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridColumnVisible/CS/datagridcolumnvisiblecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridColumnVisible/VB/datagridcolumnvisiblevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridColumnVisible/VB/datagridcolumnvisiblevb.aspx" id="Snippet1":::
+
]]>
@@ -1914,36 +1914,36 @@
Gets the style properties of the items in the control.
A object that contains the style properties of the items in the control. The default value is an empty object.
- control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
-
-|Precedence|Style Property|
-|----------------|--------------------|
-|1||
-|2||
-|3||
-|4||
-|5||
-
- To specify a custom style for the items of the control, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
- You can also use the property to provide a different appearance for the alternating items in the control.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to set the background color of the items in the to yellow.
-
+ control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
+
+|Precedence|Style Property|
+|----------------|--------------------|
+|1||
+|2||
+|3||
+|4||
+|5||
+
+ To specify a custom style for the items of the control, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
+ You can also use the property to provide a different appearance for the alternating items in the control.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to set the background color of the items in the to yellow.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ItemStyle Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemStyle Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemStyle Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemStyle/CS/datagriditemstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemStyle/VB/datagriditemstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemStyle/VB/datagriditemstylevb.aspx" id="Snippet1":::
+
]]>
@@ -1997,11 +1997,11 @@
Represents the Next command argument. This field is read-only.
- field to represent the Next command argument.
-
+ field to represent the Next command argument.
+
]]>
@@ -2042,14 +2042,14 @@
to indicate that this method is passing an event raised by a control within the container up the page's UI server control hierarchy; otherwise, .
- method to pass an event raised by a control within the container up the page's UI server control hierarchy.
-
+ method to pass an event raised by a control within the container up the page's UI server control hierarchy.
+
> [!NOTE]
-> This method is primarily used by control developers.
-
+> This method is primarily used by control developers.
+
]]>
@@ -2079,37 +2079,37 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when the Cancel button is clicked for an item in the control.
-
- A typical handler for the event sets the property to `-1` (to deselect the item) and then rebinds the data to the control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when the Cancel button is clicked for an item in the control.
+
+ A typical handler for the event sets the property to `-1` (to deselect the item) and then rebinds the data to the control.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to cancel edits made to an item in the control.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to cancel edits made to an item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2140,34 +2140,34 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when the Delete button is clicked for an item in the control.
-
- A typical handler for the event removes the selected item from the data source and then rebinds the data to the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to delete an item from the control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when the Delete button is clicked for an item in the control.
+
+ A typical handler for the event removes the selected item from the data source and then rebinds the data to the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to delete an item from the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2198,37 +2198,37 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when the Edit button is clicked for an item in the control.
-
- A typical handler for the event sets the property to the selected row and then rebinds the data to the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
+ method to provide a custom handler for the event.
+
+ The event is raised when the Edit button is clicked for an item in the control.
+
+ A typical handler for the event sets the property to the selected row and then rebinds the data to the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to edit an item in the control.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to edit an item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2259,32 +2259,32 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when any button is clicked in the control. This event is commonly used to handle buttons controls with a custom CommandName value, such as Add, in the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to add or remove an item from a shopping cart.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when any button is clicked in the control. This event is commonly used to handle buttons controls with a custom CommandName value, such as Add, in the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to add or remove an item from a shopping cart.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2315,37 +2315,37 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when an item in the control is created, both during round-trips and at the time data is bound to the control.
-
- The event is commonly used to control the content and appearance of a row in the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to display the order that items are created in the control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when an item in the control is created, both during round-trips and at the time data is bound to the control.
+
+ The event is commonly used to control the content and appearance of a row in the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to display the order that items are created in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemCreated Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemCreated/CS/datagriditemcreatedcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated/VB/datagriditemcreatedvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated/VB/datagriditemcreatedvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemCreated2/CS/datagriditemcreated2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated2/VB/datagriditemcreated2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemCreated2/VB/datagriditemcreated2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2376,35 +2376,35 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised after an item is data bound to the control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to display the order that items in the are data bounded.
-
+ method to provide a custom handler for the event.
+
+ The event is raised after an item is data bound to the control. This event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to display the order that items in the are data bounded.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ItemDataBound Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemDataBound/CS/datagriditemdataboundcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound/VB/datagriditemdataboundvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound/VB/datagriditemdataboundvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridItemDataBound2/CS/datagriditemdatabound2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound2/VB/datagriditemdatabound2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridItemDataBound2/VB/datagriditemdatabound2vb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2435,37 +2435,37 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when one of the page selection elements is clicked.
-
- A typical handler for the event sets the property to the index of the page you want to display and then uses the method to bind the data to the control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when one of the page selection elements is clicked.
+
+ A typical handler for the event sets the property to the index of the page you want to display and then uses the method to bind the data to the control.
+
> [!NOTE]
-> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event. It displays pages on the control in 10-item increments.
-
+> The event handler receives a object as a parameter. You can use the property of this parameter to determine the index of the page selected by the user from the page selection elements of the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event. It displays pages on the control in 10-item increments.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowPaging/CS/datagridallowpagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/PageIndexChanged/CS/datagridpageindexchangedcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PageIndexChanged/VB/datagridpageindexchangedvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PageIndexChanged/VB/datagridpageindexchangedvb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2496,34 +2496,34 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when a column is sorted.
-
- A typical handler for the event sorts the list, and then rebinds the data to the control.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to sort a control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when a column is sorted.
+
+ A typical handler for the event sorts the list, and then rebinds the data to the control.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to sort a control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowSorting/CS/datagridallowsortingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridSortCommand/CS/datagridsortcommandcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSortCommand/VB/datagridsortcommandvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSortCommand/VB/datagridsortcommandvb.aspx" id="Snippet1":::
+
]]>
- When overriding in a derived class, be sure to call the base class's method.
-
- For more information about how to handle events, see <see href="/dotnet/standard/events/">Handling and Raising Events</see>.
+ When overriding in a derived class, be sure to call the base class's method.
+
+ For more information about how to handle events, see Handling and Raising Events.
@@ -2554,33 +2554,33 @@
A that contains event data.
Raises the event. This allows you to provide a custom handler for the event.
- method to provide a custom handler for the event.
-
- The event is raised when the Update button for an item is clicked.
-
- A typical handler for the event updates the data, sets the property to -1 (to deselect the item), and then rebinds the data to the control.
-
+ method to provide a custom handler for the event.
+
+ The event is raised when the Update button for an item is clicked.
+
+ A typical handler for the event updates the data, sets the property to -1 (to deselect the item), and then rebinds the data to the control.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
- Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
-
- The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to update the values of an item in the control to new values specified by the user.
-
+> Text is not HTML encoded before it is displayed in the control. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/).
+
+ The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to update the values of an item in the control to new values specified by the user.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -2611,11 +2611,11 @@
Represents the Page command name. This field is read-only.
- field to represent the Page command name.
-
+ field to represent the Page command name.
+
]]>
@@ -2659,19 +2659,19 @@
Gets the total number of pages required to display the items in the control.
The total number of pages required to display the items in the control.
- control. This property is only used when the property is set to `true`.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to determine the number of pages required to display the items in the control.
-
+ control. This property is only used when the property is set to `true`.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to determine the number of pages required to display the items in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/VB/sourcevb.aspx" id="Snippet1":::
+
]]>
@@ -2697,26 +2697,26 @@
Occurs when one of the page selection elements is clicked.
- event is raised when one of the page selection elements is clicked.
-
- A typical handler for the event sets the property to the index of the page you want to display and then uses the method to bind the data to the control.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event. It displays pages on the control in 10-item increments.
-
+ event is raised when one of the page selection elements is clicked.
+
+ A typical handler for the event sets the property to the index of the page you want to display and then uses the method to bind the data to the control.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event. It displays pages on the control in 10-item increments.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowPaging/CS/datagridallowpagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowPaging/VB/datagridallowpagingvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/PageIndexChanged/CS/datagridpageindexchangedcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PageIndexChanged/VB/datagridpageindexchangedvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/PageIndexChanged/VB/datagridpageindexchangedvb.aspx" id="Snippet1":::
+
]]>
@@ -2759,24 +2759,24 @@
Gets the style properties of the paging section of the control.
A object that contains the style properties of the paging section of the control. The default value is an empty object.
- control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- To specify a custom style for the paging section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to specify a custom style for the page selection elements of the control.
-
+ control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ To specify a custom style for the paging section, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to specify a custom style for the page selection elements of the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.PagerStyle Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PagerStyle Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PagerStyle Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridPagerStyle/CS/datagridpagerstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridPagerStyle/VB/datagridpagerstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridPagerStyle/VB/datagridpagerstylevb.aspx" id="Snippet1":::
+
]]>
@@ -2809,22 +2809,22 @@
Gets or sets the number of items to display on a single page of the control.
The number of items to display on a single page of the control. The default value is 10.
- control. The property must be set to `true` for this property have any effect.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to specify that five items are displayed on a single page of the control.
-
+ control. The property must be set to `true` for this property have any effect.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to specify that five items are displayed on a single page of the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.PageCount Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridPageSize/CS/datagridpagesizecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridPageSize/VB/datagridpagesizevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridPageSize/VB/datagridpagesizevb.aspx" id="Snippet1":::
+
]]>
The specified page size less than 1.
@@ -2858,11 +2858,11 @@
Sets up the control hierarchy for this control.
- method is a helper method called by the control to set up the control hierarchy in the control before the control is rendered.
-
+ method is a helper method called by the control to set up the control hierarchy in the control before the control is rendered.
+
]]>
@@ -2887,11 +2887,11 @@
Represents the Prev command argument. This field is read-only.
- field to represent the Prev command argument.
-
+ field to represent the Prev command argument.
+
]]>
@@ -2948,11 +2948,11 @@
Represents the Select command name. This field is read-only.
- field to represent the Select command name.
-
+ field to represent the Select command name.
+
]]>
@@ -2996,21 +2996,21 @@
Gets or sets the index of the selected item in the control.
The index of the selected item in the control.
- property to determine the index of the item selected by the user in the control. You can also use this property to programmatically specify which item is selected in the control.
-
- To deselect an item in the control, set this property to -1.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to determine the index number of the selected item in the control. It also shows how to select and deselect an item programmatically.
-
+ property to determine the index of the item selected by the user in the control. You can also use this property to programmatically specify which item is selected in the control.
+
+ To deselect an item in the control, set this property to -1.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to determine the index number of the selected item in the control. It also shows how to select and deselect an item programmatically.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
+
]]>
The specified index is less than -1.
@@ -3047,22 +3047,22 @@
Gets a object that represents the selected item in the control.
A object that represents the selected item in the control.
- property to get a object that represents the selected item in the control. This object can then be used to access the properties of the selected item.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to access the properties of the selected item in the control.
-
+ property to get a object that represents the selected item in the control. This object can then be used to access the properties of the selected item.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to access the properties of the selected item in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/BaseDataListSelectedIndexChanged/CS/basedatalistselectedindexchangedcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BaseDataListSelectedIndexChanged/VB/basedatalistselectedindexchangedvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BaseDataListSelectedIndexChanged/VB/basedatalistselectedindexchangedvb.aspx" id="Snippet1":::
+
]]>
@@ -3103,34 +3103,34 @@
Gets the style properties of the currently selected item in the control.
A object that contains the style properties of the currently selected item in the control. The default value is an empty object.
- property to provide a custom style for the selected item in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
-
- Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
-
-|Precedence|Style Property|
-|----------------|--------------------|
-|1||
-|2||
-|3||
-|4||
-|5||
-
- To specify a custom style for the selected item, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
-
-
-
-## Examples
- The following code example demonstrates how to use property to set the background color of the selected item in the control to yellow.
-
+ property to provide a custom style for the selected item in the control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the control.
+
+ Item style properties in the control are inherited from one item style property to another through a hierarchy. Item style properties set lower in the hierarchy are inherited by item style properties higher in the hierarchy. For example, if you specify a red font for the property, all other item style properties in the control will also have a red font. This allows you to provide a common appearance for the control by setting a single item style property. You can override the inherited style settings for an item style property that is higher in the hierarchy by setting its style properties. For example, you can specify a blue font for the property, overriding the red font specified in the property. The following table lists the hierarchy order from highest to lowest.
+
+|Precedence|Style Property|
+|----------------|--------------------|
+|1||
+|2||
+|3||
+|4||
+|5||
+
+ To specify a custom style for the selected item, place the `` tags between the opening and closing tags of the control. You can then list the style attributes within the opening `` tag.
+
+
+
+## Examples
+ The following code example demonstrates how to use property to set the background color of the selected item in the control to yellow.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.SelectedIndex Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridSelectedItemStyle/CS/datagridselecteditemstylecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSelectedItemStyle/VB/datagridselecteditemstylevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSelectedItemStyle/VB/datagridselecteditemstylevb.aspx" id="Snippet1":::
+
]]>
@@ -3169,22 +3169,22 @@
to display the footer; otherwise, . The default value is .
- control. The appearance of the footer is controlled by using the property.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to display the footer in the control.
-
+ control. The appearance of the footer is controlled by using the property.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to display the footer in the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ShowFooter Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ShowFooter Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ShowFooter Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridShowHeader/CS/datagridshowheadercs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridShowHeader/VB/datagridshowheadervb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridShowHeader/VB/datagridshowheadervb.aspx" id="Snippet1":::
+
]]>
@@ -3222,22 +3222,22 @@
to display the header; otherwise, . The default value is .
- . The appearance of the header is controlled by using the property.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to hide the header on the control.
-
+ . The appearance of the header is controlled by using the property.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to hide the header on the control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataGrid.ShowHeader Example/CS/sourcecs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ShowHeader Example/VB/sourcevb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataGrid.ShowHeader Example/VB/sourcevb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridShowHeader/CS/datagridshowheadercs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridShowHeader/VB/datagridshowheadervb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridShowHeader/VB/datagridshowheadervb.aspx" id="Snippet1":::
+
]]>
@@ -3263,26 +3263,26 @@
Occurs when a column is sorted.
- event is raised when a column is sorted.
-
- A typical handler for the event sorts the list, and then rebinds the data to the control.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to sort a control.
-
+ event is raised when a column is sorted.
+
+ A typical handler for the event sorts the list, and then rebinds the data to the control.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to sort a control.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridAllowSorting/CS/datagridallowsortingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridAllowSorting/VB/datagridallowsortingvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridSortCommand/CS/datagridsortcommandcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSortCommand/VB/datagridsortcommandvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridSortCommand/VB/datagridsortcommandvb.aspx" id="Snippet1":::
+
]]>
@@ -3310,11 +3310,11 @@
Represents the Sort command name. This field is read-only.
- field to represent the Sort command name.
-
+ field to represent the Sort command name.
+
]]>
@@ -3347,11 +3347,11 @@
Gets the value for the control.
Always returns .
- property allows the output stream to write the appropriate HTML markup for the control.
-
+ property allows the output stream to write the appropriate HTML markup for the control.
+
]]>
@@ -3401,29 +3401,29 @@
Occurs when the Update button is clicked for an item in the control.
- event is raised when the Update button for an item is clicked.
-
- A typical handler for the event updates the data, sets the property to `-1` (to deselect the item), and then rebinds the data to the control.
-
+ event is raised when the Update button for an item is clicked.
+
+ A typical handler for the event updates the data, sets the property to `-1` (to deselect the item), and then rebinds the data to the control.
+
> [!CAUTION]
-> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
-
- For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
-
-
-
-## Examples
- The following code example demonstrates how to specify and code a handler for the event to update the values of an item in the control to new values specified by the user.
-
+> Text is not HTML encoded before it is displayed in the control. This makes it possible to embed script within HTML tags in the text. If the values for the control come from user input, be sure to validate the values to reduce security vulnerabilities.
+
+ For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
+
+
+
+## Examples
+ The following code example demonstrates how to specify and code a handler for the event to update the values of an item in the control to new values specified by the user.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit/CS/datagrideditcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit/VB/datagrideditvb.aspx" id="Snippet1":::
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridEdit2/CS/datagridedit2cs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridEdit2/VB/datagridedit2vb.aspx" id="Snippet1":::
+
]]>
@@ -3451,11 +3451,11 @@
Represents the Update command name. This field is read-only.
- field to represent the Update command name.
-
+ field to represent the Update command name.
+
]]>
@@ -3499,23 +3499,23 @@
Gets or sets the virtual number of items in the control when custom paging is used.
The virtual number of items in the control when custom paging is used.
- control when custom paging is used. This property is only used when the property is set to `true`.
-
- If the property is set to `true`, the number of pages required to display every item in the control is calculated based on the values of the and properties.
-
- If the property is set to `false`, the number of pages displayed in the control is calculated based on the values of the property and the total number of items in the data source.
-
-
-
-## Examples
- The following code example demonstrates how to use the property to specify the total number of items in the control when custom paging is used.
-
+ control when custom paging is used. This property is only used when the property is set to `true`.
+
+ If the property is set to `true`, the number of pages required to display every item in the control is calculated based on the values of the and properties.
+
+ If the property is set to `false`, the number of pages displayed in the control is calculated based on the values of the property and the total number of items in the data source.
+
+
+
+## Examples
+ The following code example demonstrates how to use the property to specify the total number of items in the control when custom paging is used.
+
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridCustomPaging/CS/datagridcustompagingcs.aspx" id="Snippet1":::
- :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCustomPaging/VB/datagridcustompagingvb.aspx" id="Snippet1":::
-
+ :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataGridCustomPaging/VB/datagridcustompagingvb.aspx" id="Snippet1":::
+
]]>
The specified value is a negative number.
@@ -3524,4 +3524,4 @@
-
\ No newline at end of file
+
diff --git a/xml/System.Web.UI.WebControls/Wizard.xml b/xml/System.Web.UI.WebControls/Wizard.xml
index f042d7bba7e..5784b08211b 100644
--- a/xml/System.Web.UI.WebControls/Wizard.xml
+++ b/xml/System.Web.UI.WebControls/Wizard.xml
@@ -1235,7 +1235,7 @@
to display **Cancel** on the ; otherwise, . The default is .
- This property cannot be set by themes or style sheet themes. For more information, see and <see href="https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100">ASP.NET Themes and Skins</see>).
+ This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes and Skins).
To be added.
@@ -1280,7 +1280,7 @@
to display the sidebar area on the ; otherwise, . The default is .
- This property cannot be set by themes or style sheet themes. For more information, see and <see href="https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100">ASP.NET Themes and Skins</see>).
+ This property cannot be set by themes or style sheet themes. For more information, see and ASP.NET Themes and Skins).
-
\ No newline at end of file
+
diff --git a/xml/System.Web.UI/Control.xml b/xml/System.Web.UI/Control.xml
index 8f1112a66f3..e642c4a1e9d 100644
--- a/xml/System.Web.UI/Control.xml
+++ b/xml/System.Web.UI/Control.xml
@@ -2223,7 +2223,7 @@ HyperLink1.NavigateUrl = HyperLink1.GetRouteUrl("Product",
]]>
- The method should be overridden only to change metadata attributes such as . For more information about using attributes, see <see href="/dotnet/standard/attributes/">Attributes</see>.
+ The method should be overridden only to change metadata attributes such as . For more information about using attributes, see Attributes.
@@ -3798,7 +3798,7 @@ HyperLink1.NavigateUrl = HyperLink1.GetRouteUrl("Product",
When control state is saved, a string object is returned to the client as a variable that is stored in an HTML element. Override this method to extract the state information to use in your control.
- Control state is intended for small amounts of critical data, such as a page index or a keyword. Using control state for large amounts of data can adversely affect page performance. For more information, see <see href="https://learn.microsoft.com/previous-versions/aspnet/75x4ha6s(v=vs.100">ASP.NET State Management Overview</see>).
+ Control state is intended for small amounts of critical data, such as a page index or a keyword. Using control state for large amounts of data can adversely affect page performance. For more information, see ASP.NET State Management Overview).
@@ -4951,4 +4951,4 @@ HyperLink1.NavigateUrl = HyperLink1.GetRouteUrl("Product",
-
\ No newline at end of file
+
diff --git a/xml/System.Web.UI/PartialCachingControl.xml b/xml/System.Web.UI/PartialCachingControl.xml
index ab02ec926c5..6914a57d61e 100644
--- a/xml/System.Web.UI/PartialCachingControl.xml
+++ b/xml/System.Web.UI/PartialCachingControl.xml
@@ -16,15 +16,15 @@
- Created when a user control (.ascx file) is specified for output caching, using either the <see href="https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100">@ OutputCache</see>) page directive or the attribute, and the user control is inserted into a page's control hierarchy by dynamically loading the user control with the method.
+ Created when a user control (.ascx file) is specified for output caching, using either the @ OutputCache) page directive or the attribute, and the user control is inserted into a page's control hierarchy by dynamically loading the user control with the method.
- class directly. ASP.NET creates an instance of the class to wrap a user control (.ascx file) when a dynamically loaded user control enables output caching. You can enable output caching for a user control using either the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) page directive or the attribute.
-
- You add a user control to a page programmatically by calling the method.
-
+ class directly. ASP.NET creates an instance of the class to wrap a user control (.ascx file) when a dynamically loaded user control enables output caching. You can enable output caching for a user control using either the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) page directive or the attribute.
+
+ You add a user control to a page programmatically by calling the method.
+
]]>
Caching Portions of an ASP.NET Page
@@ -57,14 +57,14 @@
Gets a reference to the user control that is cached.
The user control that is cached.
-
-
\ No newline at end of file
+
diff --git a/xml/System.Web.UI/ScriptMode.xml b/xml/System.Web.UI/ScriptMode.xml
index 28f6fbb81dc..877f800b12d 100644
--- a/xml/System.Web.UI/ScriptMode.xml
+++ b/xml/System.Web.UI/ScriptMode.xml
@@ -16,30 +16,30 @@
Specifies whether and objects refer to the debug or release version of client scripts.
- enumeration provides values for setting the version of client script to use on a Web page. The enumeration values can be applied to either the property or to the [ScriptReference.ScriptMode]() property. The object sets the version for all scripts on the page unless it is overridden by a object. The object sets the version for a particular script.
-
- The value produces different results depending on whether it refers to a standalone script file or to a script file that is embedded as a resource in an assembly. A standalone script file is defined with the [ScriptReference.Path]() property. An assembly reference must be accessed through the and properties. The results for the value are as follows:
-
-- When it is applied to a standalone script file where the [ScriptReference.Path] property is specified, the value is equivalent to .
-
-- When it is applied to a script reference in an assembly, is equivalent to . When only is specified, it is used to reference the script. When and the [ScriptReference.Path] property are both specified, the [ScriptReference.Path] property is used instead of , but the value is still equivalent to .
-
- An error is thrown if the requested version of the script does not exist. For instance, an error is thrown if a reference is made to a standalone script file that is named CustomScript.js and the property is set to , but CustomScript.debug.js does not exist on the site. References to scripts in an assembly return the release version if the debug version does not exist.
-
+ enumeration provides values for setting the version of client script to use on a Web page. The enumeration values can be applied to either the property or to the [ScriptReference.ScriptMode]() property. The object sets the version for all scripts on the page unless it is overridden by a object. The object sets the version for a particular script.
+
+ The value produces different results depending on whether it refers to a standalone script file or to a script file that is embedded as a resource in an assembly. A standalone script file is defined with the [ScriptReference.Path]() property. An assembly reference must be accessed through the and properties. The results for the value are as follows:
+
+- When it is applied to a standalone script file where the [ScriptReference.Path] property is specified, the value is equivalent to .
+
+- When it is applied to a script reference in an assembly, is equivalent to . When only is specified, it is used to reference the script. When and the [ScriptReference.Path] property are both specified, the [ScriptReference.Path] property is used instead of , but the value is still equivalent to | |