DataGridViewCell.ToolTipText Property

Definition

Obtiene o establece el texto de información sobre herramientas asociado a esta celda.Gets or sets the ToolTip text associated with this cell.

public:
 property System::String ^ ToolTipText { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
public string ToolTipText { get; set; }
member this.ToolTipText : string with get, set
Public Property ToolTipText As String

Property Value

String

Texto de información sobre herramientas asociado a la celda.The ToolTip text associated with the cell. De manera predeterminada, es Empty.The default is Empty.

Attributes

Examples

En el ejemplo de código siguiente se muestra cómo establecer la propiedad ToolTipText dentro de un controlador de eventos para el evento CellFormatting.The following code example shows how to set the ToolTipText property within an event handler for the CellFormatting event. Este ejemplo forma parte de un ejemplo de código más grande que se proporciona en Cómo: agregar información sobre herramientas a celdas individuales en un control DataGridView Windows Forms.This example is part of a larger code example provided in How to: Add ToolTips to Individual Cells in a Windows Forms DataGridView Control.

// Sets the ToolTip text for cells in the Rating column.
void dataGridView1_CellFormatting(Object^ /*sender*/, 
    DataGridViewCellFormattingEventArgs^ e)
{
    if ( (e->ColumnIndex == this->dataGridView1->Columns["Rating"]->Index)
        && e->Value != nullptr )
    {
        DataGridViewCell^ cell = 
            this->dataGridView1->Rows[e->RowIndex]->Cells[e->ColumnIndex];
        if (e->Value->Equals("*"))
        {                
            cell->ToolTipText = "very bad";
        }
        else if (e->Value->Equals("**"))
        {
            cell->ToolTipText = "bad";
        }
        else if (e->Value->Equals("***"))
        {
            cell->ToolTipText = "good";
        }
        else if (e->Value->Equals("****"))
        {
            cell->ToolTipText = "very good";
        }
    }
}
// Sets the ToolTip text for cells in the Rating column.
void dataGridView1_CellFormatting(object sender, 
    DataGridViewCellFormattingEventArgs e)
{
    if ( (e.ColumnIndex == this.dataGridView1.Columns["Rating"].Index)
        && e.Value != null )
    {
        DataGridViewCell cell = 
            this.dataGridView1.Rows[e.RowIndex].Cells[e.ColumnIndex];
        if (e.Value.Equals("*"))
        {                
            cell.ToolTipText = "very bad";
        }
        else if (e.Value.Equals("**"))
        {
            cell.ToolTipText = "bad";
        }
        else if (e.Value.Equals("***"))
        {
            cell.ToolTipText = "good";
        }
        else if (e.Value.Equals("****"))
        {
            cell.ToolTipText = "very good";
        }
    }
}
' Sets the ToolTip text for cells in the Rating column.
Sub dataGridView1_CellFormatting(ByVal sender As Object, _
    ByVal e As DataGridViewCellFormattingEventArgs) _
    Handles dataGridView1.CellFormatting

    If e.ColumnIndex = Me.dataGridView1.Columns("Rating").Index _
        AndAlso (e.Value IsNot Nothing) Then

        With Me.dataGridView1.Rows(e.RowIndex).Cells(e.ColumnIndex)

            If e.Value.Equals("*") Then
                .ToolTipText = "very bad"
            ElseIf e.Value.Equals("**") Then
                .ToolTipText = "bad"
            ElseIf e.Value.Equals("***") Then
                .ToolTipText = "good"
            ElseIf e.Value.Equals("****") Then
                .ToolTipText = "very good"
            End If

        End With

    End If

End Sub

Remarks

El valor de esta propiedad se muestra como la información sobre herramientas de la celda cuando el puntero del mouse está sobre la celda y el valor de la propiedad no se Empty.The value of this property is displayed as the cell ToolTip when the mouse pointer is over the cell and the property value is not Empty. Si el valor de esta propiedad es Empty, la celda mostrará una información sobre herramientas que contiene el valor de la celda si el valor se trunca en la presentación de la celda; de lo contrario, la celda no mostrará información sobre herramientas.If the value of this property is Empty, the cell will display a ToolTip containing the value of the cell if the value is truncated in the cell display; otherwise, the cell will not display a ToolTip. También puede impedir que se muestre la información sobre herramientas si establece la propiedad DataGridView.ShowCellToolTips en false.You can also prevent the display of a ToolTip by setting the DataGridView.ShowCellToolTips property to false.

Cuando se establece la propiedad de control de DataGridView DataSource o se truesu propiedad VirtualMode, al obtener el valor de la propiedad ToolTipText se genera el evento CellToolTipTextNeeded del control y se devuelve el valor de la propiedad DataGridViewCellToolTipTextNeededEventArgs.ToolTipText tal y como se especifica en el controlador de eventos.When the DataGridView control DataSource property is set or its VirtualMode property is true, getting the value of the ToolTipText property raises the CellToolTipTextNeeded event of the control and returns the value of the DataGridViewCellToolTipTextNeededEventArgs.ToolTipText property as specified in the event handler. Si no hay ningún controlador para el evento, al obtener el valor de la propiedad ToolTipText se devuelve el valor especificado anteriormente o su valor predeterminado de Empty.If there are no handlers for the event, getting the value of the ToolTipText property returns the previously specified value or its default value of Empty.

Controlar el evento CellToolTipTextNeeded es especialmente útil cuando se trabaja con grandes cantidades de datos para evitar penalizaciones de rendimiento al establecer el valor de ToolTipText de celda para varias celdas.Handling the CellToolTipTextNeeded event is primarily useful when working with large amounts of data to avoid performance penalties when setting the cell ToolTipText value for multiple cells. Para obtener más información, consulte Procedimientos recomendados para ajustar la escala del control DataGridView en Windows Forms.For more information, see Best Practices for Scaling the Windows Forms DataGridView Control.

Al cambiar esta propiedad, se genera el evento CellToolTipTextChanged en el DataGridViewpropietario, si existe uno.Changing this property raises the CellToolTipTextChanged event on the owning DataGridView, if one exists.

Applies to

See also