HeaderedContentControl.HeaderStringFormat プロパティ

定義

名前空間:

System.Windows.Controls

アセンブリ:

PresentationFramework.dll

Header プロパティが文字列として表示される場合に、その書式を指定する複合文字列を取得または設定します。

public:
 property System::String ^ HeaderStringFormat { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.Bindable(true)]
public string HeaderStringFormat { get; set; }

[<System.ComponentModel.Bindable(true)>]
member this.HeaderStringFormat : string with get, set

Public Property HeaderStringFormat As String

プロパティ値

String

Header プロパティが文字列として表示される場合に、その書式を指定する複合文字列。 既定値は、null です。

属性

BindableAttribute

例

次の例では、 を TabControl オブジェクトの Student コレクションにバインドします。 クラスにはStudent、オブジェクトのCourseコレクションである Name プロパティがあり、 メソッドをIFormattable.ToString実装して、学生の をName返すか、学生のコースを一覧表示する文字列を返します。 この例では、 を使用して各 TabItem の に学生の名前をHeader配置し ( を継承HeaderedContentControl) しTabControl.ContentStringFormat、 を使用HeaderStringFormatして、 のコンテンツに各学生のコースリストをTabItem表示します。

<Grid>
  <Grid.Resources>
    <src:Students x:Key="Students"/>

    <Style TargetType="TabItem">
      <Setter Property="HeaderStringFormat" Value="n"/>
      <Setter Property="FontFamily" Value="Lucida Sans Unicode"/>
      <Setter Property="Foreground" Value="Green"/>
      <Setter Property="FontWeight" Value="Bold"/>
    </Style>
  </Grid.Resources>

  <TabControl ItemsSource="{StaticResource Students}"
              FontFamily="Lucida Console" Foreground="Navy"
              ContentStringFormat="cl"/>
</Grid>

次の例では、 メソッドを IFormattable.ToString 実装して、学生の を Name 返すか、学生のコースを一覧表示する文字列を返します。

public string ToString(string format, IFormatProvider formatProvider)
{
    // 'n': print the name only.
    if (format == "n")
    {
        return Name;
    }

    // 'cl': print the course list.
    if (format == "cl")
    {
        string stringFormat = "{0,-25}{1,-30}{2,-10}\r\n";

        StringBuilder str = new StringBuilder();

        str.AppendLine(); 
        str.AppendFormat(stringFormat, "Title", "Description", "ID");
        str.AppendLine(); 

        foreach (Course c in Courses)
        {
            str.AppendFormat(stringFormat, c.Title, c.Description, c.SectionID);
        }

        return str.ToString();
    }

    return this.ToString();
}

Public Overloads Function ToString(ByVal format As String, ByVal formatProvider As IFormatProvider) As String Implements IFormattable.ToString
    ' 'n': print the name only.
    If format = "n" Then
        Return Name
    End If

    ' 'cl': print the course list.
    If format = "cl" Then
        Dim stringFormat As String = "{0,-25}{1,-30}{2,-10}" & vbCrLf

        Dim str As New StringBuilder()

        str.AppendLine()
        str.AppendFormat(stringFormat, "Title", "Description", "ID")
        str.AppendLine()

        For Each c As Course In Courses
            str.AppendFormat(stringFormat, c.Title, c.Description, c.SectionID)
        Next c

        Return str.ToString()
    End If

    Return Me.ToString()
End Function

注釈

HeaderStringFormat には、定義済み、複合、またはカスタムの文字列形式を指定できます。 文字列形式の詳細については、「 型の書式設定」を参照してください。 の または HeaderTemplateSelector プロパティをHeaderTemplateHeaderedContentControl設定した場合、HeaderStringFormatプロパティは無視されます。

依存プロパティ情報

識別子フィールド	HeaderStringFormatProperty
に設定されたメタデータ プロパティ true	なし