RibbonToggleButton.ImageName Propriedade

Definição

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

public string ImageName { get; set; }

Valor da propriedade

String

Uma cadeia de caracteres que você pode usar no manipulador de eventos LoadImage para identificar uma imagem para o controle.

Exemplos

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

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

  1. Adicione um item da faixa de Ribbon (designer visual) a um projeto do Office.

  2. Adicione um grupo à guia personalizada.

  3. Adicione dois botões ao grupo.

  4. Adicione duas imagens aos recursos do projeto.

Em seguida, é possível executar esse código na classe Ribbon gerada.

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

Comentários

A ImageName propriedade identifica uma imagem que é exibida pelo controle. O aplicativo do Office recupera essa imagem da solução apenas uma vez para melhorar o desempenho. Esta propriedade só pode ser definida em tempo de design, porque a imagem que ela identifica é carregada durante o evento LoadImage. LoadImage só é acionado uma vez por nome da imagem, quando a Faixa de Opções é exibida. Depois disso, a imagem de controle não pode ser modificada usando-se essa propriedade.

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

Essa propriedade será ignorada se a Image propriedade ou a OfficeImageId propriedade for definida. As imagens identificadas pela ImageName propriedade podem ser carregadas ligeiramente mais rápido que as imagens identificadas pela Image propriedade, porque o aplicativo do Office recupera a imagem da sua solução somente na primeira vez em que a faixa de imagens é exibida.

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

Aplica-se a