Propriedade RibbonButton.OfficeImageId

Artigo
08/01/2011

Obtém ou define a imagem para exibir no botão, se você quiser usar um ícone de Microsoft Office interno.

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

Sintaxe

'Declaração
Property OfficeImageId As String
    Get
    Set

string OfficeImageId { get; set; }

Valor de propriedade

Tipo: System.String
A identificação de um ícone de Microsoft Office interna que serve como um ícone para esse controle.

Comentários

O OfficeImageId propriedade identifica um ícone do Office que é exibido pelo controle. O valor da propriedade é uma seqüência de caracteres que identifica o imageMso o valor do ícone selecionado. Essa propriedade pode ser definida em tempo de design ou em tempo de execução. Se você atualizar essa propriedade em tempo de execução, a aparência do controle é atualizada para refletir a alteração.

Para obter uma lista de imageMso valores, consulte a página do Centro de Download da Microsoft Add-In do 2007 Office System: Galeria de ícones.

Esta propriedade é ignorada se a Image propriedade é definido. Imagens identificadas pelo OfficeImageId propriedade pode ser carregada ligeiramente mais rápido do que imagens identificadas pelo Image propriedade, porque as imagens são armazenadas em cache no aplicativo Office.

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

Exemplos

O exemplo a seguir atribui um ícone de Microsoft Office a um botão.

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 um botão para o grupo.
Definir o (nome) a propriedade do botão de mySaveButton.

Private Sub SetButtonImage()
    mySaveButton.OfficeImageId = "FileSave"
    mySaveButton.ShowImage = True
End Sub

private void SetButtonImage()
{
    mySaveButton.OfficeImageId = "FileSave";
    mySaveButton.ShowImage = true;
}

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.