-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CatalogZoneDesigner.xml
286 lines (279 loc) · 20.6 KB
/
CatalogZoneDesigner.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<Type Name="CatalogZoneDesigner" FullName="System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner">
<TypeSignature Language="C#" Value="public class CatalogZoneDesigner : System.Web.UI.Design.WebControls.WebParts.ToolZoneDesigner" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CatalogZoneDesigner extends System.Web.UI.Design.WebControls.WebParts.ToolZoneDesigner" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner" />
<TypeSignature Language="VB.NET" Value="Public Class CatalogZoneDesigner
Inherits ToolZoneDesigner" />
<TypeSignature Language="F#" Value="type CatalogZoneDesigner = class
 inherit ToolZoneDesigner" />
<TypeSignature Language="C++ CLI" Value="public ref class CatalogZoneDesigner : System::Web::UI::Design::WebControls::WebParts::ToolZoneDesigner" />
<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.ToolZoneDesigner</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides design-time support for <see cref="T:System.Web.UI.WebControls.WebParts.CatalogZone" /> controls.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner> provides design-time rendering of <xref:System.Web.UI.WebControls.WebParts.CatalogZone> controls. It includes support for editable designer regions, templates, and auto-formats to allow a page developer to easily alter the appearance of the control.
The public <xref:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.AutoFormats%2A> and <xref:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.TemplateGroups%2A> collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control.
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>If you want to override the <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml" /> method to change the design-time appearance of your custom control, make sure to use the <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method and invoke the parent method before adding custom code, because that is the method that creates the rendering for the regions in the control. If you override <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml" /> and do not call <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> somewhere in the method, your designer regions will not be rendered.</para>
</block>
<altmember cref="T:System.Web.UI.Design.ControlDesigner" />
<altmember cref="T:System.Web.UI.WebControls.WebParts.CatalogZone" />
<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 CatalogZoneDesigner ();" />
<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.CatalogZoneDesigner.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CatalogZoneDesigner();" />
<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.CatalogZoneDesigner" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoFormats">
<MemberSignature Language="C#" Value="public override System.Web.UI.Design.DesignerAutoFormatCollection AutoFormats { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.Design.DesignerAutoFormatCollection AutoFormats" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.AutoFormats" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property AutoFormats As DesignerAutoFormatCollection" />
<MemberSignature Language="F#" Value="member this.AutoFormats : System.Web.UI.Design.DesignerAutoFormatCollection" Usage="System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.AutoFormats" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::Design::DesignerAutoFormatCollection ^ AutoFormats { System::Web::UI::Design::DesignerAutoFormatCollection ^ 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.Web.UI.Design.DesignerAutoFormatCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of predefined automatic formatting schemes to display in the **Auto Format** dialog box for the associated control at design time.</summary>
<value>A pre-specified <see cref="T:System.Web.UI.Design.DesignerAutoFormatCollection" /> with a default CatalogZone scheme.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.AutoFormats%2A> property overrides its base implementation to return a collection that is specific to the <xref:System.Web.UI.WebControls.WebParts.CatalogZone> class.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetDesignTimeHtml">
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Gets the markup that is used to represent the control at design time.</summary>
</Docs>
</MemberGroup>
<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.CatalogZoneDesigner.GetDesignTimeHtml" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetDesignTimeHtml () As String" />
<MemberSignature Language="F#" Value="override this.GetDesignTimeHtml : unit -> string" Usage="catalogZoneDesigner.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>Gets the markup that is used to represent the control at design time by calling the <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method with a null argument.</summary>
<returns>A method call to <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> with a null argument as the parameter.</returns>
<remarks>To be added.</remarks>
<block subset="none" type="overrides">
<para>When overriding this method, you must call <see cref="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> with a <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> or <see langword="null" /> as an argument so that designer regions build correctly.</para>
</block>
</Docs>
</Member>
<Member MemberName="GetDesignTimeHtml">
<MemberSignature Language="C#" Value="public override string GetDesignTimeHtml (System.Web.UI.Design.DesignerRegionCollection regions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetDesignTimeHtml(class System.Web.UI.Design.DesignerRegionCollection regions) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetDesignTimeHtml (regions As DesignerRegionCollection) As String" />
<MemberSignature Language="F#" Value="override this.GetDesignTimeHtml : System.Web.UI.Design.DesignerRegionCollection -> string" Usage="catalogZoneDesigner.GetDesignTimeHtml regions" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ GetDesignTimeHtml(System::Web::UI::Design::DesignerRegionCollection ^ regions);" />
<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="regions" Type="System.Web.UI.Design.DesignerRegionCollection" />
</Parameters>
<Docs>
<param name="regions">The <see cref="T:System.Web.UI.Design.DesignerRegionCollection" />, if any, associated with the control.</param>
<summary>Creates an <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> in the designer before generating the design-time HTML of the control.</summary>
<returns>A <see cref="T:System.String" /> representing the design-time HTML of the control.</returns>
<remarks>To be added.</remarks>
<block subset="none" type="overrides">
<para>When overriding this method, you must call the base method so that designer regions build correctly.</para>
</block>
</Docs>
</Member>
<Member MemberName="GetEditableDesignerRegionContent">
<MemberSignature Language="C#" Value="public override string GetEditableDesignerRegionContent (System.Web.UI.Design.EditableDesignerRegion region);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetEditableDesignerRegionContent(class System.Web.UI.Design.EditableDesignerRegion region) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetEditableDesignerRegionContent (region As EditableDesignerRegion) As String" />
<MemberSignature Language="F#" Value="override this.GetEditableDesignerRegionContent : System.Web.UI.Design.EditableDesignerRegion -> string" Usage="catalogZoneDesigner.GetEditableDesignerRegionContent region" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ GetEditableDesignerRegionContent(System::Web::UI::Design::EditableDesignerRegion ^ region);" />
<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="region" Type="System.Web.UI.Design.EditableDesignerRegion" />
</Parameters>
<Docs>
<param name="region">The specified <see cref="T:System.Web.UI.Design.EditableDesignerRegion" />.</param>
<summary>Gets the content for the specified <see cref="T:System.Web.UI.Design.EditableDesignerRegion" />.</summary>
<returns>A <see cref="T:System.String" /> that represents the persisted form of the designer region's content.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEmptyDesignTimeHtml">
<MemberSignature Language="C#" Value="protected override string GetEmptyDesignTimeHtml ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string GetEmptyDesignTimeHtml() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.GetEmptyDesignTimeHtml" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function GetEmptyDesignTimeHtml () As String" />
<MemberSignature Language="F#" Value="override this.GetEmptyDesignTimeHtml : unit -> string" Usage="catalogZoneDesigner.GetEmptyDesignTimeHtml " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::String ^ GetEmptyDesignTimeHtml();" />
<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>Gets the markup to represent an empty control.</summary>
<returns>An empty <see cref="T:System.String" />.</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.CatalogZoneDesigner.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="catalogZoneDesigner.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 associated <see cref="T:System.Web.UI.WebControls.WebParts.CatalogZone" /> control.</param>
<summary>Binds the designer to the associated <see cref="T:System.Web.UI.WebControls.WebParts.CatalogZone" /> control.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetEditableDesignerRegionContent">
<MemberSignature Language="C#" Value="public override void SetEditableDesignerRegionContent (System.Web.UI.Design.EditableDesignerRegion region, string content);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void SetEditableDesignerRegionContent(class System.Web.UI.Design.EditableDesignerRegion region, string content) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub SetEditableDesignerRegionContent (region As EditableDesignerRegion, content As String)" />
<MemberSignature Language="F#" Value="override this.SetEditableDesignerRegionContent : System.Web.UI.Design.EditableDesignerRegion * string -> unit" Usage="catalogZoneDesigner.SetEditableDesignerRegionContent (region, content)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void SetEditableDesignerRegionContent(System::Web::UI::Design::EditableDesignerRegion ^ region, System::String ^ content);" />
<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="region" Type="System.Web.UI.Design.EditableDesignerRegion" />
<Parameter Name="content" Type="System.String" />
</Parameters>
<Docs>
<param name="region">The specified <see cref="T:System.Web.UI.Design.EditableDesignerRegion" />.</param>
<param name="content">A <see cref="T:System.String" /> that represents the content to go in the specified region.</param>
<summary>Sets the content of the specified <see cref="T:System.Web.UI.Design.EditableDesignerRegion" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TemplateGroups">
<MemberSignature Language="C#" Value="public override System.Web.UI.Design.TemplateGroupCollection TemplateGroups { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.Design.TemplateGroupCollection TemplateGroups" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.TemplateGroups" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property TemplateGroups As TemplateGroupCollection" />
<MemberSignature Language="F#" Value="member this.TemplateGroups : System.Web.UI.Design.TemplateGroupCollection" Usage="System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.TemplateGroups" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::Design::TemplateGroupCollection ^ TemplateGroups { System::Web::UI::Design::TemplateGroupCollection ^ 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.Web.UI.Design.TemplateGroupCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of template groups, each containing one or more template definitions.</summary>
<value>A pre-specified <see cref="T:System.Web.UI.Design.TemplateGroupCollection" /> with default settings for a CatalogZone environment.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.Design.WebControls.WebParts.CatalogZoneDesigner.TemplateGroups%2A> property overrides its base implementation to return a collection that is specific to the <xref:System.Web.UI.WebControls.WebParts.CatalogZone> class.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>