TaskItem Class

Definition

Defines a single item of the project as it is passed into a task.

public ref class TaskItem sealed : MarshalByRefObject, Microsoft::Build::Framework::ITaskItem2
public sealed class TaskItem : MarshalByRefObject, Microsoft.Build.Framework.ITaskItem2
type TaskItem = class
    inherit MarshalByRefObject
    interface ITaskItem
    interface ITaskItem2
Public NotInheritable Class TaskItem
Inherits MarshalByRefObject
Implements ITaskItem2
Inheritance
Implements

Remarks

TaskItem objects do not exactly correspond to item elements in project files. If they did, then tasks would have access to data that was not explicitly passed into the task through the project file. This is not a security issue, but rather an issue with project file clarity and transparency.

This class has to be sealed since the build engine instantiates its own copy of this type. If a third party were to extend this class, then the build engine will yield an undesired behavior.

Constructors

TaskItem()

Initializes a new instance of the TaskItem class.

TaskItem(ITaskItem)

Initializes a new instance of the TaskItem class using the specified source ITaskItem.

TaskItem(String)

Initializes a new instance of the TaskItem class using the specified item-specification string.

TaskItem(String, IDictionary)

Initializes a new instance of the TaskItem class using the specified item-specification string and its metadata.

Properties

ItemSpec

Gets or sets the item specification.

MetadataCount

Gets the number of metadata set on the item.

MetadataNames

Gets the names of all the metadata on the item.

Methods

CloneCustomMetadata()

Clones the collection of custom metadata for the item specification.

CopyMetadataTo(ITaskItem)

Copies the item-specification metadata to the specified destination task item.

CreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetMetadata(String)

Retrieves the specified metadata on the item.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService()

When overridden in a derived class, gives task items infinite lease time.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
RemoveMetadata(String)

Removes the specified metadata on the item.

SetMetadata(String, String)

Sets or modifies the value of the specified metadata on the item.

ToString()

Gets the item specification.

Operators

Explicit(TaskItem to String)

Allows an explicit type cast from a TaskItem to a String, and returns the ItemSpec for that item.

Explicit Interface Implementations

ITaskItem2.CloneCustomMetadataEscaped()

ITaskItem2 implementation which returns a clone of the metadata on this object. Values returned are in their original escaped form.

ITaskItem2.EvaluatedIncludeEscaped

ITaskItem2 implementation which gets or sets the item include value. For disk-based items this would be the file path.

ITaskItem2.GetMetadataValueEscaped(String)

ITaskItem2 implementation which allows the values of metadata on the item to be queried.

ITaskItem2.SetMetadataValueLiteral(String, String)

ITaskItem2 implementation which allows a piece of custom metadata to be set on the item. Assumes that the value passed in is unescaped, and escapes the value as necessary in order to maintain its value.

Applies to