/
ConversionJob.xml
543 lines (543 loc) · 43.8 KB
/
ConversionJob.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
<Type Name="ConversionJob" FullName="Microsoft.Office.Word.Server.Conversions.ConversionJob">
<TypeSignature Language="C#" Value="public class ConversionJob : Microsoft.Office.ConversionServices.Conversions.ConversionJob" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConversionJob extends Microsoft.Office.ConversionServices.Conversions.ConversionJob" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" />
<TypeSignature Language="VB.NET" Value="Public Class ConversionJob
Inherits ConversionJob" />
<TypeSignature Language="C++ CLI" Value="public ref class ConversionJob : Microsoft::Office::ConversionServices::Conversions::ConversionJob" />
<TypeSignature Language="F#" Value="type ConversionJob = class
 inherit ConversionJob" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Office.ConversionServices.Conversions.ConversionJob</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a collection of file conversions (of single files or entire libraries) that share a common set of conversion properties and are logically tracked as a single unit.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (serviceApplicationProxy As WordServiceApplicationProxy)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(Microsoft::Office::Word::Server::Service::WordServiceApplicationProxy ^ serviceApplicationProxy);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob serviceApplicationProxy" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="serviceApplicationProxy" Type="Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" />
</Parameters>
<Docs>
<param name="serviceApplicationProxy">A <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object that specifies which Word Services application proxy instance is associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class based on the specified <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object.</summary>
<remarks>
<para>The <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object is initialized with the default conversion job settings.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (Guid id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid id) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(System.Guid)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As Guid)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(Guid id);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : Guid -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob id" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.Guid" />
</Parameters>
<Docs>
<param name="id">A <see cref="T:System.Guid" /> structure that specifies the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class based on the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object specified by the <paramref name="id" /> parameter.</summary>
<remarks>
<para>You can find the <see cref="T:System.Guid" /> structure for the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object either through Windows PowerShell or the object model. This constructor is useful if the name of the service might change.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(System::String ^ name);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : string -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob name" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The user-defined friendly name for the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplication" /> object that services this <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class based on the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplication" /> object specified by the <paramref name="name" /> parameter.</summary>
<remarks>
<para>The <paramref name="name" /> parameter specifies the name of the Word Automation Services application as specified when the Word Automation Services application was created. You can see this name at any time through the Manage Service Applications page in Central Administration.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy, Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy, class Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy,Microsoft.Office.Word.Server.Conversions.ConversionJobSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (serviceApplicationProxy As WordServiceApplicationProxy, settings As ConversionJobSettings)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(Microsoft::Office::Word::Server::Service::WordServiceApplicationProxy ^ serviceApplicationProxy, Microsoft::Office::Word::Server::Conversions::ConversionJobSettings ^ settings);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy * Microsoft.Office.Word.Server.Conversions.ConversionJobSettings -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob (serviceApplicationProxy, settings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="serviceApplicationProxy" Type="Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" />
<Parameter Name="settings" Type="Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" />
</Parameters>
<Docs>
<param name="serviceApplicationProxy">A <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object that specifies which Word Services application proxy instance is associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="settings">A <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> object that specifies settings for the conversion job. </param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class based on the specified <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> and <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> objects.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (Guid id, Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid id, class Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(System.Guid,Microsoft.Office.Word.Server.Conversions.ConversionJobSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As Guid, settings As ConversionJobSettings)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(Guid id, Microsoft::Office::Word::Server::Conversions::ConversionJobSettings ^ settings);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : Guid * Microsoft.Office.Word.Server.Conversions.ConversionJobSettings -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob (id, settings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.Guid" />
<Parameter Name="settings" Type="Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" />
</Parameters>
<Docs>
<param name="id">A <see cref="T:System.Guid" /> structure that specifies the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="settings">A <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> object that specifies settings for the conversion job.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class based on the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object specified by the <paramref name="id" /> and <paramref name="settings" /> parameters.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversionJob (string name, Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class Microsoft.Office.Word.Server.Conversions.ConversionJobSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.#ctor(System.String,Microsoft.Office.Word.Server.Conversions.ConversionJobSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, settings As ConversionJobSettings)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConversionJob(System::String ^ name, Microsoft::Office::Word::Server::Conversions::ConversionJobSettings ^ settings);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.Word.Server.Conversions.ConversionJob : string * Microsoft.Office.Word.Server.Conversions.ConversionJobSettings -> Microsoft.Office.Word.Server.Conversions.ConversionJob" Usage="new Microsoft.Office.Word.Server.Conversions.ConversionJob (name, settings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="settings" Type="Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" />
</Parameters>
<Docs>
<param name="name">The user-defined friendly name for the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object associated with this <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="settings">A <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> object that specifies settings for the conversion job.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> class by using the specified <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> and <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> objects.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFile">
<MemberSignature Language="C#" Value="public void AddFile (string inputFile, string outputFile);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddFile(string inputFile, string outputFile) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddFile(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddFile (inputFile As String, outputFile As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AddFile(System::String ^ inputFile, System::String ^ outputFile);" />
<MemberSignature Language="F#" Value="override this.AddFile : string * string -> unit" Usage="conversionJob.AddFile (inputFile, outputFile)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputFile" Type="System.String" />
<Parameter Name="outputFile" Type="System.String" />
</Parameters>
<Docs>
<param name="inputFile">The URL for the file to convert.ImportantThis URL must specify a location on the same SharePoint farm as the Word Automation Services application that performs the conversion job.</param>
<param name="outputFile">The URL for the conversion output location.ImportantThis URL must specify a location on the same SharePoint farm as the Word Automation Services application that performs the conversion job.</param>
<summary>Adds the specified input file to the set of conversion items in the conversion job, and places the result at the specified output file location.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFolder">
<MemberSignature Language="C#" Value="public void AddFolder (Microsoft.SharePoint.SPFolder inputFolder, Microsoft.SharePoint.SPFolder outputFolder, bool recursion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddFolder(class Microsoft.SharePoint.SPFolder inputFolder, class Microsoft.SharePoint.SPFolder outputFolder, bool recursion) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddFolder(Microsoft.SharePoint.SPFolder,Microsoft.SharePoint.SPFolder,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddFolder (inputFolder As SPFolder, outputFolder As SPFolder, recursion As Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AddFolder(Microsoft::SharePoint::SPFolder ^ inputFolder, Microsoft::SharePoint::SPFolder ^ outputFolder, bool recursion);" />
<MemberSignature Language="F#" Value="override this.AddFolder : Microsoft.SharePoint.SPFolder * Microsoft.SharePoint.SPFolder * bool -> unit" Usage="conversionJob.AddFolder (inputFolder, outputFolder, recursion)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputFolder" Type="Microsoft.SharePoint.SPFolder" />
<Parameter Name="outputFolder" Type="Microsoft.SharePoint.SPFolder" />
<Parameter Name="recursion" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="inputFolder">An <see cref="T:Microsoft.SharePoint.SPFolder" /> object that specifies the input folder for the conversion job.</param>
<param name="outputFolder">An <see cref="T:Microsoft.SharePoint.SPFolder" /> that specifies the output folder for the conversion job.</param>
<param name="recursion">
<b>true</b> to indicate that files in the subfolders of the specified input folder should also be converted; otherwise, <b>false</b>.NoteIf this flag is used, the directory structure is automatically recreated within the output folder.</param>
<summary>Converts the files in the specified input folder by using the conversion settings for the job, and places the results in the specified output folder location.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddLibrary">
<MemberSignature Language="C#" Value="public void AddLibrary (Microsoft.SharePoint.SPList inputList, Microsoft.SharePoint.SPList outputList);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddLibrary(class Microsoft.SharePoint.SPList inputList, class Microsoft.SharePoint.SPList outputList) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddLibrary(Microsoft.SharePoint.SPList,Microsoft.SharePoint.SPList)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddLibrary (inputList As SPList, outputList As SPList)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AddLibrary(Microsoft::SharePoint::SPList ^ inputList, Microsoft::SharePoint::SPList ^ outputList);" />
<MemberSignature Language="F#" Value="override this.AddLibrary : Microsoft.SharePoint.SPList * Microsoft.SharePoint.SPList -> unit" Usage="conversionJob.AddLibrary (inputList, outputList)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputList" Type="Microsoft.SharePoint.SPList" />
<Parameter Name="outputList" Type="Microsoft.SharePoint.SPList" />
</Parameters>
<Docs>
<param name="inputList">An <see cref="T:Microsoft.SharePoint.SPList" /> object that specifies the input document library for the conversion job.</param>
<param name="outputList">An <see cref="T:Microsoft.SharePoint.SPList" /> that specifies the output document library for the conversion job.</param>
<summary>Converts the files in the specified document library by using the conversion settings for the job and places the output in the specified document library.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Cancel() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.Cancel" />
<MemberSignature Language="VB.NET" Value="Public Sub Cancel ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Cancel();" />
<MemberSignature Language="F#" Value="override this.Cancel : unit -> unit" Usage="conversionJob.Cancel " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels a conversion job in progress.</summary>
<remarks>
<para>When this method is executed, any conversion jobs in <b>NotStarted</b> or <b>InProgress</b> status are moved to <b>Canceled</b> status, and the status of the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object is set such that it cannot be used to start any new conversions. Any conversions currently in progress complete as normal.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Canceled">
<MemberSignature Language="C#" Value="public bool Canceled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Canceled" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.Canceled" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Canceled As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Canceled { bool get(); };" />
<MemberSignature Language="F#" Value="member this.Canceled : bool" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.Canceled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this conversion job has been canceled.</summary>
<value>
<b>true</b> if the conversion job has been canceled; otherwise, <b>false</b>.</value>
<remarks>
<para>Once a conversion job is canceled, no additional conversion requests can be sent to it.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="CancelJob">
<MemberSignature Language="C#" Value="public static void CancelJob (Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CancelJob(class Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy serviceApplicationProxy, valuetype System.Guid jobId, valuetype System.Nullable`1<valuetype System.Guid> subscriptionId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob(Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy,System.Guid,System.Nullable{System.Guid})" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub CancelJob (serviceApplicationProxy As WordServiceApplicationProxy, jobId As Guid, subscriptionId As Nullable(Of Guid))" />
<MemberSignature Language="C++ CLI" Value="public:
 static void CancelJob(Microsoft::Office::Word::Server::Service::WordServiceApplicationProxy ^ serviceApplicationProxy, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="F#" Value="static member CancelJob : Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy * Guid * Nullable<Guid> -> unit" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob (serviceApplicationProxy, jobId, subscriptionId)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceApplicationProxy" Type="Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" />
<Parameter Name="jobId" Type="System.Guid" />
<Parameter Name="subscriptionId" Type="System.Nullable<System.Guid>" />
</Parameters>
<Docs>
<param name="serviceApplicationProxy">A <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object that specifies which Word Services application proxy instance is associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="jobId">A <see cref="T:System.Guid" /> structure that specifies the unique ID for the conversion job that you want to cancel.</param>
<param name="subscriptionId">A <see cref="T:System.Nullable{System.Guid}" /> structure that specifies the partition ID of the tenant that created this conversion job. NoteIf the SharePoint farm is not configured for multiple tenants, pass a null reference (Nothing in Visual Basic) as the argument for this parameter.</param>
<summary>Cancels the specified conversion job.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CancelJob">
<MemberSignature Language="C#" Value="public static void CancelJob (Guid id, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CancelJob(valuetype System.Guid id, valuetype System.Guid jobId, valuetype System.Nullable`1<valuetype System.Guid> subscriptionId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob(System.Guid,System.Guid,System.Nullable{System.Guid})" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub CancelJob (id As Guid, jobId As Guid, subscriptionId As Nullable(Of Guid))" />
<MemberSignature Language="C++ CLI" Value="public:
 static void CancelJob(Guid id, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="F#" Value="static member CancelJob : Guid * Guid * Nullable<Guid> -> unit" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob (id, jobId, subscriptionId)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" />
<Parameter Name="jobId" Type="System.Guid" />
<Parameter Name="subscriptionId" Type="System.Nullable<System.Guid>" />
</Parameters>
<Docs>
<param name="id">A <see cref="T:System.Guid" /> structure that specifies the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object associated with the <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="jobId">A <see cref="T:System.Guid" /> that specifies the unique ID for the conversion job that you want to cancel.</param>
<param name="subscriptionId">A <see cref="T:System.Nullable{System.Guid}" /> structure that specifies the partition ID of the tenant that created this conversion job.NoteIf the SharePoint farm is not configured for multiple tenants, pass a null reference (Nothing in Visual Basic) as the argument for this parameter.</param>
<summary>Cancels the specified conversion job.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CancelJob">
<MemberSignature Language="C#" Value="public static void CancelJob (string name, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void CancelJob(string name, valuetype System.Guid jobId, valuetype System.Nullable`1<valuetype System.Guid> subscriptionId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob(System.String,System.Guid,System.Nullable{System.Guid})" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub CancelJob (name As String, jobId As Guid, subscriptionId As Nullable(Of Guid))" />
<MemberSignature Language="C++ CLI" Value="public:
 static void CancelJob(System::String ^ name, Guid jobId, Nullable<Guid> subscriptionId);" />
<MemberSignature Language="F#" Value="static member CancelJob : string * Guid * Nullable<Guid> -> unit" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.CancelJob (name, jobId, subscriptionId)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="jobId" Type="System.Guid" />
<Parameter Name="subscriptionId" Type="System.Nullable<System.Guid>" />
</Parameters>
<Docs>
<param name="name">The user-defined friendly name of the <see cref="T:Microsoft.Office.Word.Server.Service.WordServiceApplicationProxy" /> object associated with this <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object.</param>
<param name="jobId">A <see cref="T:System.Guid" /> structure that specifies the unique ID for the conversion job that you want to cancel.</param>
<param name="subscriptionId">A <see cref="T:System.Nullable{System.Guid}" /> structure that specifies the partition ID of the tenant that created this conversion job.NoteIf the SharePoint farm is not configured for multiple tenants, pass a null reference (Nothing in Visual Basic) as the argument for this parameter.</param>
<summary>Cancels the specified conversion job.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JobId">
<MemberSignature Language="C#" Value="public Guid JobId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid JobId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.JobId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property JobId As Guid" />
<MemberSignature Language="C++ CLI" Value="public:
 property Guid JobId { Guid get(); };" />
<MemberSignature Language="F#" Value="member this.JobId : Guid" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.JobId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Nullable{System.Guid}" /> structure that specifies the unique ID for this job.</summary>
<value>A <see cref="T:System.Nullable`1" /> object.</value>
<remarks>
<para>This value is created whenever a conversion job is started. Use this property to query the conversion job queue.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies a user-defined friendly name for this conversion job. </summary>
<value>Returns <see cref="T:System.String" />.</value>
<remarks>
<para>The specified name does not need to be unique across all conversion jobs.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Settings">
<MemberSignature Language="C#" Value="public Microsoft.Office.Word.Server.Conversions.ConversionJobSettings Settings { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Word.Server.Conversions.ConversionJobSettings Settings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.Settings" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Settings As ConversionJobSettings" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Word::Server::Conversions::ConversionJobSettings ^ Settings { Microsoft::Office::Word::Server::Conversions::ConversionJobSettings ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Settings : Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.Settings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Office.Word.Server.Conversions.ConversionJobSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> object that specifies the settings applied to the input files in this conversion job.</summary>
<value>A <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJobSettings" /> object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public void Start ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Start() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.Start" />
<MemberSignature Language="VB.NET" Value="Public Sub Start ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Start();" />
<MemberSignature Language="F#" Value="override this.Start : unit -> unit" Usage="conversionJob.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Starts the processing of a conversion job.</summary>
<remarks>
<para>Until this method is called, none of the conversion jobs specified by the <see cref="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddFile(System.String,System.String)" />, <see cref="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddFolder(Microsoft.SharePoint.SPFolder,Microsoft.SharePoint.SPFolder,System.Boolean)" />, or <see cref="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.AddLibrary(Microsoft.SharePoint.SPList,Microsoft.SharePoint.SPList)" /> methods are pushed into the system.When this method is called, each conversion job is pushed into the Word Automation Services conversion job queue.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Started">
<MemberSignature Language="C#" Value="public bool Started { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Started" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.Started" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Started As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Started { bool get(); };" />
<MemberSignature Language="F#" Value="member this.Started : bool" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.Started" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this conversion job has been started.</summary>
<value>
<b>true</b> if the conversion job has been started; otherwise, <b>false</b>.</value>
<remarks>
<para>This property is set to <b>true</b> when the <see cref="M:Microsoft.Office.Word.Server.Conversions.ConversionJob.Start" /> method is called. Once a conversion job is started, no additional conversion items can be added to it.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="SubscriptionId">
<MemberSignature Language="C#" Value="public Nullable<Guid> SubscriptionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.Guid> SubscriptionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.SubscriptionId" />
<MemberSignature Language="VB.NET" Value="Public Property SubscriptionId As Nullable(Of Guid)" />
<MemberSignature Language="C++ CLI" Value="public:
 property Nullable<Guid> SubscriptionId { Nullable<Guid> get(); void set(Nullable<Guid> value); };" />
<MemberSignature Language="F#" Value="member this.SubscriptionId : Nullable<Guid> with get, set" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.SubscriptionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Guid></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the partition ID of the tenant that created this conversion job.</summary>
<value>A <see cref="T:System.Nullable`1" /> object.</value>
<remarks>
<para>This property is set whenever a <see cref="T:Microsoft.Office.Word.Server.Conversions.ConversionJob" /> object is created in a partitioned environment. If the SharePoint farm has not been configured to enable multiple tenants, this property will return a null reference (Nothing in Visual Basic).</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="UserToken">
<MemberSignature Language="C#" Value="public Microsoft.SharePoint.SPUserToken UserToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.SharePoint.SPUserToken UserToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Word.Server.Conversions.ConversionJob.UserToken" />
<MemberSignature Language="VB.NET" Value="Public Property UserToken As SPUserToken" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::SharePoint::SPUserToken ^ UserToken { Microsoft::SharePoint::SPUserToken ^ get(); void set(Microsoft::SharePoint::SPUserToken ^ value); };" />
<MemberSignature Language="F#" Value="member this.UserToken : Microsoft.SharePoint.SPUserToken with get, set" Usage="Microsoft.Office.Word.Server.Conversions.ConversionJob.UserToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Word.Server</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.SharePoint.SPUserToken</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the credentials under which this conversion job is executed.</summary>
<value>An <see cref="T:Microsoft.SharePoint.SPUserToken" /> object. The default is a null reference (Nothing in Visual Basic).</value>
<remarks>
<para>All attempts to read and write files in the SharePoint content database are made in the context of these credentials. The default value for this property is a null reference (Nothing in Visual Basic), which is anonymous.</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>