-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Stapling.xml
341 lines (330 loc) · 17.7 KB
/
Stapling.xml
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<Type Name="Stapling" FullName="System.Printing.Stapling">
<TypeSignature Language="C#" Value="public enum Stapling" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed Stapling extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Printing.Stapling" />
<TypeSignature Language="VB.NET" Value="Public Enum Stapling" />
<TypeSignature Language="F#" Value="type Stapling = " />
<TypeSignature Language="C++ CLI" Value="public enum class Stapling" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Specifies whether, and where, a printer staples a multi-page document.</summary>
<remarks>
<format type="text/markdown"><), 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.Stapling%2A> 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 the 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="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling None = int32(10)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.None" />
<MemberSignature Language="VB.NET" Value="None" />
<MemberSignature Language="F#" Value="None = 10" Usage="System.Printing.Stapling.None" />
<MemberSignature Language="C++ CLI" Value="None" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>10</MemberValue>
<Docs>
<summary>The document is not stapled.</summary>
</Docs>
</Member>
<Member MemberName="SaddleStitch">
<MemberSignature Language="C#" Value="SaddleStitch" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling SaddleStitch = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.SaddleStitch" />
<MemberSignature Language="VB.NET" Value="SaddleStitch" />
<MemberSignature Language="F#" Value="SaddleStitch = 1" Usage="System.Printing.Stapling.SaddleStitch" />
<MemberSignature Language="C++ CLI" Value="SaddleStitch" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Multiple staples along the fold line. Also called saddle-stitch stapling.</summary>
</Docs>
</Member>
<Member MemberName="StapleBottomLeft">
<MemberSignature Language="C#" Value="StapleBottomLeft" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleBottomLeft = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleBottomLeft" />
<MemberSignature Language="VB.NET" Value="StapleBottomLeft" />
<MemberSignature Language="F#" Value="StapleBottomLeft = 2" Usage="System.Printing.Stapling.StapleBottomLeft" />
<MemberSignature Language="C++ CLI" Value="StapleBottomLeft" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>A single staple in the lower-left corner.</summary>
</Docs>
</Member>
<Member MemberName="StapleBottomRight">
<MemberSignature Language="C#" Value="StapleBottomRight" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleBottomRight = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleBottomRight" />
<MemberSignature Language="VB.NET" Value="StapleBottomRight" />
<MemberSignature Language="F#" Value="StapleBottomRight = 3" Usage="System.Printing.Stapling.StapleBottomRight" />
<MemberSignature Language="C++ CLI" Value="StapleBottomRight" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>A single staple in the lower-right corner.</summary>
</Docs>
</Member>
<Member MemberName="StapleDualBottom">
<MemberSignature Language="C#" Value="StapleDualBottom" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleDualBottom = int32(7)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleDualBottom" />
<MemberSignature Language="VB.NET" Value="StapleDualBottom" />
<MemberSignature Language="F#" Value="StapleDualBottom = 7" Usage="System.Printing.Stapling.StapleDualBottom" />
<MemberSignature Language="C++ CLI" Value="StapleDualBottom" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary>Two staples along the lower edge.</summary>
</Docs>
</Member>
<Member MemberName="StapleDualLeft">
<MemberSignature Language="C#" Value="StapleDualLeft" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleDualLeft = int32(4)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleDualLeft" />
<MemberSignature Language="VB.NET" Value="StapleDualLeft" />
<MemberSignature Language="F#" Value="StapleDualLeft = 4" Usage="System.Printing.Stapling.StapleDualLeft" />
<MemberSignature Language="C++ CLI" Value="StapleDualLeft" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Two staples along the left edge.</summary>
</Docs>
</Member>
<Member MemberName="StapleDualRight">
<MemberSignature Language="C#" Value="StapleDualRight" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleDualRight = int32(5)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleDualRight" />
<MemberSignature Language="VB.NET" Value="StapleDualRight" />
<MemberSignature Language="F#" Value="StapleDualRight = 5" Usage="System.Printing.Stapling.StapleDualRight" />
<MemberSignature Language="C++ CLI" Value="StapleDualRight" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>Two staples along the right edge.</summary>
</Docs>
</Member>
<Member MemberName="StapleDualTop">
<MemberSignature Language="C#" Value="StapleDualTop" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleDualTop = int32(6)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleDualTop" />
<MemberSignature Language="VB.NET" Value="StapleDualTop" />
<MemberSignature Language="F#" Value="StapleDualTop = 6" Usage="System.Printing.Stapling.StapleDualTop" />
<MemberSignature Language="C++ CLI" Value="StapleDualTop" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>Two staples along the upper edge.</summary>
</Docs>
</Member>
<Member MemberName="StapleTopLeft">
<MemberSignature Language="C#" Value="StapleTopLeft" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleTopLeft = int32(8)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleTopLeft" />
<MemberSignature Language="VB.NET" Value="StapleTopLeft" />
<MemberSignature Language="F#" Value="StapleTopLeft = 8" Usage="System.Printing.Stapling.StapleTopLeft" />
<MemberSignature Language="C++ CLI" Value="StapleTopLeft" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>A single staple in the upper-left corner.</summary>
</Docs>
</Member>
<Member MemberName="StapleTopRight">
<MemberSignature Language="C#" Value="StapleTopRight" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling StapleTopRight = int32(9)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.StapleTopRight" />
<MemberSignature Language="VB.NET" Value="StapleTopRight" />
<MemberSignature Language="F#" Value="StapleTopRight = 9" Usage="System.Printing.Stapling.StapleTopRight" />
<MemberSignature Language="C++ CLI" Value="StapleTopRight" />
<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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</ReturnType>
</ReturnValue>
<MemberValue>9</MemberValue>
<Docs>
<summary>A single staple in the upper-right corner.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
<MemberSignature Language="C#" Value="Unknown" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.Stapling Unknown = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.Printing.Stapling.Unknown" />
<MemberSignature Language="VB.NET" Value="Unknown" />
<MemberSignature Language="F#" Value="Unknown = 0" Usage="System.Printing.Stapling.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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Printing.Stapling</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>