IXpsOMVisualBrush

ビジュアル要素をソースとして使用するブラシです。

次のコード例は、このインターフェイスのインスタンスを作成する方法を示しています。

IXpsOMVisualBrush        *newInterface;

// CoInitializeEx がこのスレッドから事前に呼び出されている
//  ことが暗黙の前提となる点に注意してください。

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateVisualBrush (
        &viewBox,
        &viewPort,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // 次のいずれかの方法でビジュアルを割り当てます:
        newInterface->SetVisualLocal (localVisual);
        // または
        newInterface->SetVisualLookup (visualLookupKey);
        // newInterface を使用します

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // hr に返された HRESULT エラーを評価します
}
// newInterface を使用します

newInterface->Release();
xpsFactory->Release();

ブラシのソースとして使用される、解決済みのビジュアルのインターフェイスへのポインターを取得します。

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

このメソッドは IXpsOMVisual インターフェイスポインターを返します。ただし、返されるインターフェイスは、IXpsOMCanvas、IXpsOMPath、IXpsOMGlyphs など、IXpsOMVisual を継承する任意のインターフェイスである可能性があります。

ブラシのソースとして使用される、ローカルで共有されないビジュアルのインターフェイスへのポインターを取得します。

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

このメソッドは IXpsOMVisual インターフェイスポインターを返します。ただし、返されるインターフェイスは、IXpsOMCanvas、IXpsOMPath、IXpsOMGlyphs など、IXpsOMVisual を継承する任意のインターフェイスである可能性があります。

ブラシのソースとして使用される、ローカルで共有されないビジュアルのインターフェイスポインターを設定します。

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

SetVisualLocal を呼び出すと、ビジュアルのルックアップキーは解放され、GetVisualLookup は lookup パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

ブラシのソースとして使用されるビジュアルについて、リソースディクショナリ内のルックアップキー名を取得します。

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

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

ブラシのソースとして使用される、リソースディクショナリに格納された共有ビジュアルのルックアップキー名を設定します。

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

SetVisualLookup を呼び出すと、ローカルのビジュアルは解放され、GetVisualLocal は visual パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

インターフェイスのディープコピーを作成します。(IXpsOMVisualBrush.Clone)

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

このメソッドは、新しい IXpsOMVisualBrush インターフェイス内のリソースポインターを更新しません。