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 | |
|---|---|---|
.gif "Public method") |
ConversionJob(Guid) | Initializes a new instance of the ConversionJob class based on the WordServiceApplicationProxy object specified by the id parameter. |
|
ConversionJob(String) | Initializes a new instance of the ConversionJob class based on the WordServiceApplication object specified by the name parameter. |
|
ConversionJob(WordServiceApplicationProxy) | Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy object. |
|
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) | Initializes a new instance of the ConversionJob class by using the specified WordServiceApplicationProxy and ConversionJobSettings objects. |
|
ConversionJob(WordServiceApplicationProxy, ConversionJobSettings) | Initializes a new instance of the ConversionJob class based on the specified WordServiceApplicationProxy and ConversionJobSettings objects. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Canceled | Gets a value that indicates whether this conversion job has been canceled. |
|
JobId | Gets a Nullable<Guid> structure that specifies the unique ID for this job. |
|
Name | Specifies a user-defined friendly name for this conversion job. |
|
Settings | Gets a ConversionJobSettings object that specifies the settings applied to the input files in this conversion job. |
|
Started | Gets a value that indicates whether this conversion job has been started. |
|
SubscriptionId | Gets or sets the partition ID of the tenant that created this conversion job. |
|
UserToken | Gets or sets the credentials under which this conversion job is executed. |
Top
Methods
| Name | Description | |
|---|---|---|
|
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. |
|
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. |
|
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. |
|
Cancel | Cancels a conversion job in progress. |
.gif "Static member") |
CancelJob(Guid, Guid, Nullable<Guid>) | Cancels the specified conversion job. |
|
CancelJob(String, Guid, Nullable<Guid>) | Cancels the specified conversion job. |
|
CancelJob(WordServiceApplicationProxy, Guid, Nullable<Guid>) | Cancels the specified conversion job. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Start | Starts the processing of a conversion job. |
|
ToString | (Inherited from Object.) |
Top