ListView Class
TOC
Collapse the table of content
Expand the table of content

ListView Class

.NET Framework (current version)
 

Displays the values of a data source by using user-defined templates. The ListView control enables users to select, sort, delete, edit, and insert records.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataBoundControl
        System.Web.UI.WebControls.DataBoundControl
          System.Web.UI.WebControls.ListView

[ControlValuePropertyAttribute("SelectedValue")]
[ToolboxBitmapAttribute(typeof(ListView), "ListView.bmp")]
public class ListView : DataBoundControl, INamingContainer, IPageableItemContainer, 
	IPersistedSelector, IDataKeysControl, IDataBoundListControl, 
	IDataBoundControl

NameDescription
System_CAPS_pubmethodListView()

Initializes a new instance of the ListView class.

NameDescription
System_CAPS_pubpropertyAccessKey

Overrides the WebControl.AccessKey property. Setting this property is not supported by the ListView control.(Overrides WebControl.AccessKey.)

System_CAPS_protpropertyAdapter

Gets the browser-specific adapter for the control.(Inherited from Control.)

System_CAPS_pubpropertyAlternatingItemTemplate

Gets or sets the custom content for the alternating data item in a ListView control.

System_CAPS_pubpropertyAppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)

System_CAPS_pubpropertyAttributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.(Inherited from WebControl.)

System_CAPS_pubpropertyBackColor

Overrides the WebControl.BackColor property. Setting this property is not supported by the ListView control.(Overrides WebControl.BackColor.)

System_CAPS_pubpropertyBindingContainer

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)

System_CAPS_pubpropertyBorderColor

Overrides the WebControl.BorderColor property. Setting this property is not supported by the ListView control.(Overrides WebControl.BorderColor.)

System_CAPS_pubpropertyBorderStyle

Overrides the WebControl.BorderStyle property. Setting this property is not supported by the ListView control.(Overrides WebControl.BorderStyle.)

System_CAPS_pubpropertyBorderWidth

Overrides the WebControl.BorderWidth property. Setting this property is not supported by the ListView control.(Overrides WebControl.BorderWidth.)

System_CAPS_protpropertyChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)

System_CAPS_pubpropertyClientID

Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)

System_CAPS_pubpropertyClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)

System_CAPS_pubpropertyClientIDRowSuffix

Gets or sets the name of the data field whose value is used to uniquely identify each data row of a ListView control when the ClientIDMode property is set to Predictable.

System_CAPS_pubpropertyClientIDRowSuffixDataKeys

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the data values that are used to uniquely identify each instance of a data-bound control when ASP.NET generates the ClientID value.

System_CAPS_protpropertyClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)

System_CAPS_protpropertyContext

Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)

System_CAPS_pubpropertyControls

Gets a ControlCollection object that represents the child controls of the ListView control.(Overrides Control.Controls.)

System_CAPS_pubpropertyControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubpropertyControlStyleCreated

Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.(Inherited from WebControl.)

System_CAPS_pubpropertyConvertEmptyStringToNull

Gets or sets a value that indicates whether empty string values ("") are automatically converted to null values when the data field is updated in the data source.

System_CAPS_pubpropertyCssClass

Overrides the WebControl.CssClass property. Setting this property is not supported by the ListView control.(Overrides WebControl.CssClass.)

System_CAPS_pubpropertyDataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)

System_CAPS_pubpropertyDataKeyNames

Gets or sets an array that contains the names of the primary key fields for the items displayed in a ListView control.

System_CAPS_pubpropertyDataKeys

Gets a collection of DataKey objects that represent the data-key value for each item in a ListView control.

System_CAPS_pubpropertyDataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)

System_CAPS_pubpropertyDataMember

Gets or sets the name of the list of data that the data-bound control binds to, in cases where the data source contains more than one distinct list of data items.(Inherited from DataBoundControl.)

System_CAPS_pubpropertyDataSource

Gets or sets the object from which the data-bound control retrieves its list of data items.(Inherited from BaseDataBoundControl.)

System_CAPS_pubpropertyDataSourceID

Gets or sets the ID of the control from which the data-bound control retrieves its list of data items.(Inherited from DataBoundControl.)

System_CAPS_pubpropertyDataSourceObject

Gets an object that implements the IDataSource interface, which provides access to the object's data content.(Inherited from DataBoundControl.)

System_CAPS_pubpropertyDeleteMethod

System_CAPS_protpropertyDesignMode

Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)

System_CAPS_pubpropertyEditIndex

Gets or sets the index of the item being edited.

System_CAPS_pubpropertyEditItem

Gets the item that is in edit mode in a ListView control.

System_CAPS_pubpropertyEditItemTemplate

Gets or sets the custom content for the item in edit mode.

System_CAPS_pubpropertyEmptyDataTemplate

Gets or sets the user-defined content for the empty template that is rendered when a ListView control is bound to a data source that does not contain any records.

System_CAPS_pubpropertyEmptyItemTemplate

Gets or sets the user-defined content for the empty item that is rendered in a ListView control when there are no more data items to display in the last row of the current data page.

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)

System_CAPS_pubpropertyEnableModelValidation

Gets or sets a value that indicates whether a validator control will handle exceptions that occur during insert or update operations.

System_CAPS_pubpropertyEnablePersistedSelection

Gets or sets a value that indicates whether row selection persists when a user pages through data in a data-bound control.

System_CAPS_pubpropertyEnableTheming

Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)

System_CAPS_pubpropertyEnableViewState

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

System_CAPS_protpropertyEvents

Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)

System_CAPS_pubpropertyFont

Overrides the WebControl.Font property. This property is not supported by the ListView control.(Overrides WebControl.Font.)

System_CAPS_pubpropertyForeColor

Overrides the WebControl.ForeColor property. Setting this property is not supported by the ListView control.(Overrides WebControl.ForeColor.)

System_CAPS_pubpropertyGroupItemCount

Gets or sets the number of items to display per group in a ListView control.

System_CAPS_pubpropertyGroupPlaceholderID

Gets or sets the ID for the group placeholder in a ListView control.

System_CAPS_pubpropertyGroupSeparatorTemplate

Gets or sets the user-defined content for the separator between groups in a ListView control.

System_CAPS_pubpropertyGroupTemplate

Gets or sets the user-defined content for the group container in a ListView control.

System_CAPS_pubpropertyHasAttributes

Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)

System_CAPS_protpropertyHasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)

System_CAPS_pubpropertyHeight

Overrides the WebControl.Height property. Setting this property is not supported by the ListView control.(Overrides WebControl.Height.)

System_CAPS_pubpropertyID

Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)

System_CAPS_protpropertyIdSeparator

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)

System_CAPS_protpropertyInitialized

Gets a value indicating whether the data-bound control has been initialized.(Inherited from BaseDataBoundControl.)

System_CAPS_pubpropertyInsertItem

Gets the insert item of a ListView control.

System_CAPS_pubpropertyInsertItemPosition

Gets or sets the location of the InsertItemTemplate template when it is rendered as part of the ListView control.

System_CAPS_pubpropertyInsertItemTemplate

Gets or sets the custom content for an insert item in the ListView control.

System_CAPS_pubpropertyInsertMethod

Gets or sets the name of the method to call in order to insert data.

System_CAPS_protpropertyIsBoundUsingDataSourceID

Gets a value indicating whether the DataSourceID property is set.(Inherited from BaseDataBoundControl.)

System_CAPS_protpropertyIsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)

System_CAPS_protpropertyIsDataBindingAutomatic

Gets a value that indicates whether data binding is automatic.(Inherited from BaseDataBoundControl.)

System_CAPS_protpropertyIsEnabled

Gets a value indicating whether the control is enabled.(Inherited from WebControl.)

System_CAPS_protpropertyIsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)

System_CAPS_protpropertyIsUsingModelBinders

Gets a value that indicates whether model binding is in use.(Overrides DataBoundControl.IsUsingModelBinders.)

System_CAPS_protpropertyIsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)

System_CAPS_pubpropertyItemPlaceholderID

Gets or sets the ID for the item placeholder in a ListView control.

System_CAPS_pubpropertyItems

Gets a collection of ListViewDataItem objects that represent the data items of the current page of data in a ListView control.

System_CAPS_pubpropertyItemSeparatorTemplate

Gets or sets the custom content for the separator between the items in a ListView control.

System_CAPS_pubpropertyItemTemplate

Gets or sets the custom content for the data item in a ListView control.

System_CAPS_pubpropertyItemType

Gets or sets the name of the data item type for strongly typed data binding.(Inherited from DataBoundControl.)

System_CAPS_pubpropertyLayoutTemplate

Gets or sets the custom content for the root container in a ListView control.

System_CAPS_protpropertyLoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)

System_CAPS_protpropertyMaximumRows

Gets the maximum number of items to display on a single page of the ListView control.

System_CAPS_pubpropertyNamingContainer

Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.(Inherited from Control.)

System_CAPS_pubpropertyPage

Gets a reference to the Page instance that contains the server control.(Inherited from Control.)

System_CAPS_pubpropertyParent

Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)

System_CAPS_pubpropertyRenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)

System_CAPS_protpropertyRequiresDataBinding

Gets or sets a value indicating whether the DataBind method should be called. (Inherited from BaseDataBoundControl.)

System_CAPS_protpropertySelectArguments

Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from DataBoundControl.)

System_CAPS_pubpropertySelectedDataKey

Gets the data-key value for the selected item in a ListView control.

System_CAPS_pubpropertySelectedIndex

Gets or sets the index of the selected item in a ListView control.

System_CAPS_pubpropertySelectedItemTemplate

Gets or sets the custom content for the selected item in a ListView control.

System_CAPS_pubpropertySelectedPersistedDataKey

Gets or sets the data-key value for the persisted selected item in a data-bound control.

System_CAPS_pubpropertySelectedValue

Gets the data-key value of the selected item in a ListView control.

System_CAPS_pubpropertySelectMethod

The name of the method to call in order to read data.(Inherited from DataBoundControl.)

System_CAPS_pubpropertySite

Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)

System_CAPS_pubpropertySkinID

Gets or sets the skin to apply to the control.(Inherited from WebControl.)

System_CAPS_pubpropertySortDirection

Gets the sort direction of the field or fields that are being sorted.

System_CAPS_pubpropertySortExpression

Gets the sort expression that is associated with the field or fields that are being sorted.

System_CAPS_protpropertyStartRowIndex

Gets the index of the first record that is displayed on a page of data in the ListView control.

System_CAPS_pubpropertyStyle

Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.(Inherited from WebControl.)

System_CAPS_pubpropertySupportsDisabledAttribute

Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.(Inherited from BaseDataBoundControl.)

System_CAPS_pubpropertyTabIndex

Overrides the WebControl.TabIndex property. Setting this property is not supported by the ListView control.(Overrides WebControl.TabIndex.)

System_CAPS_protpropertyTagKey

Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protpropertyTagName

Gets the name of the control tag. This property is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubpropertyTemplateControl

Gets or sets a reference to the template that contains this control. (Inherited from Control.)

System_CAPS_pubpropertyTemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)

System_CAPS_pubpropertyToolTip

Overrides the WebControl.ToolTip property. Setting this property is not supported by the ListView control.(Overrides WebControl.ToolTip.)

System_CAPS_pubpropertyUniqueID

Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)

System_CAPS_pubpropertyUpdateMethod

Gets or sets the name of the method to call in order to update data.

System_CAPS_pubpropertyValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)

System_CAPS_protpropertyViewState

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

System_CAPS_protpropertyViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)

System_CAPS_pubpropertyViewStateMode

Gets or sets the view-state mode of this control.(Inherited from Control.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.)

System_CAPS_pubpropertyWidth

Overrides the WebControl.Width property. Setting this property is not supported by the ListView control.(Overrides WebControl.Width.)

NameDescription
System_CAPS_protmethodAddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodAddControlToContainer(Control, Control, Int32)

Adds the specified control to the specified container.

System_CAPS_protmethodAddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodAddParsedSubObject(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.)

System_CAPS_pubmethodApplyStyle(Style)

Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.(Inherited from WebControl.)

System_CAPS_pubmethodApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)

System_CAPS_protmethodBeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethodBuildProfileTree(String, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_protmethodClearCachedClientID()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)

System_CAPS_protmethodClearChildControlState()

Deletes the control-state information for the server control's child controls. (Inherited from Control.)

System_CAPS_protmethodClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearChildViewState()

Deletes the view-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearEffectiveClientIDMode()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)

System_CAPS_protmethodConfirmInitState()

Sets the initialized state of the data-bound control.(Inherited from BaseDataBoundControl.)

System_CAPS_pubmethodCopyBaseAttributes(WebControl)

Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodCreateChildControls()

Creates the control hierarchy that is used to render the ListView control, based on the values that are stored in view state.(Overrides Control.CreateChildControls().)

System_CAPS_protmethodCreateChildControls(IEnumerable, Boolean)

Creates the control hierarchy that is used to render the ListView control by using the specified data source.

System_CAPS_protmethodCreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.)

System_CAPS_protmethodCreateControlStyle()

Creates the default style for the control.(Overrides WebControl.CreateControlStyle().)

System_CAPS_protmethodCreateDataItem(Int32, Int32)

Creates a data item in the ListView control.

System_CAPS_protmethodCreateDataSourceSelectArguments()

Creates the DataSourceSelectArguments object that contains the arguments that are passed to the data source.(Overrides DataBoundControl.CreateDataSourceSelectArguments().)

