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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="DesignerRegion" FullName="System.Web.UI.Design.DesignerRegion">
<TypeSignature Language="C#" Value="public class DesignerRegion : System.Web.UI.Design.DesignerObject" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Design.DesignerObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> object represents a region of content within the design-time markup that is generated by a <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation. A control developer uses designer regions in a custom <see cref="T:System.Web.UI.Design.ControlDesigner" /> implementation to define separate areas within the design-time markup for the associated control and to provide editing and event handling for the area. A visual designer, such as vsprvslong, can use designer regions to display the separate areas of a control on the design surface and to raise user events for the region to the control designer. Designer regions can simplify a control designer implementation because many region-based features are provided by the base designer classes and the visual designer.</para>
<para>The <see cref="T:System.Web.UI.Design.DesignerRegion" /> class provides the base functionality for designer regions, such as the ability to click, select, and highlight a region in the design surface. Use a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object in a control designer implementation to define a region that does not require editing. Use the derived <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> class in a control designer implementation to define a region with editable content at design time. Use the derived <see cref="T:System.Web.UI.Design.TemplatedEditableDesignerRegion" /> class in a control designer implementation to define an editable region that represents a template in a control.</para>
<para>To support regions within a class that is derived from the <see cref="T:System.Web.UI.Design.ControlDesigner" />, override the <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method and add one or more initialized <see cref="T:System.Web.UI.Design.DesignerRegion" /> objects to the <see cref="T:System.Web.UI.Design.DesignerRegionCollection" /> collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method.</para>
<para>Use the properties of a <see cref="T:System.Web.UI.Design.DesignerRegion" /> object to determine how the region is displayed by the visual designer. Override the <see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" /> property to indicate that the region can be selected by the user on the design surface. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" /> property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the <see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" /> and <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> properties to store or retrieve additional details about the region. In particular, the <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> property to access the methods and properties of the control designer object that contains the designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a region of content within the design-time markup for the associated control.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerRegion (System.Web.UI.Design.ControlDesigner designer, string name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="designer" Type="System.Web.UI.Design.ControlDesigner" />
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Initial Value</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Description" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para>
</term>
<description>
<para>The input <paramref name="designer" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para>
</term>
<description>
<para>The input <paramref name="name" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para>
</term>
<description>
<para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selected" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.UserData" />
</para>
</term>
<description>
<para>null.</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer.</para>
</summary>
<param name="designer">
<attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerRegion (System.Web.UI.Design.ControlDesigner designer, string name, bool selectable);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="designer" Type="System.Web.UI.Design.ControlDesigner" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="selectable" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the initial property values for an instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Initial Value</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Description" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> </para>
</term>
<description>
<para>The input <paramref name="designer" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.DisplayName" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.EnsureSize" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Highlight" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Name" /> </para>
</term>
<description>
<para>The input <paramref name="name" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerObject.Properties" /> </para>
</term>
<description>
<para>An empty <see cref="T:System.Collections.Specialized.HybridDictionary" /> object.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selectable" />
</para>
</term>
<description>
<para>The input <paramref name="selectable" /> value.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.Selected" />
</para>
</term>
<description>
<para>false.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.Design.DesignerRegion.UserData" />
</para>
</term>
<description>
<para>null.</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.DesignerRegion" /> class with the specified name for a control designer, optionally setting the instance as a selectable region in the designer.</para>
</summary>
<param name="designer">
<attribution license="cc4" from="Microsoft" modified="false" />The control designer that contains this designer region.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of this designer region.</param>
<param name="selectable">
<attribution license="cc4" from="Microsoft" modified="false" />true to select the region; otherwise, false.</param>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public virtual string Description { set; 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>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.Design.DesignerRegion.Description" /> property is used by the design host to display ToolTip information when the user moves the mouse pointer over the designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the description for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DesignerRegionAttributeName">
<MemberSignature Language="C#" Value="public static readonly string DesignerRegionAttributeName = null;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<MemberValue>null</MemberValue>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The attribute name for a designer region is _designerRegion. The <see cref="F:System.Web.UI.Design.DesignerRegion.DesignerRegionAttributeName" /> field is used to identify regions within the design-time HTML markup for the control designer.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the HTML attribute name for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DisplayName">
<MemberSignature Language="C#" Value="public virtual string DisplayName { set; 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 or sets the friendly display name for a designer region.</para>
</summary>
</Docs>
</Member>
<Member MemberName="EnsureSize">
<MemberSignature Language="C#" Value="public bool EnsureSize { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the region size is to be explicitly set on the designer region by the design host.</para>
</summary>
</Docs>
</Member>
<Member MemberName="GetBounds">
<MemberSignature Language="C#" Value="public System.Drawing.Rectangle GetBounds ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Drawing.Rectangle</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.Design.DesignerRegion.GetBounds" /> method returns a value that is equivalent to calling the <see cref="M:System.Web.UI.Design.IControlDesignerView.GetBounds(System.Web.UI.Design.DesignerRegion)" /> method on the <see cref="P:System.Web.UI.Design.DesignerObject.Designer" /> object with this designer region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves the size of the designer region on the design surface.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Drawing.Rectangle" /> representing the designer region size on the design surface.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Highlight">
<MemberSignature Language="C#" Value="public virtual bool Highlight { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether to highlight the designer region on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Selectable">
<MemberSignature Language="C#" Value="public virtual bool Selectable { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the designer region can be selected by the user on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Selected">
<MemberSignature Language="C#" Value="public virtual bool Selected { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the designer region is currently selected on the design surface.</para>
</summary>
</Docs>
</Member>
<Member MemberName="UserData">
<MemberSignature Language="C#" Value="public object UserData { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Within a control designer implementation, use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property to store or retrieve additional information for the designer region.</para>
<para>For example, if the control designer implementation supports selecting from multiple designer regions, you can use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property in a control designer to store a unique index for each region. You can then use the <see cref="P:System.Web.UI.Design.DesignerRegion.UserData" /> property for the region that is passed into the <see cref="M:System.Web.UI.Design.ControlDesigner.OnClick(System.Web.UI.Design.DesignerRegionMouseEventArgs)" /> method to store the index for the currently selected region.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets optional user data to associate with the designer region.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>
|
