DeploymentProgressChangedEventArgs.xml

<Type Name="DeploymentProgressChangedEventArgs" FullName="System.Deployment.Application.DeploymentProgressChangedEventArgs">
  <TypeSignature Language="C#" Value="public class DeploymentProgressChangedEventArgs : System.ComponentModel.ProgressChangedEventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DeploymentProgressChangedEventArgs extends System.ComponentModel.ProgressChangedEventArgs" />
  <TypeSignature Language="DocId" Value="T:System.Deployment.Application.DeploymentProgressChangedEventArgs" />
  <TypeSignature Language="VB.NET" Value="Public Class DeploymentProgressChangedEventArgs&#xA;Inherits ProgressChangedEventArgs" />
  <TypeSignature Language="F#" Value="type DeploymentProgressChangedEventArgs = class&#xA;    inherit ProgressChangedEventArgs" />
  <TypeSignature Language="C++ CLI" Value="public ref class DeploymentProgressChangedEventArgs : System::ComponentModel::ProgressChangedEventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Deployment</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.ProgressChangedEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents progress data reported in an asynchronous operation.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This class contains properties that describe progress for the <xref:System.Deployment.Application.ApplicationDeployment.CheckForUpdateProgressChanged>, <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupProgressChanged>, and <xref:System.Deployment.Application.ApplicationDeployment.UpdateProgressChanged> events. Not every property in this class applies to each event.  
  
 <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesCompleted%2A> and <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesTotal%2A> represent the total number of bytes downloaded to date and the total number of bytes in the download operation, respectively; they apply to all three events. <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.Group%2A> names the file group corresponding to the current <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupProgressChanged> event, and <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.State%2A> reflects the current stage of the download operation.  
  
   
  
