linux-packaging-mono/mcs/class/System/Documentation/en/System.Net/UploadProgressChangedEventArgs.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

129 lines
8.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="UploadProgressChangedEventArgs" FullName="System.Net.UploadProgressChangedEventArgs">
<TypeSignature Language="C#" Value="public class UploadProgressChangedEventArgs : System.ComponentModel.ProgressChangedEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UploadProgressChangedEventArgs extends System.ComponentModel.ProgressChangedEventArgs" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ComponentModel.ProgressChangedEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instances of this class are passed to the <see cref="T:System.Net.UploadProgressChangedEventHandler" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides data for the <see cref="E:System.Net.WebClient.UploadProgressChanged" /> event of a <see cref="T:System.Net.WebClient" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="BytesReceived">
<MemberSignature Language="C#" Value="public long BytesReceived { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 BytesReceived" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Uploading data to a server may result in a download from the server. For example, suppose your application uploads a POST request to a Web server. The resulting download will update <see cref="P:System.Net.UploadProgressChangedEventArgs.BytesReceived" /> and <see cref="P:System.Net.UploadProgressChangedEventArgs.TotalBytesToReceive" />.</para>
<para>To determine what percentage of the transfer has occurred, use the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> property. When the upload is complete, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 50%. When the download completes, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 100%.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the number of bytes received.</para>
</summary>
</Docs>
</Member>
<Member MemberName="BytesSent">
<MemberSignature Language="C#" Value="public long BytesSent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 BytesSent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Uploading data to a server may result in a download from the server. For example, suppose your application uploads a POST request to a Web server. The resulting download will update <see cref="P:System.Net.UploadProgressChangedEventArgs.BytesReceived" /> and <see cref="P:System.Net.UploadProgressChangedEventArgs.TotalBytesToReceive" />.</para>
<para>To determine what percentage of the transfer has occurred, use the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> property. When the upload is complete, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 50%. When the download completes, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 100%.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the number of bytes sent.</para>
</summary>
</Docs>
</Member>
<Member MemberName="TotalBytesToReceive">
<MemberSignature Language="C#" Value="public long TotalBytesToReceive { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 TotalBytesToReceive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To determine the number of bytes already received, use the <see cref="P:System.Net.DownloadProgressChangedEventArgs.BytesReceived" /> property.</para>
<para>Uploading data to a server may result in a download from the server. For example, suppose your application uploads a POST request to a Web server. The resulting download will update <see cref="P:System.Net.UploadProgressChangedEventArgs.BytesReceived" /> and <see cref="P:System.Net.UploadProgressChangedEventArgs.TotalBytesToReceive" />.</para>
<para>To determine what percentage of the transfer has occurred, use the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> property. When the upload is complete, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 50%. When the download completes, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 100%.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the total number of bytes in a <see cref="T:System.Net.WebClient" /> data upload operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="TotalBytesToSend">
<MemberSignature Language="C#" Value="public long TotalBytesToSend { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 TotalBytesToSend" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To determine the number of bytes already sent, use the <see cref="P:System.Net.UploadProgressChangedEventArgs.BytesSent" /> property.</para>
<para>Uploading data to a server may result in a download from the server. For example, suppose your application uploads a POST request to a Web server. The resulting download will update <see cref="P:System.Net.UploadProgressChangedEventArgs.BytesReceived" /> and <see cref="P:System.Net.UploadProgressChangedEventArgs.TotalBytesToReceive" />.</para>
<para>To determine what percentage of the transfer has occurred, use the <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> property. When the upload is complete, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 50%. When the download completes, <see cref="P:System.ComponentModel.ProgressChangedEventArgs.ProgressPercentage" /> will be 100%.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the total number of bytes to send.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>