PrinterCapabilities element

Article
07/19/2012

The required PrinterCapabilities element defines all of the allowed values for job-related and document-related elements that can be specified to affect print processing.

PrinterCapabilities is defined in the namespace at this URI: https://schemas.microsoft.com/windows/2005/05/wdp/print and referenced by the prefix wprt. (This resource may not be available in some languages and countries.)

Usage

<wprt:PrintCapabilities>
  child elements
</wprt:PrintCapabilities>

Attributes

There are no attributes.

Text value

None

Child elements

Element	Description
DocumentValues	Contains the printer's allowed values for job and document processing.
JobValues	Contains the printer's allowed values for job and document processing.
Xxx	Any IHV-defined elements

DocumentValues

Contains the printer's allowed values for job and document processing.

JobValues

Contains the printer's allowed values for job and document processing.

Xxx

Any IHV-defined elements

Parent elements

Element	Description
ElementData Element for parent JobElements	Contains the job-specific element data that the GetJobElementsResponse operation returns to the client.

ElementData Element for parent JobElements

Contains the job-specific element data that the GetJobElementsResponse operation returns to the client.

Remarks

PrinterCapabilities contains all of the printer's allowed values for elements that affect print processing. Specifically, the range of values for the JobProcessing, DocumentProcessing, and DocumentDescription elements are found within the JobValues and DocumentValues child elements.

A client can request the printer's PrinterCapabilities element through the GetPrinterElementsRequest operation to obtain the features and associated values available on the printer. The client can then use any of these values without error when requesting a print job through the CreatePrintJobRequest operation.

The printer's default values for JobDescription, JobProcessing, and DocumentProcessing are contained in the DefaultPrintTicket element.

In the following example code, note that you must also prefix the names of the child and other elements with the appropriate namespace (in this case wprt), to be certain that your name references apply to elements in the correct namespace.

Examples

The following code shows a sample PrinterCapabilities element:

<wprt:PrinterCapabilities>
  <wprt:JobValues>
    <wprt:JobProcessing>
      <wprt:Copies>
        <wprt:MaxValue>100</wprt:MaxValue>
      </wprt:Copies>
      <wprt:JobFinishings>
        <wprt:Staple>
          <wprt:Location>
            <wprt:AllowedValue>None</wprt:AllowedValue>
            <wprt:AllowedValue>TopLeft</wprt:AllowedValue>
            <wprt:AllowedValue>BottomLeft</wprt:AllowedValue>
          <wprt:Location>
          <wprt:Angle>
            <wprt:AllowedValue>Horizontal</wprt:AllowedValue>
            <wprt:AllowedValue>Slanted</wprt:AllowedValue>
          </wprt:Angle>
        </wprt:Staple>
        <wprt:HolePunch>
          <wprt:Edge>
            <wprt:AllowedValue>None</wprt:AllowedValue>
            <wprt:AllowedValue>Top</wprt:AllowedValue>
            <wprt:AllowedValue>Bottom</wprt:AllowedValue>
            <wprt:AllowedValue>Left</wprt:AllowedValue>
            <wprt:AllowedValue>Right</wprt:AllowedValue>
          <wprt:Edge>
          <wprt:Pattern>
            <wprt:AllowedValue>TwoHoleUSTop</wprt:AllowedValue>
            <wprt:AllowedValue>ThreeHoleUS</wprt:AllowedValue>
            <wprt:AllowedValue>TwoHoleDIN</wprt:AllowedValue>
            <wprt:AllowedValue>FourHoleDIN</wprt:AllowedValue>
            <wprt:AllowedValue>SevenHoleUS</wprt:AllowedValue>
            <wprt:AllowedValue>Metric30Hole</wprt:AllowedValue>
          </wprt:Pattern >
        </wprt:HolePunch>
      </wprt:JobFinishings>
      <wprt:Priority>
        <wprt:MinValue>1</wprt:MinValue>
        <wprt:MaxValue>100</wprt:MinValue>
      </wprt:Priority>
    </wprt:JobProcessing>
    <wprt:DocumentProcessing>
      <wprt:MediaSizeName>
        <wprt:AllowedValue>iso_a4_210x297mm</wprt:AllowedValue>
        <wprt:AllowedValue>iso_c5_162x229mm</wprt:AllowedValue>
        <wprt:AllowedValue>iso_dl_110x220mm</wprt:AllowedValue>
        <wprt:AllowedValue>jis_b4_257x364mm</wprt:AllowedValue>
        <wprt:AllowedValue>na_legal_8.5x14in</wprt:AllowedValue>
        <wprt:AllowedValue>na_letter_8.5x11in</wprt:AllowedValue>
      </wprt:MediaSizeName>
      <wprt:MediaType>
        <wprt:AllowedValue>envelope</wprt:AllowedValue>
        <wprt:AllowedValue>labels</wprt:AllowedValue>
        <wprt:AllowedValue>photographic</wprt:AllowedValue>
        <wprt:AllowedValue>stationery</wprt:AllowedValue>
        <wprt:AllowedValue>stationery-inkjet</wprt:AllowedValue>
        <wprt:AllowedValue>transparency</wprt:AllowedValue>
        <wprt:AllowedValue>other</wprt:AllowedValue>
      </wprt:MediaType>
      <wprt:NumberUp>
        <wprt:PagesPerSheet>
          <wprt:AllowedValue>1</wprt:AllowedValue>
          <wprt:AllowedValue>2</wprt:AllowedValue>
          <wprt:AllowedValue>4</wprt:AllowedValue>
          <wprt:AllowedValue>8</wprt:AllowedValue>
          <wprt:AllowedValue>9</wprt:AllowedValue>
          <wprt:AllowedValue>16</wprt:AllowedValue>
        </wprt:PagesPerSheet>
        <wprt:Direction>
          <wprt:AllowedValue>RightDown</wprt:AllowedValue>
          <wprt:AllowedValue>DownRight</wprt:AllowedValue>
          <wprt:AllowedValue>LeftDown</wprt:AllowedValue>
          <wprt:AllowedValue>DownLeft</wprt:AllowedValue>
        </wprt:Direction>
      <wprt:NumberUp>
      <wprt:Orientation>
        <wprt:AllowedValue>Landscape</wprt:AllowedValue>
        <wprt:AllowedValue>Portrait</wprt:AllowedValue> 
        <wprt:AllowedValue>ReverseLandscape</wprt:AllowedValue>
      </wprt:Orientation>
      <wprt:Resolution>
        <wprt:AllowedValue>
          <wprt:Width>150</wprt:Width>
        </wprt:AllowedValue>
        <wprt:AllowedValue>
          <wprt:Width>300</wprt:Width>
        </wprt:AllowedValue>
        <wprt:AllowedValue>
          <wprt:Width>300</wprt:Width>
          <wprt:Height>600</wprt:Height>
        </wprt:AllowedValue>
        <wprt:AllowedValue>
          <wprt:Width>600</wprt:Width>
        </wprt:AllowedValue>
        <wprt:AllowedValue>
          <wprt:Width>600</wprt:Width>
          <wprt:Height>1200</wprt:Height>
        </wprt:AllowedValue>
      </wprt:Resolution>
      <wprt:PrintQuality>
        <wprt:AllowedValue>Draft</wprt:AllowedValue>
        <wprt:AllowedValue>High</wprt:AllowedValue>
        <wprt:AllowedValue>Normal</wprt:AllowedValue>
        <wprt:AllowedValue>Photo</wprt:AllowedValue>
      </wprt:PrintQuality>
      <wprt:Sides>
        <wprt:AllowedValue>OneSided</wprt:AllowedValue>
        <wprt:AllowedValue>TwoSidedLongEdge</wprt:AllowedValue>
        <wprt:AllowedValue>TwoSidedShortEdge</wprt:AllowedValue>
      </wprt:Sides>
    </wprt:DocumentProcessing>
  </wprt:JobValues>
  <wprt:DocumentValues>
    <wprt:DocumentDescriprion>
      <wprt:Compression>
        <wprt:AllowedValue>Gzip<wprt:AllowedValue>
        <wprt:AllowedValue>None<wprt:AllowedValue>
      </wprt:Compression>
      <wprt:Format>
        <wprt:AllowedValue>application/octet-stream</wprt:AllowedValue>
        <wprt:AllowedValue>application/postscript</wprt:AllowedValue>
        <wprt:AllowedValue>application/vnd.hp-PCL</wprt:AllowedValue>
        <wprt:AllowedValue>application/vnd.pwg-xhtml-print+xml</wprt:AllowedValue>
        <wprt:AllowedValue>text/plain</wprt:AllowedValue>
        <wprt:AllowedValue>text/plain;charset=utf-8</wprt:AllowedValue>
        <wprt:AllowedValue>unknown</wprt:AllowedValue>
      </wprt:Format>
    </wprt:DocumentDescriprion>
  </wprt:DocumentValues>
</wprt:PrinterCapabilities>