DataGridViewImageColumn::Description Property

 

Gets or sets a string that describes the column's image.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public:
[BrowsableAttribute(true)]
property String^ Description {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

The textual description of the column image. The default is String::Empty.

Exception Condition
InvalidOperationException

The value of the CellTemplate property is null.

You can use the Description property to describe the image provided by the Image or Icon property. This description provides an accessible alternative to the image. Additionally, the description text is used when the cell value is copied onto the Clipboard.

Getting or setting this property gets or sets the Description property of the object returned by the CellTemplate property. Setting this property also sets the Description property of every cell in the column. To override the specified value for individual cells, set the cell values after you set the column value.

The following code example demonstrates how to use the Description property to reflect the image layout. This example is part of a larger example available in How to: Work with Image Columns in the Windows Forms DataGridView Control.

void Stretch( Object^ sender, EventArgs^ e )
{
   System::Collections::IEnumerator^ myEnum = dataGridView1->Columns->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DataGridViewImageColumn^ column = safe_cast<DataGridViewImageColumn^>(myEnum->Current);
      column->ImageLayout = DataGridViewImageCellLayout::Stretch;
      column->Description = L"Stretched";
   }
}

void ZoomToImage( Object^ sender, EventArgs^ e )
{
   System::Collections::IEnumerator^ myEnum1 = dataGridView1->Columns->GetEnumerator();
   while ( myEnum1->MoveNext() )
   {
      DataGridViewImageColumn^ column = safe_cast<DataGridViewImageColumn^>(myEnum1->Current);
      column->ImageLayout = DataGridViewImageCellLayout::Zoom;
      column->Description = L"Zoomed";
   }
}

void NormalImage( Object^ sender, EventArgs^ e )
{
   System::Collections::IEnumerator^ myEnum2 = dataGridView1->Columns->GetEnumerator();
   while ( myEnum2->MoveNext() )
   {
      DataGridViewImageColumn^ column = safe_cast<DataGridViewImageColumn^>(myEnum2->Current);
      column->ImageLayout = DataGridViewImageCellLayout::Normal;
      column->Description = L"Normal";
   }
}


.NET Framework
Available since 2.0
Return to top
Show: