ホーム › Storage.Xps › IXpsOMVisual

IXpsOMVisual

COM

📘 Microsoft Learn (日本語) · English

IIDbc3e7333-fb0b-4af3-a819-0b4eaad0d2fd継承元IXpsOMShareable自前メソッド開始 vtbl5

公式ドキュメント

path、canvas、glyph の各インターフェイスの基本インターフェイスです。

メソッド 25

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 5 HRESULT GetTransform(IXpsOMMatrixTransform** matrixTransform)

ビジュアルの解決済みの行列変換を格納する IXpsOMMatrixTransform インターフェイスへのポインターを取得します。

matrixTransform

IXpsOMMatrixTransform**

out

ビジュアルの解決済みの行列変換を格納する IXpsOMMatrixTransform インターフェイスへのポインター。行列変換が設定されていない場合は、NULL ポインターが返されます。

このパラメーターに返される値は、変換を設定するために直近に呼び出されたメソッドによって異なります。

直近に呼び出されたメソッド	matrixTransform に返されるオブジェクト
SetTransformLocal	SetTransformLocal によって設定されたローカル変換。
SetTransformLookup	SetTransformLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有変換。
SetTransformLocal と SetTransformLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定される値には、以下の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS ドキュメントのエラーを参照してください。

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	matrixTransform が NULL です。
XPS_E_LOOKUP_INVALID_TYPE	SetStrokeBrushLookup によって設定された参照キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	参照値と一致するキー名を持つオブジェクトが見つかりませんでした。

vtbl 6 HRESULT GetTransformLocal(IXpsOMMatrixTransform** matrixTransform)

ビジュアルのローカルで共有されない解決済みの行列変換を格納する IXpsOMMatrixTransform インターフェイスへのポインターを取得します。

matrixTransform

IXpsOMMatrixTransform**

out

ビジュアルのローカルで共有されない解決済みの行列変換を格納する IXpsOMMatrixTransform インターフェイスへのポインター。行列変換の参照キーが設定されていない場合、またはローカルの行列変換が設定されている場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	matrixTransform に返されるオブジェクト
SetTransformLocal	SetTransformLocal によって設定されたローカル変換。
SetTransformLookup	NULL ポインター。
SetTransformLocal と SetTransformLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	matrixTransform が NULL です。

vtbl 7 HRESULT SetTransformLocal(IXpsOMMatrixTransform* matrixTransform)

ローカルで共有されない行列変換を設定します。(IXpsOMVisual.SetTransformLocal)

matrixTransform

IXpsOMMatrixTransform*

ローカルで共有されない行列変換として設定する IXpsOMMatrixTransform インターフェイスへのポインター。NULL ポインターを指定すると、以前に割り当てられた変換が解放されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS	matrixTransform が認識可能なインターフェイス実装を指していません。XPS ドキュメント API インターフェイスの独自実装はサポートされていません。

解説(Remarks)

SetTransformLocal を呼び出すと、変換の参照キーは解放され、GetTransformLookup は key パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetTransform によって transform に返されるオブジェクト	GetTransformLocal によって matrixTransform に返されるオブジェクト	GetTransformLookup によって key に返されるオブジェクト
SetTransformLocal (このメソッド)	SetTransformLocal によって設定されたローカル変換。	SetTransformLocal によって設定されたローカル変換。	NULL ポインター。
SetTransformLookup	SetTransformLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有変換。	NULL ポインター。	SetTransformLookup によって設定された参照キー。
SetTransformLocal と SetTransformLookup のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 8 HRESULT GetTransformLookup(LPWSTR* key)

ビジュアルの解決済みの行列変換を格納する、リソースディクショナリ内の IXpsOMMatrixTransform インターフェイスの参照キー名を取得します。

key

LPWSTR*

out

ビジュアルの解決済みの行列変換を格納する、リソースディクショナリ内の IXpsOMMatrixTransform インターフェイスの参照キー名。行列変換の参照キーが設定されていない場合、またはローカルの行列変換が設定されている場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	key に返されるオブジェクト
SetTransformLocal	NULL ポインター。
SetTransformLookup	SetTransformLookup によって設定された参照キー。
SetTransformLocal と SetTransformLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	key が NULL です。

解説(Remarks)

