RibbonDialogLauncher.ImageName プロパティ

[アーティクル]
08/09/2011

クイックアクセスツールバーにこの RibbonDialogLauncher を追加するときにイメージを割り当てるために使用される識別子を取得または設定します。

名前空間: 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
クイックアクセスツールバーにこの RibbonDialogLauncher を追加するときにイメージを割り当てるために使用される識別子。

解説

このプロパティは、特定の条件が満たされた場合にのみ、実行時に設定できます。詳細については、「リボンオブジェクトモデルの概要」を参照してください。

RibbonDialogLauncher がリボン上のグループ内に表示される場合、ImageName プロパティには目に見える効果はありません。一方、ユーザーが RibbonDialogLauncher をクイックアクセスツールバーに追加する場合は、Image プロパティまたは OfficeImageId プロパティが設定されていないと、このプロパティが表示されるイメージの動作を制御します。

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

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

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