DataGridView.GetClipboardContent Método

public:
 virtual System::Windows::Forms::DataObject ^ GetClipboardContent();

public virtual System.Windows.Forms.DataObject GetClipboardContent ();

public virtual System.Windows.Forms.DataObject? GetClipboardContent ();

abstract member GetClipboardContent : unit -> System.Windows.Forms.DataObject
override this.GetClipboardContent : unit -> System.Windows.Forms.DataObject

Public Overridable Function GetClipboardContent () As DataObject

Retornos

Um DataObject que representa o conteúdo das células selecionadas.

Exceções

Exemplos

O exemplo de código a seguir demonstra como adicionar programaticamente o conteúdo selecionado DataGridView à Área de Transferência. Este exemplo faz parte de um exemplo maior disponível em Como habilitar os usuários a copiar várias células para a área de transferência do controle Windows Forms DataGridView.

private void Form1_Load(object sender, System.EventArgs e)
{
    // Initialize the DataGridView control.
    this.DataGridView1.ColumnCount = 5;
    this.DataGridView1.Rows.Add(new string[] { "A", "B", "C", "D", "E" });
    this.DataGridView1.Rows.Add(new string[] { "F", "G", "H", "I", "J" });
    this.DataGridView1.Rows.Add(new string[] { "K", "L", "M", "N", "O" });
    this.DataGridView1.Rows.Add(new string[] { "P", "Q", "R", "S", "T" });
    this.DataGridView1.Rows.Add(new string[] { "U", "V", "W", "X", "Y" });
    this.DataGridView1.AutoResizeColumns();
    this.DataGridView1.ClipboardCopyMode = 
        DataGridViewClipboardCopyMode.EnableWithoutHeaderText;
}

private void CopyPasteButton_Click(object sender, System.EventArgs e)
{
    if (this.DataGridView1
        .GetCellCount(DataGridViewElementStates.Selected) > 0)
    {
        try
        {
            // Add the selection to the clipboard.
            Clipboard.SetDataObject(
                this.DataGridView1.GetClipboardContent());
            
            // Replace the text box contents with the clipboard text.
            this.TextBox1.Text = Clipboard.GetText();
        }
        catch (System.Runtime.InteropServices.ExternalException)
        {
            this.TextBox1.Text = 
                "The Clipboard could not be accessed. Please try again.";
        }
    }
}

Private Sub Form1_Load(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles Me.Load

    ' Initialize the DataGridView control.
    Me.DataGridView1.ColumnCount = 5
    Me.DataGridView1.Rows.Add(New String() {"A", "B", "C", "D", "E"})
    Me.DataGridView1.Rows.Add(New String() {"F", "G", "H", "I", "J"})
    Me.DataGridView1.Rows.Add(New String() {"K", "L", "M", "N", "O"})
    Me.DataGridView1.Rows.Add(New String() {"P", "Q", "R", "S", "T"})
    Me.DataGridView1.Rows.Add(New String() {"U", "V", "W", "X", "Y"})
    Me.DataGridView1.AutoResizeColumns()
    Me.DataGridView1.ClipboardCopyMode = _
        DataGridViewClipboardCopyMode.EnableWithoutHeaderText

End Sub

Private Sub CopyPasteButton_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles CopyPasteButton.Click

    If Me.DataGridView1.GetCellCount( _
        DataGridViewElementStates.Selected) > 0 Then

        Try

            ' Add the selection to the clipboard.
            Clipboard.SetDataObject( _
                Me.DataGridView1.GetClipboardContent())

            ' Replace the text box contents with the clipboard text.
            Me.TextBox1.Text = Clipboard.GetText()

        Catch ex As System.Runtime.InteropServices.ExternalException
            Me.TextBox1.Text = _
                "The Clipboard could not be accessed. Please try again."
        End Try

    End If

End Sub

Comentários

Esse método recupera dados que representam a região definida pelas células selecionadas. Essa região é o menor retângulo que inclui todas as células selecionadas. O valor de cada célula selecionada nessa região é recuperado chamando o DataGridViewCell.GetClipboardContent método . Os valores de espaço reservado em branco são usados para células não selecionadas nessa região. Esse método combina esses valores em um DataObject que contém vários formatos para copiar para a área de transferência. Os formatos de área de transferência com suporte incluem DataFormats.Text, DataFormats.UnicodeText, DataFormats.Htmle DataFormats.CommaSeparatedValue.

Para obter mais informações, consulte a classe Clipboard.

Notas aos Herdeiros

Substitua esse método para fornecer valores personalizados da área de transferência. Isso é útil, por exemplo, para dar suporte à cópia de valores de tipos de célula personalizados.

Aplica-se a

Confira também

• ClipboardCopyMode
• DataGridViewClipboardCopyMode
• DataFormats
• Controle DataGridView (Windows Forms)