/
MailFileEditor.xml
122 lines (114 loc) · 8 KB
/
MailFileEditor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<Type Name="MailFileEditor" FullName="System.Web.UI.Design.MailFileEditor">
<TypeSignature Language="C#" Value="public class MailFileEditor : System.Web.UI.Design.UrlEditor" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MailFileEditor extends System.Web.UI.Design.UrlEditor" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.Design.MailFileEditor" />
<TypeSignature Language="VB.NET" Value="Public Class MailFileEditor
Inherits UrlEditor" />
<TypeSignature Language="F#" Value="type MailFileEditor = class
 inherit UrlEditor" />
<TypeSignature Language="C++ CLI" Value="public ref class MailFileEditor : System::Web::UI::Design::UrlEditor" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.UrlEditor</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides a user interface for selecting and editing a mail file name for a property at design time.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.Design.MailFileEditor> class is an <xref: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 <xref:System.Web.UI.WebControls.EmbeddedMailObject> control uses the <xref:System.Web.UI.Design.MailFileEditor> class at design time to set the value of the <xref:System.Web.UI.WebControls.EmbeddedMailObject.Path%2A> property.
Use the <xref:System.ComponentModel.EditorAttribute> attribute to associate the <xref:System.Web.UI.Design.MailFileEditor> with a property. When the associated property is edited in the design surface, the designer host calls the <xref:System.Web.UI.Design.UrlEditor.EditValue%2A> method. The <xref:System.Web.UI.Design.UrlEditor.EditValue%2A> 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 <xref:System.Web.UI.Design.UrlEditor.GetEditStyle%2A> method indicates the display style of the user interface.
Derive a class from the <xref:System.Web.UI.Design.MailFileEditor> to define a custom editor for a mail file name property. For example, a derived class can override the <xref:System.Web.UI.Design.UrlEditor.EditValue%2A> method, and display an <xref:System.Windows.Forms.OpenFileDialog> instance with a custom mail file filter or title.
## Examples
The following code example demonstrates how to associate an instance of the <xref:System.Web.UI.Design.MailFileEditor> class with a property that is contained within a custom control. When the control property is edited in the design surface, the <xref:System.Web.UI.Design.MailFileEditor> class provides the user interface to select and edit a mail file name for the property value.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.FileEditor/CS/simplecontrolwithfilename.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.FileEditor/VB/simplecontrolwithfilename.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditor" />
<altmember cref="T:System.ComponentModel.EditorAttribute" />
<altmember cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MailFileEditor ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.MailFileEditor.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 MailFileEditor();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.Design.MailFileEditor" /> class.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditor" />
<altmember cref="T:System.ComponentModel.EditorAttribute" />
<altmember cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" />
</Docs>
</Member>
<Member MemberName="Caption">
<MemberSignature Language="C#" Value="protected override string Caption { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Caption" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.Design.MailFileEditor.Caption" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Caption As String" />
<MemberSignature Language="F#" Value="member this.Caption : string" Usage="System.Web.UI.Design.MailFileEditor.Caption" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::String ^ Caption { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the caption for the editor dialog.</summary>
<value>The caption for the design-time dialog box.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditor" />
<altmember cref="T:System.ComponentModel.EditorAttribute" />
<altmember cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" />
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="protected override string Filter { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Filter" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.Design.MailFileEditor.Filter" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Filter As String" />
<MemberSignature Language="F#" Value="member this.Filter : string" Usage="System.Web.UI.Design.MailFileEditor.Filter" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::String ^ Filter { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the file filter string for the dialog (such as "*.txt").</summary>
<value>The filter for selecting files in the design-time dialog box.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Drawing.Design.UITypeEditor" />
<altmember cref="T:System.ComponentModel.EditorAttribute" />
<altmember cref="P:System.Web.UI.WebControls.EmbeddedMailObject.Path" />
</Docs>
</Member>
</Members>
</Type>