Propriedade RibbonButton.ImageName

Artigo
08/01/2011

Obtém ou define o nome que você pode usar para identificar o botão no LoadImage manipulador de eventos.

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

Sintaxe

'Declaração
Property ImageName As String
    Get
    Set

string ImageName { get; set; }

Valor de propriedade

Tipo: System.String
Uma seqüência de caracteres que você pode usar o LoadImage o manipulador de eventos para identificar o botão.

Comentários

Essa propriedade pode ser definida em tempo de execução somente sob certas condições. For more information, see Visão geral do modelo de objeto de faixa de opções.

Para obter informações sobre como definir essa propriedade, consulte Visão geral do modelo de objeto de faixa de opções.

O ImageName propriedade identifica uma imagem que é exibida pelo controle. O aplicativo do Office recupera essa imagem de sua solução apenas uma vez, para melhorar o desempenho. Essa propriedade pode ser definida apenas em tempo de design, porque a imagem que ele identifica é carregada durante a LoadImage de evento. LoadImageé gerado apenas uma vez por nome da imagem, quando a faixa de opções é exibida. Depois disso, a imagem do controle não pode ser alterada usando essa propriedade.

Para carregar a imagem, adicione código para o LoadImage manipulador de eventos. Verifique o ImageName propriedade da RibbonLoadImageEventArgs e defina a Image propriedade da RibbonLoadImageEventArgs objeto para a imagem que você deseja carregar.

Esta propriedade é ignorada se a Image propriedade ou o OfficeImageId propriedade é definido. Imagens identificadas pelo ImageName propriedade pode ser carregada ligeiramente mais rápido do que imagens identificadas pelo Image propriedade, porque o aplicativo do Office recupera a imagem de seu tempo de solução somente a primeira a faixa de opções é exibida.

O ShowImage a propriedade deve ser true para o controle para exibir a imagem. Ao definir o ImageName da propriedade em tempo de design, Visual Studio define automaticamente a ShowImage propriedade para true. Se você definir a ImageName a propriedade em tempo de execução, você deve definir o ShowImage propriedade para true em seu código.

Exemplos

O exemplo a seguir armazena em cache as imagens de dois botões.

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.
Adicione um grupo à guia personalizada.
Adicione dois botões ao grupo.
Adicione duas imagens aos recursos do projeto. For more information, see Como: Adicionar ou remover recursos.

Em seguida, você pode executar esse código na classe gerada da faixa de opções.

Private Sub Ribbon1_LoadImage(ByVal sender As Object, _
    ByVal e As RibbonLoadImageEventArgs)
    Select Case e.ImageName
        Case "Button1Image"
            e.Image = My.Resources.Image1
        Case "Button2Image"
            e.Image = My.Resources.Image2
    End Select
End Sub

private void Ribbon1_LoadImage(object sender, RibbonLoadImageEventArgs e)
{
    switch (e.ImageName)
    {
        case "Button1Image":
            e.Image = Properties.Resources.Image1;
            break;
        case "Button2Image":
            e.Image = Properties.Resources.Image2;
            break;
    }
}

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.