ListControlConvertEventArgs Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ListControlConvertEventArgs.cs

Provides data for the Format event.

public ref class ListControlConvertEventArgs : System::Windows::Forms::ConvertEventArgs

public class ListControlConvertEventArgs : System.Windows.Forms.ConvertEventArgs

type ListControlConvertEventArgs = class
    inherit ConvertEventArgs

Public Class ListControlConvertEventArgs
Inherits ConvertEventArgs

Inheritance

Object

EventArgs

ConvertEventArgs

ListControlConvertEventArgs

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Format event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of a type that inherits from ListControl, such as a ComboBox or ListBox. Then name the instance ListControl1 and ensure that the event handler is associated with the Format event.

private void ListControl1_Format(Object sender, ListControlConvertEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "ListItem", e.ListItem );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Value", e.Value );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "DesiredType", e.DesiredType );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "Format Event" );
}

Private Sub ListControl1_Format(sender as Object, e as ListControlConvertEventArgs) _ 
     Handles ListControl1.Format

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "ListItem", e.ListItem)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Value", e.Value)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "DesiredType", e.DesiredType)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"Format Event")

End Sub

Constructors

ListControlConvertEventArgs(Object, Type, Object)

Initializes a new instance of the ListControlConvertEventArgs class with the specified object, type, and list item.

Properties

DesiredType	Gets the data type of the desired value. (Inherited from ConvertEventArgs)
ListItem	Gets a data source item.
Value	Gets or sets the value of the ConvertEventArgs. (Inherited from ConvertEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)