Export (0) Print
Expand All

TaskItem Class

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


Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (in Microsoft.Build.Utilities.v4.0.dll)

public sealed class TaskItem : MarshalByRefObject, 
	ITaskItem, ITaskItem2

The TaskItem type exposes the following members.

Public methodTaskItem()Initializes a new instance of the TaskItem class.
Public methodTaskItem(ITaskItem)Initializes a new instance of the TaskItem class using the specified source ITaskItem.
Public methodTaskItem(String)Initializes a new instance of the TaskItem class using the specified item-specification string.
Public methodTaskItem(String, IDictionary)Initializes a new instance of the TaskItem class using the specified item-specification string and its metadata.

Public propertyItemSpecGets or sets the item specification.
Public propertyMetadataCountGets the number of metadata set on the item.
Public propertyMetadataNamesGets the names of all the metadata on the item.

Public methodCloneCustomMetadataClones the collection of custom metadata for the item specification.
Public methodCopyMetadataToCopies the item-specification metadata to the specified destination task item.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetMetadataRetrieves the specified metadata on the item.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceWhen overridden in a derived class, gives task items infinite lease time. (Overrides MarshalByRefObject.InitializeLifetimeService().)
Public methodRemoveMetadataRemoves the specified metadata on the item.
Public methodSetMetadataSets or modifies the value of the specified metadata on the item.
Public methodToStringGets the item specification. (Overrides Object.ToString().)

Public operatorStatic memberExplicit(TaskItem to String)Allows an explicit type cast from a TaskItem to a String, and returns the ItemSpec for that item.

Explicit interface implemetationPrivate methodITaskItem2.CloneCustomMetadataEscapedITaskItem2 implementation which returns a clone of the metadata on this object. Values returned are in their original escaped form.
Explicit interface implemetationPrivate propertyITaskItem2.EvaluatedIncludeEscapedITaskItem2 implementation which gets or sets the item include value. For disk-based items this would be the file path.
Explicit interface implemetationPrivate methodITaskItem2.GetMetadataValueEscapedITaskItem2 implementation which allows the values of metadata on the item to be queried.
Explicit interface implemetationPrivate methodITaskItem2.SetMetadataValueLiteralITaskItem2 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.

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft