mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/Microsoft.Build.Engine/Documentation/en/Microsoft.Build.BuildEngine/BuildItem.xml

390 lines
17 KiB
XML
Raw Normal View History

Imported Upstream version 3.6.0 Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BuildItem" FullName="Microsoft.Build.BuildEngine.BuildItem">
<TypeSignature Language="C#" Value="public class BuildItem" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Engine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version="2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <format type="text/html"><a href="dcef5f91-0613-4bfc-8ee9-d7004bb6d3a9">Item</a></format> element in a project can represent multiple items through the use of wildcards. Therefore, each <see cref="T:Microsoft.Build.BuildEngine.BuildItem" /> object does not necessarily represent an <unmanagedCodeEntityReference>Item</unmanagedCodeEntityReference> element in the project.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a single item in an vstecmsbuild project. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BuildItem (string itemName, Microsoft.Build.Framework.ITaskItem taskItem);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="itemName" Type="System.String" />
<Parameter Name="taskItem" Type="Microsoft.Build.Framework.ITaskItem" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" /> class based on an <see cref="T:Microsoft.Build.Framework.ITaskItem" /> object.</para>
</summary>
<param name="itemName">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Name" /> property of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</param>
<param name="taskItem">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.Framework.ITaskItem" /> from which to create the <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Include" /> property of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BuildItem (string itemName, string itemInclude);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="itemName" Type="System.String" />
<Parameter Name="itemInclude" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" /> class with the specified <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Name" /> and <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Include" /> property values.</para>
</summary>
<param name="itemName">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Name" /> property of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</param>
<param name="itemInclude">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:Microsoft.Build.BuildEngine.BuildItem.Include" /> property of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Microsoft.Build.BuildEngine.BuildItem Clone ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Microsoft.Build.BuildEngine.BuildItem</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a shallow copy of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A copy of the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Condition">
<MemberSignature Language="C#" Value="public string Condition { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the <unmanagedCodeEntityReference>Condition</unmanagedCodeEntityReference> attribute value of the item.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyCustomMetadataTo">
<MemberSignature Language="C#" Value="public void CopyCustomMetadataTo (Microsoft.Build.BuildEngine.BuildItem destinationItem);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="destinationItem" Type="Microsoft.Build.BuildEngine.BuildItem" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies all item metadata on this <see cref="T:Microsoft.Build.BuildEngine.BuildItem" /> to the specified <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</para>
</summary>
<param name="destinationItem">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Build.BuildEngine.BuildItem" /> to which to copy the item metadata.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Exclude">
<MemberSignature Language="C#" Value="public string Exclude { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the <unmanagedCodeEntityReference>Exclude</unmanagedCodeEntityReference> attribute value of the item.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FinalItemSpec">
<MemberSignature Language="C#" Value="public string FinalItemSpec { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the final specification of the item after all wildcards and properties have been evaluated.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetEvaluatedMetadata">
<MemberSignature Language="C#" Value="public string GetEvaluatedMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the value of the specified item metadata after after all item and property references have been evaluated.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value of the specified item metadata after after all item and property references have been evaluated.</para>
</returns>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetMetadata">
<MemberSignature Language="C#" Value="public string GetMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the value of the specified item metadata.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value of the specified item metadata.</para>
</returns>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HasMetadata">
<MemberSignature Language="C#" Value="public bool HasMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the item has the specified item metadata.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the item has the specified item metadata; otherwise, false.</para>
</returns>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Include">
<MemberSignature Language="C#" Value="public string Include { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the <unmanagedCodeEntityReference>Include</unmanagedCodeEntityReference> attribute that created the <see cref="T:Microsoft.Build.BuildEngine.BuildItem" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsImported">
<MemberSignature Language="C#" Value="public bool IsImported { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the item was imported into the project.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the item collection to which the item belongs.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RemoveMetadata">
<MemberSignature Language="C#" Value="public void RemoveMetadata (string metadataName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the specified item metadata.</para>
</summary>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetMetadata">
<MemberSignature Language="C#" Value="public void SetMetadata (string metadataName, string metadataValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
<Parameter Name="metadataValue" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Assigns the specified value to the specified item metadata.</para>
</summary>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
<param name="metadataValue">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata value.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetMetadata">
<MemberSignature Language="C#" Value="public void SetMetadata (string metadataName, string metadataValue, bool treatMetadataValueAsLiteral);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataName" Type="System.String" />
<Parameter Name="metadataValue" Type="System.String" />
<Parameter Name="treatMetadataValueAsLiteral" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version="2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Assigns the specified value to the specified item metadata, and optionally treats the metadata as a literal value.</para>
</summary>
<param name="metadataName">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata name.</param>
<param name="metadataValue">
<attribution license="cc4" from="Microsoft" modified="false" />The item metadata value.</param>
<param name="treatMetadataValueAsLiteral">
<attribution license="cc4" from="Microsoft" modified="false" />true to treat the metadata as a literal value by escaping all vstecmsbuild special characters; otherwise, false.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
Reference in New Issue Copy Permalink