このメソッドは、key で返される文字列が使用するメモリを割り当てます。key が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 9 HRESULT SetTransformLookup(LPWSTR key)

リソースディクショナリ内の共有行列変換の参照キー名を設定します。(IXpsOMVisual.SetTransformLookup)

key

LPWSTR

ディクショナリ内の行列変換の参照キー名。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY	XML Paper Specification に照らして、lookup の値が有効な参照キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE	key のルックアップキー名が、ジオメトリではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	key に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetTransformLookup を呼び出すと、ローカル変換は解放され、GetTransformLocal は matrixTransform パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetTransform によって transform に返されるオブジェクト	GetTransformLocal によって matrixTransform に返されるオブジェクト	GetTransformLookup によって key に返されるオブジェクト
SetTransformLocal	SetTransformLocal によって設定されたローカル変換。	SetTransformLocal によって設定されたローカル変換。	NULL ポインター。
SetTransformLookup (このメソッド)	SetTransformLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有変換。	NULL ポインター。	SetTransformLookup によって設定された参照キー。
SetTransformLocal と SetTransformLookup のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 10 HRESULT GetClipGeometry(IXpsOMGeometry** clipGeometry)

ビジュアルのクリッピング領域の解決済みのジオメトリを格納する IXpsOMGeometry インターフェイスへのポインターを取得します。

clipGeometry

IXpsOMGeometry**

out

ビジュアルのクリッピング領域の解決済みのジオメトリを格納する IXpsOMGeometry インターフェイスへのポインター。クリップジオメトリが設定されていない場合は、NULL ポインターが返されます。

このパラメーターに返される値は、ジオメトリを設定するために直近に呼び出されたメソッドによって異なります。

直近に呼び出されたメソッド	clipGeometry に返されるオブジェクト
SetClipGeometryLocal	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。
SetClipGeometryLookup	SetClipGeometryLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有のクリップジオメトリ。
SetClipGeometryLocal と SetClipGeometryLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	clipGeometry が NULL です。
XPS_E_LOOKUP_INVALID_TYPE	SetStrokeBrushLookup によって設定された参照キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	参照値と一致するキー名を持つオブジェクトが見つかりませんでした。

vtbl 11 HRESULT GetClipGeometryLocal(IXpsOMGeometry** clipGeometry)

ビジュアルのクリッピング領域のローカルで共有されないジオメトリを格納する IXpsOMGeometry インターフェイスへのポインターを取得します。

clipGeometry

IXpsOMGeometry**

out

ビジュアルのクリッピング領域のローカルで共有されないジオメトリを格納する IXpsOMGeometry インターフェイスへのポインター。クリップジオメトリの参照キーが設定されている場合、またはローカルのクリップジオメトリが設定されていない場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	clipGeometry に返されるオブジェクト
SetClipGeometryLocal	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。
SetClipGeometryLookup	NULL ポインター。
SetClipGeometryLocal と SetClipGeometryLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	clipGeometry が NULL です。

vtbl 12 HRESULT SetClipGeometryLocal(IXpsOMGeometry* clipGeometry)

ビジュアルのローカルで共有されないクリッピング領域を設定します。

clipGeometry

IXpsOMGeometry*

ビジュアルのローカルで共有されないクリッピング領域として設定する IXpsOMGeometry インターフェイスへのポインター。NULL ポインターを指定すると、以前に割り当てられたジオメトリインターフェイスが解放されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS	clipGeometry が認識可能なインターフェイス実装を指していません。XPS ドキュメント API インターフェイスの独自実装はサポートされていません。

解説(Remarks)

SetClipGeometryLocal を呼び出すと、クリップジオメトリの参照キーは解放され、GetClipGeometryLookup は key パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetClipGeometry によって clipGeometry に返されるオブジェクト	GetClipGeometryLocal によって clipGeometry に返されるオブジェクト	GetClipGeometryLookup によって key に返される文字列
SetClipGeometryLocal (このメソッド)	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。	NULL ポインター。
SetClipGeometryLookup	SetClipGeometryLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有のクリップジオメトリ。	NULL ポインター。	SetClipGeometryLookup によって設定された参照キー。
SetClipGeometryLookup と SetClipGeometryLocal のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 13 HRESULT GetClipGeometryLookup(LPWSTR* key)

