RibbonButton.ImageName 属性

项目
08/12/2011

获取或设置用于在 LoadImage 事件处理程序中标识按钮的名称。

命名空间： Microsoft.Office.Tools.Ribbon
程序集： Microsoft.Office.Tools.Common（在 Microsoft.Office.Tools.Common.dll 中）

语法

声明
Property ImageName As String
    Get
    Set

string ImageName { get; set; }

属性值

类型：System.String
一个字符串，可在 LoadImage 事件处理程序中用来标识按钮。

备注

只有在特定条件下，才可以在运行时设置此属性。有关更多信息，请参见功能区对象模型概述。

有关如何设置此属性的信息，请参见功能区对象模型概述。

ImageName 属性标识该控件所显示的图像。为了提高性能，Office 应用程序从解决方案中只检索一次此图像。此属性只能在设计时设置，因为它标识的图像是在 LoadImage 事件过程中加载的。当显示功能区时，对于每个图像名称，只会引发一次 LoadImage。此后，不能再使用此属性更改控件图像。

若要加载图像，请在 LoadImage 事件处理程序中添加代码。检查 RibbonLoadImageEventArgs 的 ImageName 属性，将 RibbonLoadImageEventArgs 对象的 Image 属性设置为要加载的图像。

如果设置了 Image 属性或 OfficeImageId 属性，则忽略此属性。加载 ImageName 属性所标识的图像比加载 Image 属性所标识的图像可能稍快一些，这是因为 Office 应用程序仅在首次显示功能区时从解决方案中检索图像。

若要使该控件显示图像，ShowImage 属性必须为 true。如果在设计时设置了 ImageName 属性，Visual Studio 就会自动将 ShowImage 属性设置为 true。如果在运行时设置 ImageName 属性，则必须在代码中将 ShowImage 属性设置为 true。

示例

下面的示例为两个按钮缓存图像。

若要运行此代码示例，必须先执行下列步骤：

将**“功能区(可视化设计器)”**项添加到使用 Visual Studio 中的 Office 开发工具创建的项目中。
在自定义选项卡中添加一个组。
在该组中添加两个按钮。
在项目资源中添加两个图像。有关更多信息，请参见如何：添加或移除资源。

然后可以在生成的功能区类中运行此代码。

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