DataGridViewImageCell.Description プロパティ

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

DataGridViewImageCell.Description プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

イメージに関連付けられたテキストを取得または設定します。

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

Visual Basic (宣言)

Public Property Description As
 String

Visual Basic (使用法)

Dim instance As DataGridViewImageCell
Dim value As String

value = instance.Description

instance.Description = value

C#

public string Description { get;
 set; }

C++

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

J#

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

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

JScript

public function get Description
 () : String

public function set Description
 (value : String)

プロパティ値
セルに表示されるイメージに関連付けられたテキスト。

解説

各イメージ セルには、通常、テキストによる説明を用意します。この説明により、イメージをよりわかりやすく示すことができます。さらに、この説明テキストは、セル値がクリップボードにコピーされるときにも使われます。

セルを所有している列の Description プロパティを設定すると、その列に含まれるすべてのセルの Description プロパティも設定されます。各セルの指定した値をオーバーライドするには、列の値を設定してからセルの値を設定します。

使用例

このプロパティに類似している DataGridViewImageColumn.Description プロパティの使用方法を次のコード例に示します。次の例は「方法 : Windows フォーム DataGridView コントロールのイメージ列を操作する」で取り上げている例の一部です。

Visual Basic

Private Sub Stretch(ByVal
 sender As Object, _
    ByVal e As EventArgs) Handles
 Button3.Click

    For Each column As DataGridViewImageColumn
 _
        In dataGridView1.Columns
        column.ImageLayout = DataGridViewImageCellLayout.Stretch
        column.Description = "Stretched image layout"
    Next
End Sub

Private Sub ZoomToImage(ByVal
 sender As Object, _
    ByVal e As EventArgs) Handles
 Button4.Click

    For Each column As DataGridViewImageColumn
 _
        In dataGridView1.Columns
        column.ImageLayout = DataGridViewImageCellLayout.Zoom
        column.Description = "Zoomed image layout"
    Next
End Sub

Private Sub NormalImage(ByVal
 sender As Object, _
    ByVal e As EventArgs) Handles
 Button5.Click

    For Each column As DataGridViewImageColumn
 _
        In dataGridView1.Columns
        column.ImageLayout = DataGridViewImageCellLayout.Normal
        column.Description = "Normal image layout"
    Next
End Sub

C#

private void Stretch(object sender, EventArgs
 e)
{
    foreach (DataGridViewImageColumn column in
        dataGridView1.Columns)
    {
        column.ImageLayout = DataGridViewImageCellLayout.Stretch;
        column.Description = "Stretched";
    }
}

private void ZoomToImage(object sender, EventArgs
 e)
{

    foreach (DataGridViewImageColumn column in
        dataGridView1.Columns)
    {
        column.ImageLayout = DataGridViewImageCellLayout.Zoom;
        column.Description = "Zoomed";
    }
}

private void NormalImage(object sender, EventArgs
 e)
{

    foreach (DataGridViewImageColumn column in
        dataGridView1.Columns)
    {
        column.ImageLayout = DataGridViewImageCellLayout.Normal;
        column.Description = "Normal";
    }
}

プラットフォーム

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

参照

関連項目
DataGridViewImageCell クラス
DataGridViewImageCell メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridViewImageColumn.Description