System_CAPS_protmethodCreateEmptyDataItem()

Creates the EmptyDataTemplate template in the ListView control.

System_CAPS_protmethodCreateEmptyItem()

Creates an empty item in the ListView control.

System_CAPS_protmethodCreateInsertItem()

Creates an insert item in the ListView control.

System_CAPS_protmethodCreateItem(ListViewItemType)

Creates a ListViewItem object with the specified type.

System_CAPS_protmethodCreateItemsInGroups(ListViewPagedDataSource, Boolean, InsertItemPosition, ArrayList)

Creates the ListView control hierarchy in groups.

System_CAPS_protmethodCreateItemsWithoutGroups(ListViewPagedDataSource, Boolean, InsertItemPosition, ArrayList)

Creates the ListView control hierarchy without groups.

System_CAPS_protmethodCreateLayoutTemplate()

Creates the root container in the ListView control.

System_CAPS_protmethodCreateSuffixArrayList(ListViewPagedDataSource, ArrayList)

This API supports the product infrastructure and is not intended to be used directly from your code. Creates an array of suffixes for ASP.NET to use when it generates the ClientID value.

System_CAPS_pubmethodDataBind()

Binds a data source to the invoked server control and all its child controls.(Inherited from BaseDataBoundControl.)

System_CAPS_protmethodDataBind(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.)

System_CAPS_protmethodDataBindChildren()

Binds a data source to the server control's child controls.(Inherited from Control.)

System_CAPS_pubmethodDeleteItem(Int32)

Deletes the record at the specified index from the data source.

System_CAPS_pubmethodDispose()

Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)

System_CAPS_protmethodEndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_protmethodEnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)

System_CAPS_protmethodEnsureDataBound()

Calls the DataBind method if the DataSourceID property is set and the data-bound control is marked to require binding.(Inherited from BaseDataBoundControl.)

System_CAPS_protmethodEnsureID()

Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)

System_CAPS_protmethodEnsureLayoutTemplate()

Ensures that the LayoutTemplate content is correctly created in the ListView control.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExtractItemValues(IOrderedDictionary, ListViewItem, Boolean)

Retrieves the values of each field that is declared in the specified item, and stores them in the specified IOrderedDictionary object.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindControl(String)

Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)

System_CAPS_protmethodFindControl(String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.(Inherited from Control.)

System_CAPS_protmethodFindPlaceholder(String, Control)

Searches the specified container for a control that has the specified identifier.

System_CAPS_pubmethodFocus()

Sets input focus to a control.(Inherited from Control.)

System_CAPS_protmethodGetData()

Retrieves a DataSourceView object that the data-bound control uses to perform data operations.(Inherited from DataBoundControl.)

System_CAPS_protmethodGetDataSource()

Retrieves the IDataSource interface that the data-bound control is associated with, if any.(Inherited from DataBoundControl.)

System_CAPS_protmethodGetDesignModeState()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)

System_CAPS_pubmethodHasControls()

Determines if the server control contains any child controls.(Inherited from Control.)

System_CAPS_protmethodHasEvents()

Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)

System_CAPS_pubmethodInsertNewItem(Boolean)

Inserts the current record in the data source.

System_CAPS_protmethodInstantiateEmptyDataTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the EmptyDataTemplate template.

System_CAPS_protmethodInstantiateEmptyItemTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the EmptyItemTemplate template.

System_CAPS_protmethodInstantiateGroupSeparatorTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the GroupSeparatorTemplate template.

System_CAPS_protmethodInstantiateGroupTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the GroupTemplate template.

System_CAPS_protmethodInstantiateInsertItemTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the InsertItemTemplate template.

System_CAPS_protmethodInstantiateItemSeparatorTemplate(Control)

Populates the specified Control object by using the child controls that are contained in the ItemSeparatorTemplate template.

System_CAPS_protmethodInstantiateItemTemplate(Control, Int32)

Populates the specified Control object by using child controls from one of the ListView control templates.

System_CAPS_protmethodIsLiteralContent()

This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)

System_CAPS_protmethodLoadControlState(Object)

Loads the state of the properties in the ListView control that must be persisted, even when the EnableViewState property is set to false.(Overrides Control.LoadControlState(Object).)

System_CAPS_protmethodLoadViewState(Object)

Loads the previously saved view state of the ListView control.(Overrides DataBoundControl.LoadViewState(Object).)

System_CAPS_protmethodMapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)

System_CAPS_protmethodMarkAsDataBound()

Sets the state of the control in view state as successfully bound to data.(Inherited from DataBoundControl.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMergeStyle(Style)

Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodOnBubbleEvent(Object, EventArgs)

Determines whether an event for the ListView control should be handled.(Overrides Control.OnBubbleEvent(Object, EventArgs).)

System_CAPS_protmethodOnCreatingModelDataSource(CreatingModelDataSourceEventArgs)

Raises the CreatingModelDataSource event.(Inherited from DataBoundControl.)

System_CAPS_protmethodOnDataBinding(EventArgs)

Raises the DataBinding event.(Inherited from Control.)

System_CAPS_protmethodOnDataBound(EventArgs)

Raises the DataBound event.(Inherited from BaseDataBoundControl.)

System_CAPS_protmethodOnDataPropertyChanged()

Rebinds the data-bound control to its data after one of the base data source identification properties changes.(Inherited from DataBoundControl.)

System_CAPS_protmethodOnDataSourceViewChanged(Object, EventArgs)

Raises the DataSourceViewChanged event.(Inherited from DataBoundControl.)

System_CAPS_protmethodOnInit(EventArgs)

Raises the Init event.(Overrides BaseDataBoundControl.OnInit(EventArgs).)

System_CAPS_protmethodOnItemCanceling(ListViewCancelEventArgs)

Raises the ItemCanceling event.

System_CAPS_protmethodOnItemCommand(ListViewCommandEventArgs)

Raises the ItemCommand event.

System_CAPS_protmethodOnItemCreated(ListViewItemEventArgs)

Raises the ItemCreated event.

System_CAPS_protmethodOnItemDataBound(ListViewItemEventArgs)

Raises the ItemDataBound event.

System_CAPS_protmethodOnItemDeleted(ListViewDeletedEventArgs)

Raises the ItemDeleted event.

System_CAPS_protmethodOnItemDeleting(ListViewDeleteEventArgs)

Raises the ItemDeleting event.

System_CAPS_protmethodOnItemEditing(ListViewEditEventArgs)

Raises the ItemEditing event.

System_CAPS_protmethodOnItemInserted(ListViewInsertedEventArgs)

Raises the ItemInserted event.

System_CAPS_protmethodOnItemInserting(ListViewInsertEventArgs)

Raises the ItemInserting event.

System_CAPS_protmethodOnItemUpdated(ListViewUpdatedEventArgs)

Raises the ItemUpdated event.

System_CAPS_protmethodOnItemUpdating(ListViewUpdateEventArgs)

Raises the ItemUpdating event.

System_CAPS_protmethodOnLayoutCreated(EventArgs)

Raises the LayoutCreated event.

System_CAPS_protmethodOnLoad(EventArgs)

Handles the Control.Load event.(Inherited from DataBoundControl.)

System_CAPS_protmethodOnPagePreLoad(Object, EventArgs)

Sets the initialized state of the data-bound control before the control is loaded.(Inherited from DataBoundControl.)

System_CAPS_protmethodOnPagePropertiesChanged(EventArgs)

Raises the PagePropertiesChanged event.

System_CAPS_protmethodOnPagePropertiesChanging(PagePropertiesChangingEventArgs)

Raises the PagePropertiesChanging event.

System_CAPS_protmethodOnPreRender(EventArgs)

Handles the PreRender event.(Inherited from BaseDataBoundControl.)

System_CAPS_protmethodOnSelectedIndexChanged(EventArgs)

Raises the SelectedIndexChanged event.

System_CAPS_protmethodOnSelectedIndexChanging(ListViewSelectEventArgs)

Raises the SelectedIndexChanging event.

System_CAPS_protmethodOnSorted(EventArgs)

Raises the Sorted event.

System_CAPS_protmethodOnSorting(ListViewSortEventArgs)

Raises the Sorting event.

System_CAPS_protmethodOnTotalRowCountAvailable(PageEventArgs)
System_CAPS_protmethodOnUnload(EventArgs)

Raises the Unload event.(Inherited from Control.)

System_CAPS_protmethodOpenFile(String)

Gets a Stream used to read a file.(Inherited from Control.)

System_CAPS_protmethodPerformDataBinding(IEnumerable)

Binds the ListView control to the specified data source.(Overrides DataBoundControl.PerformDataBinding(IEnumerable).)

System_CAPS_protmethodPerformSelect()

Retrieves data from the associated data source.(Overrides DataBoundControl.PerformSelect().)

System_CAPS_protmethodRaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)

