ListControl.Format Event
Assembly: System.Windows.Forms (in system.windows.forms.dll)
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 Consuming Events.
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 System.Windows.Forms.MessageBox.Show with System.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" ); }
Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.