RibbonToggleButton.ImageName Свойство

Определение

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

public string ImageName { get; set; }

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

String

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

Примеры

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

Чтобы запустить этот пример кода, необходимо сначала выполнить следующие действия.

  1. Добавьте элемент Лента (визуальный конструктор) в проект Office.

  2. Добавьте группу на настраиваемую вкладку.

  3. Добавьте две кнопки в группу.

  4. Добавьте два изображения в ресурсы проекта.

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

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

Комментарии

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

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

Это свойство пропускается, если свойство Image или свойство OfficeImageId задано. Изображения, идентифицируемые ImageName свойством, могут загружаться немного быстрее, чем изображения Image , определяемые свойством, так как приложение Office извлекает изображение из решения только при первом отображении ленты.

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

Применяется к