System_CAPS_protmethodRemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodRemoveItems()

Deletes all child controls in an item or group container of the ListView control.

System_CAPS_protmethodRender(HtmlTextWriter)

Renders the Web server control content to the client's browser by using the specified HtmlTextWriter object.(Overrides WebControl.Render(HtmlTextWriter).)

System_CAPS_pubmethodRenderBeginTag(HtmlTextWriter)

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodRenderChildren(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.)

System_CAPS_protmethodRenderContents(HtmlTextWriter)

Renders the contents of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_pubmethodRenderControl(HtmlTextWriter)

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)

System_CAPS_protmethodRenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)

System_CAPS_pubmethodRenderEndTag(HtmlTextWriter)

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)

System_CAPS_protmethodResolveAdapter()

Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)

System_CAPS_pubmethodResolveClientUrl(String)

Gets a URL that can be used by the browser.(Inherited from Control.)

System_CAPS_pubmethodResolveUrl(String)

Converts a URL into one that is usable on the requesting client.(Inherited from Control.)

System_CAPS_protmethodSaveControlState()

Saves the state of the properties in the ListView control that must be persisted, even when the EnableViewState property is set to false.(Overrides Control.SaveControlState().)

System_CAPS_protmethodSaveViewState()

Saves the current view state of the ListView control.(Overrides DataBoundControl.SaveViewState().)

System_CAPS_pubmethodSelectItem(Int32)

Selects the item that is in edit mode in a ListView control.

System_CAPS_protmethodSetDesignModeState(IDictionary)

Sets design-time data for a control.(Inherited from Control.)

System_CAPS_pubmethodSetEditItem(Int32)

Sets the specified item into edit mode in a ListView control.

System_CAPS_protmethodSetPageProperties(Int32, Int32, Boolean)

Sets the properties of a page of data in the ListView control.

System_CAPS_pubmethodSetRenderMethodDelegate(RenderMethod)

This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)

System_CAPS_pubmethodSetTraceData(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.)

System_CAPS_pubmethodSetTraceData(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.)

System_CAPS_pubmethodSort(String, SortDirection)

Sorts the ListView control, depending on the specified sort expression and direction.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTrackViewState()

Causes view-state changes to the control to be tracked so they can be stored in the control's StateBag object.(Inherited from DataBoundControl.)

System_CAPS_pubmethodUpdateItem(Int32, Boolean)

Updates the record at the specified index in the data source.

System_CAPS_protmethodValidateDataSource(Object)

Verifies that the object a data-bound control binds to is one it can work with.(Inherited from DataBoundControl.)

NameDescription
System_CAPS_pubeventCallingDataMethods

Occurs when data methods are being called.(Inherited from DataBoundControl.)

System_CAPS_pubeventCreatingModelDataSource

Occurs when the ModelDataSource object is being created.(Inherited from DataBoundControl.)

System_CAPS_pubeventDataBinding

Occurs when the server control binds to a data source.(Inherited from Control.)

System_CAPS_pubeventDataBound

Occurs after the server control binds to a data source.(Inherited from BaseDataBoundControl.)

System_CAPS_pubeventDisposed

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

System_CAPS_pubeventInit

Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)

System_CAPS_pubeventItemCanceling

Occurs when a cancel operation is requested, but before the ListView control cancels the insert or edit operation.

System_CAPS_pubeventItemCommand

Occurs when a button in a ListView control is clicked.

System_CAPS_pubeventItemCreated

Occurs when an item is created in a ListView control.

System_CAPS_pubeventItemDataBound

Occurs when a data item is bound to data in a ListView control.

System_CAPS_pubeventItemDeleted

Occurs when a delete operation is requested, after the ListView control deletes the item.

System_CAPS_pubeventItemDeleting

Occurs when a delete operation is requested, but before the ListView control deletes the item.

System_CAPS_pubeventItemEditing

Occurs when an edit operation is requested, but before the ListView item is put in edit mode.

System_CAPS_pubeventItemInserted

Occurs when an insert operation is requested, after the ListView control has inserted the item in the data source.

System_CAPS_pubeventItemInserting

Occurs when an insert operation is requested, but before the ListView control performs the insert.

System_CAPS_pubeventItemUpdated

Occurs when an update operation is requested, after the ListView control updates the item.

System_CAPS_pubeventItemUpdating

Occurs when an update operation is requested, but before the ListView control updates the item.

System_CAPS_pubeventLayoutCreated

Occurs when the LayoutTemplate template is created in a ListView control.

System_CAPS_pubeventLoad

Occurs when the server control is loaded into the Page object.(Inherited from Control.)

System_CAPS_pubeventPagePropertiesChanged

