Propriedade RibbonComponent.Tag

Artigo
05/21/2013

Obtém ou define os dados específicos do aplicativo que estão associados com esse RibbonComponent.

Namespace: Microsoft.Office.Tools.Ribbon
Assemblies: Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)
Microsoft.Office.Tools.Common.v4.0.Utilities (em Microsoft.Office.Tools.Common.v4.0.Utilities.dll)

Sintaxe

'Declaração
Property Tag As Object

Object Tag { get; set; }

Valor de propriedade

Tipo: System.Object
System.Object que representa os dados específicos do aplicativo que estão associados com esse RibbonComponent.

Comentários

Qualquer tipo derivado da classe de System.Object pode ser atribuído à propriedade.Entretanto, se você definir a propriedade de Tag na janela do Visual Studio Propriedades , você só pode atribuir texto.

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

Exemplos

O exemplo a seguir demonstra como definir uma matriz de objetos de Funcionário à propriedade de Tag de um grupo e como recuperar o valor da propriedade de Tag .Esse exemplo requer que você definiu uma classe chamada Funcionário que expõe a propriedade Identificação de String e que você definiu um método de GetEmployees que retorna uma matriz de objetos de Funcionário .

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

Adicionar um item de 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 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

Partilhar via