DataRepeaterItemValueEventArgs Class

Article
09/30/2015

Provides data for the ItemValueNeeded and ItemValuePushed events.

Namespace: Microsoft.VisualBasic.PowerPacks
Assembly: Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

Inheritance Hierarchy

System.Object
System.EventArgs
Microsoft.VisualBasic.PowerPacks.DataRepeaterItemValueEventArgs

Syntax

public class DataRepeaterItemValueEventArgs : EventArgs

public ref class DataRepeaterItemValueEventArgs : EventArgs

type DataRepeaterItemValueEventArgs = 
    class
        inherit EventArgs
    end

Public Class DataRepeaterItemValueEventArgs
    Inherits EventArgs

Constructors

	Name	Description
	DataRepeaterItemValueEventArgs(Int32, Control, String, Object)	Initializes a new instance of the DataRepeaterItemValueEventArgs class.

Properties

	Name	Description
	Control	Gets the child control of a DataRepeaterItem that is raising the ItemValueNeeded or ItemValuePushed event.
	ItemIndex	Gets the index of the DataRepeaterItem that contains the control that is raising the ItemValueNeeded or ItemValuePushed event.
	PropertyName	Gets the name of the data-bound property of the control that is raising a ItemValueNeeded or ItemValuePushed event.
	Value	Gets the property value that has changed to raise a ItemValueNeeded or ItemValuePushed event.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

In virtual mode, use the ItemValueNeeded event to populate the child controls of the ItemTemplate with values from your data store when a DataRepeaterItem is displayed or when a new item is added.

Use the ItemValuePushed event to save changes to the child control values to your data store.

When the VirtualMode property is set to False, these events are not raised.

Examples

The following example demonstrates how to handle the ItemValueNeeded event. It assumes that you have a DataRepeater control named DataRepeater1 that has its VirtualMode property set to True. The code will resemble the following example, which is for a data source named Employees.

private void dataRepeater1_ItemValueNeeded(object sender, Microsoft.VisualBasic.PowerPacks.DataRepeaterItemValueEventArgs e)
{
    if (e.ItemIndex < Employees.Count)
    {
        switch (e.Control.Name)
        {
            case "txtFirstName":
                e.Value = Employees[e.ItemIndex + 1].firstName;
                break;
            case "txtLastName":
                e.Value = Employees[e.ItemIndex + 1].lastName;
                break;
        }
    }
}

Private Sub DataRepeater1_ItemValueNeeded(
    ByVal sender As Object, 
    ByVal e As Microsoft.VisualBasic.PowerPacks.DataRepeaterItemValueEventArgs
  ) Handles DataRepeater1.ItemValueNeeded
    If e.ItemIndex < Employees.Count Then
        Select Case e.Control.Name
            Case "txtFirstName"
                e.Value = Employees.Item(e.ItemIndex + 1).firstName
            Case "txtLastName"
                e.Value = Employees.Item(e.ItemIndex + 1).lastName
        End Select
    End If
End Sub

Thread Safety

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