ビジュアルのクリッピング領域を格納する、リソースディクショナリ内の IXpsOMGeometry インターフェイスの参照キーを取得します。

key

LPWSTR*

out

ビジュアルのクリッピング領域を格納する、リソースディクショナリ内の IXpsOMGeometry インターフェイスの参照キー。クリップジオメトリの参照キーが設定されていない場合、またはローカルのクリップジオメトリが設定されている場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	key に返される参照キー文字列
SetClipGeometryLocal	NULL ポインター。
SetClipGeometryLookup	SetClipGeometryLookup によって設定された参照キー。
SetClipGeometryLocal と SetClipGeometryLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	key が NULL です。

解説(Remarks)

このメソッドは、key で返される文字列が使用するメモリを割り当てます。key が NULL でない場合は、SignatureDefinitions 関数を使用してメモリを解放してください。

vtbl 14 HRESULT SetClipGeometryLookup(LPWSTR key)

リソースディクショナリ内の共有クリップジオメトリの参照キー名を設定します。

key

LPWSTR

ディクショナリ内のクリップジオメトリの参照キー名。NULL ポインターを指定すると、以前に割り当てられたキー名がクリアされます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY	XML Paper Specification に照らして、lookup の値が有効な参照キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE	key のルックアップキー名が、ジオメトリではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	key に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetClipGeometryLookup を呼び出すと、ローカルのクリップジオメトリは解放され、GetClipGeometryLocal は clipGeometry パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetClipGeometry によって clipGeometry に返されるオブジェクト	GetClipGeometryLocal によって clipGeometry に返されるオブジェクト	GetClipGeometryLookup によって key に返される文字列
SetClipGeometryLocal	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。	SetClipGeometryLocal によって設定されたローカルのクリップジオメトリ。	NULL ポインター。
SetClipGeometryLookup (このメソッド)	SetClipGeometryLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有のクリップジオメトリ。	NULL ポインター。	SetClipGeometryLookup によって設定された参照キー。
SetClipGeometryLookup と SetClipGeometryLocal のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 15 HRESULT GetOpacity(FLOAT* opacity)

このビジュアルの不透明度の値を取得します。

opacity

FLOAT*

out

不透明度の値。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	opacity が NULL です。

vtbl 16 HRESULT SetOpacity(FLOAT opacity)

ビジュアルの不透明度の値を設定します。

opacity

FLOAT

ビジュアルに設定する不透明度の値。

このパラメーターに指定できる値の範囲は 0.0 から 1.0 です。0.0 の場合、ビジュアルは完全に透明になり、1.0 の場合は完全に不透明になります。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	opacity に、許可されていない値が指定されています。

vtbl 17 HRESULT GetOpacityMaskBrush(IXpsOMBrush** opacityMaskBrush)

ビジュアルの不透明度マスクブラシの IXpsOMBrush インターフェイスへのポインターを取得します。

opacityMaskBrush

IXpsOMBrush**

out

ビジュアルの不透明度マスクブラシの IXpsOMBrush インターフェイスへのポインター。このビジュアルに不透明度マスクブラシが設定されていない場合は、NULL ポインターが返されます。

このパラメーターで返される値は、ブラシを設定するために直前に呼び出されたメソッドによって異なります。

直近に呼び出されたメソッド	opacityMaskBrush に返されるオブジェクト
SetOpacityMaskBrushLocal	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。
SetOpacityMaskBrushLookup	SetOpacityMaskBrushLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有の不透明度マスクブラシ。
SetOpacityMaskBrushLocal と SetOpacityMaskBrushLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	opacityMaskBrush が NULL です。
XPS_E_LOOKUP_INVALID_TYPE	SetStrokeBrushLookup によって設定された参照キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	参照値と一致するキー名を持つオブジェクトが見つかりませんでした。

vtbl 18 HRESULT GetOpacityMaskBrushLocal(IXpsOMBrush** opacityMaskBrush)

ビジュアルのローカルで共有されない不透明度マスクブラシを取得します。

opacityMaskBrush

IXpsOMBrush**

out

ビジュアルの不透明度マスクブラシの IXpsOMBrush インターフェイスへのポインター。不透明度マスクブラシの参照キーが設定されている場合、またはローカルの不透明度マスクブラシが設定されていない場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	opacityMaskBrush に返されるオブジェクト
SetOpacityMaskBrushLocal	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。
SetOpacityMaskBrushLookup	NULL ポインター。
SetOpacityMaskBrushLocal と SetOpacityMaskBrushLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	opacityMaskBrush が NULL です。

