ListControl.Format イベント

定義

コントロールがデータ値にバインドされると発生します。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 

このメンバーの使用例を次のコード例に示します。The following code example demonstrates the use of this member. この例では、イベントハンドラーは、Format イベントの発生を報告します。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. 複数のイベントまたは頻繁に発生するイベントについてレポートするには、MessageBox.ShowConsole.WriteLine に置き換えるか、複数行 TextBoxにメッセージを追加することを検討してください。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.

コード例を実行するには、ComboBoxListBoxなどの ListControlから継承する型のインスタンスを含むプロジェクトに貼り付けます。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. 次に、インスタンスに ListControl1 という名前を付け、イベントハンドラーが Format イベントに関連付けられていることを確認します。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

注釈

ListControl に表示されている各項目が書式設定される前に、Format イベントが発生します。The Format event is raised before each visible item in the ListControl is formatted. このイベントを処理することにより、このリスト項目に対して表示される文字列に、ListControlConvertEventArgsValue プロパティを使用してアクセスできます。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.

適用対象