Propriedade RibbonButton.ImageName

Artigo
05/21/2013

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

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

Sintaxe

'Declaração
Property ImageName As String

string ImageName { get; set; }

Valor de propriedade

Tipo: System.String
Uma cadeia de caracteres que você possa usar no manipulador de eventos de LoadImage para identificar o botão.

Comentários

Esta propriedade pode ser definida em tempo de execução somente sob certas condições.Para obter mais informações, consulte 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.

A propriedade de ImageName identifica uma imagem que é exibido pelo controle.O aplicativo do Office recupera esta imagem de sua solução somente uma vez, para melhorar o desempenho.Esta propriedade pode ser definida somente em tempo de design, porque a imagem que identifica é carregado durante o evento de LoadImage .LoadImage é gerado apenas uma vez pelo nome de imagem, quando a fita é exibida.Após o, a imagem do controle não pode ser modificada usando a propriedade.

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

Esta propriedade é ignorada se a propriedade de Image ou a propriedade de OfficeImageId são definidas.Imagens identificadas pela propriedade de ImageName podem ser carregadas ligeiramente mais rápido do que as imagens identificadas pela propriedade de Image , porque o aplicativo do Office recupera a imagem de sua solução somente na primeira vez a fita são exibidas.

A propriedade de ShowImage deve ser true para que o controle exiba a imagem.Quando você define a propriedade de ImageName em tempo de design, o Visual Studio automaticamente definir a propriedade de ShowImage a true.Se você definir a propriedade de ImageName em tempo de execução, você deve definir a propriedade de ShowImage a true no seu código.

Exemplos

O exemplo também as imagens para dois botões.

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 grupo para a guia personalizado.
Adicione dois botões ao grupo.
Adicionar duas imagens aos recursos do projeto.Para obter mais informações, consulte Como: Adicionar ou remover recursos.

Você pode então executar esse código na classe gerada de fita.

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.