359 lines
21 KiB
XML
359 lines
21 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="AlternateView" FullName="System.Net.Mail.AlternateView">
|
|
<TypeSignature Language="C#" Value="public class AlternateView : System.Net.Mail.AttachmentBase" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AlternateView extends System.Net.Mail.AttachmentBase" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Net.Mail.AttachmentBase</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="T:System.Net.Mail.AlternateView" /> class to specify copies of an e-mail message in different formats. For example, if you send a message in HTML, you might also want provide a plain text version in case some of the recipients use e-mail readers that cannot display HTML content.</para>
|
|
<para>This class has two properties <see cref="P:System.Net.Mail.AlternateView.LinkedResources" /> and <see cref="P:System.Net.Mail.AlternateView.BaseUri" /> that are used to resolve URLs within the content of the email. <see cref="P:System.Net.Mail.AlternateView.LinkedResources" /> is a collection of <see cref="T:System.Net.Mail.LinkedResource" /> objects. When rendered, URLs within the e-mail's content are first matched against the URLs in the <see cref="P:System.Net.Mail.LinkedResource.ContentLink" /> of each <see cref="T:System.Net.Mail.LinkedResource" /> object in the <see cref="P:System.Net.Mail.AlternateView.LinkedResources" /> collection, and resolved. <see cref="P:System.Net.Mail.AlternateView.BaseUri" /> is used by the mail reader to resolve relative URLs within the body, and also to resolve relative <see cref="P:System.Net.Mail.LinkedResource.ContentLink" /> URLs, in the <see cref="P:System.Net.Mail.AlternateView.LinkedResources" /> collection.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents the format to view an email message.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (System.IO.Stream contentStream);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="contentStream" Type="System.IO.Stream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified <see cref="T:System.IO.Stream" />.</para>
|
|
</summary>
|
|
<param name="contentStream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A stream that contains the content for this view.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (string fileName);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="fileName" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified file name.</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the file that contains the content for this alternate view.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (System.IO.Stream contentStream, System.Net.Mime.ContentType contentType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream, class System.Net.Mime.ContentType contentType) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="contentStream" Type="System.IO.Stream" />
|
|
<Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified <see cref="T:System.IO.Stream" /> and <see cref="T:System.Net.Mime.ContentType" />.</para>
|
|
</summary>
|
|
<param name="contentStream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A stream that contains the content for this attachment.</param>
|
|
<param name="contentType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of the content.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (System.IO.Stream contentStream, string mediaType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream, string mediaType) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="contentStream" Type="System.IO.Stream" />
|
|
<Parameter Name="mediaType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified <see cref="T:System.IO.Stream" /> and media type.</para>
|
|
</summary>
|
|
<param name="contentStream">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A stream that contains the content for this attachment.</param>
|
|
<param name="mediaType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The MIME media type of the content.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (string fileName, System.Net.Mime.ContentType contentType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName, class System.Net.Mime.ContentType contentType) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="fileName" Type="System.String" />
|
|
<Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified file name and content type.</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the file that contains the content for this alternate view.</param>
|
|
<param name="contentType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of the content.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public AlternateView (string fileName, string mediaType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName, string mediaType) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="fileName" Type="System.String" />
|
|
<Parameter Name="mediaType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of the <see cref="T:System.Net.Mail.AlternateView" /> class call also be initialized by calling one of the <see cref="Overload:System.Net.Mail.AlternateView.CreateAlternateViewFromString" /> methods. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of <see cref="T:System.Net.Mail.AlternateView" /> with the specified file name and media type.</para>
|
|
</summary>
|
|
<param name="fileName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the file that contains the content for this alternate view.</param>
|
|
<param name="mediaType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The MIME media type of the content.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="BaseUri">
|
|
<MemberSignature Language="C#" Value="public Uri BaseUri { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri BaseUri" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Uri</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the base URI to use for resolving relative URIs in the <see cref="T:System.Net.Mail.AlternateView" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateAlternateViewFromString">
|
|
<MemberSignature Language="C#" Value="public static System.Net.Mail.AlternateView CreateAlternateViewFromString (string content);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.AlternateView CreateAlternateViewFromString(string content) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.Mail.AlternateView</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="content" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default media type is plain text and the default encoding is ASCII.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a <see cref="T:System.Net.Mail.AlternateView" /> of an email message using the content specified in a <see cref="T:System.String" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Net.Mail.AlternateView" /> object that represents an alternate view of an email message.</para>
|
|
</returns>
|
|
<param name="content">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> that contains the content of the email message.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateAlternateViewFromString">
|
|
<MemberSignature Language="C#" Value="public static System.Net.Mail.AlternateView CreateAlternateViewFromString (string content, System.Net.Mime.ContentType contentType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.AlternateView CreateAlternateViewFromString(string content, class System.Net.Mime.ContentType contentType) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.Mail.AlternateView</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="content" Type="System.String" />
|
|
<Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates an <see cref="T:System.Net.Mail.AlternateView" /> of an email message using the content specified in a <see cref="T:System.String" /> and the specified MIME media type of the content.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Net.Mail.AlternateView" /> object that represents an alternate view of an email message.</para>
|
|
</returns>
|
|
<param name="content">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
|
|
<param name="contentType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Net.Mime.ContentType" /> that describes the data in <paramref name="string" />.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateAlternateViewFromString">
|
|
<MemberSignature Language="C#" Value="public static System.Net.Mail.AlternateView CreateAlternateViewFromString (string content, System.Text.Encoding encoding, string mediaType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.AlternateView CreateAlternateViewFromString(string content, class System.Text.Encoding encoding, string mediaType) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.Mail.AlternateView</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="content" Type="System.String" />
|
|
<Parameter Name="encoding" Type="System.Text.Encoding" />
|
|
<Parameter Name="mediaType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="encoding">To be added.</param>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates an <see cref="T:System.Net.Mail.AlternateView" /> of an email message using the content specified in a <see cref="T:System.String" />, the specified text encoding, and MIME media type of the content.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Net.Mail.AlternateView" /> object that represents an alternate view of an email message.</para>
|
|
</returns>
|
|
<param name="content">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
|
|
<param name="mediaType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The MIME media type of the content.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Dispose">
|
|
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="disposing" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This method is called by the public Dispose() method and the <see cref="M:System.Object.Finalize" /> method. Dispose() invokes the protected Dispose(Boolean) method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes Dispose with <paramref name="disposing" /> set to false.</para>
|
|
<para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Net.Mail.AlternateView" /> references. This method invokes the Dispose() method of each referenced object.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Releases the unmanaged resources used by the <see cref="T:System.Net.Mail.AlternateView" /> and optionally releases the managed resources. </para>
|
|
</summary>
|
|
<param name="disposing">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LinkedResources">
|
|
<MemberSignature Language="C#" Value="public System.Net.Mail.LinkedResourceCollection LinkedResources { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.LinkedResourceCollection LinkedResources" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.Mail.LinkedResourceCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the set of embedded resources referred to by this attachment.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |