-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
LoginNameDesigner.xml
151 lines (140 loc) · 11.2 KB
/
LoginNameDesigner.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<Type Name="LoginNameDesigner" FullName="System.Web.UI.Design.WebControls.LoginNameDesigner">
<TypeSignature Language="C#" Value="public class LoginNameDesigner : System.Web.UI.Design.ControlDesigner" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LoginNameDesigner extends System.Web.UI.Design.ControlDesigner" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.Design.WebControls.LoginNameDesigner" />
<TypeSignature Language="VB.NET" Value="Public Class LoginNameDesigner
Inherits ControlDesigner" />
<TypeSignature Language="F#" Value="type LoginNameDesigner = class
 inherit ControlDesigner" />
<TypeSignature Language="C++ CLI" Value="public ref class LoginNameDesigner : System::Web::UI::Design::ControlDesigner" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.ControlDesigner</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.WebControls.LoginName" /> Web server control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.LoginName> control renders a label that contains the name of the current user.
In a visual designer, when you switch from Source to Design view, the markup source code that describes the <xref:System.Web.UI.WebControls.LoginName> control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The <xref:System.Web.UI.Design.WebControls.LoginNameDesigner> class provides design-time support for the <xref:System.Web.UI.WebControls.LoginName> control.
The <xref:System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl%2A> property always returns `true`, indicating that the designer creates a temporary copy of the associated <xref:System.Web.UI.WebControls.LoginName> to generate the design-time markup. The <xref:System.Web.UI.Design.WebControls.LoginNameDesigner.GetErrorDesignTimeHtml%2A> method provides the markup that is used to render the associated <xref:System.Web.UI.WebControls.LoginName> at design time when an error has occurred.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.LoginName" />
<altmember cref="T:System.Web.UI.WebControls.WebControl" />
<altmember cref="T:System.Web.UI.Design.ControlDesigner" />
<altmember cref="T:System.Web.UI.Design.HtmlControlDesigner" />
<altmember cref="T:System.ComponentModel.Design.ComponentDesigner" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/wxh45wzs(v=vs.100)">Introduction to ASP.NET Control Designers</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/12yydcke(v=vs.100)">Walkthrough: Creating a Basic Control Designer for a Web Server Control</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LoginNameDesigner ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.LoginNameDesigner.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 LoginNameDesigner();" />
<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.WebControls.LoginNameDesigner" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The .NET Framework internally constructs a new instance of the <xref:System.Web.UI.Design.WebControls.LoginNameDesigner> class when it creates the associated <xref:System.Web.UI.WebControls.LoginName> control or a copy of that control on the design surface.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.LoginName" />
<altmember cref="T:System.Web.UI.Design.ControlDesigner" />
<altmember cref="T:System.Web.UI.Design.HtmlControlDesigner" />
<altmember cref="T:System.ComponentModel.Design.ComponentDesigner" />
</Docs>
</Member>
<Member MemberName="GetErrorDesignTimeHtml">
<MemberSignature Language="C#" Value="protected override string GetErrorDesignTimeHtml (Exception e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string GetErrorDesignTimeHtml(class System.Exception e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.LoginNameDesigner.GetErrorDesignTimeHtml(System.Exception)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function GetErrorDesignTimeHtml (e As Exception) As String" />
<MemberSignature Language="F#" Value="override this.GetErrorDesignTimeHtml : Exception -> string" Usage="loginNameDesigner.GetErrorDesignTimeHtml e" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::String ^ GetErrorDesignTimeHtml(Exception ^ e);" />
<MemberType>Method</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>
<Parameters>
<Parameter Name="e" Type="System.Exception" />
</Parameters>
<Docs>
<param name="e">The <see cref="T:System.Exception" /> that was thrown.</param>
<summary>Provides the markup that is used to render the associated control at design time when an error has occurred.</summary>
<returns>A string that contains the markup used to render the associated <see cref="T:System.Web.UI.WebControls.LoginName" /> at design time after an error has occurred.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If an error occurs in trying to display the design-time view of the <xref:System.Web.UI.WebControls.LoginName> control, this method returns the HTML markup to display a placeholder that contains the type name, the control name, and one or more messages describing the error.
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.Design.ControlDesigner.CreatePlaceHolderDesignTimeHtml(System.String)" />
<altmember cref="T:System.Web.UI.WebControls.LoginName" />
</Docs>
</Member>
<Member MemberName="UsePreviewControl">
<MemberSignature Language="C#" Value="protected override bool UsePreviewControl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UsePreviewControl" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property UsePreviewControl As Boolean" />
<MemberSignature Language="F#" Value="member this.UsePreviewControl : bool" Usage="System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property bool UsePreviewControl { bool 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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the designer should use a temporary copy, rather than the actual control that is associated with the designer, to generate the design-time markup.</summary>
<value>Always <see langword="true" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Because the <xref:System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl%2A> property is always `true`, the designer <xref:System.Web.UI.Design.ControlDesigner.ViewControl%2A> property returns a copy of the associated <xref:System.Web.UI.WebControls.LoginName> control to generate the design-time markup. The <xref:System.Web.UI.Design.ControlDesigner.ViewControl%2A> property creates the copy by persisting the actual <xref:System.Web.UI.WebControls.LoginName> control, then parsing the persisted control string. The copied control does not affect any persistence for the actual <xref:System.Web.UI.WebControls.LoginName> control.
If the <xref:System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl%2A> property has been overridden to return `false`, the designer will use the associated <xref:System.Web.UI.WebControls.LoginName> control itself to generate the design-time markup, and design-time changes to the control will persist to the page markup source.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>You can override the <see cref="P:System.Web.UI.Design.WebControls.LoginNameDesigner.UsePreviewControl" /> property to return <see langword="false" /> or to determine its value based on whether the control is marked with a class level <see cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" /> object. If the actual <see cref="T:System.Web.UI.WebControls.LoginName" /> control is used to generate the design time markup, the control may not be visible on the design surface, since the runtime behavior of the control is to not render if the user identity is not known.</para>
</block>
<altmember cref="T:System.Web.UI.WebControls.LoginName" />
<altmember cref="M:System.Web.UI.Design.ControlPersister.PersistControl(System.IO.TextWriter,System.Web.UI.Control)" />
<altmember cref="M:System.Web.UI.Design.ControlParser.ParseControl(System.ComponentModel.Design.IDesignerHost,System.String)" />
<altmember cref="P:System.Web.UI.Design.ControlDesigner.ViewControl" />
<altmember cref="T:System.Web.UI.Design.SupportsPreviewControlAttribute" />
<altmember cref="P:System.Web.UI.Design.ControlDesigner.UsePreviewControl" />
</Docs>
</Member>
</Members>
</Type>