次の方法で共有

RibbonToggleButton.ImageName プロパティ

  • [アーティクル]

コントロールのイメージを指定するために 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 アプリケーションは、パフォーマンスを向上させるために、このイメージをソリューションから 1 度だけ取得します。 このプロパティが示す画像は LoadImage イベントの間に読み込まれるので、このプロパティはデザイン時にのみ設定できます。 LoadImage は、リボンが表示されるときに、イメージ名ごとに 1 回だけ発生します。 その後は、このプロパティを使用してコントロールのイメージを変更することはできません。

イメージを読み込むには、コードを LoadImage イベント ハンドラーに追加します。 RibbonLoadImageEventArgs の ImageName プロパティを確認し、RibbonLoadImageEventArgs オブジェクトの Image プロパティを読み込むイメージに設定します。

このプロパティは、Image プロパティまたは OfficeImageId プロパティが設定されている場合は無視されます。 ImageName プロパティで示されるイメージは、Image プロパティで示されるイメージより、わずかに速く読み込まれます。これは、Office アプリケーションは、リボンが初めて表示されるときにのみ、ソリューションからイメージを取得するためです。

コントロールにイメージを表示するには、ShowImage プロパティを true に設定する必要があります。 デザイン時に ImageName プロパティを設定する場合は、Visual Studio によって自動的に ShowImage プロパティが true に設定されます。 実行時に ImageName プロパティを設定する場合は、コードで ShowImage プロパティを true に設定する必要があります。

例

次の例では、2 つのボタンのイメージをキャッシュしています。

このコード例を実行するには、最初に次の手順を実行する必要があります。

  1. [リボン (ビジュアル デザイナー)] アイテムを Office プロジェクトに追加します。

  2. カスタム タブにグループを追加します。

  3. グループに 2 つのボタンを追加します。

  4. プロジェクト リソースに 2 つのイメージを追加します。 詳細については、「方法 : リソースを追加または削除する」を参照してください。

その後、生成されたリボン クラスでこのコードを実行できます。

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 セキュリティ

  • 直前の呼び出し元に対する完全な信頼。 このメンバーは、部分的に信頼されているコードから使用することはできません。 詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

参照

RibbonToggleButton インターフェイス

Microsoft.Office.Tools.Ribbon 名前空間

その他の技術情報

リボン オブジェクト モデルの概要