Occurs when the page properties change, after the ListView control sets the new values.

System_CAPS_pubeventPagePropertiesChanging

Occurs when the page properties change, but before the ListView control sets the new values.

System_CAPS_pubeventPreRender

Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)

System_CAPS_pubeventSelectedIndexChanged

Occurs when an item's Select button is clicked, after the ListView control handles the select operation.

System_CAPS_pubeventSelectedIndexChanging

Occurs when an item's Select button is clicked, but before the ListView control handles the select operation.

System_CAPS_pubeventSorted

Occurs when a sort operation is requested, after the ListView control handles the sort operation.

System_CAPS_pubeventSorting

Occurs when a sort operation is requested, but before the ListView control handles the sort operation.

System_CAPS_pubeventUnload

Occurs when the server control is unloaded from memory.(Inherited from Control.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventIPageableItemContainer.TotalRowCountAvailable

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IPageableItemContainer.TotalRowCountAvailable.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAttributeAccessor.GetAttribute(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an attribute of the Web control with the specified name.(Inherited from WebControl.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.(Inherited from WebControl.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.GetDesignModeState()

For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetOwnerControl(Control)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIParserAccessor.AddParsedSubObject(Object)

For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIPageableItemContainer.SetPageProperties(Int32, Int32, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IPageableItemContainer.SetPageProperties.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlBuilderAccessor.ControlBuilder

For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlDesignerAccessor.UserData

For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.DataBindings

For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.HasDataBindings

For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataKeysControl.ClientIDRowSuffixDataKeys

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of the data values that are used to uniquely identify each instance of a data-bound control when ASP.NET generates the ClientID value.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.Expressions

For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.HasExpressions

For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundControl.DataKeyNames

Gets or sets an array that contains the names of the primary-key fields of the items that are displayed in a data-bound control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundControl.DataMember

Gets or sets the name of the list of data that the data-bound control binds to when the data source contains more than one distinct list of data items.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundControl.DataSource

Gets or sets the object from which a data-bound control retrieves its list of data items.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundControl.DataSourceID

Gets or sets the ID of the data source control from which a data-bound control retrieves its list of data items.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundControl.DataSourceObject

Gets an object that implements the IDataSource interface, which provides access to the object's data content.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundListControl.ClientIDRowSuffix

Gets the name of the data field whose value is used to uniquely identify each data row of a ListView control when the ClientIDMode property is set to Predictable.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundListControl.DataKeys

Gets a collection of data-key values that represent each row in a data-bound control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundListControl.EnablePersistedSelection

Gets or sets the value that specifies whether a selected row persists when a user pages through data in a data-bound control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundListControl.SelectedDataKey

Gets the data-key object that contains the data-key value for the selected row in a data-bound control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBoundListControl.SelectedIndex

Gets or sets the index of the selected row in a data-bound control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIPageableItemContainer.MaximumRows

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IPageableItemContainer.MaximumRows.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIPageableItemContainer.StartRowIndex

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IPageableItemContainer.StartRowIndex.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIPersistedSelector.DataKey

Gets or sets the data-key value for the selected record in a data-bound control.

NameDescription
System_CAPS_pubmethodEnableDynamicData(Type)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, IDictionary<String, Object>)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, Object)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnablePersistedSelection()

Obsolete.Enables selection to be persisted in data controls that support selection and paging.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindDataSourceControl()

Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindFieldTemplate(String)

Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindMetaTable()

Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetDefaultValues()

Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetMetaTable()

Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable)

Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, IDictionary<String, Object>)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, Object)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodTryGetMetaTable(MetaTable)

Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

The ListView control is used to display the values from a data source. It resembles the GridView control, except that it displays data by using user-defined templates instead of row fields. Creating your own templates gives you more flexibility in controlling how the data is displayed.

A Visual Studio project with source code is available to accompany this topic: Download.

The ListView control supports the following features:

  • Support for binding to data source controls such as SqlDataSource, LinqDataSource, and ObjectDataSource.

  • Customizable appearance through user-defined templates and styles.

  • Built-in sorting capabilities.

  • Built-in update and delete capabilities.

  • Built-in insert capabilities.

  • Support for paging capabilities by using a DataPager control.

  • Built-in item selection capabilities.

  • Programmatic access to the ListView object model to dynamically set properties, handle events, and so on.

  • Multiple key fields.

To learn about other data-bound controls that are available in ASP.NET, see Data-Bound Web Server Controls.

In order for the ListView control to display content, you must create templates for different parts of the control. The ItemTemplate is required. All other templates are optional. The LayoutTemplate property is not required.

However, you must create a template for the mode in which the control is configured. For example, a ListView control that supports inserting records must have an InsertItemTemplate template defined. The following table lists the templates that you can create for the ListView control.

Template type

Description

LayoutTemplate

The root template that defines a container object, such as a table, div, or span element, that will contain the content defined in the ItemTemplate or GroupTemplate template. It might also contain a DataPager object.

ItemTemplate

Defines the data-bound content to display for individual items.

ItemSeparatorTemplate

Defines the content to render between individual items.

GroupTemplate

Defines a container object, such as a table row (tr), div, or span element, that will contain the content defined in the ItemTemplate and EmptyItemTemplate templates. The number of items that are displayed in a group is specified by the GroupItemCount property.

GroupSeparatorTemplate

Defines the content to render between groups of items.

EmptyItemTemplate

Defines the content to render for an empty item when a GroupTemplate template is used. For example, if the GroupItemCount property is set to 5, and the total number of items returned from the data source is 8, the last group of data displayed by the ListView control will contain three items as specified by the ItemTemplate template, and two items as specified by the EmptyItemTemplate template.

EmptyDataTemplate

Defines the content to render if the data source returns no data.

SelectedItemTemplate

Defines the content to render for the selected data item to differentiate the selected item from other items.

AlternatingItemTemplate

Defines the content to render for alternating items to make it easier to distinguish between consecutive items.

EditItemTemplate

Defines the content to render when an item is being edited. The EditItemTemplate template is rendered in place of the ItemTemplate template for the data item that is being edited.

InsertItemTemplate

Defines the content to render to insert an item. The InsertItemTemplate template is rendered in place of an ItemTemplate template at either the start or at the end of the items that are displayed by the ListView control. You can specify where the InsertItemTemplate template is rendered by using the InsertItemPosition property of the ListView control.

To display the value of a field in a template such as ItemTemplate, you use a data-binding expression. For more information about data-binding expressions, see Data-Binding Expressions Overview.

To bind input controls in the EditItemTemplate and InsertItemTemplate templates to fields of a data source, you can use two-way binding expressions. This enables the ListView control to automatically extract the values of the input control for an update or insert operation. Two-way binding expressions also enable input controls in an EditItemTemplate to automatically display the original field values. For more information about two-way binding expressions, see Binding to Databases.

