BindingBase.StringFormat プロパティ

定義

バインドされている値が文字列として表示される場合に、バインディングの書式を指定する文字列を取得または設定します。Gets or sets a string that specifies how to format the binding if it displays the bound value as a string.

public:
 property System::String ^ StringFormat { System::String ^ get(); void set(System::String ^ value); };
public string StringFormat { get; set; }
member this.StringFormat : string with get, set
Public Property StringFormat As String

プロパティ値

String

バインドされている値が文字列として表示される場合に、バインディングの書式を指定する文字列。A string that specifies how to format the binding if it displays the bound value as a string.

次の例では、プロパティを使用して、を、 StringFormat Price 通貨を Double 表す文字列に変換します。The following example uses the StringFormat property to convert Price, which is a Double, to a string that represents a currency.

<ListView ItemsSource="{StaticResource MyData}">
  <ListView.View>
    <GridView>
      <GridViewColumn DisplayMemberBinding="{Binding Path=Description}"/>
      <GridViewColumn DisplayMemberBinding="{Binding Path=Price, StringFormat=Now {0:c}!}"/>
    </GridView>
  </ListView.View>
</ListView>

次の例では、のプロパティを使用して、 StringFormat MultiBinding 内の Description 各項目のおよびを含む文字列を作成し Price ListBox ます。The following example uses the StringFormat property on a MultiBinding to build a string that includes the Description and Price of each item in a ListBox.

<ListBox ItemsSource="{StaticResource MyData}">

  <ListBox.ItemTemplate>
    <DataTemplate>
      <TextBlock>
        <TextBlock.Text>
          <MultiBinding  StringFormat="{}{0} -- Now only {1:C}!">
            <Binding Path="Description"/>
            <Binding Path="Price"/>
          </MultiBinding>
        </TextBlock.Text>
      </TextBlock>
    </DataTemplate>
  </ListBox.ItemTemplate>
</ListBox>

注釈

StringFormat は、定義済み、複合、またはカスタムの文字列形式にすることができます。StringFormat can be a predefined, composite, or custom string format. 文字列形式の詳細については、「 型の書式設定」を参照してください。For more information about string formats, see Formatting Types.

プロパティとプロパティを設定すると、 Converter StringFormat 最初にコンバーターがデータ値に適用されてから、 StringFormat が適用されます。If you set the Converter and StringFormat properties, the converter is applied to the data value first, and then the StringFormat is applied.

StringFormatでを Binding 複合文字列形式に設定すると、パラメーターを1つだけ指定できます。When you set the StringFormat on a Binding to a composite string format, you can specify only one parameter.

を使用する場合、 MultiBinding StringFormat プロパティはに設定されている場合にのみ適用され MultiBinding ます。When you use a MultiBinding, the StringFormat property applies only when it is set on the MultiBinding. StringFormat子オブジェクトに設定されているの値 Binding は無視されます。The value of StringFormat that is set on any child Binding objects is ignored. 複合文字列形式のパラメーターの数は、内の子オブジェクトの数を超えることはできません Binding MultiBindingThe number of parameters in a composite string format cannot exceed the number of child Binding objects in the MultiBinding.

を使用する場合は、、 PriorityBinding StringFormat PriorityBinding 子バインドオブジェクト、またはその両方でを設定できます。When you use a PriorityBinding, you can set the StringFormat on the PriorityBinding, on child binding objects, or both. StringFormatが適用される子バインディングにが設定されている場合、その値が使用されます。If the StringFormat is set on the child binding that is applied, that value is used. StringFormatが適用される子バインディングでが設定されていない場合は、が設定されていると、のが適用され StringFormat PriorityBinding ます。If the StringFormat is not set on the child binding that is applied, the StringFormat of the PriorityBinding is applied if it is set.

適用対象