IXpsOMCanvas

ビジュアル要素と関連するプロパティのグループです。

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

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
}

キャンバス内のビジュアルオブジェクトのコレクションを格納する IXpsOMVisualCollection インターフェースへのポインターを取得します。

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

キャンバス内のオブジェクトのエッジをエイリアスエッジモードでレンダリングするかどうかを決定するブール値を取得します。

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

このメソッドが返すプロパティは、ドキュメントマークアップ内の Canvas 要素の RenderOptions.EdgeMode 属性に対応します。

このキャンバス内のオブジェクトのエッジをエイリアスエッジモードでレンダリングするかどうかを決定する値を設定します。

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

このプロパティは、ドキュメントマークアップ内の Canvas 要素の RenderOptions.EdgeMode 属性に対応します。

オブジェクトの内容に関する短いテキストの説明を取得します。

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

このメソッドが返すプロパティは、ドキュメントマークアップ内の Canvas 要素の AutomationProperties.Name 属性に対応します。

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

オブジェクトの内容に関する短いテキストの説明を設定します。(IXpsOMCanvas.SetAccessibilityShortDescription)

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

このメソッドで設定されるプロパティは、ドキュメントマークアップ内の Canvas 要素の AutomationProperties.HelpText 属性に対応します。

オブジェクトの内容に関する長い (詳細な) テキストの説明を取得します。(IXpsOMCanvas.GetAccessibilityLongDescription)

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

このメソッドが返すプロパティは、ドキュメントマークアップ内の Canvas 要素の AutomationProperties.HelpText 属性に対応します。

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

オブジェクトの内容に関する長い (詳細な) テキストの説明を設定します。(IXpsOMCanvas.SetAccessibilityLongDescription)

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

このメソッドで設定されるプロパティは、ドキュメントマークアップ内の Canvas 要素の AutomationProperties.HelpText 属性に対応します。

キャンバスに関連付けられたディクショナリの、解決済みの IXpsOMDictionary インターフェースへのポインターを取得します。

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

GetDictionary は、ローカルディクショナリまたはリモートディクショナリのインターフェースポインターを返すことがあります。ディクショナリがローカルかリモートかを判断するには、GetOwner を呼び出します。

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

ローカルの非共有ディクショナリの IXpsOMDictionary インターフェースへのポインターを取得します。

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

このメソッドがリソースを XPS OM に読み込んで解析するとき、別のリソースに関するエラーを返す場合があります。これは、リソースの読み込み時にすべてのリレーションシップが解析されるためです。

このメソッドが返す可能性があるその他の戻り値については、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 は resourceDictionary パラメーターに NULL ポインターを返します。

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

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

新しいインターフェースの所有者は NULL です。