次の方法で共有


ParameterDef 要素と ParameterInit 要素

このトピックは最新ではありません。 最新の情報については、「印刷スキーマ仕様」を参照してください。

ParameterDef 要素は ParameterInit 要素とは異なり、ParameterInit 要素に含めることができる値を記述しますが、ParameterInit 要素はパラメーターに値を割り当てます。 ParameterDef 要素は、データの型、最大値、最小値、および既定値、およびその他の情報を指定する、ParameterDef 要素の子である特定の Property 要素のセットで構成されます。 これらの Property 要素については、このトピックの後半で説明します。

ParameterDef 要素は、許可されたコンテキストでのみ使用できます。 印刷スキーマの初期バージョンでは、PrintCapabilities ドキュメントのルート レベルに配置できます。 ParameterDef 要素の name 属性は、パラメーター名を定義します。 PrintCapabilities ドキュメント内の各 ParameterDef 要素には、一意の名前属性を割り当てる必要があります。

手記

印刷機能ドキュメント プロバイダー:

パラメーター名の意味は汎用です。つまり、ある PrintCapabilities ドキュメント内の ParameterDef 要素に、別の PrintCapabilities ドキュメントの ParameterDef 要素と同じ名前属性 (名前空間から形成された文字列と ParameterDef 要素のわかりやすい名前) がある場合、これらの要素の両方が同じ概念を表し、同じ方法で解釈される必要があります。 したがって、1 つの PrintCapabilities ドキュメントの PrintTicket で定義されている ParameterDef 要素を使用して、別の PrintCapabilities ドキュメントで定義されている同じ名前の ParameterInit 要素を初期化できます。

XML 属性との関係

すべての名前属性に当てはまるように、パラメーター名は XML QName の形式になります。 スキーマ定義パラメーター コンストラクトにはパブリック名前空間によって修飾される名前があり、name 属性を形成します。一方、プライベートに定義されたパラメーター コンストラクトの name 属性は、作成者に固有のプライベート名前空間によって修飾されます。

ParameterDef と Property 要素型の関係

印刷スキーマ キーワードで定義されている ParameterDef 要素は、PrintCapabilities ドキュメントで完全に定義する必要があります。 印刷スキーマ キーワード ドキュメントは、ParameterDef 要素の一部の Property 要素 (DefaultValue など) の標準値を提供しますが、PrintCapabilities ドキュメントの作成者は、残りの Property 要素を定義します。 いずれの場合も、印刷スキーマ キーワードで定義されているものも含め、すべての Property 要素を ParameterDef 要素で明示的に定義する必要があります。

印刷スキーマ キーワードに表示される各 ParameterDef 要素の特定の Property 要素は、変更できない 指定されます。 つまり、Print Schema Keywords で定義された ParameterDef 要素のすべての PrintCapabilities ドキュメント定義は、これらの Property 要素を変更せずに保持する必要があります。 これらの変更できない Property 要素を使用すると、すべての PrintCapabilities ドキュメントでパラメーター コンストラクトを移植可能で明確にすることができます。 主な例は、ParameterDef 要素で使用される単位です。 これらのユニットは、その意味の一貫した理解を促進するために、不変である必要があります。 変更不可として指定された ParameterDef のプロパティ要素は、PrintCapabilities ドキュメント内で再定義できます。

ParameterDef 要素は、次の Property 要素で構成されます。 特に明記されていない限り、すべてが存在する必要があります。

プロパティ名 価値観 形容 不変。
DataType
整数
小数

既定値はありません。
パラメーター値が整数か浮動小数点数か、テキスト文字列かを指定します。 パラメーターの値は、対応する XSD 基本データ型と同じ形式で表されます。つまり、整数、10 進数、または文字列です。
はい
DefaultValue
DataType プロパティで指定された型。
既定値はありません。
ユーザー インターフェイス (UI) コントロールの初期化に使用する値を指定します。
  • 又は
関連するパラメーター要素が PrintTicket に存在しない場合に使用する値を指定します。
いいえ
必須
無条件: ParameterInit 要素は常に指定する必要があります。
条件付き: ParameterInit 要素は、パラメーターが PrintTicket の Option 要素内で参照されている場合にのみ必要です。
DefaultValue: 条件付き。
ParameterInit 要素が明示的に出現する必要があるタイミングを示します。 条件の場合、PrintTicket にパラメーターを参照するオプションが含まれている場合は、ParameterInit を初期化する必要があります。
UI クライアントおよび PrintCapabilities または PrintTicket プロバイダーによって使用されます。 制約では、ParameterDef 要素の Mandatory プロパティを無条件に設定する必要があります。 ParameterDef には定義された値が必要です。それ以外の場合は、依存する値または制約を評価できませんでした。
いいえ
MaxLength
DataType プロパティが文字列を指定する場合は整数。
DefaultValue: 最大値は適用されません。
文字列値パラメーターの場合は、許可される文字列の最長を指定します。 UI および PrintCapabilities または PrintTicket プロバイダーは、このプロパティを使用して ParameterDef 要素を検証します。
いいえ
MaxValue
DataType プロパティが整数を指定する場合は integer。
DataType プロパティが decimal を指定する場合は decimal。
DefaultValue: 最大値は適用されません。
整数または 10 進数の ParameterDef 要素の場合、許容される最大値を定義します。
いいえ
MinLength
DataType プロパティが文字列を指定する場合は整数。
DefaultValue: 最小値は適用されません。
文字列値の場合は、許可される最短の文字列を定義します。 UI および PrintCapabilities または PrintTicket プロバイダーは、このプロパティを使用して ParameterDef 要素を検証します。
いいえ
MinValue
DataType プロパティが整数を指定する場合は integer。
DataType プロパティが decimal を指定する場合は decimal。
DefaultValue: 最小値は適用されません。
整数または 10 進値パラメーターの場合は、許容される最小の値を定義します。
いいえ
倍数
DataType プロパティが整数を指定する場合は integer。
DataType プロパティが decimal を指定する場合は decimal。
DefaultValue: 1
整数または 10 進数のパラメーターの場合、パラメーターの値はこの数値の倍数である必要があります。 詳細については、次の表の「複数の に関する ノート」を参照してください。
いいえ
UnitType
パラメーターに使用される単位を示す文字列値。
既定値はありません。
パラメーターを表す単位を示します。 たとえば、角度は 10 分の 1 の角度、長さはミクロン単位などです。
はい

複数に関する注意事項

整数または 10 進値を持つ ParameterInit 要素の場合、ParameterInit の値はこの数値の倍数である必要があります。 たとえば、このプロパティを 0.1 に設定することで、10 進数の ParameterInit 要素を 10 分の 1 に制限できます。 UI 要素は、ダイアログと UI コントロールを構築するときにこのプロパティを使用します。 さらに、PrintTicket 検証コードでは、このプロパティを使用して、ParameterInit の値を Multiple で示される最も近い値に丸めることができます。 注: デバイス ドライバーと PrintCapabilities プロバイダーでは、ParameterInit 値がこのプロパティ値の倍数であると想定しないでください。 各プロバイダーは、このプロパティに異なる値と競合する値を指定する可能性があるため、任意の値を最も近い使用できる値に丸める必要があります。

印刷スキーマ仕様