ConversionJob ConversionJob ConversionJob Class

Definition

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.

public ref class ConversionJob : Microsoft::Office::ConversionServices::Conversions::ConversionJob
public class ConversionJob : Microsoft.Office.ConversionServices.Conversions.ConversionJob
Public Class ConversionJob
Inherits ConversionJob
Inheritance
ConversionJobConversionJobConversionJob

Constructors

ConversionJob(WordServiceApplicationProxy) ConversionJob(WordServiceApplicationProxy) ConversionJob(WordServiceApplicationProxy)

Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy object.

ConversionJob(Guid) ConversionJob(Guid) ConversionJob(Guid)

Initializes a new instance of the ConversionJob class based on the WordServiceApplicationProxy object specified by the id parameter.

ConversionJob(String) ConversionJob(String) ConversionJob(String)

Initializes a new instance of the ConversionJob class based on the WordServiceApplication object specified by the name parameter.

ConversionJob(WordServiceApplicationProxy, ConversionJobSettings) ConversionJob(WordServiceApplicationProxy, ConversionJobSettings) ConversionJob(WordServiceApplicationProxy, ConversionJobSettings)

Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy and ConversionJobSettings objects.

ConversionJob(Guid, ConversionJobSettings) ConversionJob(Guid, ConversionJobSettings) ConversionJob(Guid, ConversionJobSettings)

Initializes a new instance of the ConversionJob class based on the WordServiceApplicationProxy object specified by the id and settings parameters.

ConversionJob(String, ConversionJobSettings) ConversionJob(String, ConversionJobSettings) ConversionJob(String, ConversionJobSettings)

Initializes a new instance of the ConversionJob class by using the specified WordServiceApplicationProxy and ConversionJobSettings objects.

Properties

Canceled Canceled Canceled

Gets a value that indicates whether this conversion job has been canceled.

JobId JobId JobId

Gets a System.Nullable<System.Guid> structure that specifies the unique ID for this job.

Name Name Name

Specifies a user-defined friendly name for this conversion job.

Settings Settings Settings

Gets a ConversionJobSettings object that specifies the settings applied to the input files in this conversion job.

Started Started Started

Gets a value that indicates whether this conversion job has been started.

SubscriptionId SubscriptionId SubscriptionId

Gets or sets the partition ID of the tenant that created this conversion job.

UserToken UserToken UserToken

Gets or sets the credentials under which this conversion job is executed.

Methods

AddFile(String, String) AddFile(String, String) AddFile(String, String)

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.

AddFolder(SPFolder, SPFolder, Boolean) AddFolder(SPFolder, SPFolder, Boolean) AddFolder(SPFolder, SPFolder, Boolean)

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.

AddLibrary(SPList, SPList) AddLibrary(SPList, SPList) AddLibrary(SPList, SPList)

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.

Cancel() Cancel() Cancel()

Cancels a conversion job in progress.

CancelJob(WordServiceApplicationProxy, Guid, Nullable<Guid>) CancelJob(WordServiceApplicationProxy, Guid, Nullable<Guid>) CancelJob(WordServiceApplicationProxy, Guid, Nullable<Guid>)

Cancels the specified conversion job.

CancelJob(Guid, Guid, Nullable<Guid>) CancelJob(Guid, Guid, Nullable<Guid>) CancelJob(Guid, Guid, Nullable<Guid>)

Cancels the specified conversion job.

CancelJob(String, Guid, Nullable<Guid>) CancelJob(String, Guid, Nullable<Guid>) CancelJob(String, Guid, Nullable<Guid>)

Cancels the specified conversion job.

Start() Start() Start()

Starts the processing of a conversion job.

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to