RibbonButton.ImageName A propriedade (sistema de 2007)

Artigo
08/25/2010

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

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

Sintaxe

Public Property ImageName As String

Dim instance As RibbonButton
Dim value As String

value = instance.ImageName

instance.ImageName = value

public string ImageName { get; set; }

Valor de propriedade

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

Comentários

Essa propriedade pode ser definida em time de execução somente sob certas condições.Para obter mais informações, consulte Visão geral do modelo de objeto da Faixa de Opções.

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

The ImageName propriedade identifica uma imagem que é exibida pelo controle. O aplicativo recupera a essa imagem de sua solução apenas uma vez, para melhorar o desempenho.Esta propriedade pode ser conjunto somente em time de design, como a imagem identifica é carregado durante o LoadImage evento. LoadImage é disparado somente uma vez por nome de 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 das RibbonLoadImageEventArgs e conjunto o Image propriedade das RibbonLoadImageEventArgs objeto para a imagem que você deseja carregar.

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

The ShowImage propriedade deve ser true para o controle exibir a imagem. Ao conjunto o ImageName propriedade pelo time de design, Visual Studio Tools for Office define automaticamente a ShowImage propriedade para true. Se você conjunto o ImageName propriedade em time de execução, você deve conjunto o ShowImage propriedade para true em seu código.

Exemplos

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

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

Adicionar um Faixa de opções (Visual Designer) item to a Visual Studio Tools for Office projeto.
Adicione um agrupar à guia personalizada.
Adicione dois botões ao agrupar.
Adicione duas imagens para os recursos do projeto.Para obter mais informações, consulte Como: Adicionar ou remover recursos.

Em seguida, você pode executar esse código na classe Faixa de Opções de Opções gerada.

PrivateSub Ribbon1_LoadImage(ByVal sender AsObject, _
    ByVal e As RibbonLoadImageEventArgs)
    SelectCase e.ImageName
        Case"Button1Image"
            e.Image = My.Resources.Image1
        Case"Button2Image"
            e.Image = My.Resources.Image2
    EndSelectEndSub

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

Permissões

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ódigos parcialmente Confiável.