## Examples  
 The following code example downloads a file group named `HelpFiles`, and displays download progress in a status bar. This example requires that you deploy a Windows Forms application, and that your main form has a <xref:System.Windows.Forms.StatusStrip> control, and a <xref:System.Windows.Forms.ToolStripStatusLabel> control named `downloadStatus`.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ClickOnceAPI/cpp/form1.cpp" id="Snippet8":::
 :::code language="csharp" source="~/snippets/csharp/System.Deployment.Application/ApplicationDeployment/Overview/Form1.cs" id="Snippet8":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClickOnceAPI/VB/Form1.vb" id="Snippet8":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Deployment.Application.DeploymentProgressChangedEventHandler" />
  </Docs>
  <Members>
    <Member MemberName="BytesCompleted">
      <MemberSignature Language="C#" Value="public long BytesCompleted { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 BytesCompleted" />
      <MemberSignature Language="DocId" Value="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesCompleted" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property BytesCompleted As Long" />
      <MemberSignature Language="F#" Value="member this.BytesCompleted : int64" Usage="System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesCompleted" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property long BytesCompleted { long get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Deployment</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the number of bytes already downloaded by this operation.</summary>
        <value>An <see cref="T:System.Int64" /> representing the data already transferred, in bytes.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For <xref:System.Deployment.Application.ApplicationDeployment.CheckForUpdateProgressChanged>, the <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesCompleted%2A> property refers to the downloading of the deployment manifest. For <xref:System.Deployment.Application.ApplicationDeployment.UpdateProgressChanged>, the property refers to the download progress of the entire update, included the manifests, assemblies, and data files. For <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupProgressChanged>, the property refers to the download progress of the entire set of files that are part of the named group.  
  
   
  
## Examples  
 The following code example downloads a file group named `HelpFiles`, and displays download progress in a status bar. This example requires that you deploy a Windows Forms application, and that your main form has a <xref:System.Windows.Forms.StatusStrip> control, and a <xref:System.Windows.Forms.ToolStripStatusLabel> control named `downloadStatus`.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ClickOnceAPI/cpp/form1.cpp" id="Snippet8":::
 :::code language="csharp" source="~/snippets/csharp/System.Deployment.Application/ApplicationDeployment/Overview/Form1.cs" id="Snippet8":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClickOnceAPI/VB/Form1.vb" id="Snippet8":::  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesTotal" />
      </Docs>
    </Member>
    <Member MemberName="BytesTotal">
      <MemberSignature Language="C#" Value="public long BytesTotal { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 BytesTotal" />
      <MemberSignature Language="DocId" Value="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesTotal" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property BytesTotal As Long" />
      <MemberSignature Language="F#" Value="member this.BytesTotal : int64" Usage="System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesTotal" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property long BytesTotal { long get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Deployment</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the total number of bytes in the download operation.</summary>
        <value>An <see cref="T:System.Int64" /> representing the total size of the download, in bytes.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For <xref:System.Deployment.Application.ApplicationDeployment.CheckForUpdateProgressChanged>, the <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesTotal%2A> property refers to the downloading of the deployment manifest. For <xref:System.Deployment.Application.ApplicationDeployment.UpdateProgressChanged>, the property refers to the download progress of the entire update, included the manifests, assemblies, and data files. For <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupProgressChanged>, the property refers to the download progress of the entire set of files that are part of the named group.  
  
   
  
## Examples  
 The following code example downloads a file group named `HelpFiles`, and displays download progress in a status bar. This example requires that you deploy a Windows Forms application, and that your main form has a <xref:System.Windows.Forms.StatusStrip> control, and a <xref:System.Windows.Forms.ToolStripStatusLabel> control named `downloadStatus`.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ClickOnceAPI/cpp/form1.cpp" id="Snippet8":::
 :::code language="csharp" source="~/snippets/csharp/System.Deployment.Application/ApplicationDeployment/Overview/Form1.cs" id="Snippet8":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClickOnceAPI/VB/Form1.vb" id="Snippet8":::  
  
 ]]></format>
        </remarks>
        <altmember cref="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.BytesCompleted" />
      </Docs>
    </Member>
    <Member MemberName="Group">
      <MemberSignature Language="C#" Value="public string Group { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Group" />
      <MemberSignature Language="DocId" Value="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.Group" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Group As String" />
      <MemberSignature Language="F#" Value="member this.Group : string" Usage="System.Deployment.Application.DeploymentProgressChangedEventArgs.Group" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Group { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Deployment</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the name of the file group being downloaded.</summary>
        <value>A <see cref="T:System.String" /> containing the name of the file group, if the event occurred as the result of a call to <see cref="Overload:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupAsync" />; otherwise, a zero-length string.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 You can initiate multiple calls to <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroupAsync%2A> and download multiple file groups simultaneously. Use <xref:System.Deployment.Application.DeploymentProgressChangedEventArgs.Group%2A> to determine which event callbacks correspond to which group.  
  
   
  
## Examples  
 The following code example downloads a file group named `HelpFiles`, and displays download progress in a status bar. This example requires that you deploy a Windows Forms application, and that your main form has a <xref:System.Windows.Forms.StatusStrip> control, and a <xref:System.Windows.Forms.ToolStripStatusLabel> control named `downloadStatus`.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ClickOnceAPI/cpp/form1.cpp" id="Snippet8":::
 :::code language="csharp" source="~/snippets/csharp/System.Deployment.Application/ApplicationDeployment/Overview/Form1.cs" id="Snippet8":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClickOnceAPI/VB/Form1.vb" id="Snippet8":::  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="State">
      <MemberSignature Language="C#" Value="public System.Deployment.Application.DeploymentProgressState State { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Deployment.Application.DeploymentProgressState State" />
      <MemberSignature Language="DocId" Value="P:System.Deployment.Application.DeploymentProgressChangedEventArgs.State" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As DeploymentProgressState" />
      <MemberSignature Language="F#" Value="member this.State : System.Deployment.Application.DeploymentProgressState" Usage="System.Deployment.Application.DeploymentProgressChangedEventArgs.State" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Deployment::Application::DeploymentProgressState State { System::Deployment::Application::DeploymentProgressState get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Deployment</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Deployment.Application.DeploymentProgressState</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the action that the process is currently executing.</summary>
        <value>A <see cref="T:System.Deployment.Application.DeploymentProgressState" /> value, stating what element or elements the operation is currently downloading.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code example downloads a file group named `HelpFiles`, and displays download progress in a status bar. This example requires that you deploy a Windows Forms application, and that your main form has a <xref:System.Windows.Forms.StatusStrip> control, and a <xref:System.Windows.Forms.ToolStripStatusLabel> control named `downloadStatus`.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ClickOnceAPI/cpp/form1.cpp" id="Snippet8":::
 :::code language="csharp" source="~/snippets/csharp/System.Deployment.Application/ApplicationDeployment/Overview/Form1.cs" id="Snippet8":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ClickOnceAPI/VB/Form1.vb" id="Snippet8":::  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>