DocumentNUp

This topic is not current. For the most current information, see the Print Schema Specification.

Describes the output and format of multiple logical pages to a single physical sheet. Each document is compiled separately. DocumentNUp and JobNUpAllDocumentsContiguously are mutually exclusive. It is up to the driver to determine constraint handling between these keywords.

The following diagram illustrates an example with Document 1 containing 3 pages, and Document 2 containing 2 pages. Each document is duplexed separately. The presentation direction shown below is the RightBottom option.

a diagram that shows how document pages are laid out on a single sheet based on the documentnup setting

Element Information

Name Value
Element Type
Feature
Scoping Prefix
Document
Notes
Top, Bottom, Left, and Right are relative to the PageImageableSize, where TopLeft is denoted by the origin of the x-axis and y-axis.

Structural Content

The XML structure of this element is as follows:

<psf:Feature name="psk:DocumentNUp">
  <psf:Property name="psf:SelectionType">
    <psf:Value xsi:type="xs:string">psk:PickOne</psf:Value>
  </psf:Property>
  <psf:Option>
    <psf:Property name="psf:IdentityOption">
      <psf:Value xsi:type="xs:string">_IdentityOptionValue_</psf:Value>
    </psf:Property>
    <psf:ScoredProperty name="psk:PagesPerSheet">
      <psf:Value xsi:type="xs:integer">_PagesPerSheetValue_</psf:Value>
    </psf:ScoredProperty>
  </psf:Option>
  <!-- Specifies the ordering direction of the pages.  First direction followed by second direction. -->
  <psf:Feature name="psk:PresentationDirection">
    <psf:Option name="psk:_PresentationDirectionOptionName_" />
  </psf:Feature>
</psf:Feature>

Structure Variables

The following table outlines the characteristics of the variables defined in the XML structure.

Name Data type Unit Supported values Summary
_OptionName_
string
characters
Valid fully qualified name as defined by Namespaces in XML. If no namespace is specified, default namespace is assumed.
The name of the option.
_IdentityOptionValue_
string
n/a
True, False.
Defines an Option which when selected would disable this feature.
_PagesPerSheetValue_
integer
Logical pages
All integers (Greater than Zero).
Specifies the number of logical pages per physical sheet. Supported set can be any set of integers E.g. {1,2,4,6,8,9,16}.
_PresentationDirectionOptionName_
string
characters
Valid fully qualified name as defined by Namespaces in XML. If no namespace is specified, default namespace is assumed.
The name of the option.

Extensible Markup Language (XML) Content

The public Print Schema keywords are defined in the https://schemas.microsoft.com/windows/2003/08/printing/printschemakeywords namespace. The public Extensible Markup Language (XML) content for this keyword is defined below:

<psf:Feature name="psk:DocumentNUp">
  <psf:Property name="psf:SelectionType">
    <psf:Value xsi:type="xs:string">psk:PickOne</psf:Value>
  </psf:Property>
  <psf:Option>
    <psf:ScoredProperty name="psk:PagesPerSheet">
      <psf:Value xsi:type="xs:integer">_Undefined_</psf:Value>
    </psf:ScoredProperty>
  </psf:Option>
  <psf:Feature name="psk:PresentationDirection">
    <!-- Specifies format left to right, top to bottom. -->
    <psf:Option name="psk:RightBottom" />
    <!-- Specifies format top to bottom, left to right. -->
    <psf:Option name="psk:BottomRight" />
    <!-- Specifies format right to left, top to bottom. -->
    <psf:Option name="psk:LeftBottom" />
    <!-- Specifies format top to bottom, right to left. -->
    <psf:Option name="psk:BottomLeft" />
    <!-- Specifies format left to right, bottom to top. -->
    <psf:Option name="psk:RightTop" />
    <!-- Specifies format bottom to top, left to right. -->
    <psf:Option name="psk:TopRight" />
    <!-- Specifies format right to left, bottom to top. -->
    <psf:Option name="psk:LeftTop" />
    <!-- Specifies format bottom to top, right to left. -->
    <psf:Option name="psk:TopLeft" />
  </psf:Feature>
</psf:Feature>
    

Print Schema Specification