Binding.Format イベント

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

public event System.Windows.Forms.ConvertEventHandler Format;

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

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

Public Custom Event Format As ConvertEventHandler 

イベントの種類

例

次のコード例では、Bindingを作成し、Parse イベントとFormat イベントの両方にConvertEventHandler デリゲートを追加し、DataBindings プロパティを使用してTextBox コントロールのBindingsCollectionにBindingを追加します。 Format イベントに追加された DecimalToCurrencyString イベント デリゲートは、ToString メソッドを使用して、バインドされた値 (Decimal型) を通貨として書式設定します。 CurrencyStringToDecimal イベント デリゲートは、Parse イベントに追加され、コントロールによって表示される値をDecimal型に戻します。

この例では、dsという名前のDataSetが存在することを前提としています。

private:
   void DecimalToCurrencyString( Object^ /*sender*/, ConvertEventArgs^ cevent )
   {
      // The method converts only to string type. Test this using the DesiredType.
      if ( cevent->DesiredType != String::typeid )
      {
         return;
      }
      
      // Use the ToString method to format the value as currency ("c").
      cevent->Value = ( (Decimal)(cevent->Value) ).ToString( "c" );
   }

   void CurrencyStringToDecimal( Object^ /*sender*/, ConvertEventArgs^ cevent )
   {
      // The method converts back to decimal type only. 
      if ( cevent->DesiredType != Decimal::typeid )
      {
         return;
      }
      
      // Converts the string back to decimal using the static Parse method.
      cevent->Value = Decimal::Parse( cevent->Value->ToString(),
         NumberStyles::Currency, nullptr );
   }

   void BindControl()
   {
      // Creates the binding first. The OrderAmount is a Decimal type.
      Binding^ b = gcnew Binding(
         "Text",ds,"customers.custToOrders.OrderAmount" );
      
      // Add the delegates to the event.
      b->Format += gcnew ConvertEventHandler( this, &Form1::DecimalToCurrencyString );
      b->Parse += gcnew ConvertEventHandler( this, &Form1::CurrencyStringToDecimal );
      text1->DataBindings->Add( b );
   }

private void DecimalToCurrencyString(object sender, ConvertEventArgs cevent)
{
   // The method converts only to string type. Test this using the DesiredType.
   if(cevent.DesiredType != typeof(string)) return;

   // Use the ToString method to format the value as currency ("c").
   cevent.Value = ((decimal) cevent.Value).ToString("c");
}

private void CurrencyStringToDecimal(object sender, ConvertEventArgs cevent)
{
   // The method converts back to decimal type only. 
   if(cevent.DesiredType != typeof(decimal)) return;

   // Converts the string back to decimal using the static Parse method.
   cevent.Value = Decimal.Parse(cevent.Value.ToString(),
   NumberStyles.Currency, null);
}

private void BindControl()
{
   // Creates the binding first. The OrderAmount is a Decimal type.
   Binding b = new Binding
      ("Text", ds, "customers.custToOrders.OrderAmount");
   // Add the delegates to the event.
   b.Format += new ConvertEventHandler(DecimalToCurrencyString);
   b.Parse += new ConvertEventHandler(CurrencyStringToDecimal);
   text1.DataBindings.Add(b);
}

Private Sub DecimalToCurrencyString(sender As Object, cevent As _
ConvertEventArgs)
   ' The method converts only to string type. Test this using the DesiredType.
   If cevent.DesiredType IsNot GetType(String) Then
      Exit Sub
   End If

   ' Use the ToString method to format the value as currency ("c").
   cevent.Value = CType(cevent.Value, Decimal).ToString("c")
End Sub

Private Sub CurrencyStringToDecimal(sender As Object, cevent As _
ConvertEventArgs)
   ' The method converts back to decimal type only.
   If cevent.DesiredType IsNot GetType(Decimal) Then
      Exit Sub
   End If

   ' Converts the string back to decimal using the static ToDecimal method.
   cevent.Value = Decimal.Parse(cevent.Value.ToString, _
   NumberStyles.Currency, nothing)
End Sub

Private Sub BindControl
   ' Creates the binding first. The OrderAmount is a Decimal type.
   Dim b As Binding = New Binding _
      ("Text", ds, "customers.custToOrders.OrderAmount")
   ' Add the delegates to the event
   AddHandler b.Format, AddressOf DecimalToCurrencyString
   AddHandler b.Parse, AddressOf CurrencyStringToDecimal
   text1.DataBindings.Add(b)
End Sub

注釈

Format イベントは、データ ソースからコントロールにデータがプッシュされるときに発生します。 Format イベントを処理して、書式設定されていないデータをデータ ソースから書式設定されたデータに変換して表示できます。 コントロールからデータ ソースにデータがプルされると、 Parse イベントが発生して表示値の書式設定が解除された後、 Format イベントが発生して、表示用のデータを再フォーマットします。 これにより、ユーザーがコントロールに書式設定されたデータを入力するか、書式設定されていないデータを入力したかに関係なく、バインドされたコントロールに正しく書式設定されたデータが表示されるようになります。

FormatイベントとParseイベントを使用すると、データを表示するためのカスタム形式を作成できます。 たとえば、テーブル内のデータがDecimal型の場合は、ConvertEventArgsの Value プロパティを Format イベントの書式設定された値に設定することで、現地通貨形式でデータを表示できます。 その結果、 Parse イベントに表示される値の書式設定を解除する必要があります。

Format イベントは、BindingManagerBaseのCurrent値が変更されるたびに発生します。これには次のものが含まれます。

• プロパティが初めてバインドされるとき。

• Positionが変更されるたびに。

• データ バインド リストが並べ替えまたはフィルター処理されるたびに、 DataView がリストを提供するときに実行されます。

Format イベントは、Parse イベントの後にも発生します。 たとえば、コントロールがフォーカスを失うと、その内容が解析されます。 その直後に、新しいデータがコントロールにプッシュされると、 Format イベントが発生し、新しいコンテンツの書式設定が可能になります。

イベントの処理の詳細については、「処理とイベントの発生」を参照してください。

こちらもご覧ください

• Parse
• OnFormat(ConvertEventArgs)