IXpsOMObjectFactory

XPS ドキュメント オブジェクト モデルのオブジェクトを作成します。

XPS オブジェクト モデルのドキュメント ツリーのルート ノードとなる IXpsOMPackage インターフェイスを作成します。

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

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

IXpsOMPackage    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePackage (&newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }

    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

プログラムで IXpsOMPackage インターフェイスを使用する方法については、空の XPS OM の作成を参照してください。

XPS パッケージ ファイルを開き、インスタンス化された XPS ドキュメント オブジェクト ツリーを返します。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

このメソッドは、ストリームから XPS OM のオブジェクトに読み込むストリームベースのリソースの内容を検証しません。これらのリソースは、使用する前にアプリケーション側で検証する必要があります。

このメソッドはドキュメントのページを逆シリアル化しません。XPS パッケージをページ参照パートまでしか逆シリアル化しません。実際のページは、必要に応じて IXpsOMPageReference::GetPage メソッドを呼び出して逆シリアル化できます。GetPage の呼び出し時点ではページが逆シリアル化されていないため、このメソッドは S_OK を返すこともあれば、XPS パッケージ内の問題のあるページを読み込もうとした場合にエラーを返すこともあります。

XPS パッケージを XPS OM に読み込んだ直後に XPS OM を書き出すと、元のコンテンツの一部が失われたり変更されたりする場合があります。

そのような場合に発生し得る変更の一部を次の表に示します。

プログラムで IXpsOMPackage インターフェイスを使用する方法については、空の XPS OM の作成を参照してください。

XPS パッケージを含むストリームを開き、インスタンス化された XPS ドキュメント オブジェクト ツリーを返します。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

このメソッドは、ストリームから XPS OM のオブジェクトに読み込むストリームベースのリソースの内容を検証しません。これらのリソースは、使用する前にアプリケーション側で検証する必要があります。

このメソッドはドキュメントのページを逆シリアル化しません。XPS パッケージをページ参照パートまでしか逆シリアル化しません。実際のページは、必要に応じて IXpsOMPageReference::GetPage メソッドを呼び出して逆シリアル化できます。GetPage の呼び出し時点ではページが逆シリアル化されていないため、このメソッドは S_OK を返すこともあれば、XPS パッケージ内の問題のあるページを読み込もうとした場合にエラーを返すこともあります。

XPS パッケージを XPS OM に読み込んだ直後に XPS OM を書き出すと、元のコンテンツの一部が失われたり変更されたりする場合があります。

そのような場合に発生し得る変更の一部を次の表に示します。

プログラムで IXpsOMPackage インターフェイスを使用する方法については、空の XPS OM の作成を参照してください。

ページの StoryFragments パートのリソース ストリームの内容にアクセスできる IXpsOMStoryFragmentsResource インターフェイスを作成します。

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

ページの StoryFragments パートには、単一の固定ページに関連付けられた 1 つ以上のストーリーの一部分について、その構造を記述する XML マークアップが含まれます。StoryFragments パートの XML マークアップが記述するドキュメントの内容には、そのページに存在するストーリーの表や段落などがあります。

DocumentStructure パートおよび StoryFragments パートの XML マークアップについては、XML Paper Specification で説明されています。

ドキュメント構造リソース ストリームにアクセスできる IXpsOMDocumentStructureResource インターフェイスを作成します。

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

XPS ドキュメントの DocumentStructure パートにはドキュメントのアウトラインが含まれ、このアウトラインは StoryFragments パートとともに、ドキュメントの固定ページに出現するすべての要素の読み取り順序を定義します。このインターフェイスを使用すると、プログラムから DocumentStructure パートの XML 内容を読み取り、また置き換えることができます。

DocumentStructure パートには、ドキュメントのフレームワークと、ドキュメント全体の読み取り順序を記述するアウトラインが含まれます。読み取り順序は、ストーリーと呼ばれる意味的なブロックに整理されます。ストーリーは、雑誌における記事と同じように、ドキュメントの論理的な単位です。ストーリーは 1 つ以上の StoryFragments パートで構成されます。

StoryFragments パートには、ストーリーの内容を構成する段落や表など、ストーリーの意味的なブロックを定義するコンテンツ構造マークアップが含まれます。

DocumentStructure パートおよび StoryFragments パートの内容については、XML Paper Specification で説明されています。

1 つ以上の署名要求を格納できる IXpsOMSignatureBlockResource を作成します。

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

プロパティ リソースの共有を可能にする IXpsOMRemoteDictionaryResource インターフェイスを作成します。

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

リモート リソース ディクショナリのマークアップを、ルートに接続されていない IXpsOMRemoteDictionaryResource インターフェイスに読み込みます。

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

パートベースのリソースを格納できる IXpsOMPartResources インターフェイスを作成します。

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