You can bind the ListView control to a data source control (such as the SqlDataSource control or ObjectDataSource control) or to any data source collection that implements the System.Collections.IEnumerable interface, such as System.Data.DataView, System.Collections.ArrayList, System.Collections.Generic.List<T>, or other collection types. Use one of the following methods to bind the ListView control to the appropriate data source type:

  • To bind to a data source control, set the DataSourceID property of the ListView control to the ID value of the data source control. The ListView control automatically binds to the specified data source control and can take advantage of the data source control's capabilities to perform sorting, inserting, updating, deleting, and paging functionality. This is the preferred method to bind to data.

  • To bind to a data source that implements the System.Collections.IEnumerable interface, programmatically set the DataSource property of the ListView control to the data source, and then call the DataBind method. When you use this technique, the ListView control does not provide built-in sorting, updating, deleting, and paging functionality. You must provide this functionality by using the appropriate event.

For more information about data binding, see ASP.NET Data Access Content Map.

System_CAPS_noteNote

The ListView control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before you display it in the application. We strongly recommend that values be HTML-encoded whenever possible before they are displayed in this control. ASP.NET provides an input request validation feature to help block script and HTML in user input. You can also use validation server controls to check user input. For more information, see Introduction to the Validation Controls.

When the ListView control is bound to a data source control, the ListView control can take advantage of the data source control's capabilities and provide automatic sort, insert, update, and delete functionality.

System_CAPS_noteNote

The ListView control can provide support for sorting, inserting, updating, and deleting with other types of data sources. However, in order to implement these operations, you must create code in an appropriate event handler.

Because the ListView control uses templates, it does not provide a way to automatically generate buttons to perform update, delete, insert, sort, or select operations. You must manually include these buttons in the appropriate template. The ListView control recognizes certain buttons whose CommandName property is set to a specific value. The following table lists the buttons that the ListView control recognizes and their functions.

Button

CommandName value

Description

Cancel

"Cancel"

Cancels an edit or insert operation. Raises the ItemCanceling event.

Delete

"Delete"

Deletes the current record from the data source. Raises the ItemDeleted and ItemDeleting events.

Select

"Select"

Sets the SelectedIndex property to the DisplayIndex property value for the item. Renders the SelectedItemTemplate template for the item. Raises the SelectedIndexChanging and SelectedIndexChanged events.

Edit

"Edit"

Puts the item in edit mode. Renders the EditItemTemplate template for the item. Raises the ItemEditing event.

Insert

"Insert"

Inserts the bound values from the InsertItemTemplate template into the data source. Raises the ItemInserting and ItemInserted events.

Update

"Update"

Updates the current record in the data source with the bound values from the EditItemTemplate template. Raises the ItemUpdating and ItemUpdated events.

Sort

"Sort"

Sorts the columns listed in the CommandArgument property of the button. Raises the Sorting and Sorted events.

Unlike the Delete button (which deletes the current data item immediately), when the Edit button is clicked, the ListView control displays the current item in edit mode. In edit mode, the content that is contained in the EditItemTemplate property is displayed for the current data item. Typically, in the edit item template, the Edit button is replaced with an Update and a Cancel button. Input controls that are appropriate for the field's data type (such as a TextBox or CheckBox control) also usually display a field's value for a user to modify. Clicking the Update button updates the record in the data source, and clicking the Cancel button cancels the edit operation.

The insert functionality is enabled when the InsertItemPosition property is set to FirstItem or LastItem. This property defines where the InsertItemTemplate template is rendered for the insert item. The insert item template typically includes an Insert and a Cancel button, and empty input controls are displayed for users to enter the values for the new record. Clicking the Insert button inserts the record in the data source, and clicking the Cancel button clears all the fields.

The ListView control enables users to sort the items by clicking the Sort button. Sort functionality is defined in the CommandArgument property of the button that contains the columns to be sorted.

Instead of displaying all the records from the data source at the same time, the ListView control can break the records into pages. To enable paging, associate a DataPager control with the ListView control. Then insert a DataPager control inside the LayoutTemplate template. Alternatively, if the DataPager control is outside the ListView control, set the PagedControlID property to the ID of the ListView control.

The following table lists the events that are supported by the ListView control.

Event

Description

ItemCanceling

Occurs when the Cancel button (a button with its CommandName property set to "Cancel") is clicked, but before the ListView control cancels the insert or edit operation. This event is often used to stop the cancel operation.

ItemCommand

Occurs when a button is clicked in the ListView control. This event is often used to perform a custom task when a button is clicked in the control.

ItemCreated

Occurs when a new item is created in the ListView control. This event is often used to modify the content of an item when the item is created.

ItemDataBound

Occurs when a data item is bound to data in the ListView control. This event is often used to modify the content of an item when the item is bound to data.

ItemDeleted

Occurs when a Delete button (a button with its CommandName property set to "Delete") is clicked or the DeleteItem method is called, after the ListView control deletes the record from the data source. This event is often used to check the results of the delete operation.

ItemDeleting

Occurs when a Delete button (a button with its CommandName property set to "Delete") is clicked or the DeleteItem method is called, but before the ListView control deletes the record from the data source. This event is often used to confirm or cancel the delete operation.

ItemEditing

Occurs when an Edit button (a button with its CommandName property set to "Edit") is clicked, but before the ListView control enters edit mode. This event is often used to cancel the editing operation.

ItemInserted

Occurs when an Insert button (a button with its CommandName property set to "Insert") is clicked or the InsertNewItem method is called, after the ListView control inserts the new record from the data source. This event is often used to check the results of the insert operation.

ItemInserting

Occurs when an Insert button (a button with its CommandName property set to "Insert") is clicked or the InsertNewItem method is called, but before the ListView control inserts the record. This event is often used to cancel the insert operation or change or validate the values of the new item.

ItemUpdated

Occurs when an Update button (a button with its CommandName property set to "Update") is clicked or the UpdateItem method is called, after the ListView control updates the record. This event is often used to check the results of the update operation.

ItemUpdating

Occurs when an Update button (a button with its CommandName property set to "Update") is clicked or the UpdateItem method is called, but before the ListView control updates the record. This event is often used to cancel the updating operation or change or validate the values of the edited item.

LayoutCreated

Occurs when the LayoutTemplate template is created in a ListView control. This event is often used to perform a task after the template is created.

PagePropertiesChanged

Occurs when the page properties change, after the ListView control sets the new values.

PagePropertiesChanging

Occurs when the data-page properties change, but before the ListView control sets the new values.

SelectedIndexChanged

Occurs when a Select button (a button with its CommandName property set to "Select") is clicked, after the ListView control handles the select operation. This event is often used to perform a custom task after an item is selected in the control.

SelectedIndexChanging

