412 lines
20 KiB
XML
412 lines
20 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="ContentDispositionHeaderValue" FullName="System.Net.Http.Headers.ContentDispositionHeaderValue">
|
||
<TypeSignature Language="C#" Value="public class ContentDispositionHeaderValue : ICloneable" />
|
||
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ContentDispositionHeaderValue extends System.Object implements class System.ICloneable" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System.Net.Http</AssemblyName>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Base>
|
||
<BaseTypeName>System.Object</BaseTypeName>
|
||
</Base>
|
||
<Interfaces>
|
||
<Interface>
|
||
<InterfaceName>System.ICloneable</InterfaceName>
|
||
</Interface>
|
||
</Interfaces>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The Content-Disposition header is normally used for working with file uploads and downloads. The format differs from other headers in that it is a single header with a disposition type followed by a list of parameters, some of which are well defined. </para>
|
||
<para>This header is used in two different contexts: </para>
|
||
<list type="ordered">
|
||
<item>
|
||
<para>A MIME header for nested body content in the <see cref="T:System.Net.Http.MultipartFormDataContent" /> class. For more information, see IETF RFC 2183.</para>
|
||
</item>
|
||
<item>
|
||
<para>An HTTP header in <see cref="T:System.Net.Http.Headers.HttpContentHeaders" /> class. For more information, see IETF RFC 6266.</para>
|
||
</item>
|
||
</list>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Represents the value of the Content-Disposition header.</para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="protected ContentDispositionHeaderValue (System.Net.Http.Headers.ContentDispositionHeaderValue source);" />
|
||
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Net.Http.Headers.ContentDispositionHeaderValue source) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="source" Type="System.Net.Http.Headers.ContentDispositionHeaderValue" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> class.</para>
|
||
</summary>
|
||
<param name="source">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" />. </param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public ContentDispositionHeaderValue (string dispositionType);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string dispositionType) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="dispositionType" Type="System.String" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> class.</para>
|
||
</summary>
|
||
<param name="dispositionType">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />A string that contains a <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" />.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CreationDate">
|
||
<MemberSignature Language="C#" Value="public Nullable<DateTimeOffset> CreationDate { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> CreationDate" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The date at which the file was created.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="DispositionType">
|
||
<MemberSignature Language="C#" Value="public string DispositionType { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance string DispositionType" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A body part should be marked with a <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.DispositionType" /> property of "inline" if it is intended to be displayed automatically upon display of the message. A body part can be designated with a <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.DispositionType" /> property of "attachment" to indicate that they are separate from the main body of the HTTP request or response.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The disposition type for a content body part.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Equals">
|
||
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="obj" Type="System.Object" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> object.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns <see cref="T:System.Boolean" />.</para>
|
||
<para>true if the specified <see cref="T:System.Object" /> is equal to the current object; otherwise, false.</para>
|
||
</returns>
|
||
<param name="obj">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current object.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="FileName">
|
||
<MemberSignature Language="C#" Value="public string FileName { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance string FileName" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.FileName" /> property uses MIME encoding for non-ascii characters.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A suggestion for how to construct a filename for storing the message payload to be used if the entity is detached and stored in a separate file.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="FileNameStar">
|
||
<MemberSignature Language="C#" Value="public string FileNameStar { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance string FileNameStar" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.FileNameStar" /> property uses IETF RFC 5987 encoding. The <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.FileName" /> and <see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.FileNameStar" /> properties differ only in that<see cref="P:System.Net.Http.Headers.ContentDispositionHeaderValue.FileNameStar" /> uses the encoding defined in IETF RFC 5987, allowing the use of characters not present in the ISO-8859-1 character set.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A suggestion for how to construct filenames for storing message payloads to be used if the entities are detached and stored in a separate files.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="GetHashCode">
|
||
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A hash code is a numeric value that is used to identify an object during equality testing. It can also serve as an index for an object in a collection.</para>
|
||
<para>The <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> method is suitable for use in hashing algorithms and data structures such as a hash table.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Serves as a hash function for an <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> object.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns <see cref="T:System.Int32" />.</para>
|
||
<para>A hash code for the current object.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="ModificationDate">
|
||
<MemberSignature Language="C#" Value="public Nullable<DateTimeOffset> ModificationDate { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> ModificationDate" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The date at which the file was last modified. </para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Name">
|
||
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The name for a content body part.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Parameters">
|
||
<MemberSignature Language="C#" Value="public System.Collections.Generic.ICollection<System.Net.Http.Headers.NameValueHeaderValue> Parameters { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ICollection`1<class System.Net.Http.Headers.NameValueHeaderValue> Parameters" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Collections.Generic.ICollection<System.Net.Http.Headers.NameValueHeaderValue></ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A set of parameters included the Content-Disposition header.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Parse">
|
||
<MemberSignature Language="C#" Value="public static System.Net.Http.Headers.ContentDispositionHeaderValue Parse (string input);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Http.Headers.ContentDispositionHeaderValue Parse(string input) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Net.Http.Headers.ContentDispositionHeaderValue</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="input" Type="System.String" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Converts a string to an <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> instance.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" />.</para>
|
||
<para>An <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> instance.</para>
|
||
</returns>
|
||
<param name="input">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />A string that represents content disposition header value information.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="ReadDate">
|
||
<MemberSignature Language="C#" Value="public Nullable<DateTimeOffset> ReadDate { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> ReadDate" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The date the file was last read.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Size">
|
||
<MemberSignature Language="C#" Value="public Nullable<long> Size { get; set; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> Size" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Nullable<System.Int64></ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The approximate size, in bytes, of the file. </para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.ICloneable.Clone">
|
||
<MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance object System.ICloneable.Clone() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Object</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> instance.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns <see cref="T:System.Object" />.</para>
|
||
<para>A copy of the current instance.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="ToString">
|
||
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns a string that represents the current <see cref="T:System.Net.Http.Headers.ContentDispositionHeaderValue" /> object.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns <see cref="T:System.String" />.</para>
|
||
<para>A string that represents the current object.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryParse">
|
||
<MemberSignature Language="C#" Value="public static bool TryParse (string input, out System.Net.Http.Headers.ContentDispositionHeaderValue parsedValue);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(string input, class System.Net.Http.Headers.ContentDispositionHeaderValue parsedValue) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="input" Type="System.String" />
|
||
<Parameter Name="parsedValue" Type="System.Net.Http.Headers.ContentDispositionHeaderValue&" RefType="out" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="input">To be added.</param>
|
||
<param name="parsedValue">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
</Members>
|
||
</Type> |