DataGridColumnStyle.HeaderText プロパティ

.NET Framework クラス ライブラリ リファレンス

DataGridColumnStyle.HeaderText プロパティ

列ヘッダーのテキストを取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Overridable Property
 HeaderText As String

Visual Basic (使用法)

Dim instance As DataGridColumnStyle
Dim value As String

value = instance.HeaderText

instance.HeaderText = value

C#

[LocalizableAttribute(true)] 
public virtual string HeaderText { get;
 set; }

C++

[LocalizableAttribute(true)] 
public:
virtual property String^ HeaderText {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_HeaderText ()

/** @property */
public void set_HeaderText (String value)

JScript

public function get HeaderText
 () : String

public function set HeaderText
 (value : String)

プロパティ値
列ヘッダーとして表示される文字列。文字列が DataGrid によって作成される場合、既定値は列の作成に使用した PropertyDescriptor の名前です。文字列がユーザーによって作成される場合、既定値は空の文字列 ("") です。

解説

通常、HeaderText プロパティは、MappingName 値がわかりにくい場合に、MappingName 値と異なるキャプションを表示するために使用します。たとえば、MappingName の値が "FName" の場合に、HeaderText を "First Name" に変更できます。

使用例

HeaderText プロパティを新しい値に設定するコード例を次に示します。

Visual Basic

Private Sub SetHeaderText()
    Dim dgCol As DataGridColumnStyle
    Dim dataCol1 As DataColumn
    Dim dataTable1 As DataTable
    dgCol = dataGrid1.TableStyles(0).GridColumnStyles(0)
    dataTable1 = dataSet1.Tables(dataGrid1.DataMember)
    dataCol1 = dataTable1.Columns(dgCol.MappingName)
    dgCol.HeaderText = dataCol1.Caption
End Sub 'SetHeaderText

C#

private void SetHeaderText()
{
    DataGridColumnStyle dgCol;
    DataColumn dataCol1;
    DataTable dataTable1;
    dgCol = dataGrid1.TableStyles[0].GridColumnStyles[0];
    dataTable1 = dataSet1.Tables[dataGrid1.DataMember];
    dataCol1 = dataTable1.Columns[dgCol.MappingName];
    dgCol.HeaderText = dataCol1.Caption;
}
 

C++

void SetHeaderText()
{
   DataGridColumnStyle^ dgCol;
   DataColumn^ dataCol1;
   DataTable^ dataTable1;
   dgCol = dataGrid1->TableStyles[ 0 ]->GridColumnStyles[ 0 ];
   dataTable1 = dataSet1->Tables[ dataGrid1->DataMember ];
   dataCol1 = dataTable1->Columns[ dgCol->MappingName ];
   dgCol->HeaderText = dataCol1->Caption;
}

J#

private void SetHeaderText()
{
    DataGridColumnStyle dgCol;
    DataColumn dataCol1;
    DataTable dataTable1;
    dgCol = dataGrid1.get_TableStyles(). get_Item(0).
        get_GridColumnStyles().get_Item(0);
    dataTable1 = dataSet1.get_Tables().get_Item(dataGrid1.get_DataMember());
    dataCol1 = dataTable1.get_Columns().get_Item(dgCol.get_MappingName());
    dgCol.set_HeaderText(dataCol1.get_Caption());
} //SetHeaderText

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataGridColumnStyle クラス
DataGridColumnStyle メンバ
System.Windows.Forms 名前空間
ColumnName
Caption