LVBKIMAGEA 構造体 (commctrl.h)

  • [アーティクル]

リスト ビュー コントロールの背景画像に関する情報が含まれます。 この構造体は、背景画像情報の設定と取得の両方に使用されます。

構文

typedef struct tagLVBKIMAGEA {
  ULONG   ulFlags;
  HBITMAP hbm;
  LPSTR   pszImage;
  UINT    cchImageMax;
  int     xOffsetPercent;
  int     yOffsetPercent;
} LVBKIMAGEA, *LPLVBKIMAGEA;

メンバー

ulFlags

種類: ULONG

このメンバーは、次のフラグの 1 つ以上である場合があります。 LVBKIF_SOURCE_MASK値を使用して、ソース フラグを除くすべてのフラグをマスクできます。 LVBKIF_STYLE_MASK値を使用して、スタイル フラグ以外のすべてをマスクできます。

値 意味
LVBKIF_SOURCE_NONE
 リスト ビュー コントロールには背景イメージがありません。
LVBKIF_SOURCE_HBITMAP
 背景ビットマップは LVBKIMAGE の hbm メンバーを介して提供されます。 メッセージ LVM_SETBKIMAGE 成功した場合、リスト ビューはビットマップの所有権を取得します。
LVBKIF_SOURCE_URL
 pszImage メンバーには、背景画像の URL が含まれています。
LVBKIF_STYLE_NORMAL
 背景画像は正常に表示されます。
LVBKIF_STYLE_TILE
 背景イメージは、コントロールの背景全体を塗りつぶすためにタイル化されます。
LVBKIF_FLAG_TILEOFFSET
 最初のタイルの座標を指定します。 このフラグは、 LVBKIF_STYLE_TILE フラグも指定されている場合にのみ有効です。 このフラグを指定しない場合、最初のタイルはクライアント領域の左上隅から始まります。 バージョン 6.0 ComCtl32.dll 使用する場合、xOffsetPercent フィールドと yOffsetPercent フィールドには、最初のタイルの座標を指定するために、パーセンテージ値ではなくピクセルが含まれます。 Comctl32.dll バージョン 6 は再頒布可能ではありませんが、Windows 以降に含まれています。 また、マニフェスト Comctl32.dll バージョン 6 を指定する必要があります。 マニフェストの詳細については、「 ビジュアル スタイルの有効化」を参照してください。
LVBKIF_TYPE_WATERMARK
 透かしの背景ビットマップは、LVBKIMAGE の hbm メンバーを介して提供されます。 LVM_SETBKIMAGE メッセージが成功した場合、リスト ビュー コントロールはビットマップの所有権を取得します。
LVBKIF_FLAG_ALPHABLEND
 LVBKIF_TYPE_WATERMARKも指定されている場合にのみ有効です。 このフラグは、LVBKIF_TYPE_WATERMARKを介して提供されるビットマップに有効なアルファ チャネルが含まれていることを示します。

hbm

種類: HBITMAP

背景ビットマップのハンドル。 このメンバーは、 LVBKIF_SOURCE_HBITMAP フラグが ulFlags で設定されている場合にのみ有効です。

pszImage

種類: LPTSTR

背景画像の URL を含む NULL で終わる文字列のアドレス。 このメンバーは、 LVBKIF_SOURCE_URL フラグが ulFlags で設定されている場合にのみ有効です。 このメンバーは、メッセージを送信する前に、テキストを格納または受信するバッファーを指すために初期化する必要があります。

cchImageMax

型: UINT

pszImage のアドレスにあるバッファーのサイズ。 情報がコントロールに送信されている場合、このメンバーは無視されます。

xOffsetPercent

型: int

イメージを水平方向にオフセットする必要があるコントロールのクライアント領域の割合。 たとえば、0% の場合、イメージはコントロールのクライアント領域の左端に対して表示されます。 50% の場合、イメージはコントロールのクライアント領域の水平方向の中央に表示されます。 100% の場合、イメージはコントロールのクライアント領域の右端に対して表示されます。 このメンバーは、ulFlags でLVBKIF_STYLE_NORMALが指定されている場合にのみ有効です。 LVBKIF_FLAG_TILEOFFSETとLVBKIF_STYLE_TILEの両方が ulFlags で指定されている場合、値は最初のタイルのパーセンテージ オフセットではなくピクセルを指定します。 それ以外の場合、値は無視されます。

yOffsetPercent

型: int

イメージを垂直方向にオフセットする必要があるコントロールのクライアント領域の割合。 たとえば、0% の場合、イメージはコントロールのクライアント領域の上端に対して表示されます。 50% の場合、イメージはコントロールのクライアント領域の垂直方向の中央に表示されます。 100% の場合、イメージはコントロールのクライアント領域の下端に対して表示されます。 このメンバーは、ulFlags でLVBKIF_STYLE_NORMALが指定されている場合にのみ有効です。 LVBKIF_FLAG_TILEOFFSETとLVBKIF_STYLE_TILEの両方が ulFlags で指定されている場合、値は最初のタイルのパーセンテージ オフセットではなくピクセルを指定します。 それ以外の場合、値は無視されます。

注釈

この構造体は、メッセージの LVM_GETBKIMAGE とLVM_SETBKIMAGEと共 に 使用されます。

注意

commctrl.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして LVBKIMAGE を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
Header commctrl.h