パート リソースはドキュメントのページ間で共有され、フォント、イメージ、カラー プロファイル、リモート ディクショナリなどを含めることができます。

ドキュメントのパート リソースを取得するには、IXpsOMPageReference::CollectPartResources を呼び出します。

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

IXpsOMPartResources    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartResources (&newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

XPS ドキュメントの IXpsOMDocument インターフェイスを格納できる IXpsOMDocumentSequence インターフェイスを作成します。

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

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

IXpsOMDocumentSequence    *newInterface;
IOpcPartUri               *partUri;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateDocumentSequence (partUri, &newInterface);

        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

順序付けられたシーケンスとして一連の IXpsOMPageReference インターフェイスを格納できる IXpsOMDocument インターフェイスを作成します。

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

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

IXpsOMDocument    *newInterface;
IOpcPartUri       *partUri;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateDocument (partUri, &newInterface);
        
        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

ページの仮想化を可能にする IXpsOMPageReference インターフェイスを作成します。

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

ページ参照を使用すると、ページの完全なオブジェクト モデルの読み込みを、明示的に要求されるまで遅延させることができます。ページが変更されていない場合は、要求に応じてアンロードできます。

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

IXpsOMPageReference    *newInterface;
// The following value is defined outside of 
// this example.
XPS_SIZE        advisoryPageDimensions;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePageReference (
        &advisoryPageDimensions,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

1 ページ分の内容を表すオブジェクト ツリーのルート ノードを提供する IXpsOMPage インターフェイスを作成します。

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

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

IXpsOMPage        *newInterface;
// The following values are defined outside of 
// this example.
//  LPWSTR        language;
//  XPS_SIZE      pageDimensions;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreatePage (
            &pageDimensions,
            language,
            partUri,
            &newInterface);

        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

指定されたストリームからページ マークアップを読み取り、IXpsOMPage インターフェイスを作成して内容を設定します。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

このメソッドは、ストリームからドキュメント オブジェクトに読み込むストリームベースのリソースの内容を検証しません。これらのリソースは、使用する前にアプリケーション側で検証する必要があります。

ページ要素をグループ化するために使用する IXpsOMCanvas インターフェイスを作成します。

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

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

IXpsOMCanvas    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateCanvas (&newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

ページに表示されるテキストを指定する IXpsOMGlyphs インターフェイスを作成します。

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

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

IXpsOMGlyphs       *newInterface;
// this interface is defined outside of this example
//  IXpsOMFontResource *font; 

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGlyphs (font, &newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

ページ上のグラフィック パス要素を指定する IXpsOMPath インターフェイスを作成します。

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

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

IXpsOMPath    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePath (&newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

パスまたはクリッピング領域の形状を指定する IXpsOMGeometry インターフェイスを作成します。

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

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

IXpsOMGeometry    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGeometry (&newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

IXpsOMGeometry インターフェイスで定義されるオブジェクトの一部分を指定する IXpsOMGeometryFigure インターフェイスを作成します。

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

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

IXpsOMGeometryFigure    *newInterface;
// startPoint contains the starting point
// of the geometry figure being created
XPS_POINT                startPoint = {0,0};

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGeometryFigure (&startPoint, &newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

アフィン行列変換を指定する IXpsOMMatrixTransform インターフェイスを作成します。

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

この行列で指定される変換は、他の XPS オブジェクトの変換プロパティに適用できます。

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

IXpsOMMatrixTransform    *newInterface;
// The following value is defined outside of 
// this example.
XPS_MATRIX        newMatrix;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateMatrixTransform (
        &newMatrix,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

単一の単色によるブラシを指定する IXpsOMSolidColorBrush インターフェイスを作成します。

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

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

IXpsOMSolidColorBrush             *newInterface;
// The following values are defined outside of 
// this example.
//  XPS_COLOR                     color;
//  IXpsOMColorProfileResource    *colorProfile;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateSolidColorBrush (
        &color,
        colorProfile,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

カラー プロファイル リソース ストリームにアクセスするために使用する IXpsOMColorProfileResource インターフェイスを作成します。

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

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

IXpsOMColorProfileResource    *newInterface;
IOpcPartUri                   *partUri;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    // The partUriString and acquiredStream variables 
    //   are defined outside of this example.
    hr = xpsFactory->CreatePartUri(
        partUriString, 
        &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateColorProfileResource (
            acquiredStream, 
            partUri,
            &newInterface);
        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

IXpsOMImageBrush インターフェイスを作成します。

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

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

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

次の図では、左側のイメージがソース イメージの例であり、右端がビューボックスを選択した結果得られるブラシです。

ソース イメージの解像度が 96 × 96 dpi で、イメージのサイズが 96 × 96 ピクセルの場合、viewbox パラメーターの各フィールドの値は次のようになります。

上記のパラメーター値は、ソース イメージ上の次の位置に対応します。

SourceLeft = (96 × 48) / 96 = 左端から 48 ピクセル

SourceTop = (96 × 24) / 96 = 上端から 24 ピクセル

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

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

イメージ ブラシは、イメージまたはその一部を取り込み、それを変換してタイルを作成し、生成されたタイルをビューポート (出力領域におけるタイルの配置先ジオメトリ) に配置して、タイル モードに従って出力領域を塗りつぶすタイル ブラシです。

viewport は、出力領域内で最初のタイルが占める領域です。ビューポートのイメージは、タイル モードに従って出力領域全体に繰り返し描画されます。

次の図は、イメージ ブラシを使用して出力領域を塗りつぶす方法を示しています。左から右へ、元のイメージがビューポートを埋めるように変換され、出力領域のビューポート領域に配置され、さらにタイル状に並べられて出力領域を塗りつぶします。

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

IXpsOMImageBrush            *newInterface;
// The following values are defined outside of 
// this example.
//  IXpsOMImageResource     *image;
//  XPS_RECT                viewBox;
//  XPS_RECT                viewPort;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

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

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

ビジュアル オブジェクトを使用する IXpsOMTileBrush である IXpsOMVisualBrush インターフェイスを作成します。

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

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

IXpsOMVisualBrush        *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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))
    {
        // assign visual using one of the following:
        newInterface->SetVisualLocal (localVisual);
        // or
        newInterface->SetVisualLookup (visualLookupKey);
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}
// use newInterface

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

イメージ リソース ストリームにアクセスするために使用する IXpsOMImageResource インターフェイスを作成します。

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

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

IXpsOMImageResource    *newInterface;
// The following values are defined outside of 
// this example.
//  IStream            *acquiredStream;
//  XPS_IMAGE_TYPE     contentType;
//  IOpcPartUri        *partUri;
    
// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    // The partUriString and acquiredStream variables 
    //   are defined outside of this example.
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateImageResource (
            acquiredStream,
            contentType,
            partUri,
            &newInterface);
        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

PrintTicket ストリームにアクセスできる IXpsOMPrintTicketResource インターフェイスを作成します。

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

フォント リソースへの IStream インターフェイスを提供する IXpsOMFontResource インターフェイスを作成します。

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

isObfSourceStream の値は、フォント リソースの作成時点における acquiredStream が参照するストリームの状態を表します。以後の GetStream または SetContent の呼び出しは、難読化されていない IStream に対して行われます。

isObfSourceStream が TRUE に設定され、fontEmbedding が XPS_FONT_EMBEDDING_NORMAL に設定されている場合、または partUri が参照する名前が難読化ストリームの構文に従っていない場合は、エラーが返されます。

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

IXpsOMFontResource    *newInterface;
IOpcPartUri           *partUri;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    // The partUriString and acquiredStream variables 
    //   are defined outside of this example.
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateFontResource (
            acquiredStream, 
            XPS_FONT_EMBEDDING_NORMAL,    // normal
            partUri, 
            FALSE,                        // not obfuscated
            &newInterface);
        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

グラデーション内の単一の色と位置の定義を表す IXpsOMGradientStop インターフェイスを作成します。

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

グラデーション ストップは、特定の位置における色を定義するために使用されます。色はグラデーション ストップ間で補間されます。offset で指定するオフセットは、グラデーションの開始点と終了点の間の相対位置です。線形グラデーションの開始点、または放射状グラデーションの原点におけるオフセットは 0.0 です。線形グラデーションの終了点、または放射状グラデーションの境界となる楕円のオフセットは 1.0 です。グラデーション ストップは、開始点と終了点を含め、これらの間の任意のオフセットに指定できます。次の図は、線形グラデーションのグラデーション パスとグラデーション ストップを示しています。

次の図は、放射状グラデーションのグラデーション ストップを示しています。この例では、放射状グラデーション領域は外側の楕円で囲まれた領域であり、グラデーション領域の外側の空間を塗りつぶすために XPS_SPREAD_METHOD_REFLECT スプレッド メソッドが使用されています。

IXpsOMGradientStop インターフェイスは、グラデーション内のただ 1 つのストップを指定します。

グラデーションの描画に使用される計算については、XML Paper Specification で説明されています。

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

IXpsOMGradientStop    *newInterface;
// The following values are defined outside of 
// this example.
//  XPS_COLOR                    color;
//  IXpsOMColorProfileResource    *colorProfile;
//  FLOAT                        offset;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGradientStop (
        &color,
        colorProfile,
        offset,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

IXpsOMLinearGradientBrush インターフェイスを作成します。

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

線形グラデーションのグラデーション領域は、開始点と終了点を含むその間の領域であり、グラデーション パスに対して直角方向の両側に広がります。スプレッド領域は、グラデーション領域の外側にあるジオメトリの領域です。

グラデーション ストップは、グラデーション パス上の特定の位置における色を定義します。図では、gradStop1 パラメーターで指定されるグラデーション ストップ 0 がグラデーション パスの開始点に位置し、gradStop2 パラメーターで指定されるグラデーション ストップ 1 が終了点に位置します。

次の図に示すように、線形グラデーションの開始点と終了点は、それらの点を結ぶ直線であるグラデーション パスの開始点と終了点でもあります。

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

IXpsOMLinearGradientBrush    *newInterface;
// The following values are defined outside of 
// this example.
//  IXpsOMGradientStop       *gradStop1, *gradStop2;
//  XPS_POINT                startPoint, endPoint;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateLinearGradientBrush (
        gradStop1,
        gradStop2,
        &startPoint,
        &endPoint,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

IXpsOMRadialGradientBrush インターフェイスを作成します。

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

次の図に示すように、放射状グラデーションのグラデーション領域は、中心点と、中心点から伸びる x 半径および y 半径によって表される楕円で囲まれた領域です。スプレッド領域は、その楕円の外側の領域です。グラデーション パス (図には示していません) は、グラデーションの原点と、グラデーション領域を囲む楕円との間に引かれる放射状の線です。

放射状グラデーション ブラシでは、gradStop1 パラメーターで設定するグラデーション ストップが、グラデーションの原点の位置とオフセット値 0.0 に対応します。gradStop2 パラメーターで設定するグラデーション ストップは、グラデーション領域の外周とオフセット値 1.0 に対応します。グラデーション ストップの詳細については、IXpsOMGradientStop を参照してください。

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

IXpsOMRadialGradientBrush    *newInterface;
// The following values are defined outside of 
// this example.
//  IXpsOMGradientStop       *gradStop1, *gradStop2;
//  XPS_POINT                centerPoint, gradientOrigin;
//  XPS_SIZE                 radiiSizes;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateRadialGradientBrush (
        gradStop1,
        gradStop2,
        &centerPoint,
        &gradientOrigin,
        &radiiSizes,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

XPS ドキュメントを説明するメタデータを格納する IXpsOMCoreProperties インターフェイスを作成します。

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

プロパティ リソースの共有を可能にする IXpsOMDictionary インターフェイスを作成します。

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

IOpcPartUri インターフェイス ポインターを格納できる IXpsOMPartUriCollection インターフェイスを作成します。

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

XPS OM の内容を XPS パッケージに書き込むためのファイルを開きます。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

ファイルが開かれて初期化され、返された IXpsOMPackageWriter インターフェイスを使用して、コンテンツ タイプ、パッケージのリレーションシップ、コア プロパティ、ドキュメント シーケンス リソース、ドキュメント シーケンスのリレーションシップを書き込みます。

documentSequencePrintTicket が NULL に設定され、interleaving の値が XPS_INTERLEAVING_ON の場合、このメソッドは空のジョブ レベルの印刷チケットを作成し、その空の印刷チケットへのリレーションシップを追加します。これは、パッケージのストリーミング処理をより効率的に行うためです。

documentSequencePrintTicket が NULL に設定され、interleaving の値が XPS_INTERLEAVING_OFF の場合、空の印刷チケットは作成されません。

XPS OM の内容を XPS パッケージに書き込むためのストリームを開きます。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

ストリームが開かれて初期化され、返された IXpsOMPackageWriter インターフェイスを使用して、コンテンツ タイプ、パッケージのリレーションシップ、コア プロパティ、ドキュメント シーケンス リソース、ドキュメント シーケンスのリレーションシップを書き込みます。

documentSequencePrintTicket が NULL に設定され、interleaving の値が XPS_INTERLEAVING_ON の場合、このメソッドは空のジョブ レベルの印刷チケットを作成し、その空の印刷チケットへのリレーションシップを追加します。これは、パッケージのストリーミング処理をより効率的に行うためです。

documentSequencePrintTicket が NULL に設定され、interleaving の値が XPS_INTERLEAVING_OFF の場合、空の印刷チケットは作成されません。

指定された URI を使用する IOpcPartUri インターフェイスを作成します。

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

指定されたファイルに対する読み取り専用の IStream を作成します。

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

このメソッドは Packaging API を呼び出します。Packaging API の戻り値については、パッケージ化エラーを参照してください。

CreateReadOnlyStreamOnFile は IOpcFactory::CreateStreamOnFile のラッパー メソッドです。次の呼び出しと同じ効果があります。

    hr = opcFactory->CreateStreamOnFile (
        fileName,
        OPC_STREAM_IO_READ,
        NULL,
        FILE_ATTRIBUTE_NORMAL,
        &stream);