ExternalProjectStartedEventArgs.xml

<Type Name="ExternalProjectStartedEventArgs" FullName="Microsoft.Build.Framework.ExternalProjectStartedEventArgs">
  <TypeSignature Language="C#" Value="public class ExternalProjectStartedEventArgs : Microsoft.Build.Framework.CustomBuildEventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit ExternalProjectStartedEventArgs extends Microsoft.Build.Framework.CustomBuildEventArgs" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs" />
  <TypeSignature Language="VB.NET" Value="Public Class ExternalProjectStartedEventArgs&#xA;Inherits CustomBuildEventArgs" />
  <TypeSignature Language="F#" Value="type ExternalProjectStartedEventArgs = class&#xA;    inherit CustomBuildEventArgs" />
  <TypeSignature Language="C++ CLI" Value="public ref class ExternalProjectStartedEventArgs : Microsoft::Build::Framework::CustomBuildEventArgs" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Build.Framework</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>15.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Build.Framework.CustomBuildEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Serializable]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Serializable&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Arguments for external project started events
            </summary>
    <remarks>
            WARNING: marking a type [Serializable] without implementing
            ISerializable imposes a serialization contract -- it is a
            promise to never change the type's fields i.e. the type is
            immutable; adding new fields in the next version of the type
            without following certain special FX guidelines, can break both
            forward and backward compatibility
            </remarks>
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:Microsoft.Build.Framework.ExternalProjectStartedEventArgs" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ExternalProjectStartedEventArgs ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; ExternalProjectStartedEventArgs();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>15.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>
            Default constructor
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ExternalProjectStartedEventArgs (string message, string helpKeyword, string senderName, string projectFile, string targetNames);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, string helpKeyword, string senderName, string projectFile, string targetNames) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (message As String, helpKeyword As String, senderName As String, projectFile As String, targetNames As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Build.Framework.ExternalProjectStartedEventArgs : string * string * string * string * string -&gt; Microsoft.Build.Framework.ExternalProjectStartedEventArgs" Usage="new Microsoft.Build.Framework.ExternalProjectStartedEventArgs (message, helpKeyword, senderName, projectFile, targetNames)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ExternalProjectStartedEventArgs(System::String ^ message, System::String ^ helpKeyword, System::String ^ senderName, System::String ^ projectFile, System::String ^ targetNames);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>15.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="helpKeyword" Type="System.String" />
        <Parameter Name="senderName" Type="System.String" />
        <Parameter Name="projectFile" Type="System.String" />
        <Parameter Name="targetNames" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="message">text message</param>
        <param name="helpKeyword">help keyword</param>
        <param name="senderName">name of the object sending this event</param>
        <param name="projectFile">project name</param>
        <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
        <summary>
            Useful constructor
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ExternalProjectStartedEventArgs (string message, string helpKeyword, string senderName, string projectFile, string targetNames, DateTime eventTimestamp);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, string helpKeyword, string senderName, string projectFile, string targetNames, valuetype System.DateTime eventTimestamp) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.DateTime)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (message As String, helpKeyword As String, senderName As String, projectFile As String, targetNames As String, eventTimestamp As DateTime)" />
      <MemberSignature Language="F#" Value="new Microsoft.Build.Framework.ExternalProjectStartedEventArgs : string * string * string * string * string * DateTime -&gt; Microsoft.Build.Framework.ExternalProjectStartedEventArgs" Usage="new Microsoft.Build.Framework.ExternalProjectStartedEventArgs (message, helpKeyword, senderName, projectFile, targetNames, eventTimestamp)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ExternalProjectStartedEventArgs(System::String ^ message, System::String ^ helpKeyword, System::String ^ senderName, System::String ^ projectFile, System::String ^ targetNames, DateTime eventTimestamp);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>15.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="message" Type="System.String" Index="0" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
        <Parameter Name="helpKeyword" Type="System.String" Index="1" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
        <Parameter Name="senderName" Type="System.String" Index="2" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
        <Parameter Name="projectFile" Type="System.String" Index="3" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
        <Parameter Name="targetNames" Type="System.String" Index="4" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
        <Parameter Name="eventTimestamp" Type="System.DateTime" Index="5" FrameworkAlternate="msbuild-15;msbuild-15-netcore;msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
      </Parameters>
      <Docs>
        <param name="message">text message</param>
        <param name="helpKeyword">help keyword</param>
        <param name="senderName">name of the object sending this event</param>
        <param name="projectFile">project name</param>
        <param name="targetNames">targets we are going to build (empty indicates default targets)</param>
        <param name="eventTimestamp">Timestamp when the event was created</param>
        <summary>
            Useful constructor, including the ability to set the timestamp of the event
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProjectFile">
      <MemberSignature Language="C#" Value="public string ProjectFile { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ProjectFile" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.ProjectFile" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProjectFile As String" />
      <MemberSignature Language="F#" Value="member this.ProjectFile : string" Usage="Microsoft.Build.Framework.ExternalProjectStartedEventArgs.ProjectFile" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ ProjectFile { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>15.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Project name
            </summary>
        <value>The project file that raised the event.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TargetNames">
      <MemberSignature Language="C#" Value="public string TargetNames { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TargetNames" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.ExternalProjectStartedEventArgs.TargetNames" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TargetNames As String" />
      <MemberSignature Language="F#" Value="member this.TargetNames : string" Usage="Microsoft.Build.Framework.ExternalProjectStartedEventArgs.TargetNames" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ TargetNames { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Build.Framework</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>15.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Targets that we will build in the project. This may mean different things for different project types,
            our tasks will put something like Rebuild, Clean, etc. here. This may be null if the project is being
            built with the default target.
            </summary>
        <value>The names of the targets being built in the external project. This can be a null reference (<see langword="Nothing" /> in Visual Basic) if the external project is being built with the default target.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>