IXpsOMPage

1 ページ分の内容を保持するオブジェクトツリーのルートノードを提供します。

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

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
}

プログラム内でこのインターフェイスを使用する方法については、Create a Blank XPS OM および Navigate the XPS OM を参照してください。

ページを保持している IXpsOMPageReference インターフェイスへのポインターを取得します。

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

ページに所有者がない場合は、pageReference に NULL ポインターが返されます。

ページのビジュアルオブジェクトのコレクションを保持する IXpsOMVisualCollection インターフェイスへのポインターを取得します。

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

ページの寸法を取得します。

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

既定のページサイズは、IXpsOMObjectFactory::CreatePage の pageDimensions パラメーターに渡されます。

ページの寸法を設定します。

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

ページのコンテンツボックスの寸法を取得します。

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

コンテンツボックスは、ページ上でインク (描画内容) が表示される領域を示します。

ページの既定のコンテンツボックスは次のとおりです。

ページのコンテンツボックスの寸法を設定します。

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

コンテンツボックスは、ページ上でインク (描画内容) が表示される領域を指定します。

コンテンツボックスの寸法は、ページがシリアル化されるまでページの寸法と照合されません。

ページのブリードボックスの寸法を取得します。

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

ページの既定のブリードボックスは次のとおりです。

ページのブリードボックスの寸法を設定します。

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

ブリードボックスの寸法は、ページがシリアル化されるまでページの寸法と照合されません。

ページの Language プロパティを取得します。

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

既定値は、IXpsOMObjectFactory::CreatePage の language パラメーターに渡される言語タグ文字列です。

language に返される言語タグ文字列の推奨されるエンコード方法は、Internet Engineering Task Force (IETF) RFC 3066 に記載されています。

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

ページの Language プロパティを設定します。

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

言語タグ文字列は、Internet Engineering Task Force (IETF) RFC 3066 に記載されている言語タグの構文に従っている必要があります。詳細については、http://tools.ietf.org/html/rfc3066 を参照してください。

ページの Name プロパティを取得します。

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

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

このページの Name プロパティを設定します。

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

Name プロパティは、現在のページをドキュメント内の名前付きでアドレス指定可能な位置として識別し、ハイパーリンクからページを参照できるようにします。

ページがハイパーリンクのターゲットかどうかを示すブール値を取得します。

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

ページがハイパーリンクのターゲットかどうかを指定します。

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

このプロパティが TRUE に設定されているページのみが、IXpsOMPageReference::CollectLinkTargets によって収集されるハイパーリンクターゲットに含まれます。

このページに関連付けられている、解決済みの IXpsOMDictionary インターフェイスへのポインターを取得します。

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

ディクショナリがローカルであるか、リモートディクショナリリソースに含まれているかにかかわらず、このメソッドは IXpsOMDictionary インターフェイスポインターを返します。ディクショナリがリモートかどうかは GetOwner で判断します。

ページにリモートディクショナリが含まれている場合、GetDictionary はそのディクショナリを逆シリアル化します。ページに含まれるリモートディクショナリが有効でない場合、GetDictionary は逆シリアル化のエラーコードを返すことがあります。

リソースを XPS OM に読み込んで解析した後、このメソッドは別のリソースに関するエラーを返すことがあります。これは、リソースの読み込み時にすべての関係が解析されるためです。

このページに関連付けられている、ローカルで共有されないディクショナリの IXpsOMDictionary インターフェイスへのポインターを取得します。

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

ページのローカルディクショナリリソースの IXpsOMDictionary インターフェイスポインターを設定します。

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

SetDictionaryLocal を呼び出すと、リモートディクショナリリソースは解放され、GetDictionaryResource は remoteDictionaryResource パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とリモート値の関係を示しています。

このページが使用する共有ディクショナリリソースの IXpsOMRemoteDictionaryResource インターフェイスへのポインターを取得します。

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

リソースを XPS OM に読み込んで解析した後、このメソッドは別のリソースに関するエラーを返すことがあります。これは、リソースの読み込み時にすべての関係が解析されるためです。

ページのリモートディクショナリリソースの IXpsOMRemoteDictionaryResource インターフェイスポインターを設定します。

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

この値を設定すると、GetDictionaryLocal は NULL を返すようになります。

指定されたストリームにページを書き込みます。

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

ページを XPS パッケージに書き込む前にその XPS マークアップを確認するには、アプリケーションから Write メソッドを呼び出してページの内容をストリームに書き込みます。その後、アプリケーションはそのストリームを読み取り、XPS パッケージへの書き込み時にシリアル化されるのと同じ XPS マークアップを確認できます。

このメソッドによってストリームに書き込まれる XPS マークアップには、ページのマークアップは含まれますが、ページのリソースは含まれません。

リソースディクショナリ内のリソースがルックアップキーとして使用できる、一意の名前を生成します。

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

ディクショナリ内で一意になるように、GenerateUnusedLookupKey が生成する文字列は、オブジェクトの型に基づくプレフィックス文字列と、それに続く一意な 4 文字の英数字で構成されます。

各オブジェクト型のプレフィックス文字列を次の表に示します。

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

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

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

新しいインターフェイスの所有者は NULL になります。