Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

77 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="MailFileEditor" FullName="System.Web.UI.Design.MailFileEditor">
<TypeSignature Language="C#" Value="public class MailFileEditor : System.Web.UI.Design.UrlEditor" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.UrlEditor</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.Design.MailFileEditor" /> class is an <see cref="T:System.Drawing.Design.UITypeEditor" /> object that can be used at design time to select and edit a mail file name as a string, and assign the string to a control property. For example, the <see cref="T:System.Web.UI.WebControls.EmbeddedMailObject" /> control uses the <see cref="T:System.Web.UI.Design.MailFileEditor" /> class at design time to set the value of the <see cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" /> property.</para>
<para>Use the <see cref="T:System.ComponentModel.EditorAttribute" /> attribute to associate the <see cref="T:System.Web.UI.Design.MailFileEditor" /> with a property. When the associated property is edited in the design surface, the designer host calls the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method. The <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method displays a dialog box for selecting a mail file name from a filtered list of files, and returns the file name that is selected by the user. The <see cref="Overload:System.Web.UI.Design.UrlEditor.GetEditStyle" /> method indicates the display style of the user interface.</para>
<para>Derive a class from the <see cref="T:System.Web.UI.Design.MailFileEditor" /> to define a custom editor for a mail file name property. For example, a derived class can override the <see cref="Overload:System.Web.UI.Design.UrlEditor.EditValue" /> method, and display an <see cref="T:System.Windows.Forms.OpenFileDialog" /> instance with a custom mail file filter or title.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a user interface for selecting and editing a mail file name for a property at design time.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MailFileEditor ();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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.Web.UI.Design.MailFileEditor" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Caption">
<MemberSignature Language="C#" Value="protected override string Caption { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.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>Gets the caption for the editor dialog.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="protected override string Filter { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.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>Gets the file filter string for the dialog (such as "*.txt").</para>
</summary>
</Docs>
</Member>
</Members>
</Type>