Occurs when a Select button (a button with its CommandName property set to "Select") is clicked, but before the ListView control handles the select operation. This event is often used to cancel the select operation.

Sorted

Occurs when a Sort button (a button with its CommandName property set to "Sort") is clicked or the Sort method is called, after the ListView control handles the sort operation. This event is typically used to perform a custom task after a user clicks a Sort button and the data has been sorted.

Sorting

Occurs when a Sort button (a button with its CommandName property set to "Sort") is clicked or the Sort method is called, but before the ListView control handles the sort operation. This event is often used to cancel the sorting operation or to perform a custom sorting routine.

<asp:ListView
    ConvertEmptyStringToNull="True|False"
    DataKeyNames="string"
    DataMember="string"
    DataSource="string"
    DataSourceID="string"
    EditIndex="integer"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    GroupPlaceholderID="string"
    GroupItemCount="integer"
    ID="string"
    InsertItemPosition="None|FirstItem|LastItem"
    ItemPlaceholderID="string"
    OnDataBinding="DataBinding event handler"
    OnDataBound="DataBound event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnItemCanceling="ItemCanceling event handler"
    OnItemCommand="ItemCommand event handler"
    OnItemCreated="ItemCreated event handler"
    OnItemDataBound="ItemDataBound event handler"
    OnItemDeleted="ItemDeleted event handler"
    OnItemDeleting="ItemDeleting event handler"
    OnItemEditing="ItemEditing event handler"
    OnItemInserted="ItemInserted event handler"
    OnItemInserting="ItemInserting event handler"
    OnItemUpdated="ItemUpdated event handler"
    OnItemUpdating="ItemUpdating event handler"
    OnLayoutCreated="LayoutCreated event handler"
    OnLoad="Load event handler"
    OnPagePropertiesChanged="PagePropertiesChanged event handler"
    OnPagePropertiesChanging="PagePropertiesChanging event handler"
    OnPreRender="PreRender event handler"
    OnSelectedIndexChanged="SelectedIndexChanged event handler"
    OnSelectedIndexChanging="SelectedIndexChanging event handler"
    OnSorted="Sorted event handler"
    OnSorting="Sorting event handler"
    OnUnload="Unload event handler"
    runat="server"
    SelectedIndex="integer"
    SkinID="string"
    Style="string"
    Visible="True|False"
>
        <AlternatingItemTemplate>
            <!-- child controls -->
        </AlternatingItemTemplate>
        <EditItemTemplate>
            <!-- child controls -->
        </EditItemTemplate>
        <EmptyDataTemplate>
            <!-- child controls -->
        </EmptyDataTemplate>
        <EmptyItemTemplate>
            <!-- child controls -->
        </EmptyItemTemplate>
        <GroupSeparatorTemplate>
            <!-- child controls -->
        </GroupSeparatorTemplate>
        <GroupTemplate>
            <!-- child controls -->
        </GroupTemplate>
        <InsertItemTemplate>
            <!-- child controls -->
        </InsertItemTemplate>
        <ItemSeparatorTemplate>
            <!-- child controls -->
        </ItemSeparatorTemplate>
        <ItemTemplate>
            <!-- child controls -->
        </ItemTemplate>
        <LayoutTemplate>
                <!-- child controls -->
        </LayoutTemplate>
        <SelectedItemTemplate>
            <!-- child controls -->
        </SelectedItemTemplate>
</asp:ListView>

The following example shows how to use the ListView control to display records from a database by using an HTML table. The values are retrieved by using a LinqDataSource control.

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>ListView Example</title>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>ListView Example</h3>

      <asp:ListView ID="VendorsListView"
        DataSourceID="VendorsDataSource"
        DataKeyNames="VendorID"
        runat="server">
        <LayoutTemplate>
          <table cellpadding="2" width="640px" border="1" ID="tbl1" runat="server">
            <tr runat="server" style="background-color: #98FB98">
              <th runat="server">ID</th>
              <th runat="server">Account Number</th>
              <th runat="server">Name</th>
              <th runat="server">Preferred Vendor</th>
            </tr>
            <tr runat="server" id="itemPlaceholder" />
          </table>
          <asp:DataPager ID="DataPager1" runat="server">
            <Fields>
              <asp:NumericPagerField />
            </Fields>
          </asp:DataPager>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Label ID="VendorIDLabel" runat="server" Text='<%# Eval("VendorID") %>' />
            </td>
            <td>
              <asp:Label ID="AccountNumberLabel" runat="server" Text='<%# Eval("AccountNumber") %>' />
            </td>
            <td>
              <asp:Label ID="NameLabel" runat="server" Text='<%# Eval("Name") %>' /></td>
            <td>
              <asp:CheckBox ID="PreferredCheckBox" runat="server" 
                Checked='<%# Eval("PreferredVendorStatus") %>' Enabled="False" />
            </td>
          </tr>
        </ItemTemplate>
      </asp:ListView>

      <!-- This example uses Microsoft SQL Server and connects   -->
      <!-- to the AdventureWorks sample database. Add a LINQ     -->
      <!-- to SQL class to the project to map to a table in      -->
      <!-- the database.                                         -->
      <asp:LinqDataSource ID="VendorsDataSource" runat="server" 
        ContextTypeName="AdventureWorksClassesDataContext" 
        Select="new (VendorID, AccountNumber, Name, PreferredVendorStatus)" 
        TableName="Vendors" Where="ActiveFlag == @ActiveFlag">
        <WhereParameters>
          <asp:Parameter DefaultValue="true" Name="ActiveFlag" Type="Boolean" />
        </WhereParameters>
      </asp:LinqDataSource>

    </form>
  </body>
</html>

