RibbonComponent.Tag Propriedade

Referência

Definição

Namespace:: Microsoft.Office.Tools.Ribbon

Assemblies:: Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém ou define dados específicos do aplicativo associados a este RibbonComponent.

public:
 property System::Object ^ Tag { System::Object ^ get(); void set(System::Object ^ value); };

public object Tag { get; set; }

member this.Tag : obj with get, set

Public Property Tag As Object

Valor da propriedade

Object

Um Object que representa os dados específicos do aplicativo que está associados a essa RibbonComponent.

Exemplos

O exemplo a seguir demonstra como definir uma matriz de Employee objetos para a Tag propriedade de um grupo e como recuperar o valor da Tag propriedade . Este exemplo exige que você tenha definido uma classe chamada Employee que expõe a String propriedade ID e que você tenha definido um GetEmployees método que retorna uma matriz de Employee objetos.

Para executar esse exemplo de código, você deve primeiro executar as seguintes etapas:

Adicione um item Faixa de Opções (Visual Designer) a um projeto criado usando ferramentas de desenvolvimento do Office no Visual Studio.
Adicione um botão ao grupo Group1padrão .

private void button1_Click(object sender, RibbonControlEventArgs e)
{
    // Set the group's Tag property
    group1.Tag = GetEmployees();

    // Show all customers by retrieving them from the group's Tag property
    foreach (Employee emp in (Employee[])group1.Tag)
    {
        System.Windows.Forms.MessageBox.Show(emp.ID);
    }
}

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Button1.Click
    ' Set the group's Tag property
    Group1.Tag = GetEmployees()

    ' Show all customers by retrieving them from the group's Tag property
    For Each emp As Employee In CType(Group1.Tag, Employee())
        System.Windows.Forms.MessageBox.Show(emp.ID)
    Next
End Sub

Comentários

Qualquer tipo derivado da System.Object classe pode ser atribuído a essa propriedade. No entanto, se você definir a Tag propriedade na janela Propriedades do Visual Studio, só poderá atribuir texto.

Um uso comum para a Tag propriedade é armazenar dados que estão intimamente associados ao controle. Por exemplo, se você tiver um botão que exibe informações sobre um cliente, poderá armazenar um System.Data.DataSet que contém o histórico de pedidos do cliente na propriedade do Tag botão para que os dados possam ser acessados rapidamente.

Aplica-se a

Compartilhar via