Share via


ConversionJob members

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.

The ConversionJob type exposes the following members.

Constructors

  Name Description
Public method ConversionJob(Guid) Initializes a new instance of the ConversionJob class based on the WordServiceApplicationProxy object specified by the id parameter.
Public method ConversionJob(String) Initializes a new instance of the ConversionJob class based on the WordServiceApplication object specified by the name parameter.
Public method ConversionJob(WordServiceApplicationProxy) Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy object.
Public method ConversionJob(Guid, ConversionJobSettings) Initializes a new instance of the ConversionJob class based on the WordServiceApplicationProxy object specified by the id and settings parameters.
Public method ConversionJob(String, ConversionJobSettings) Initializes a new instance of the ConversionJob class by using the specified WordServiceApplicationProxy and ConversionJobSettings objects.
Public method ConversionJob(WordServiceApplicationProxy, ConversionJobSettings) Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy and ConversionJobSettings objects.

Top

Properties

  Name Description
Public property Canceled Gets a value that indicates whether this conversion job has been canceled.
Public property JobId Gets a Nullable<Guid> structure that specifies the unique ID for this job.
Public property Name Specifies a user-defined friendly name for this conversion job.
Public property Settings Gets a ConversionJobSettings object that specifies the settings applied to the input files in this conversion job.
Public property Started Gets a value that indicates whether this conversion job has been started.
Public property SubscriptionId Gets or sets the partition ID of the tenant that created this conversion job.
Public property UserToken Gets or sets the credentials under which this conversion job is executed.

Top

Methods

  Name Description
Public method AddFile 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.
Public method AddFolder 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.
Public method AddLibrary 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.
Public method Cancel Cancels a conversion job in progress.
Public methodStatic member CancelJob(Guid, Guid, Nullable<Guid>) Cancels the specified conversion job.
Public methodStatic member CancelJob(String, Guid, Nullable<Guid>) Cancels the specified conversion job.
Public methodStatic member CancelJob(WordServiceApplicationProxy, Guid, Nullable<Guid>) Cancels the specified conversion job.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Start Starts the processing of a conversion job.
Public method ToString (Inherited from Object.)

Top

See also

Reference

ConversionJob class

Microsoft.Office.Word.Server.Conversions namespace