The following example shows how to use the ListView control to display values in a flow layout by using the div element. The values are retrieved by using a SqlDataSource control.

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>ListView Flow Layout Example</title>
    <style type="text/css">
      .plainBox {
          font-family: Verdana, Arial, sans-serif;
          font-size: 11px;
          background: #ffffff;
          border:1px solid #336666;
          }
    </style>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>ListView Flow Layout Example</h3>

      Select the color:
      <asp:DropDownList ID="ColorList" runat="server" 
        AutoPostBack="True" 
        DataSourceID="ColorDataSource" 
        DataTextField="Color" 
        DataValueField="Color">
      </asp:DropDownList><br /><br />

      <asp:ListView runat="server" ID="ProductListView"
        DataSourceID="ProductsDataSource"
        DataKeyNames="ProductID">
        <LayoutTemplate>
          <div runat="server" id="lstProducts">
            <div runat="server" id="itemPlaceholder" />
          </div>
          <asp:DataPager runat="server" PageSize="5" >
            <Fields>
              <asp:NextPreviousPagerField 
                ButtonType="Button"
                ShowFirstPageButton="True" 
                ShowLastPageButton="True" />
            </Fields>
          </asp:DataPager>
        </LayoutTemplate>
        <ItemTemplate>
          <asp:Image ID="ProductImage" runat="server"
            ImageUrl='<%# "~/images/thumbnails/" + Eval("ThumbnailPhotoFileName") %>' />	        
          <div class="plainBox" runat="server">
            <asp:HyperLink ID="ProductLink" runat="server" Text='<%# Eval("Name") %>' 
              NavigateUrl='<%# "ProductDetails.aspx?productID=" + Eval("ProductID") %>' />
            <br /><br />
            <b>Price:</b> 
            <asp:Label ID="PriceLabel" runat="server" Text='<%# Eval("ListPrice", "{0:c}")%>' /> <br />
          </div>
          <br />
        </ItemTemplate>
      </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="ProductsDataSource" runat="server" 
        ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"            	        
        SelectCommand="SELECT P.ProductID, P.Name, P.Color, P.ListPrice, 
          PF.ThumbnailPhotoFileName, P.Size
          FROM Production.Product AS P 
          INNER JOIN Production.ProductProductPhoto AS PPF ON P.ProductID = PPF.ProductID 
          INNER JOIN Production.ProductPhoto AS PF ON PPF.ProductPhotoID = PF.ProductPhotoID
          WHERE P.Color = @Color" >
        <SelectParameters>
          <asp:ControlParameter ControlID="ColorList" Name="Color" 
            PropertyName="SelectedValue" />
        </SelectParameters>
      </asp:SqlDataSource>

      <asp:SqlDataSource ID="ColorDataSource" runat="server" 
        ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>" 
        SelectCommand="SELECT DISTINCT Color FROM Production.Product">
      </asp:SqlDataSource>

    </form>
  </body>
</html>

The following example shows how to use the ListView control to insert, delete, and update records.

System_CAPS_security Security Note

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">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>ListView Example</title>
    <style type="text/css">
        .EditItem { background-color:#8FBC8F;}
        .SelectedItem {	background-color:#9ACD32; }
        .InsertItem { background-color:#FFFACD;}
    </style>
  </head>
  <body>
    <form id="form1" runat="server">

      <h3>ListView Example</h3>

      <h5>Departments</h5>

      <asp:ListView ID="DepartmentsListView" 
        DataSourceID="DepartmentsDataSource" 
        DataKeyNames="DepartmentID"
        ConvertEmptyStringToNull="true"
        InsertItemPosition="LastItem"
        runat="server">
        <LayoutTemplate>
          <table cellpadding="2" runat="server" id="tblDepartments" width="640px" cellspacing="0">
            <tr runat="server" id="itemPlaceholder" />
          </table>
        </LayoutTemplate>
        <ItemTemplate>
          <tr runat="server">
            <td>
              <asp:Button ID="SelectButton" runat="server" Text="Select" CommandName="Select" />
              <asp:Button ID="EditButton" runat="server" Text="Edit" CommandName="Edit" />
            </td>
            <td>
              <asp:Label ID="IDLabel" runat="server" Text='<%#Eval("DepartmentID") %>' />
            </td>
            <td>
              <asp:Label ID="NameLabel" runat="server" Text='<%#Eval("Name") %>' />
            </td>
            <td>
              <asp:Label ID="GroupNameLabel" runat="server" Text='<%#Eval("GroupName") %>' />
            </td>
          </tr>
        </ItemTemplate>
        <SelectedItemTemplate>
          <tr class="SelectedItem" runat="server">
            <td>
              <asp:Button ID="DeleteButton" runat="server" Text="Delete" CommandName="Delete" />
              <asp:Button ID="EditButton" runat="server" Text="Edit" CommandName="Edit" />
            </td>
            <td>
              <asp:Label ID="IDLabel" runat="server" Text='<%#Eval("DepartmentID") %>' />
            </td>
            <td>
              <asp:Label ID="NameLabel" runat="server" Text='<%#Eval("Name") %>' />
            </td>
            <td>
              <asp:Label ID="GroupNameLabel" runat="server" Text='<%#Eval("GroupName") %>' />
            </td>
          </tr>
        </SelectedItemTemplate>
        <EditItemTemplate>
          <tr class="EditItem">
            <td>
              <asp:Button ID="UpdateButton" runat="server" CommandName="Update" Text="Update" />
              <asp:Button ID="CancelButton" runat="server" CommandName="Cancel" Text="Cancel" />
            </td>
            <td>
              <b>ID</b><br />
              <asp:Label ID="IDLabel" runat="server" Text='<%#Eval("DepartmentID") %>' />
            </td>
            <td>
              <asp:Label runat="server" ID="NameLabel" AssociatedControlID="NameTextBox" 
                Text="Name" Font-Bold="true"/><br />
              <asp:TextBox ID="NameTextBox" runat="server" Text='<%#Bind("Name") %>' />
            </td>
            <td>
              <asp:Label runat="server" ID="GroupNameLabel" AssociatedControlID="GroupNameTextBox" 
                Text="Group Name" Font-Bold="true" /><br />
              <asp:TextBox ID="GroupNameTextBox" runat="server" 
                Width="200px"
                Text='<%#Bind("GroupName") %>' />
              <br />
            </td>
          </tr>
        </EditItemTemplate>
        <InsertItemTemplate>
          <tr class="InsertItem">
            <td colspan="2">
              <asp:Button ID="InsertButton" runat="server" CommandName="Insert" Text="Insert" />
              <asp:Button ID="CancelButton" runat="server" CommandName="Cancel" Text="Cancel" />
            </td>
            <td>
              <asp:Label runat="server" ID="NameLabel" AssociatedControlID="NameTextBox" 
                Text="Name" Font-Bold="true"/><br />
              <asp:TextBox ID="NameTextBox" runat="server" Text='<%#Bind("Name") %>' /><br />
            </td>
            <td>
              <asp:Label runat="server" ID="GroupNameLabel" AssociatedControlID="GroupNameTextBox" 
                Text="Group Name" Font-Bold="true" /><br />                
              <asp:TextBox ID="GroupNameTextBox" runat="server" Text='<%#Bind("GroupName") %>' />
            </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="DepartmentsDataSource" runat="server" 
            ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
            SelectCommand="SELECT DepartmentID, Name, GroupName FROM HumanResources.Department"
            UpdateCommand="UPDATE HumanResources.Department 
                SET Name = @Name, GroupName = @GroupName WHERE (DepartmentID = @DepartmentID)"            
	        DeleteCommand="DELETE FROM HumanResources.Department 
	            WHERE (DepartmentID = @DepartmentID)" 
	        InsertCommand="INSERT INTO HumanResources.Department(Name, GroupName) 
	            VALUES (@Name, @GroupName)">
      </asp:SqlDataSource>

    </form>
  </body>
</html>

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft