RibbonDropDown.ImageName プロパティ

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

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

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

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