This topic has not yet been rated - Rate this topic

ProjectTaskElement Class

Represents a Task Element (MSBuild) in an MSBuild project.

Namespace:  Microsoft.Build.Construction
Assembly:  Microsoft.Build (in Microsoft.Build.dll)
public class ProjectTaskElement : ProjectElementContainer

The ProjectTaskElement type exposes the following members.

  NameDescription
Public propertyAllChildrenGets a recursive depth-first enumerator over all child elements. (Inherited from ProjectElementContainer.)
Public propertyAllParentsAll parent elements of this element, going up to the ProjectRootElement. None if this is a ProjectRootElement. None if this has not been attached to a parent yet. (Inherited from ProjectElement.)
Public propertyChildrenGets all child elements. (Inherited from ProjectElementContainer.)
Public propertyChildrenReversedGets all child elements, starting from the last child. (Inherited from ProjectElementContainer.)
Public propertyConditionGets or sets the Condition value. It will return empty string IFF a condition attribute is legal but it’s not present or has no value. It will return null IFF a Condition attribute is illegal on that element. Removes the attribute if the value to set is empty. It is possible for derived classes to throw an InvalidOperationException if setting the condition is not applicable for those elements. (Inherited from ProjectElement.)
Public propertyConditionLocationLocation of the "Condition" attribute on this element, if any. If there is no such attribute, returns null. (Inherited from ProjectElement.)
Public propertyContainingProjectProjectRootElement (possibly imported) that contains this Xml. Cannot be null. (Inherited from ProjectElement.)
Public propertyContinueOnErrorGets or sets the ContinueOnError attribute value.
Public propertyContinueOnErrorLocationLocation of the "ContinueOnError" attribute on this element, if any. If there is no such attribute, returns null;
Public propertyCountGets the number of child elements. (Inherited from ProjectElementContainer.)
Public propertyFirstChildGets the first child element. (Inherited from ProjectElementContainer.)
Public propertyLabelGets or sets the Label value. Returns empty string if it is not present. Removes the attribute if the value to set is empty. (Inherited from ProjectElement.)
Public propertyLabelLocationLocation of the "Label" attribute on this element, if any. If there is no such attribute, returns null; (Inherited from ProjectElement.)
Public propertyLastChildGets the last child element. (Inherited from ProjectElementContainer.)
Public propertyLocationLocation of the corresponding Xml element. May not be correct if file is not saved, or file has been edited since it was last saved. In the case of an unsaved edit, the location only contains the path to the file that the element originates from. (Inherited from ProjectElement.)
Public propertyMSBuildArchitectureGets or sets the architecture value for the task. Returns empty string if it is not present. Removes the attribute if the value to set is empty.
Public propertyMSBuildArchitectureLocationLocation of the "MSBuildArchitecture" attribute on this element, if any. If there is no such attribute, returns null;
Public propertyMSBuildRuntimeGets or sets the runtime value for the task. Returns empty string if it is not present. Removes the attribute if the value to set is empty.
Public propertyMSBuildRuntimeLocationLocation of the "MSBuildRuntime" attribute on this element, if any. If there is no such attribute, returns null;
Public propertyNameGets the name of this task.
Public propertyNextSiblingNext sibling element. May be null. (Inherited from ProjectElement.)
Public propertyOutputsGets all Output Element (MSBuild) children.
Public propertyParameterLocationsEnumerable over the locations of parameters on the task. Condition and ContinueOnError, which have their own properties, are not included in this collection. If parameters differ only by case only the last one will be returned. Hosts can still remove the other parameters by using RemoveAllParameters().
Public propertyParametersGets all unevaluated parameters of this task.
Public propertyParentNull if this is a ProjectRootElement. Null if this has not been attached to a parent yet. (Inherited from ProjectElement.)
Public propertyPreviousSiblingPrevious sibling element. May be null. (Inherited from ProjectElement.)
Top
  NameDescription
Public methodAddOutputItem(String, String)Adds an Output item after the last child.
Public methodAddOutputItem(String, String, String)Adds a conditioned Output item to this task after the last child.
Public methodAddOutputProperty(String, String)Adds an Output property to this task after the last child.
Public methodAddOutputProperty(String, String, String)Adds a conditioned Output property to this task after the last child.
Public methodAppendChildAppends the child element as the last child of this project container. (Inherited from ProjectElementContainer.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetParameterGets the value of the parameter with the specified name.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInsertAfterChildInserts the child element after the reference element. (Inherited from ProjectElementContainer.)
Public methodInsertBeforeChildInserts the child element before the reference element. (Inherited from ProjectElementContainer.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPrependChildPrepends the child element as the first child of this project container. (Inherited from ProjectElementContainer.)
Public methodRemoveAllChildrenRemoves all the children, if any, from this project container. (Inherited from ProjectElementContainer.)
Public methodRemoveAllParametersRemoves all parameters from the task. Does not remove any ContinueOnError and/or Condition attributes.
Public methodRemoveChildRemoves a child element from this project container. (Inherited from ProjectElementContainer.)
Public methodRemoveParameterRemoves any parameter on this task with the specified name. If no parameter by that name exists in the task, does nothing.
Public methodSetParameterUpdates or adds a parameter on this task
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

.NET Framework

Supported in: 4.5, 4

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.