IXpsOMTileBrush::GetViewbox メソッド (xpsobjectmodel.h)

タイルで使用されるソースイメージの部分を取得します。

構文

HRESULT GetViewbox(
  [out, retval] XPS_RECT *viewbox
);

[out, retval] viewbox

タイルで使用するソースコンテンツの領域を記述する XPS_RECT 構造。

メソッドが成功すると、S_OKが返されます。それ以外の場合は、 HRESULT エラーコードが返されます。

リターンコード	説明
S_OK	メソッドが成功しました。
E_POINTER	viewbox が NULL です。

ブラシのビューボックスは、タイルイメージとして使用するソースイメージまたはビジュアルの部分を指定します。

ブラシのビューボックスの座標はソースコンテンツに対する相対座標であり、(0,0) はソースコンテンツの左上隅を指定します。画像の場合、ブラシのビューボックスで指定された寸法は、1/96 の単位で表されます。ソースイメージ内の対応するピクセル座標は、次のように計算されます。

次の図では、左側の画像はソースイメージの例であり、中央の画像は選択したビューボックスを示し、右側の画像は結果のブラシを示しています。

ソースイメージの解像度が 1 インチあたり 96 x 96 ドットで、画像のサイズが 96 x 96 ピクセルの場合、 viewbox パラメーターのフィールドの値は次のようになります。

上記のパラメーター値は、ソースイメージに次のように対応しています。

SourceLeft = 96 × 48 / 96 = 左側から 48 ピクセル

SourceTop = 96 × 4 / 96 = 上から 24 ピクセル

SourceWidth = 96 × 24 / 96 = 幅 24 ピクセル

SourceHeight = 96 × 48 / 96 = 48 ピクセルの高さ

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h