Share via

ListCommandEventHandler Delegate

  • Article

Represents the method that will handle the ItemCommand (List) event of a List control.

public delegate void
   System.Web.UI.MobileControls.ListCommandEventHandler(
   System.Object sender,
   System.Web.UI.MobileControls.ListCommandEventArgs e
)

Parameters

The declaration of your event handler must have the same parameters as the ListCommandEventHandler delegate declaration.

  • sender
    The source of the event, a List control.
  • e
    A ListCommandEventArgs object that contains the event data.

Remarks

When you create a ListCommandEventHandler delegate for a List control, you identify the method that will handle the event. The List control notifies the handler when an item event is generated. To associate the event with your event handler, add an instance of the delegate to the event. Unless you remove the delegate, the event handler is called whenever the event occurs.

For default rendering, the control provides a UI that allows the user to click individual list items. On postback, the control calls the OnItemCommand event handler, with an argument pointing to the source item. The value of the CommandName property is null.

When rendering with a template, the event bubbling mechanism of ASP.NET calls the OnItemCommand method. The event handler is passed a parameter, pointing to the source item, and to the CommandName property of the control that generated the event. This allows you to render a single list item with multiple associated interactions.

To render an item as a hyperlink, you can set the ItemsAsLinks property to true. The value of the Text property is used for display, and the contents of the Value property are used as the target link address when selected.

Note   Command events will not be generated for these links.

See Also

List Class