vtbl 19 HRESULT SetOpacityMaskBrushLocal(IXpsOMBrush* opacityMaskBrush)

IXpsOMBrush インターフェイスポインターを、ローカルで共有されない不透明度マスクブラシとして設定します。

opacityMaskBrush

IXpsOMBrush*

ローカルで共有されない不透明度マスクブラシとして設定する IXpsOMBrush インターフェイスへのポインター。NULL ポインターを指定すると、以前に割り当てられた不透明度マスクブラシがクリアされます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS	opacityMaskBrush が認識可能なインターフェイス実装を指していません。XPS ドキュメント API インターフェイスの独自実装はサポートされていません。

解説(Remarks)

SetOpacityMaskBrushLocal を呼び出すと、不透明度マスクブラシの参照キーは解放され、GetOpacityMaskBrushLookup は key パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetOpacityMaskBrush によって opacityMaskBrush に返されるオブジェクト	GetOpacityMaskBrushLocal によって opacityMaskBrush に返されるオブジェクト	GetOpacityMaskBrushLookup によって key に返される文字列
SetOpacityMaskBrushLocal (このメソッド)	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。	NULL ポインター。
SetOpacityMaskBrushLookup	SetOpacityMaskBrushLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有の不透明度マスクブラシ。	NULL ポインター。	SetOpacityMaskBrushLookup によって設定された参照キー。
SetOpacityMaskBrushLocal と SetOpacityMaskBrushLookup のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 20 HRESULT GetOpacityMaskBrushLookup(LPWSTR* key)

リソースディクショナリ内の共有の不透明度マスクブラシの参照キー名を取得します。

key

LPWSTR*

out

リソースディクショナリ内の共有の不透明度マスクブラシの参照キー名。不透明度マスクブラシの参照キーが設定されていない場合、またはローカルの不透明度マスクブラシが設定されている場合は、NULL ポインターが返されます。

直近に呼び出されたメソッド	key に返されるオブジェクト
SetOpacityMaskBrushLocal	NULL ポインター。
SetOpacityMaskBrushLookup	SetOpacityMaskBrushLookup によって設定された参照キー。
SetOpacityMaskBrushLocal と SetOpacityMaskBrushLookup のいずれもまだ呼び出されていません。	NULL ポインター。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	key が NULL です。

解説(Remarks)

vtbl 21 HRESULT SetOpacityMaskBrushLookup(LPWSTR key)

リソースディクショナリ内の共有の不透明度マスクブラシの参照キー名を設定します。

key

LPWSTR

ディクショナリ内の不透明度マスクブラシの参照キー名。NULL ポインターを指定すると、以前に割り当てられたキー名がクリアされます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY	XML Paper Specification に照らして、lookup の値が有効な参照キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE	key のルックアップキー名が、ジオメトリではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND	key に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetOpacityMaskBrushLookup を呼び出すと、ローカルの不透明度マスクブラシは解放され、GetOpacityMaskBrushLocal は opacityMaskBrush パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値と参照値の関係を示しています。

直近に呼び出されたメソッド	GetOpacityMaskBrush によって opacityMaskBrush に返されるオブジェクト	GetOpacityMaskBrushLocal によって opacityMaskBrush に返されるオブジェクト	GetOpacityMaskBrushLookup によって key に返される文字列
SetOpacityMaskBrushLocal	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。	SetOpacityMaskBrushLocal によって設定されたローカルの不透明度マスクブラシ。	NULL ポインター。
SetOpacityMaskBrushLookup (このメソッド)	SetOpacityMaskBrushLookup によって設定されたキーと一致する参照キーで、リソースディレクトリから取得される共有の不透明度マスクブラシ。	NULL ポインター。	SetOpacityMaskBrushLookup によって設定された参照キー。
SetOpacityMaskBrushLocal と SetOpacityMaskBrushLookup のいずれもまだ呼び出されていません。	NULL ポインター。	NULL ポインター。	NULL ポインター。

vtbl 22 HRESULT GetName(LPWSTR* name)

ビジュアルの Name プロパティを取得します。

name

