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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SiteMapDataSource" FullName="System.Web.UI.WebControls.SiteMapDataSource">
<TypeSignature Language="C#" Value="public class SiteMapDataSource : System.Web.UI.HierarchicalDataSourceControl, System.ComponentModel.IListSource, System.Web.UI.IDataSource" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.HierarchicalDataSourceControl</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ComponentModel.IListSource</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Web.UI.IDataSource</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Web.UI.ParseChildren(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Designer("System.Web.UI.Design.WebControls.SiteMapDataSourceDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Web.UI.PersistChildren(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>In this topic:</para>
<list type="bullet">
<item>
<para>
<format type="text/html">
<a href="#introduction">Introduction</a>
</format>
</para>
</item>
<item>
<para>
<format type="text/html">
<a href="#specifying_the_starting_node">Specifying the Starting Node</a>
</format>
</para>
</item>
<item>
<para>
<format type="text/html">
<a href="#retrieving_site_map_data">Retrieving Site Map Data</a>
</format>
</para>
</item>
<item>
<para>
<format type="text/html">
<a href="#declarative_syntax">Declarative Syntax</a>
</format>
</para>
</item>
</list>
<format type="text/html">
<a href="#introduction" />
</format>
<format type="text/html">
<h2>Introduction</h2>
</format>
<para>The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control is a data source to the site map data that is stored by the site map providers that are configured for your site. The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> enables Web server controls that are not specifically site navigation controls, such as the <see cref="T:System.Web.UI.WebControls.TreeView" />, <see cref="T:System.Web.UI.WebControls.Menu" />, and <see cref="T:System.Web.UI.WebControls.DropDownList" /> controls, to bind to hierarchical site map data. You can use these Web server controls to display a site map as a table of contents or to actively navigate a site. Alternatively, you can use the <see cref="T:System.Web.UI.WebControls.SiteMapPath" /> control, which is designed specifically as a site navigation control and therefore does not need an instance of the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control.</para>
<format type="text/html">
<a href="#specifying_the_starting_node" />
</format>
<format type="text/html">
<h2>Specifying the Starting Node</h2>
</format>
<para>The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> binds to site map data and presents its view based on a specified starting node in the site map hierarchy. By default, it is the root node of the hierarchy but it can also be any node within the hierarchy. The starting node is identified by the values of several <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> properties as follows:</para>
<list type="table">
<listheader>
<item>
<term>
<para>Starting Node</para>
</term>
<description>
<para>Property Values</para>
</description>
</item>
</listheader>
<item>
<term>
<para>The root node of the hierarchy (the default setting).</para>
</term>
<description>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> is false.</para>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> is not set.</para>
</description>
</item>
<item>
<term>
<para>The node that represents the currently viewed page.</para>
</term>
<description>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> is true.</para>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> is not set.</para>
</description>
</item>
<item>
<term>
<para>A specific node of the hierarchy.</para>
</term>
<description>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> is false.</para>
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> is set.</para>
</description>
</item>
</list>
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a value other than 0, it affects the starting node and with it the site map data hierarchy that is exposed by the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control. The negative or positive integer value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> identifies the number of levels up or down the site map hierarchy from the starting node that is identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> and <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> properties to offset the starting node of the subtree that is exposed by data source control.</para>
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a negative number -n, the starting node of the subtree that is exposed by the data source control is the ancestor node n hierarchical levels above the identified starting node. If the value n is greater than the number of ancestor levels in the hierarchical tree, the starting node of the subtree is the root node of the site map hierarchy.</para>
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a positive number +n, the starting node of the subtree that is exposed is a child node n levels below the identified starting node. Because more than one branch of child nodes might exist in the hierarchy, the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> attempts to resolve a child node directly on the path between the identified starting node and the node that represents the currently requested page, if possible. If the node that represents the currently requested page is not in the subtree of the identified starting node, the value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is ignored. If the node that represents the currently requested page is less than n levels below the identified starting node, the currently requested page node is used as the starting node.</para>
<format type="text/html">
<a href="#retrieving_site_map_data" />
</format>
<format type="text/html">
<h2>Retrieving Site Map Data</h2>
</format>
<para>Site map data is retrieved from an <see cref="T:System.Web.SiteMapProvider" /> object, such as <see cref="T:System.Web.XmlSiteMapProvider" />, which is the default site map provider for ASP.NET. You can specify any provider that is configured for your site to provide the site map data to the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> and can obtain the list of available providers by accessing the <see cref="P:System.Web.SiteMap.Providers" /> collection.</para>
<para>Like all data source controls, every instance of a <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> is associated with a single helper object, known as a data source view. The <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> is a view on the site map data, according to the properties of the data source, and is retrieved by calling the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetHierarchicalView(System.String)" /> method. The <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> maintains the <see cref="T:System.Web.SiteMapNodeCollection" /> object that the controls bind to. </para>
<para>By default, the starting node is the root node of the hierarchy, but you can set the starting node to any node. The starting point can be a node that is relative to the current position in the site map or to an absolute position. You can specify the starting node by setting the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property. </para>
<para>The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> is specialized for navigation data, and does not support common data source operations such as sorting, filtering, paging, caching, or data record operations such as updates, insertions or deletions. </para>
<format type="text/html">
<a href="#declarative_syntax" />
</format>
<format type="text/html">
<h2>Declarative Syntax</h2>
</format>
<code><asp:SiteMapDataSource
EnableTheming="True|<codeFeaturedElement>False</codeFeaturedElement>"
EnableViewState="<codeFeaturedElement>True</codeFeaturedElement>|False"
ID="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
runat="server"
ShowStartingNode="<codeFeaturedElement>True</codeFeaturedElement>|False"
SiteMapProvider="string"
SkinID="string"
StartFromCurrentNode="True|<codeFeaturedElement>False</codeFeaturedElement>"
StartingNodeOffset="integer"
StartingNodeUrl="uri"
Visible="True|<codeFeaturedElement>False</codeFeaturedElement>"
/></code>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a data source control that Web server controls and other controls can use to bind to hierarchical site map data.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SiteMapDataSource ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ContainsListCollection">
<MemberSignature Language="C#" Value="public virtual bool ContainsListCollection { get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ContainsListCollection" /> property calls the static <see cref="M:System.Web.UI.ListSourceHelper.ContainsListCollection(System.Web.UI.IDataSource)" /> method of the <see cref="T:System.Web.UI.ListSourceHelper" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the data source control contains a collection of data source view objects.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetHierarchicalView">
<MemberSignature Language="C#" Value="protected override System.Web.UI.HierarchicalDataSourceView GetHierarchicalView (string viewPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.HierarchicalDataSourceView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="viewPath" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a single view on the site map data for the <see cref="T:System.Web.SiteMapProvider" /> object according to the starting node and other properties of the data source.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.UI.HierarchicalDataSourceView" /> helper object on the site map data, starting with the node that is identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> or its child, if the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ShowStartingNode" /> is false.</para>
</returns>
<param name="viewPath">
<attribution license="cc4" from="Microsoft" modified="false" />The URL of the starting node, specified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetList">
<MemberSignature Language="C#" Value="public virtual System.Collections.IList GetList ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetList" /> method to retrieve a set of objects that can be used as sources for the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control. Site map data source controls encapsulate their lists of data as <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> objects. Therefore, when associated with one or more <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> objects, a <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control represents a list source object and the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetList" /> method returns a list containing one element — the data source control itself.</para>
<para>The <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetList" /> method calls the static <see cref="M:System.Web.UI.ListSourceHelper.GetList(System.Web.UI.IDataSource)" /> method to retrieve a list of objects that can be used as sources of data. The <see cref="T:System.Web.UI.ListSourceHelper" /> checks whether the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetViewNames" /> method returns a valid collection of view names. If it does, the <see cref="T:System.Web.UI.ListSourceHelper" /> returns a list containing one element — the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a list of data source controls that can be used as sources of lists of data.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.IList" /> of data source controls that can be used as sources of lists of data.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetView">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.DataSourceView GetView (string viewName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.DataSourceView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="viewName" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="viewName" /> parameter is the URL for the root node of the view, not the name of the data source view as it is with other data source controls that support named views.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a named view on the site map data of the site map provider according to the starting node and other properties of the data source.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.UI.HierarchicalDataSourceView" /> helper object on the site map data, according to the starting node that is identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property or its child, if the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ShowStartingNode" /> is false.</para>
</returns>
<param name="viewName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the data source view to retrieve.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetViewNames">
<MemberSignature Language="C#" Value="public virtual System.Collections.ICollection GetViewNames ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetViewNames" /> method returns a collection with one element (the default name) instead of null so that the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ContainsListCollection" /> method returns true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Retrieves a collection of named views for the data source control.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.ICollection" /> of named <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> objects associated with the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" />. Because the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> supports only one named view, the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetViewNames" /> method returns an <see cref="T:System.Collections.ICollection" /> with one <see cref="F:System.String.Empty" /> element.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Provider">
<MemberSignature Language="C#" Value="public System.Web.SiteMapProvider Provider { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.SiteMapProvider</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.Provider" /> property to specify the site map provider instance to use with the data source control. The instance can be different than the provider that is identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.SiteMapProvider" /> property, if set.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a <see cref="T:System.Web.SiteMapProvider" /> object that is associated with the data source control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ShowStartingNode">
<MemberSignature Language="C#" Value="public virtual bool ShowStartingNode { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ShowStartingNode" /> property is evaluated during calls to the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetView(System.String)" /> and <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetHierarchicalView(System.String)" /> methods, when the node tree that is returned by these methods is populated.</para>
<para>The value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ShowStartingNode" /> property is stored in view state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the starting node is retrieved and displayed. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SiteMapProvider">
<MemberSignature Language="C#" Value="public virtual string SiteMapProvider { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.SiteMapProvider" /> property is stored in view state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the site map provider that the data source binds to.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartFromCurrentNode">
<MemberSignature Language="C#" Value="public virtual bool StartFromCurrentNode { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> property is evaluated during calls to the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetView(System.String)" /> and the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetHierarchicalView(System.String)" /> methods to help determine which site map node to use as a starting point to build the node tree. The <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> and <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> properties are mutually exclusive — if you set the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property, ensure that the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> property is false.</para>
<para>The value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> property is stored in view state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the site map node tree is retrieved using the node that represents the current page.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartingNodeOffset">
<MemberSignature Language="C#" Value="public virtual int StartingNodeOffset { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a value other than 0, it affects the starting node and with it the site map data hierarchy that is exposed by the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> control. The negative or positive integer value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> identifies the number of levels up or down the site map hierarchy from the starting node that is identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> and <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> properties to offset the starting node of the subtree that is exposed by data source control.</para>
<para>If the identified starting node is the node that represents the currently requested page, the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> is ignored.</para>
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a negative number -n, the starting node of the subtree that is exposed by the data source control is the ancestor node n hierarchical levels above the identified starting node. If the value n is greater than the number of ancestor levels in the hierarchical tree, the starting node of the subtree is the root node of the site map hierarchy.</para>
<para>If the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is set to a positive number +n, the starting node of the subtree that is exposed is a child node n levels below the identified starting node. Because more than one branch of child nodes might exist in the hierarchy, the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> attempts to resolve a child node directly on the path between the identified starting node and the node that represents the currently requested page, if possible. If the node that represents the currently requested page is not in the subtree of the identified starting node, the value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is ignored. If the node that represents the currently requested page is less than n levels below the identified starting node, the currently requested page node is used as the starting node.</para>
<para>The value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeOffset" /> property is stored in view state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a positive or negative integer offset from the starting node that determines the root hierarchy that is exposed by the data source control.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartingNodeUrl">
<MemberSignature Language="C#" Value="public virtual string StartingNodeUrl { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Web.UI.UrlProperty</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.UrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> property binds to site map data and presents its view based on a specified starting node in the site map hierarchy. By default, the starting node is the root node of the hierarchy, but you can set the starting node to any node with the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property or set the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartFromCurrentNode" /> property to true. </para>
<para>The value of the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property is stored in view state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a node in the site map that the data source then uses as a reference point to retrieve nodes from a hierarchical site map.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="System.ComponentModel.IListSource.ContainsListCollection">
<MemberSignature Language="C#" Value="bool System.ComponentModel.IListSource.ContainsListCollection { 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>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> instance is cast to an <see cref="T:System.ComponentModel.IListSource" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the collection is a collection of <see cref="T:System.Collections.IList" /> objects.</para>
</summary>
</Docs>
</Member>
<Member MemberName="System.ComponentModel.IListSource.GetList">
<MemberSignature Language="C#" Value="System.Collections.IList IListSource.GetList ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.IList</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> instance is cast to an <see cref="T:System.ComponentModel.IListSource" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For a description of this member, see <see cref="M:System.ComponentModel.IListSource.GetList" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.IList" /> of data source controls that can be used as sources of lists of data.</para>
</returns>
</Docs>
</Member>
<Member MemberName="System.Web.UI.IDataSource.GetView">
<MemberSignature Language="C#" Value="System.Web.UI.DataSourceView IDataSource.GetView (string viewName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.DataSourceView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="viewName" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> instance is cast to an <see cref="T:System.Web.UI.IDataSource" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For a description of this member, see <see cref="M:System.Web.UI.IDataSource.GetView(System.String)" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.UI.HierarchicalDataSourceView" /> helper object on the site map data, according to the starting node identified by the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.StartingNodeUrl" /> property or its child, if the <see cref="P:System.Web.UI.WebControls.SiteMapDataSource.ShowStartingNode" /> is false.</para>
</returns>
<param name="viewName">
<attribution license="cc4" from="Microsoft" modified="false" />The URL of the root node of the view. </param>
</Docs>
</Member>
<Member MemberName="System.Web.UI.IDataSource.GetViewNames">
<MemberSignature Language="C#" Value="System.Collections.ICollection IDataSource.GetViewNames ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> instance is cast to an <see cref="T:System.Web.UI.IDataSource" /> interface.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For a description of this member, see <see cref="M:System.Web.UI.IDataSource.GetViewNames" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Collections.ICollection" /> of named <see cref="T:System.Web.UI.WebControls.SiteMapDataSourceView" /> objects associated with the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" />. Because the <see cref="T:System.Web.UI.WebControls.SiteMapDataSource" /> supports only one named view, the <see cref="M:System.Web.UI.WebControls.SiteMapDataSource.GetViewNames" /> returns a collection containing one element set to <see cref="F:System.String.Empty" />.</para>
</returns>
</Docs>
</Member>
</Members>
</Type>
|
