dotnet-api-docs/xml/System.Printing/Collation.xml at 6dac9a9fb555c5e35fbca1577fed2c7121d45e5a · dotnet/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<Type Name="Collation" FullName="System.Printing.Collation">
  <TypeSignature Language="C#" Value="public enum Collation" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed Collation extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Printing.Collation" />
  <TypeSignature Language="VB.NET" Value="Public Enum Collation" />
  <TypeSignature Language="F#" Value="type Collation = " />
  <TypeSignature Language="C++ CLI" Value="public enum class Collation" />
  <AssemblyInfo>
    <AssemblyName>ReachFramework</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Specifies whether a printer collates output when it prints multiple copies of a multi-page print job.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 A standard printer typically collates output by printing every page of the first copy, then every page of the second copy, and so on. When a standard printer does not collate, it prints every copy of the first page, then every copy of the second page, and so on.

 Some printers are specially equipped with collating bins. The printing sequence for these specially equipped printers may differ from those of standard printers; however the outcome is the same: each copy of a multi-paged print job contains all its pages in the proper sequence without manual sorting.

 Use the values of this type primarily for the following purposes.

- As members of the <xref:System.Printing.PrintCapabilities.CollationCapability*> collection, which is a property of <xref:System.Printing.PrintCapabilities>, these values indicate the type of output that the printer supports. (Many printers support both types.)

- As the value of the <xref:System.Printing.PrintTicket.Collation> property of a <xref:System.Printing.PrintTicket>, the value instructs the printer whether to collate.

 The **Unknown** value is never used in properties of <xref:System.Printing.PrintCapabilities> objects.

 You should never set a <xref:System.Printing.PrintTicket> property to **Unknown**. If some other <xref:System.Printing.PrintTicket> producing application has created a *PrintTicket document* that sets the collation feature to an unrecognized collation option, then a <xref:System.Printing.PrintTicket> object in your application that is constructed with that document will have **Unknown** as the value of the <xref:System.Printing.PrintTicket.Collation> property.

 Although the <xref:System.Printing.PrintTicket> and <xref:System.Printing.PrintCapabilities> classes cannot be inherited, you can extend the [Print Schema](https://go.microsoft.com/fwlink/?LinkId=186397) to recognize print device features that are not accounted for in the <xref:System.Printing.PrintTicket> or <xref:System.Printing.PrintCapabilities> classes. For more information see [How to: Extend the Print Schema and Create New Print System Classes](https://learn.microsoft.com/previous-versions/aa970573(v=vs.100)).


## Examples
 The following example shows how to test a printer's capabilities and configure a print job to take advantage of them. .

 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetprintercapabilities":::
 :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetprintercapabilities":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetprintercapabilities":::

 ]]></format>
    </remarks>
    <altmember cref="T:System.Printing.PrintCapabilities" />
    <altmember cref="T:System.Printing.PrintTicket" />
  </Docs>
  <Members>
    <Member MemberName="Collated">
      <MemberSignature Language="C#" Value="Collated" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Collation Collated = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.Collation.Collated" />
      <MemberSignature Language="VB.NET" Value="Collated" />
      <MemberSignature Language="F#" Value="Collated = 1" Usage="System.Printing.Collation.Collated" />
      <MemberSignature Language="C++ CLI" Value="Collated" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.Collation</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>Collated output.</summary>
      </Docs>
    </Member>
    <Member MemberName="Uncollated">
      <MemberSignature Language="C#" Value="Uncollated" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Collation Uncollated = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.Collation.Uncollated" />
      <MemberSignature Language="VB.NET" Value="Uncollated" />
      <MemberSignature Language="F#" Value="Uncollated = 2" Usage="System.Printing.Collation.Uncollated" />
      <MemberSignature Language="C++ CLI" Value="Uncollated" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.Collation</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>Uncollated output.</summary>
      </Docs>
    </Member>
    <Member MemberName="Unknown">
      <MemberSignature Language="C#" Value="Unknown" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Collation Unknown = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.Collation.Unknown" />
      <MemberSignature Language="VB.NET" Value="Unknown" />
      <MemberSignature Language="F#" Value="Unknown = 0" Usage="System.Printing.Collation.Unknown" />
      <MemberSignature Language="C++ CLI" Value="Unknown" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.Collation</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>The feature (whose options are represented by this enumeration) is set to an option not defined in the <see href="https://learn.microsoft.com/windows/desktop/printdocs/printschema">Print Schema</see>.</summary>
      </Docs>
    </Member>
  </Members>
</Type>