RibbonButton.ImageName - свойство

Статья
05/19/2013

Возврат или установка имени, определяющего кнопку в обработчике событий LoadImage.

Пространство имен: Microsoft.Office.Tools.Ribbon
Сборка: Microsoft.Office.Tools.Common (в Microsoft.Office.Tools.Common.dll)

Синтаксис

'Декларация
Property ImageName As String

string ImageName { get; set; }

Значение свойства

Тип: System.String
Строка, определяющая кнопку в обработчике событий LoadImage.

Заметки

Во время выполнения это свойство можно установить только при определенных условиях.Для получения дополнительной информации см. Общие сведения об объектной модели ленты.

Дополнительные сведения об установке этого свойства см. в разделе Общие сведения об объектной модели ленты.

Свойство ImageName определяет изображение, отображаемое на элементе управления.В целях повышения производительности в приложении Office это изображение извлекается из решения только один раз.Это свойство можно установить только во время разработки, так как идентифицируемое им изображение загружается в ходе события LoadImage.Событие LoadImage вызывается только один раз для каждого имени изображения при отображении ленты.После этого изменение изображения элемента управления с помощью данного свойства невозможно.

Чтобы загрузить изображение, добавьте соответствующий код в обработчик событий LoadImage.Проверьте значение свойства ImageName объекта RibbonLoadImageEventArgs и присвойте свойству Image объекта RibbonLoadImageEventArgs изображение, которое требуется загрузить.

Если установлено свойство Image или OfficeImageId, это свойство игнорируется.Изображения, определяемые свойством ImageName, загружаются несколько быстрее изображений, определяемых свойством Image, поскольку загрузка изображения из решения в приложение Office выполняется только при первом отображении ленты.

Чтобы отобразить изображение элемента управления, для свойства ShowImage необходимо установить значение true.При установке свойства ImageName во время разработки Visual Studio автоматически задает для свойства ShowImage значение true.Если свойство ImageName устанавливается во время выполнения, в коде необходимо присвоить свойству ShowImage значение true.

Примеры

В следующем примере выполняется кэширование изображений для двух кнопок.

Перед выполнением этого примера выполните следующие действия:

Добавьте элемент Лента (визуальный конструктор) в проект, созданный с использованием средств разработки для Office в Visual Studio.
Добавьте группу на пользовательскую вкладку.
Добавьте две кнопки в группу.
Добавьте два изображения в ресурсы проекта.Дополнительные сведения см. в разделе Практическое руководство. Добавление или удаление ресурсов.

После этого можно выполнить код в созданном классе ленты.

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

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.