LPWSTR*

out

Name プロパティの文字列。Name プロパティが設定されていない場合は、NULL ポインターが返されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	name が NULL です。

解説(Remarks)

このメソッドは、name で返される文字列が使用するメモリを割り当てます。name が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 23 HRESULT SetName(LPWSTR name)

ビジュアルの Name プロパティを設定します。

name

LPWSTR

ビジュアルの名前。NULL ポインターを指定すると、Name プロパティがクリアされます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_INVALID_NAME	XML Paper Specification に照らして、name に渡された文字列が有効な名前ではありません。

解説(Remarks)

名前は一意である必要があります。

name に NULL ポインターを渡して Name プロパティをクリアすると、IsHyperlinkTarget プロパティは FALSE に設定されます。

vtbl 24 HRESULT GetIsHyperlinkTarget(BOOL* isHyperlink)

ビジュアルがハイパーリンクのターゲットであるかどうかを示す値を取得します。

isHyperlink

BOOL*

out

ビジュアルがハイパーリンクのターゲットであるかどうかを示すブール値。

値	意味
TRUE	ビジュアルはハイパーリンクのターゲットです。
FALSE	ビジュアルはハイパーリンクのターゲットではありません。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	isHyperlink が NULL です。

vtbl 25 HRESULT SetIsHyperlinkTarget(BOOL isHyperlink)

ビジュアルがハイパーリンクのターゲットであるかどうかを指定します。

isHyperlink

BOOL

ビジュアルがハイパーリンクのターゲットであるかどうかを指定するブール値。

値	意味
TRUE	ビジュアルはハイパーリンクのターゲットです。
FALSE	ビジュアルはハイパーリンクのターゲットではありません。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_MISSING_NAME	ページに名前が設定されていません。ハイパーリンクターゲットの状態は、ページに名前がある場合にのみ設定できます。

解説(Remarks)

ビジュアルをハイパーリンクのターゲットとして設定するには、あらかじめビジュアルに名前を設定しておく必要があります。

vtbl 26 HRESULT GetHyperlinkNavigateUri(IUri** hyperlinkUri)

このビジュアルオブジェクトのリンク先となる IUri インターフェイスへのポインターを取得します。

hyperlinkUri

IUri**

out

リンクの宛先 URI を格納する IUri インターフェイスへのポインター。このオブジェクトに URI が設定されていない場合は、NULL ポインターが返されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	hyperlinkUri が NULL です。

vtbl 27 HRESULT SetHyperlinkNavigateUri(IUri* hyperlinkUri)

ビジュアルのハイパーリンクの宛先 URI を設定します。

hyperlinkUri

IUri*

ビジュアルのハイパーリンクの宛先 URI を格納する IUri インターフェイス。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

オブジェクトに URI を設定すると、そのオブジェクトはハイパーリンクになります。アクティブ化またはクリックされると、オブジェクトは hyperlinkUri の URI で指定された宛先に移動します。

vtbl 28 HRESULT GetLanguage(LPWSTR* language)

ビジュアルとその内容の Language プロパティを取得します。

language

LPWSTR*

out

ページの言語を指定する言語文字列。言語が設定されていない場合は、NULL ポインターが返されます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
E_POINTER	language が NULL です。

解説(Remarks)

このメソッドで設定される Language プロパティは、リソースの内容の言語を指定します。

このメソッドは、language で返される文字列が使用するメモリを割り当てます。language が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

Language プロパティの推奨されるエンコードは、Internet Engineering Task Force (IETF) RFC 3066 で規定されています。

vtbl 29 HRESULT SetLanguage(LPWSTR language)

ビジュアルの Language プロパティを設定します。

language

LPWSTR

ビジュアルとその内容の言語を指定する言語文字列。NULL ポインターを指定すると、Language プロパティがクリアされます。

戻り値

戻り値	説明
S_OK	メソッドは成功しました。
XPS_E_INVALID_LANGUAGE	language の値の形式が正しくないか、有効でない言語が指定されています。

解説(Remarks)

