Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
290 lines (281 sloc) 17 KB
<Type Name="Target" FullName="Microsoft.Build.BuildEngine.Target">
<TypeSignature Language="C#" Value="public class Target : System.Collections.IEnumerable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Target extends System.Object implements class System.Collections.IEnumerable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.BuildEngine.Target" />
<TypeSignature Language="VB.NET" Value="Public Class Target&#xA;Implements IEnumerable" />
<TypeSignature Language="C++ CLI" Value="public ref class Target : System::Collections::IEnumerable" />
<TypeSignature Language="F#" Value="type Target = class&#xA; interface IEnumerable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Diagnostics.DebuggerDisplay("Target (Name = { Name }, Condition = { Condition })")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a single <see href="https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca">Target</see> element in an MSBuild project.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddNewTask">
<MemberSignature Language="C#" Value="public Microsoft.Build.BuildEngine.BuildTask AddNewTask (string taskName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Build.BuildEngine.BuildTask AddNewTask(string taskName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.BuildEngine.Target.AddNewTask(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AddNewTask (taskName As String) As BuildTask" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Microsoft::Build::BuildEngine::BuildTask ^ AddNewTask(System::String ^ taskName);" />
<MemberSignature Language="F#" Value="member this.AddNewTask : string -&gt; Microsoft.Build.BuildEngine.BuildTask" Usage="target.AddNewTask taskName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.BuildTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskName" Type="System.String" />
</Parameters>
<Docs>
<param name="taskName">The <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> object that represents the <see langword="Task" /> element to add to the <see langword="Target" /> element.</param>
<summary>Adds the specified <see href="https://msdn.microsoft.com/library/d82e2485-e5f0-4936-a357-745bacccc299">Task</see> element to the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element.</summary>
<returns>A <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> object represents a child <c>Task</c> element of the <c>Target</c> element.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Condition">
<MemberSignature Language="C#" Value="public string Condition { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Condition" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.Condition" />
<MemberSignature Language="VB.NET" Value="Public Property Condition As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Condition { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Condition : string with get, set" Usage="Microsoft.Build.BuildEngine.Target.Condition" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <c>Condition</c> attribute value of the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element.</summary>
<value>The <c>Condition</c> attribute value of the <c>Target</c> element.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DependsOnTargets">
<MemberSignature Language="C#" Value="public string DependsOnTargets { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DependsOnTargets" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.DependsOnTargets" />
<MemberSignature Language="VB.NET" Value="Public Property DependsOnTargets As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ DependsOnTargets { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.DependsOnTargets : string with get, set" Usage="Microsoft.Build.BuildEngine.Target.DependsOnTargets" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <c>DependsOnTargets</c> attribute value of the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element, which is a semicolon-separated list.</summary>
<value>The <c>DependsOnTargets</c> attribute value of the <c>Target</c> element.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
<MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.IEnumerator GetEnumerator() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.BuildEngine.Target.GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Public Function GetEnumerator () As IEnumerator" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual System::Collections::IEnumerator ^ GetEnumerator();" />
<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -&gt; System.Collections.IEnumerator&#xA;override this.GetEnumerator : unit -&gt; System.Collections.IEnumerator" Usage="target.GetEnumerator " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets an enumerator that iterates through the <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> objects in the <see cref="T:Microsoft.Build.BuildEngine.Target" />.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> objects in the <see cref="T:Microsoft.Build.BuildEngine.Target" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method allows the caller to use the `foreach` statement of the C# language (`for each` in Visual Basic) to iterate through the individual <xref:Microsoft.Build.BuildEngine.BuildTask> objects in the <xref:Microsoft.Build.BuildEngine.Target>.
A <xref:Microsoft.Build.BuildEngine.BuildTask> object represents a child [Task](/visualstudio/msbuild/task-element-msbuild) element of the `Target` element.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Inputs">
<MemberSignature Language="C#" Value="public string Inputs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Inputs" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.Inputs" />
<MemberSignature Language="VB.NET" Value="Public Property Inputs As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Inputs { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Inputs : string with get, set" Usage="Microsoft.Build.BuildEngine.Target.Inputs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the items that are to be input into this target.</summary>
<value>A string representing the items.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Items inside this target attribute are used as the inputs in the top level dependency analysis.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsImported">
<MemberSignature Language="C#" Value="public bool IsImported { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsImported" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.IsImported" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsImported As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsImported { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsImported : bool" Usage="Microsoft.Build.BuildEngine.Target.IsImported" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element was imported into the project.</summary>
<value>
<see langword="true" /> if the <c>Target</c> element was imported into the project; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Name { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Build.BuildEngine.Target.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <c>Name</c> attribute value of the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element.</summary>
<value>The <c>Name</c> attribute value of the <c>Target</c> element.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Outputs">
<MemberSignature Language="C#" Value="public string Outputs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Outputs" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.BuildEngine.Target.Outputs" />
<MemberSignature Language="VB.NET" Value="Public Property Outputs As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Outputs { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Outputs : string with get, set" Usage="Microsoft.Build.BuildEngine.Target.Outputs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the expected outputs of this target.</summary>
<value>A string representing the outputs.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You can apply transforms to this target attribute to transform a set of input items into a set of output items. This attribute is used not only for top level dependency analysis but also for the purposes of defining this targets outputs.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveTask">
<MemberSignature Language="C#" Value="public void RemoveTask (Microsoft.Build.BuildEngine.BuildTask taskElement);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveTask(class Microsoft.Build.BuildEngine.BuildTask taskElement) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.BuildEngine.Target.RemoveTask(Microsoft.Build.BuildEngine.BuildTask)" />
<MemberSignature Language="VB.NET" Value="Public Sub RemoveTask (taskElement As BuildTask)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void RemoveTask(Microsoft::Build::BuildEngine::BuildTask ^ taskElement);" />
<MemberSignature Language="F#" Value="member this.RemoveTask : Microsoft.Build.BuildEngine.BuildTask -&gt; unit" Usage="target.RemoveTask taskElement" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="taskElement" Type="Microsoft.Build.BuildEngine.BuildTask" />
</Parameters>
<Docs>
<param name="taskElement">The <see cref="T:Microsoft.Build.BuildEngine.BuildTask" /> object that represents the <see langword="Task" /> element to remove from the <see langword="Target" /> element.</param>
<summary>Removes the specified <see href="https://msdn.microsoft.com/library/d82e2485-e5f0-4936-a357-745bacccc299">Task</see> element from the [Target](https://msdn.microsoft.com/library/350f6fc2-86b3-45f2-a31e-ece0e6bd4dca) element.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A <xref:Microsoft.Build.BuildEngine.BuildTask> object represents a child `Task` element of the `Target` element.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.