ListControl.Format Event

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ListControl.cs

Occurs when the control is bound to a data value.

public:
 event System::Windows::Forms::ListControlConvertEventHandler ^ Format;

public event System.Windows.Forms.ListControlConvertEventHandler? Format;

member this.Format : System.Windows.Forms.ListControlConvertEventHandler 

Public Custom Event Format As ListControlConvertEventHandler 

Event Type

ListControlConvertEventHandler

Examples

The following code example demonstrates the use of this member. 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 MessageBox.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

Remarks

The Format event is raised before each visible item in the ListControl is formatted. Handling this event gives you access to the string to be displayed for this list item, through the Value property of the ListControlConvertEventArgs.

For more information about handling events, see Handling and Raising Events.