Language プロパティの推奨されるエンコードは、Internet Engineering Task Force (IETF) RFC 3066r で規定されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IXpsOMVisual "{BC3E7333-FB0B-4AF3-A819-0B4EAAD0D2FD}"
#usecom global IXpsOMVisual IID_IXpsOMVisual "{}"
#comfunc global IXpsOMVisual_GetTransform               5 sptr
#comfunc global IXpsOMVisual_GetTransformLocal          6 sptr
#comfunc global IXpsOMVisual_SetTransformLocal          7 sptr
#comfunc global IXpsOMVisual_GetTransformLookup         8 var
#comfunc global IXpsOMVisual_SetTransformLookup         9 wstr
#comfunc global IXpsOMVisual_GetClipGeometry            10 sptr
#comfunc global IXpsOMVisual_GetClipGeometryLocal       11 sptr
#comfunc global IXpsOMVisual_SetClipGeometryLocal       12 sptr
#comfunc global IXpsOMVisual_GetClipGeometryLookup      13 var
#comfunc global IXpsOMVisual_SetClipGeometryLookup      14 wstr
#comfunc global IXpsOMVisual_GetOpacity                 15 var
#comfunc global IXpsOMVisual_SetOpacity                 16 float
#comfunc global IXpsOMVisual_GetOpacityMaskBrush        17 sptr
#comfunc global IXpsOMVisual_GetOpacityMaskBrushLocal   18 sptr
#comfunc global IXpsOMVisual_SetOpacityMaskBrushLocal   19 sptr
#comfunc global IXpsOMVisual_GetOpacityMaskBrushLookup  20 var
#comfunc global IXpsOMVisual_SetOpacityMaskBrushLookup  21 wstr
#comfunc global IXpsOMVisual_GetName                    22 var
#comfunc global IXpsOMVisual_SetName                    23 wstr
#comfunc global IXpsOMVisual_GetIsHyperlinkTarget       24 var
#comfunc global IXpsOMVisual_SetIsHyperlinkTarget       25 int
#comfunc global IXpsOMVisual_GetHyperlinkNavigateUri    26 sptr
#comfunc global IXpsOMVisual_SetHyperlinkNavigateUri    27 sptr
#comfunc global IXpsOMVisual_GetLanguage                28 var
#comfunc global IXpsOMVisual_SetLanguage                29 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IXpsOMVisual "{BC3E7333-FB0B-4AF3-A819-0B4EAAD0D2FD}"
#usecom global IXpsOMVisual IID_IXpsOMVisual "{}"
#comfunc global IXpsOMVisual_GetTransform               5 sptr
#comfunc global IXpsOMVisual_GetTransformLocal          6 sptr
#comfunc global IXpsOMVisual_SetTransformLocal          7 sptr
#comfunc global IXpsOMVisual_GetTransformLookup         8 sptr
#comfunc global IXpsOMVisual_SetTransformLookup         9 wstr
#comfunc global IXpsOMVisual_GetClipGeometry            10 sptr
#comfunc global IXpsOMVisual_GetClipGeometryLocal       11 sptr
#comfunc global IXpsOMVisual_SetClipGeometryLocal       12 sptr
#comfunc global IXpsOMVisual_GetClipGeometryLookup      13 sptr
#comfunc global IXpsOMVisual_SetClipGeometryLookup      14 wstr
#comfunc global IXpsOMVisual_GetOpacity                 15 sptr
#comfunc global IXpsOMVisual_SetOpacity                 16 float
#comfunc global IXpsOMVisual_GetOpacityMaskBrush        17 sptr
#comfunc global IXpsOMVisual_GetOpacityMaskBrushLocal   18 sptr
#comfunc global IXpsOMVisual_SetOpacityMaskBrushLocal   19 sptr
#comfunc global IXpsOMVisual_GetOpacityMaskBrushLookup  20 sptr
#comfunc global IXpsOMVisual_SetOpacityMaskBrushLookup  21 wstr
#comfunc global IXpsOMVisual_GetName                    22 sptr
#comfunc global IXpsOMVisual_SetName                    23 wstr
#comfunc global IXpsOMVisual_GetIsHyperlinkTarget       24 sptr
#comfunc global IXpsOMVisual_SetIsHyperlinkTarget       25 int
#comfunc global IXpsOMVisual_GetHyperlinkNavigateUri    26 sptr
#comfunc global IXpsOMVisual_SetHyperlinkNavigateUri    27 sptr
#comfunc global IXpsOMVisual_GetLanguage                28 sptr
#comfunc global IXpsOMVisual_SetLanguage                29 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。