ListViewItem Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an individual item in a ListView control.
public ref class ListViewItem : System::Web::UI::Control, System::Web::UI::INamingContainerpublic ref class ListViewItem : System::Web::UI::Control, System::Web::UI::IDataItemContainerpublic class ListViewItem : System.Web.UI.Control, System.Web.UI.INamingContainerpublic class ListViewItem : System.Web.UI.Control, System.Web.UI.IDataItemContainertype ListViewItem = class
inherit Control
interface INamingContainertype ListViewItem = class
inherit Control
interface IDataItemContainer
interface INamingContainertype ListViewItem = class
inherit Control
interface INamingContainer
interface IDataItemContainerPublic Class ListViewItem
Inherits Control
Implements INamingContainerPublic Class ListViewItem
Inherits Control
Implements IDataItemContainer- Inheritance
- Derived
- Implements
Examples
The following example shows how to use the ListViewItem class to access the properties of the item that is being created in the ListView control.
Important
This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.
<%@ Page language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
// <Snippet2>
protected void ContactsListView_ItemCreated(object sender, ListViewItemEventArgs e)
{
// Retrieve the current item.
ListViewItem item = e.Item;
// Verify if the item is a data item.
if (item.ItemType == ListViewItemType.DataItem)
{
// Get the EmailAddressLabel Label control in the item.
Label EmailAddressLabel = (Label)item.FindControl("EmailAddressLabel");
// Display the email address in italics.
EmailAddressLabel.Font.Italic = true;
}
}
// </Snippet2>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ListViewItem Example</title>
<style type="text/css">
body { text-align: center; }
.bgcolor { background-color: #CAEEFF; }
</style>
</head>
<body style="font: 10pt Trebuchet MS">
<form id="form1" runat="server">
<h3>ListViewItem Example</h3>
<asp:ListView ID="ContactsListView"
DataSourceID="ContactsDataSource"
InsertItemPosition="LastItem"
OnItemCreated="ContactsListView_ItemCreated"
runat="server">
<LayoutTemplate>
<table cellpadding="2" width="680px" border="0">
<tr class="bgcolor" runat="server">
<th runat="server">First Name</th>
<th runat="server">Last Name</th>
<th runat="server">Email Address</th>
</tr>
<tr id="itemPlaceholder" runat="server"></tr>
</table>
<asp:DataPager runat="server" ID="PeopleDataPager">
<Fields>
<asp:NumericPagerField ButtonCount="10" />
</Fields>
</asp:DataPager>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td>
<asp:Label ID="FirstNameLabel" runat="server" Text='<%#Eval("FirstName") %>' />
</td>
<td>
<asp:Label ID="LastNameLabel" runat="server" Text='<%#Eval("LastName") %>' />
</td>
<td>
<asp:Label ID="EmailAddressLabel" runat="server" Text='<%#Eval("EmailAddress") %>' />
</td>
</tr>
</ItemTemplate>
<InsertItemTemplate>
<tr class="bgcolor">
<td>
<asp:TextBox ID="FirstNameTextBox" runat="server"
Text='<%#Bind("FirstName") %>' MaxLength="50" />
</td>
<td>
<asp:TextBox ID="LastNameTextBox" runat="server"
Text='<%#Bind("LastName") %>' MaxLength="50" /> <br />
</td>
<td>
<asp:TextBox ID="EmailAddressTextBox" runat="server"
Text='<%#Bind("EmailAddress") %>' MaxLength="50" /> <br />
</td>
</tr>
<tr class="bgcolor" runat="server">
<td colspan="3">
<asp:Button ID="InsertButton" runat="server" CommandName="Insert" Text="Insert" />
<asp:Button ID="CancelInsertButton" runat="server" CommandName="Cancel" Text="Cancel" />
</td>
</tr>
</InsertItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="ContactsDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT FirstName, LastName, EmailAddress FROM Person.Contact"
InsertCommand="INSERT INTO Person.Contact
([FirstName], [LastName], [EmailAddress], [PasswordHash], [PasswordSalt])
Values(@FirstName, @LastName, @EmailAddress, '', '')">
</asp:SqlDataSource>
</form>
</body>
</html>
<%@ Page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
' <Snippet2>
Protected Sub ContactsListView_ItemCreated(ByVal sender As Object, ByVal e As ListViewItemEventArgs)
' Retrieve the current item.
Dim item As ListViewItem = e.Item
' Verify if the item is a data item.
If item.ItemType = ListViewItemType.DataItem Then
' Get the EmailAddressLabel Label control in the item.
Dim EmailAddressLabel As Label = CType(item.FindControl("EmailAddressLabel"), Label)
' Display the email address in italics.
EmailAddressLabel.Font.Italic = True
End If
End Sub
' </Snippet2>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ListViewItem Example</title>
<style type="text/css">
body { text-align: center; }
.bgcolor { background-color: #CAEEFF; }
</style>
</head>
<body style="font: 10pt Trebuchet MS">
<form id="form1" runat="server">
<h3>ListViewItem Example</h3>
<asp:ListView ID="ContactsListView"
DataSourceID="ContactsDataSource"
InsertItemPosition="LastItem"
OnItemCreated="ContactsListView_ItemCreated"
runat="server">
<LayoutTemplate>
<table cellpadding="2" width="680px" border="0">
<tr class="bgcolor" runat="server">
<th runat="server">First Name</th>
<th runat="server">Last Name</th>
<th runat="server">Email Address</th>
</tr>
<tr id="itemPlaceholder" runat="server"></tr>
</table>
<asp:DataPager runat="server" ID="PeopleDataPager">
<Fields>
<asp:NumericPagerField ButtonCount="10" />
</Fields>
</asp:DataPager>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td>
<asp:Label ID="FirstNameLabel" runat="server" Text='<%#Eval("FirstName") %>' />
</td>
<td>
<asp:Label ID="LastNameLabel" runat="server" Text='<%#Eval("LastName") %>' />
</td>
<td>
<asp:Label ID="EmailAddressLabel" runat="server" Text='<%#Eval("EmailAddress") %>' />
</td>
</tr>
</ItemTemplate>
<InsertItemTemplate>
<tr class="bgcolor">
<td>
<asp:TextBox ID="FirstNameTextBox" runat="server"
Text='<%#Bind("FirstName") %>' MaxLength="50" />
</td>
<td>
<asp:TextBox ID="LastNameTextBox" runat="server"
Text='<%#Bind("LastName") %>' MaxLength="50" /> <br />
</td>
<td>
<asp:TextBox ID="EmailAddressTextBox" runat="server"
Text='<%#Bind("EmailAddress") %>' MaxLength="50" /> <br />
</td>
</tr>
<tr class="bgcolor" runat="server">
<td colspan="3">
<asp:Button ID="InsertButton" runat="server" CommandName="Insert" Text="Insert" />
<asp:Button ID="CancelInsertButton" runat="server" CommandName="Cancel" Text="Cancel" />
</td>
</tr>
</InsertItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="ContactsDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT FirstName, LastName, EmailAddress FROM Person.Contact"
InsertCommand="INSERT INTO Person.Contact
([FirstName], [LastName], [EmailAddress], [PasswordHash], [PasswordSalt])
Values(@FirstName, @LastName, @EmailAddress, '', '')">
</asp:SqlDataSource>
</form>
</body>
</html>
Remarks
The ListViewItem class is used to represent an individual item in a ListView control. An individual item usually represents a record in the underlying data source of a ListView control.
Each item in the ListView control has a designated item type, as listed in the following table.
| Item type | Description |
|---|---|
| DataItem | A data item in the ListView control. |
| InsertItem | An insert item in the ListView control. |
| EmptyItem | An empty item in the ListView control. The empty item is displayed when the ListView control does not have any records to display, or when a group in the ListView control does not have any more records to display. |
To determine the type of a ListViewItem object, use the ItemType property.
If an item contains other controls, you can retrieve a control by using the Controls collection of the item. If the control's ID property is set, you can also use the FindControl method to find the control.
For a list of initial property values for an instance of ListViewItem, see the ListViewItem constructor.
Constructors
| ListViewItem(ListViewItemType) |
Initializes a new instance of the ListViewItem class. |
Properties
| Adapter |
Gets the browser-specific adapter for the control. (Inherited from Control) |
| AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
| BindingContainer |
Gets the control that contains this control's data binding. (Inherited from Control) |
| ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
| ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control) |
| ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control) |
| ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property. (Inherited from Control) |
| Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
| Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control) |
| DataItem |
Gets or sets the underlying data object that the ListViewItem object is bound to. |
| DataItemContainer |
Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control) |
| DataItemIndex |
Gets the index of the data item that is bound to the ListViewItem control. |
| DataKeysContainer |
Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control) |
| DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
| DisplayIndex |
Gets the position of the data item as displayed in the ListView control. |
| EnableTheming |
Gets or sets a value indicating whether themes apply to this control. (Inherited from Control) |
| EnableViewState |
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control) |
| Events |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
| HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
| ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
| IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
| IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
| IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
| IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
| ItemType |
Gets the item type of the ListViewItem object. |
| LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control) |
| NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control) |
| Page |
Gets a reference to the Page instance that contains the server control. (Inherited from Control) |
| Parent |
Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control) |
| RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
| Site |
Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control) |
| SkinID |
Gets or sets the skin to apply to the control. (Inherited from Control) |
| TemplateControl |
Gets or sets a reference to the template that contains this control. (Inherited from Control) |
| TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control) |
| UniqueID |
Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control) |
| ValidateRequestMode |
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control) |
| ViewState |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control) |
| ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
| ViewStateMode |
Gets or sets the view-state mode of this control. (Inherited from Control) |
| Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control) |
Methods
| AddedControl(Control, Int32) |
Called after a child control is added to the Controls collection of the Control object. (Inherited from Control) |
| AddParsedSubObject(Object) |
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control) |
| ApplyStyleSheetSkin(Page) |
Applies the style properties defined in the page style sheet to the control. (Inherited from Control) |
| BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
| BuildProfileTree(String, Boolean) |
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control) |
| ClearCachedClientID() |
Sets the cached ClientID value to |
| ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
| ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
| ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
| ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control) |
| CreateChildControls() |
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control) |
| CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
| DataBind() |
Binds a data source to the invoked server control and all its child controls. (Inherited from Control) |
| DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control) |
| DataBindChildren() |
Binds a data source to the server control's child controls. (Inherited from Control) |
| Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
| EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
| EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control) |
| EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
| FindControl(String) |
Searches the current naming container for a server control with the specified |
| Focus() |
Sets input focus to a control. (Inherited from Control) |
| GetDesignModeState() |
Gets design-time data for a control. (Inherited from Control) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetUniqueIDRelativeTo(Control) |
Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control) |
| HasControls() |
Determines if the server control contains any child controls. (Inherited from Control) |
| HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
| IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
| LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control) |
| LoadViewState(Object) |
Restores view-state information from a previous page request that was saved by the SaveViewState() method. (Inherited from Control) |
| MapPathSecure(String) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnBubbleEvent(Object, EventArgs) |
Determines whether to pass an event up the page's ASP.NET server control hierarchy. |
| OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
| OnInit(EventArgs) |
Raises the Init event. (Inherited from Control) |
| OnLoad(EventArgs) |
Raises the Load event. (Inherited from Control) |
| OnPreRender(EventArgs) |
Raises the PreRender event. (Inherited from Control) |
| OnUnload(EventArgs) |
Raises the Unload event. (Inherited from Control) |
| OpenFile(String) |
Gets a Stream used to read a file. (Inherited from Control) |
| RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (Inherited from Control) |
| RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
| Render(HtmlTextWriter) |
Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control) |
| RenderChildren(HtmlTextWriter) |
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control) |
| RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
| RenderControl(HtmlTextWriter) |
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control) |
| ResolveAdapter() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
| ResolveClientUrl(String) |
Gets a URL that can be used by the browser. (Inherited from Control) |
| ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client. (Inherited from Control) |
| SaveControlState() |
Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control) |
| SaveViewState() |
Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control) |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
| SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control) |
| SetTraceData(Object, Object, Object) |
Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control) |
| SetTraceData(Object, Object) |
Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| TrackViewState() |
Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. (Inherited from Control) |
Events
| DataBinding |
Occurs when the server control binds to a data source. (Inherited from Control) |
| Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control) |
| Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control) |
| Load |
Occurs when the server control is loaded into the Page object. (Inherited from Control) |
| PreRender |
Occurs after the Control object is loaded but prior to rendering. (Inherited from Control) |
| Unload |
Occurs when the server control is unloaded from memory. (Inherited from Control) |
Explicit Interface Implementations
Extension Methods
| FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
| FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
| FindMetaTable(Control) |
Returns the metatable object for the containing data control. |
| GetDefaultValues(INamingContainer) |
Gets the collection of the default values for the specified data control. |
| GetMetaTable(INamingContainer) |
Gets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, Object) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable) |
Sets the table metadata for the specified data control. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Determines whether table metadata is available. |
| EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, Object) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type) |
Enables Dynamic Data behavior for the specified data control. |
