TaskDefinition Class

Represents a single task that defines a transformation process.

Inheritance Hierarchy

System. . :: . .Object
  Microsoft.Web.Media.TransformManager. . :: . .ConfigurationBase
    Microsoft.Web.Media.TransformManager..::..TaskDefinition

Namespace:  Microsoft.Web.Media.TransformManager
Assembly:  Microsoft.Web.Media.TransformManager.Common (in Microsoft.Web.Media.TransformManager.Common.dll)

Syntax

'Declaration
<SerializableAttribute> _
<DataContractAttribute> _
Public Class TaskDefinition _
    Inherits ConfigurationBase
'Usage

  Dim instance As TaskDefinition
[SerializableAttribute]
[DataContractAttribute]
public class TaskDefinition : ConfigurationBase
[SerializableAttribute]
[DataContractAttribute]
public ref class TaskDefinition : public ConfigurationBase
[<SerializableAttribute>]
[<DataContractAttribute>]
type TaskDefinition =  
    class
        inherit ConfigurationBase
    end
  public class TaskDefinition extends ConfigurationBase

The TaskDefinition type exposes the following members.

Constructors

  Name Description
Public method TaskDefinition(FileInfo, XElement) Initializes a new instance of the TaskDefinition class by using the specified file information and task definition.
Public method TaskDefinition(FileInfo, XElement, XElement) Initializes a new instance of the TaskDefinition class by using the specified file information, task definition, and default task definition.

Top

Properties

  Name Description
Public property BaseNamespace Gets or sets the XML namespace for the configuration. (Inherited from ConfigurationBase.)
Public property CommandLine Gets or sets a command line for the task.
Public property CommandLineArchitecture Gets or sets the architecture of the command-line executable.
Public property ConfigurationDirectory Gets the path to the task definition configuration file.
Public property ConfigurationMessages Gets or sets a list of IIS Transform Manager configuration messages. (Inherited from ConfigurationBase.)
Public property ConfigurationMessagesElement Gets or sets an XML element that contains configuration messages for the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public property ConfigurationStatus Gets or sets the IIS Transform Manager configuration status. (Inherited from ConfigurationBase.)
Public property Copyright Gets or sets the copyright string that has been supplied by the task author.
Public property Description Gets or sets a description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public property DescriptionElement Gets or set the XML element that contains the description of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public property FileName Gets or sets the name of the task definition configuration file.
Public property Id Gets or sets the XML element ID of a configuration object. (Inherited from ConfigurationBase.)
Public property IdElement Gets or sets the XML ID element of a configuration object. (Inherited from ConfigurationBase.)
Public property InputFolder Gets or sets the folder name to append to the working directory in order to find input files.
Public property IsExecutable Gets or sets a value that specifies whether the type of task is an executable or an ITask interface.
Public property LastModified Gets or sets the date and time when the IIS Transform Manager configuration was last modified. (Inherited from ConfigurationBase.)
Public property LogLevel Gets or sets a value that represents the level of detail for a log that is contained in the log level element of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public property LogLevelElement Gets or sets an XML element that contains log level details. (Inherited from ConfigurationBase.)
Public property Name Gets or sets the XML element name of the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public property NameElement Gets or sets an XML element that contains name details. (Inherited from ConfigurationBase.)
Public property OutputFolder Gets or sets the folder name to append to the working directory in order to write output files.
Public property Properties Gets or sets a collection of the properties that are defined for the current task.
Public property PropertyNamespace Gets or sets a property namespace for the current task.
Public property PropertyNamespacePrefix Gets or sets a prefix for the property namespace of the current task.
Public property SuccessCodes Gets or sets a set of codes that indicate whether the task completed successfully.
Public property TaskCodeType Gets or sets the task type.
Public property TaskDefinitionElement Gets or sets the XElement object container of the template file.
Public property TaskTypeArchitecture Gets or sets the architecture of the task type, if the command-line executable is architecture specific.

Top

Methods

  Name Description
Public method AddConfigurationMessage(String) Adds the specified message to the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public method AddConfigurationMessage(String, ConfigurationMessageSeverity) Adds the specified message to the IIS Transform Manager configuration using the specified severity value. (Inherited from ConfigurationBase.)
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 RemoveRestartWarningMessage Removes the restart warning message from the IIS Transform Manager configuration. (Inherited from ConfigurationBase.)
Public method Save Saves a task definition object to a configuration file.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member idElementName Represents a constant that is used when assigning the ID of the element that contains the input folder of the task. The value is "ID". This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code.
Public fieldStatic member taskDefinitionElementName Represents a constant that is used when assigning the taskDefinition element name of the task. The value is "taskDefinition". This type/member supports the IIS Transform Manager infrastructure and is not intended to be used directly from your code.

Top

Remarks

TaskDefinition objects are contained in a JobTemplate object that defines a transformation process.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Web.Media.TransformManager Namespace