-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CatalogPartDesigner.xml
143 lines (135 loc) · 9.85 KB
/
CatalogPartDesigner.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
<Type Name="CatalogPartDesigner" FullName="System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner">
<TypeSignature Language="C#" Value="public class CatalogPartDesigner : System.Web.UI.Design.WebControls.WebParts.PartDesigner" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CatalogPartDesigner extends System.Web.UI.Design.WebControls.WebParts.PartDesigner" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner" />
<TypeSignature Language="VB.NET" Value="Public Class CatalogPartDesigner
Inherits PartDesigner" />
<TypeSignature Language="F#" Value="type CatalogPartDesigner = class
 inherit PartDesigner" />
<TypeSignature Language="C++ CLI" Value="public ref class CatalogPartDesigner : System::Web::UI::Design::WebControls::WebParts::PartDesigner" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.WebControls.WebParts.PartDesigner</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides design-time support for <see cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" />, <see cref="T:System.Web.UI.WebControls.WebParts.ImportCatalogPart" />, and <see cref="T:System.Web.UI.WebControls.WebParts.PageCatalogPart" /> controls.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner> is a multi-purpose designer that provides design-time rendering for <xref:System.Web.UI.WebControls.WebParts.ImportCatalogPart> and <xref:System.Web.UI.WebControls.WebParts.PageCatalogPart> controls, which both inherit from the <xref:System.Web.UI.WebControls.WebParts.CatalogPart> base class. <xref:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner> serves as a standard control designer, adding only what customization is needed to validate the associated control and apply its design mode state to the design-time rendering.
If you have a custom <xref:System.Web.UI.WebControls.WebParts.PageCatalogPart> control, you can create a derived designer, such as <xref:System.Web.UI.Design.WebControls.WebParts.DeclarativeCatalogPartDesigner>, to provide design-time rendering. You can safely override any of the members as needed; however, when overriding the <xref:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner.CreateViewControl%2A> method, be sure to call the base implementation to avoid losing design mode state information.
## Examples
<xref:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner> and <xref:System.Web.UI.Design.WebControls.WebParts.EditorPartDesigner> share an identical interface and functionality. For an applicable code example, see the <xref:System.Web.UI.Design.WebControls.WebParts.EditorPartDesigner> class overview.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.Design.ControlDesigner" />
<altmember cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/e0s9t4ck(v=vs.100)">ASP.NET Web Parts Controls</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/wxh45wzs(v=vs.100)">ASP.NET Control Designers Overview</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CatalogPartDesigner ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CatalogPartDesigner();" />
<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.WebParts.CatalogPartDesigner" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateViewControl">
<MemberSignature Language="C#" Value="protected override System.Web.UI.Control CreateViewControl ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Web.UI.Control CreateViewControl() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner.CreateViewControl" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateViewControl () As Control" />
<MemberSignature Language="F#" Value="override this.CreateViewControl : unit -> System.Web.UI.Control" Usage="catalogPartDesigner.CreateViewControl " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Web::UI::Control ^ CreateViewControl();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.Control</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a copy of the associated <see cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" /> control to render at design time.</summary>
<returns>A copy of the associated <see cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" /> control.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is overridden to copy zone information to the view control.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetDesignTimeHtml">
<MemberSignature Language="C#" Value="public override string GetDesignTimeHtml ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetDesignTimeHtml() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner.GetDesignTimeHtml" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetDesignTimeHtml () As String" />
<MemberSignature Language="F#" Value="override this.GetDesignTimeHtml : unit -> string" Usage="catalogPartDesigner.GetDesignTimeHtml " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ GetDesignTimeHtml();" />
<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 />
<Docs>
<summary>Verifies that the control resides in a zone of type <see cref="T:System.Web.UI.WebControls.WebParts.CatalogZoneBase" />, and then gets the markup that is used to represent the control at design time.</summary>
<returns>The markup that is used to represent the control at design time, or error markup if the control does not reside in a <see cref="T:System.Web.UI.WebControls.WebParts.CatalogZoneBase" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public override void Initialize (System.ComponentModel.IComponent component);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Initialize(class System.ComponentModel.IComponent component) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogPartDesigner.Initialize(System.ComponentModel.IComponent)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Initialize (component As IComponent)" />
<MemberSignature Language="F#" Value="override this.Initialize : System.ComponentModel.IComponent -> unit" Usage="catalogPartDesigner.Initialize component" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Initialize(System::ComponentModel::IComponent ^ component);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<param name="component">The <see cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" />-derived control associated with the designer.</param>
<summary>Binds the designer to the associated <see cref="T:System.Web.UI.WebControls.WebParts.CatalogPart" />-derived control.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>