Propriedade RibbonComponent.Tag

Artigo
08/01/2011

Obtém ou define os dados específicos do aplicativo que está associados esta RibbonComponent.

Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)

Sintaxe

'Declaração
Property Tag As Object
    Get
    Set

Object Tag { get; set; }

Valor de propriedade

Tipo: System.Object
Um System.Object que representa os dados específicos do aplicativo que está associados esta RibbonComponent.

Comentários

Qualquer tipo derivado de System.Object classe pode ser atribuído a esta propriedade. No entanto, se você definir a Tag propriedade no Visual Studio Propriedades janela, você pode atribuir somente texto.

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

Exemplos

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

Para executar este exemplo de código, realize as seguintes etapas:

Adicionar um a faixa de opções (Visual Designer) item a um projeto criado usando ferramentas de desenvolvimento do Office em Visual Studio.
Adicionar um botão para o grupo padrão Grupo1.

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

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);
    }
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

RibbonComponent Interface

Namespace Microsoft.Office.Tools.Ribbon

Compartilhar via