1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="ListControl" FullName="System.Web.UI.WebControls.ListControl"> 3 <TypeSignature Language="C#" Maintainer="auto" Value="public abstract class ListControl : System.Web.UI.WebControls.DataBoundControl, System.Web.UI.IEditableTextControl" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Web</AssemblyName> 6 <AssemblyPublicKey> 7 </AssemblyPublicKey> 8 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 9 <AssemblyVersion>2.0.0.0</AssemblyVersion> 10 </AssemblyInfo> 11 <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> 12 <Base> 13 <BaseTypeName>System.Web.UI.WebControls.DataBoundControl</BaseTypeName> 14 </Base> 15 <Interfaces> 16 <Interface> 17 <InterfaceName>System.Web.UI.IEditableTextControl</InterfaceName> 18 </Interface> 19 </Interfaces> 20 <Attributes> 21 <Attribute> 22 <AttributeName>System.Web.UI.ControlValueProperty("SelectedValue", null)</AttributeName> 23 </Attribute> 24 <Attribute> 25 <AttributeName>System.Web.UI.ParseChildren(true, "Items")</AttributeName> 26 </Attribute> 27 <Attribute> 28 <AttributeName>System.ComponentModel.Designer("System.Web.UI.Design.WebControls.ListControlDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName> 29 </Attribute> 30 <Attribute> 31 <AttributeName>System.ComponentModel.DefaultEvent("SelectedIndexChanged")</AttributeName> 32 </Attribute> 33 <Attribute> 34 <AttributeName>System.Web.UI.DataBindingHandler("System.Web.UI.Design.WebControls.ListControlDataBindingHandler, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName> 35 </Attribute> 36 </Attributes> 37 <Docs> 38 <remarks> 39 <attribution license="cc4" from="Microsoft" modified="false" /> 40 <para>An instance of the <see cref="T:System.Web.UI.WebControls.ListControl" /> abstract class cannot be created directly. Instead, this class is inherited by other classes, such as the <see cref="T:System.Web.UI.WebControls.CheckBoxList" />, <see cref="T:System.Web.UI.WebControls.DropDownList" />, <see cref="T:System.Web.UI.WebControls.ListBox" />, and <see cref="T:System.Web.UI.WebControls.RadioButtonList" /> classes, to provide common basic functionality.</para> 41 <para>The properties of the <see cref="T:System.Web.UI.WebControls.ListControl" /> class allow you to specify the source of the data to populate the list control. Use the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSource" /> property to specify the data source to bind to the list control. If the data source contains more than one table, use the <see cref="P:System.Web.UI.WebControls.DataBoundControl.DataMember" /> property to specify the table to use. You can bind different fields in the data source to the <see cref="P:System.Web.UI.WebControls.ListItem.Text" /> and <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> properties of the items in the list control by setting the <see cref="P:System.Web.UI.WebControls.ListControl.DataTextField" /> and <see cref="P:System.Web.UI.WebControls.ListControl.DataValueField" /> properties, respectively. The text displayed for each item in the list control can by formatted by setting the <see cref="P:System.Web.UI.WebControls.ListControl.DataTextFormatString" /> property.</para> 42 <para>All items displayed in the list control are stored in the <see cref="P:System.Web.UI.WebControls.ListControl.Items" /> collection. You can programmatically specify or determine the index of a selected item in the list control by using the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedIndex" /> property. The properties of the selected item can be accessed by using the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedItem" /> property.</para> 43 <para>The <see cref="T:System.Web.UI.WebControls.ListControl" /> class provides the <see cref="E:System.Web.UI.WebControls.ListControl.SelectedIndexChanged" /> event, which is raised when the selection in the list control changes between posts to the server. This allows you to provide a custom handler for this event. For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para> 44 <para>The <see cref="T:System.Web.UI.WebControls.ListControl" /> class implements the <see cref="T:System.Web.UI.IEditableTextControl" /> interface so that derived list-type controls can be used in the template mode of other controls.</para> 45 </remarks> 46 <summary> 47 <attribution license="cc4" from="Microsoft" modified="false" /> 48 <para>Serves as the abstract base class that defines the properties, methods, and events common for all list-type controls.</para> 49 </summary> 50 </Docs> 51 <Members> 52 <Member MemberName=".ctor"> 53 <MemberSignature Language="C#" Value="public ListControl ();" /> 54 <MemberType>Constructor</MemberType> 55 <ReturnValue /> 56 <Parameters /> 57 <Docs> 58 <remarks>To be added</remarks> 59 <summary> 60 <attribution license="cc4" from="Microsoft" modified="false" /> 61 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.ListControl" /> class.</para> 62 </summary> 63 </Docs> 64 <AssemblyInfo> 65 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 66 <AssemblyVersion>2.0.0.0</AssemblyVersion> 67 </AssemblyInfo> 68 </Member> 69 <Member MemberName="AddAttributesToRender"> 70 <MemberSignature Language="C#" Value="protected override void AddAttributesToRender (System.Web.UI.HtmlTextWriter w);" /> 71 <MemberType>Method</MemberType> 72 <AssemblyInfo> 73 <AssemblyVersion>2.0.0.0</AssemblyVersion> 74 </AssemblyInfo> 75 <ReturnValue> 76 <ReturnType>System.Void</ReturnType> 77 </ReturnValue> 78 <Parameters> 79 <Parameter Name="w" Type="System.Web.UI.HtmlTextWriter" /> 80 </Parameters> 81 <Docs> 82 <param name="w">To be added.</param> 83 <remarks> 84 <attribution license="cc4" from="Microsoft" modified="false" /> 85 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.AddAttributesToRender(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers to insert the additional attributes and styles into the <see cref="T:System.Web.UI.HtmlTextWriter" /> output stream for controls that are derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class. </para> 86 </remarks> 87 <summary> 88 <attribution license="cc4" from="Microsoft" modified="false" /> 89 <para>Applies HTML attributes and styles to render to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object. </para> 90 </summary> 91 </Docs> 92 </Member> 93 <Member MemberName="AppendDataBoundItems"> 94 <MemberSignature Language="C#" Value="public virtual bool AppendDataBoundItems { set; get; }" /> 95 <MemberType>Property</MemberType> 96 <AssemblyInfo> 97 <AssemblyVersion>2.0.0.0</AssemblyVersion> 98 </AssemblyInfo> 99 <Attributes> 100 <Attribute> 101 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 102 </Attribute> 103 <Attribute> 104 <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName> 105 </Attribute> 106 </Attributes> 107 <ReturnValue> 108 <ReturnType>System.Boolean</ReturnType> 109 </ReturnValue> 110 <Docs> 111 <value>To be added.</value> 112 <remarks> 113 <attribution license="cc4" from="Microsoft" modified="false" /> 114 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.AppendDataBoundItems" /> property allows you to add items to the <see cref="T:System.Web.UI.WebControls.ListControl" /> object before data binding occurs. After data binding, the items collection contains both the items from the data source and the previously added items.</para> 115 <para>The value of this property is stored in view state.</para> 116 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 117 </remarks> 118 <summary> 119 <attribution license="cc4" from="Microsoft" modified="false" /> 120 <para>Gets or sets a value that indicates whether list items are cleared before data binding.</para> 121 </summary> 122 </Docs> 123 </Member> 124 <Member MemberName="AutoPostBack"> 125 <MemberSignature Language="C#" Value="public virtual bool AutoPostBack { set; get; }" /> 126 <MemberType>Property</MemberType> 127 <ReturnValue> 128 <ReturnType>System.Boolean</ReturnType> 129 </ReturnValue> 130 <Parameters /> 131 <Docs> 132 <value>To be added: an object of type 'bool'</value> 133 <remarks> 134 <attribution license="cc4" from="Microsoft" modified="false" /> 135 <para>Set this property to true if the server needs to capture the selection as soon as it is made. For example, other controls on the Web page can be automatically filled depending on the user's selection from a list control.</para> 136 <para>This property can be used to allow automatic population of other controls on the Web page based on a user's selection from a list.</para> 137 <para>The value of this property is stored in view state.</para> 138 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 139 </remarks> 140 <summary> 141 <attribution license="cc4" from="Microsoft" modified="false" /> 142 <para>Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection.</para> 143 </summary> 144 </Docs> 145 <AssemblyInfo> 146 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 147 <AssemblyVersion>2.0.0.0</AssemblyVersion> 148 </AssemblyInfo> 149 <Attributes> 150 <Attribute> 151 <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName> 152 </Attribute> 153 <Attribute> 154 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 155 </Attribute> 156 </Attributes> 157 </Member> 158 <Member MemberName="CausesValidation"> 159 <MemberSignature Language="C#" Value="public virtual bool CausesValidation { set; get; }" /> 160 <MemberType>Property</MemberType> 161 <AssemblyInfo> 162 <AssemblyVersion>2.0.0.0</AssemblyVersion> 163 </AssemblyInfo> 164 <Attributes> 165 <Attribute> 166 <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName> 167 </Attribute> 168 <Attribute> 169 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 170 </Attribute> 171 </Attributes> 172 <ReturnValue> 173 <ReturnType>System.Boolean</ReturnType> 174 </ReturnValue> 175 <Docs> 176 <value>To be added.</value> 177 <remarks> 178 <attribution license="cc4" from="Microsoft" modified="false" /> 179 <para>Use the <see cref="P:System.Web.UI.WebControls.ListControl.CausesValidation" /> property to determine whether validation is performed when a <see cref="T:System.Web.UI.WebControls.ListControl" /> control is clicked. Page validation determines whether the input controls that are associated with a validation control on the page all pass the validation rules that are specified by the validation control.</para> 180 <para>By default, clicking a control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class does not cause page validation. To perform page validation when the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class is clicked, set the <see cref="P:System.Web.UI.WebControls.ListControl.CausesValidation" /> property to true.</para> 181 <para>When the value of the <see cref="P:System.Web.UI.WebControls.ListControl.CausesValidation" /> property is set to true, you can also use the <see cref="P:System.Web.UI.WebControls.ListControl.ValidationGroup" /> property to specify the name of the validation group for which the <see cref="T:System.Web.UI.WebControls.ListControl" /> control causes validation.</para> 182 <para>The value of this property is stored in view state.</para> 183 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 184 </remarks> 185 <summary> 186 <attribution license="cc4" from="Microsoft" modified="false" /> 187 <para>Gets or sets a value indicating whether validation is performed when a control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class is clicked.</para> 188 </summary> 189 </Docs> 190 </Member> 191 <Member MemberName="ClearSelection"> 192 <MemberSignature Language="C#" Value="public virtual void ClearSelection ();" /> 193 <MemberType>Method</MemberType> 194 <ReturnValue> 195 <ReturnType>System.Void</ReturnType> 196 </ReturnValue> 197 <Parameters /> 198 <Docs> 199 <remarks> 200 <attribution license="cc4" from="Microsoft" modified="false" /> 201 <para>Use this method to reset the control so that no items are selected.</para> 202 </remarks> 203 <summary> 204 <attribution license="cc4" from="Microsoft" modified="false" /> 205 <para>Clears out the list selection and sets the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of all items to false.</para> 206 </summary> 207 </Docs> 208 <AssemblyInfo> 209 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 210 <AssemblyVersion>2.0.0.0</AssemblyVersion> 211 </AssemblyInfo> 212 </Member> 213 <Member MemberName="DataMember"> 214 <MemberSignature Language="C#" Value="public virtual string DataMember { set; get; }" /> 215 <MemberType>Property</MemberType> 216 <ReturnValue> 217 <ReturnType>System.String</ReturnType> 218 </ReturnValue> 219 <Parameters /> 220 <Docs> 221 <summary>To be added</summary> 222 <value>To be added: an object of type 'string'</value> 223 <remarks>To be added</remarks> 224 </Docs> 225 <AssemblyInfo> 226 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 227 <AssemblyVersion>2.0.0.0</AssemblyVersion> 228 </AssemblyInfo> 229 <Attributes> 230 <Attribute> 231 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 232 </Attribute> 233 <Attribute> 234 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 235 </Attribute> 236 </Attributes> 237 </Member> 238 <Member MemberName="DataSource"> 239 <MemberSignature Language="C#" Value="public virtual object DataSource { set; get; }" /> 240 <MemberType>Property</MemberType> 241 <ReturnValue> 242 <ReturnType>System.Object</ReturnType> 243 </ReturnValue> 244 <Parameters /> 245 <Docs> 246 <summary>To be added</summary> 247 <value>To be added: an object of type 'object'</value> 248 <remarks>To be added</remarks> 249 </Docs> 250 <AssemblyInfo> 251 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 252 <AssemblyVersion>2.0.0.0</AssemblyVersion> 253 </AssemblyInfo> 254 <Attributes> 255 <Attribute> 256 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName> 257 </Attribute> 258 <Attribute> 259 <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName> 260 </Attribute> 261 <Attribute> 262 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 263 </Attribute> 264 <Attribute> 265 <AttributeName>System.ComponentModel.Bindable(true)</AttributeName> 266 </Attribute> 267 </Attributes> 268 </Member> 269 <Member MemberName="DataTextField"> 270 <MemberSignature Language="C#" Value="public virtual string DataTextField { set; get; }" /> 271 <MemberType>Property</MemberType> 272 <ReturnValue> 273 <ReturnType>System.String</ReturnType> 274 </ReturnValue> 275 <Parameters /> 276 <Docs> 277 <value>To be added: an object of type 'string'</value> 278 <remarks> 279 <attribution license="cc4" from="Microsoft" modified="false" /> 280 <para>Use this property to specify a field in the <see cref="P:System.Web.UI.WebControls.BaseDataBoundControl.DataSource" /> property to display as the items of the list in a list control.</para> 281 <para>The value of this property is stored in view state.</para> 282 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 283 </remarks> 284 <summary> 285 <attribution license="cc4" from="Microsoft" modified="false" /> 286 <para>Gets or sets the field of the data source that provides the text content of the list items.</para> 287 </summary> 288 </Docs> 289 <AssemblyInfo> 290 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 291 <AssemblyVersion>2.0.0.0</AssemblyVersion> 292 </AssemblyInfo> 293 <Attributes> 294 <Attribute> 295 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 296 </Attribute> 297 <Attribute> 298 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 299 </Attribute> 300 </Attributes> 301 </Member> 302 <Member MemberName="DataTextFormatString"> 303 <MemberSignature Language="C#" Value="public virtual string DataTextFormatString { set; get; }" /> 304 <MemberType>Property</MemberType> 305 <ReturnValue> 306 <ReturnType>System.String</ReturnType> 307 </ReturnValue> 308 <Parameters /> 309 <Docs> 310 <value>To be added: an object of type 'string'</value> 311 <remarks> 312 <attribution license="cc4" from="Microsoft" modified="false" /> 313 <para>Use the <see cref="P:System.Web.UI.WebControls.ListControl.DataTextFormatString" /> property to provide a custom display format the items in a list control.</para> 314 <para>The data format string consists of two parts, separated by a colon, in the form { <paramref name="A" /> : <paramref name="Bxx" /> }. For example, the formatting string {0:F2} would format the cell to display a fixed point number with two decimal places.</para> 315 <block subset="none" type="note"> 316 <para>The entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text.</para> 317 </block> 318 <para>The value before the colon (<paramref name="A" /> in the general example) specifies the parameter index in a zero-based list of parameters.</para> 319 <block subset="none" type="note"> 320 <para>This value can only be set to 0 because there is only one value in each cell.</para> 321 </block> 322 <para>The character after the colon (<paramref name="B" /> in the general example) specifies the format to display the value in. The following table lists the common formats.</para> 323 <list type="table"> 324 <listheader> 325 <item> 326 <term> 327 <para>Format character </para> 328 </term> 329 <description> 330 <para>Description </para> 331 </description> 332 </item> 333 </listheader> 334 <item> 335 <term> 336 <para>C </para> 337 </term> 338 <description> 339 <para>Displays numeric values in currency format. </para> 340 </description> 341 </item> 342 <item> 343 <term> 344 <para>D </para> 345 </term> 346 <description> 347 <para>Displays numeric values in decimal format. </para> 348 </description> 349 </item> 350 <item> 351 <term> 352 <para>E </para> 353 </term> 354 <description> 355 <para>Displays numeric values in scientific (exponential) format. </para> 356 </description> 357 </item> 358 <item> 359 <term> 360 <para>F </para> 361 </term> 362 <description> 363 <para>Displays numeric values in fixed format. </para> 364 </description> 365 </item> 366 <item> 367 <term> 368 <para>G </para> 369 </term> 370 <description> 371 <para>Displays numeric values in general format. </para> 372 </description> 373 </item> 374 <item> 375 <term> 376 <para>N </para> 377 </term> 378 <description> 379 <para>Displays numeric values in number format. </para> 380 </description> 381 </item> 382 <item> 383 <term> 384 <para>X </para> 385 </term> 386 <description> 387 <para>Displays numeric values in hexadecimal format. </para> 388 </description> 389 </item> 390 </list> 391 <block subset="none" type="note"> 392 <para>The format character is not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.</para> 393 </block> 394 <para>The value after the format character (<paramref name="xx" /> in the general example) specifies the number of significant digits or decimal places to display.</para> 395 <para>The following table contains examples of formatting strings and the results. It assumes standard English settings.</para> 396 <list type="table"> 397 <listheader> 398 <item> 399 <term> 400 <para>Numeric Value </para> 401 </term> 402 <description> 403 <para>Format String </para> 404 </description> 405 <description> 406 <para>Result </para> 407 </description> 408 </item> 409 </listheader> 410 <item> 411 <term> 412 <para>12345.6789 </para> 413 </term> 414 <description> 415 <para>"{0:C}" </para> 416 </description> 417 <description> 418 <para>$12,345.68 </para> 419 </description> 420 </item> 421 <item> 422 <term> 423 <para>-12345.6789 </para> 424 </term> 425 <description> 426 <para>"{0:C}" </para> 427 </description> 428 <description> 429 <para>($12,345.68) </para> 430 </description> 431 </item> 432 <item> 433 <term> 434 <para>12345 </para> 435 </term> 436 <description> 437 <para>"{0:D}" </para> 438 </description> 439 <description> 440 <para>12345 </para> 441 </description> 442 </item> 443 <item> 444 <term> 445 <para>12345 </para> 446 </term> 447 <description> 448 <para>"{0:D8}" </para> 449 </description> 450 <description> 451 <para>00012345 </para> 452 </description> 453 </item> 454 <item> 455 <term> 456 <para>12345.6789 </para> 457 </term> 458 <description> 459 <para>"{0:E}" </para> 460 </description> 461 <description> 462 <para>1234568E+004 </para> 463 </description> 464 </item> 465 <item> 466 <term> 467 <para>12345.6789 </para> 468 </term> 469 <description> 470 <para>"{0:E10}" </para> 471 </description> 472 <description> 473 <para>1.2345678900E+004 </para> 474 </description> 475 </item> 476 <item> 477 <term> 478 <para>12345.6789 </para> 479 </term> 480 <description> 481 <para>"{0:F}" </para> 482 </description> 483 <description> 484 <para>12345.68 </para> 485 </description> 486 </item> 487 <item> 488 <term> 489 <para>12345.6789 </para> 490 </term> 491 <description> 492 <para>"{0:F0}" </para> 493 </description> 494 <description> 495 <para>12346 </para> 496 </description> 497 </item> 498 <item> 499 <term> 500 <para>12345.6789 </para> 501 </term> 502 <description> 503 <para>"{0:G}" </para> 504 </description> 505 <description> 506 <para>12345.6789 </para> 507 </description> 508 </item> 509 <item> 510 <term> 511 <para>123456789 </para> 512 </term> 513 <description> 514 <para>"{0:G7}" </para> 515 </description> 516 <description> 517 <para>1.234568E8 </para> 518 </description> 519 </item> 520 <item> 521 <term> 522 <para>12345.6789 </para> 523 </term> 524 <description> 525 <para>"{0:N}" </para> 526 </description> 527 <description> 528 <para>12,345.68 </para> 529 </description> 530 </item> 531 <item> 532 <term> 533 <para>123456789 </para> 534 </term> 535 <description> 536 <para>"{0:N4}" </para> 537 </description> 538 <description> 539 <para>123,456,789.0000 </para> 540 </description> 541 </item> 542 <item> 543 <term> 544 <para>12345.6789 </para> 545 </term> 546 <description> 547 <para>"Total: {0:C}" </para> 548 </description> 549 <description> 550 <para>Total: $12345.68 </para> 551 </description> 552 </item> 553 </list> 554 <para>For more information on formatting strings, see <format type="text/html"><a href="0d1364da-5b30-4d42-8e6b-03378343343f">Formatting Overview</a></format>.</para> 555 <para>The value of this property is stored in view state.</para> 556 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 557 </remarks> 558 <summary> 559 <attribution license="cc4" from="Microsoft" modified="false" /> 560 <para>Gets or sets the formatting string used to control how data bound to the list control is displayed.</para> 561 </summary> 562 </Docs> 563 <AssemblyInfo> 564 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 565 <AssemblyVersion>2.0.0.0</AssemblyVersion> 566 </AssemblyInfo> 567 <Attributes> 568 <Attribute> 569 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 570 </Attribute> 571 <Attribute> 572 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 573 </Attribute> 574 </Attributes> 575 </Member> 576 <Member MemberName="DataValueField"> 577 <MemberSignature Language="C#" Value="public virtual string DataValueField { set; get; }" /> 578 <MemberType>Property</MemberType> 579 <ReturnValue> 580 <ReturnType>System.String</ReturnType> 581 </ReturnValue> 582 <Parameters /> 583 <Docs> 584 <value>To be added: an object of type 'string'</value> 585 <remarks> 586 <attribution license="cc4" from="Microsoft" modified="false" /> 587 <para>Use this property to specify the field that contains the value of each item in a list control.</para> 588 <para>The value of this property is stored in view state.</para> 589 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 590 </remarks> 591 <summary> 592 <attribution license="cc4" from="Microsoft" modified="false" /> 593 <para>Gets or sets the field of the data source that provides the value of each list item.</para> 594 </summary> 595 </Docs> 596 <AssemblyInfo> 597 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 598 <AssemblyVersion>2.0.0.0</AssemblyVersion> 599 </AssemblyInfo> 600 <Attributes> 601 <Attribute> 602 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 603 </Attribute> 604 <Attribute> 605 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 606 </Attribute> 607 </Attributes> 608 </Member> 609 <Member MemberName="Items"> 610 <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.ListItemCollection Items { get; }" /> 611 <MemberType>Property</MemberType> 612 <ReturnValue> 613 <ReturnType>System.Web.UI.WebControls.ListItemCollection</ReturnType> 614 </ReturnValue> 615 <Docs> 616 <value>To be added: an object of type 'ListItemCollection'</value> 617 <remarks> 618 <attribution license="cc4" from="Microsoft" modified="false" /> 619 <para>Use this property to get the properties of items in the list control. This property can be used to determine the selected items in the list control.</para> 620 </remarks> 621 <summary> 622 <attribution license="cc4" from="Microsoft" modified="false" /> 623 <para>Gets the collection of items in the list control.</para> 624 </summary> 625 </Docs> 626 <AssemblyInfo> 627 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 628 <AssemblyVersion>2.0.0.0</AssemblyVersion> 629 </AssemblyInfo> 630 <Attributes> 631 <Attribute> 632 <AttributeName>System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerDefaultProperty)</AttributeName> 633 </Attribute> 634 <Attribute> 635 <AttributeName>System.ComponentModel.MergableProperty(false)</AttributeName> 636 </Attribute> 637 <Attribute> 638 <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName> 639 </Attribute> 640 <Attribute> 641 <AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.WebControls.ListItemsCollectionEditor,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> 642 </Attribute> 643 </Attributes> 644 </Member> 645 <Member MemberName="LoadViewState"> 646 <MemberSignature Language="C#" Value="protected override void LoadViewState (object savedState);" /> 647 <MemberType>Method</MemberType> 648 <ReturnValue> 649 <ReturnType>System.Void</ReturnType> 650 </ReturnValue> 651 <Parameters> 652 <Parameter Name="savedState" Type="System.Object" /> 653 </Parameters> 654 <Docs> 655 <remarks> 656 <attribution license="cc4" from="Microsoft" modified="false" /> 657 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.LoadViewState(System.Object)" /> method is used to load the previously saved view state of the <see cref="T:System.Web.UI.WebControls.ListControl" /> -derived control.</para> 658 <block subset="none" type="note"> 659 <para>This method is used primarily by control developers when extending the <see cref="T:System.Web.UI.WebControls.ListControl" /> control.</para> 660 </block> 661 </remarks> 662 <summary> 663 <attribution license="cc4" from="Microsoft" modified="false" /> 664 <para>Loads the previously saved view state of the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control.</para> 665 </summary> 666 <param name="savedState"> 667 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the state of the <see cref="T:System.Web.UI.WebControls.ListControl" /> -derived control.</param> 668 </Docs> 669 <AssemblyInfo> 670 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 671 <AssemblyVersion>2.0.0.0</AssemblyVersion> 672 </AssemblyInfo> 673 </Member> 674 <Member MemberName="OnDataBinding"> 675 <MemberSignature Language="C#" Value="protected override void OnDataBinding (EventArgs e);" /> 676 <MemberType>Method</MemberType> 677 <ReturnValue> 678 <ReturnType>System.Void</ReturnType> 679 </ReturnValue> 680 <Parameters> 681 <Parameter Name="e" Type="System.EventArgs" /> 682 </Parameters> 683 <Docs> 684 <remarks>To be added</remarks> 685 <summary> 686 <attribution license="cc4" from="Microsoft" modified="false" /> 687 <para>Raises the <see cref="E:System.Web.UI.Control.DataBinding" /> event.</para> 688 </summary> 689 <param name="e"> 690 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains event data. </param> 691 </Docs> 692 <AssemblyInfo> 693 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 694 <AssemblyVersion>2.0.0.0</AssemblyVersion> 695 </AssemblyInfo> 696 </Member> 697 <Member MemberName="OnPreRender"> 698 <MemberSignature Language="C#" Value="protected override void OnPreRender (EventArgs e);" /> 699 <MemberType>Method</MemberType> 700 <ReturnValue> 701 <ReturnType>System.Void</ReturnType> 702 </ReturnValue> 703 <Parameters> 704 <Parameter Name="e" Type="System.EventArgs" /> 705 </Parameters> 706 <Docs> 707 <remarks> 708 <attribution license="cc4" from="Microsoft" modified="false" /> 709 <para>This method notifies the server control to perform any necessary prerendering steps prior to saving view state and rendering content .It is generally used by control developers when extending the <see cref="T:System.Web.UI.WebControls.ListControl" /> class.</para> 710 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.OnPreRender(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> 711 </remarks> 712 <summary> 713 <attribution license="cc4" from="Microsoft" modified="false" /> 714 <para>Raises the <see cref="E:System.Web.UI.Control.PreRender" /> event.</para> 715 </summary> 716 <param name="e"> 717 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains the event data.</param> 718 </Docs> 719 <AssemblyInfo> 720 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 721 <AssemblyVersion>2.0.0.0</AssemblyVersion> 722 </AssemblyInfo> 723 </Member> 724 <Member MemberName="OnSelectedIndexChanged"> 725 <MemberSignature Language="C#" Value="protected virtual void OnSelectedIndexChanged (EventArgs e);" /> 726 <MemberType>Method</MemberType> 727 <ReturnValue> 728 <ReturnType>System.Void</ReturnType> 729 </ReturnValue> 730 <Parameters> 731 <Parameter Name="e" Type="System.EventArgs" /> 732 </Parameters> 733 <Docs> 734 <remarks> 735 <attribution license="cc4" from="Microsoft" modified="false" /> 736 <para>The <see cref="E:System.Web.UI.WebControls.ListControl.SelectedIndexChanged" /> event is raised when the selection from the list control changes between posts to the server.</para> 737 <block subset="none" type="note"> 738 <para>A list control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for the list control.</para> 739 </block> 740 <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para> 741 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.OnSelectedIndexChanged(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> 742 </remarks> 743 <summary> 744 <attribution license="cc4" from="Microsoft" modified="false" /> 745 <para>Raises the <see cref="E:System.Web.UI.WebControls.ListControl.SelectedIndexChanged" /> event. This allows you to provide a custom handler for the event.</para> 746 </summary> 747 <param name="e"> 748 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.EventArgs" /> that contains the event data. </param> 749 </Docs> 750 <AssemblyInfo> 751 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 752 <AssemblyVersion>2.0.0.0</AssemblyVersion> 753 </AssemblyInfo> 754 </Member> 755 <Member MemberName="OnTextChanged"> 756 <MemberSignature Language="C#" Value="protected virtual void OnTextChanged (EventArgs e);" /> 757 <MemberType>Method</MemberType> 758 <AssemblyInfo> 759 <AssemblyVersion>2.0.0.0</AssemblyVersion> 760 </AssemblyInfo> 761 <ReturnValue> 762 <ReturnType>System.Void</ReturnType> 763 </ReturnValue> 764 <Parameters> 765 <Parameter Name="e" Type="System.EventArgs" /> 766 </Parameters> 767 <Docs> 768 <remarks> 769 <attribution license="cc4" from="Microsoft" modified="false" /> 770 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.OnTextChanged(System.EventArgs)" /> method is called by the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class to raise the <see cref="E:System.Web.UI.WebControls.ListControl.TextChanged" /> event. Generally, the <see cref="M:System.Web.UI.WebControls.ListControl.OnTextChanged(System.EventArgs)" /> method is used by control developers when extending the <see cref="T:System.Web.UI.WebControls.ListControl" /> class.</para> 771 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.OnTextChanged(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> 772 </remarks> 773 <summary> 774 <attribution license="cc4" from="Microsoft" modified="false" /> 775 <para>Raises the <see cref="E:System.Web.UI.WebControls.ListControl.TextChanged" /> event.</para> 776 </summary> 777 <param name="e"> 778 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> that contains event data. </param> 779 </Docs> 780 </Member> 781 <Member MemberName="PerformDataBinding"> 782 <MemberSignature Language="C#" Value="protected override void PerformDataBinding (System.Collections.IEnumerable dataSource);" /> 783 <MemberType>Method</MemberType> 784 <AssemblyInfo> 785 <AssemblyVersion>2.0.0.0</AssemblyVersion> 786 </AssemblyInfo> 787 <ReturnValue> 788 <ReturnType>System.Void</ReturnType> 789 </ReturnValue> 790 <Parameters> 791 <Parameter Name="dataSource" Type="System.Collections.IEnumerable" /> 792 </Parameters> 793 <Docs> 794 <remarks> 795 <attribution license="cc4" from="Microsoft" modified="false" /> 796 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.PerformDataBinding(System.Collections.IEnumerable)" /> method is a helper method that is called by the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class to bind the specified data source to the control.</para> 797 </remarks> 798 <summary> 799 <attribution license="cc4" from="Microsoft" modified="false" /> 800 <para>Binds the specified data source to the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class.</para> 801 </summary> 802 <param name="dataSource"> 803 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.IEnumerable" /> that represents the data source.</param> 804 </Docs> 805 </Member> 806 <Member MemberName="PerformSelect"> 807 <MemberSignature Language="C#" Value="protected override void PerformSelect ();" /> 808 <MemberType>Method</MemberType> 809 <AssemblyInfo> 810 <AssemblyVersion>2.0.0.0</AssemblyVersion> 811 </AssemblyInfo> 812 <ReturnValue> 813 <ReturnType>System.Void</ReturnType> 814 </ReturnValue> 815 <Parameters /> 816 <Docs> 817 <remarks> 818 <attribution license="cc4" from="Microsoft" modified="false" /> 819 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.PerformSelect" /> method calls the <see cref="M:System.Web.UI.WebControls.ListControl.PerformDataBinding(System.Collections.IEnumerable)" /> method after data is retrieved to bind data to elements of the data-bound control. For more information, see <see cref="M:System.Web.UI.WebControls.DataBoundControl.PerformSelect" />.</para> 820 </remarks> 821 <summary> 822 <attribution license="cc4" from="Microsoft" modified="false" /> 823 <para>Retrieves data from the associated data source.</para> 824 </summary> 825 </Docs> 826 </Member> 827 <Member MemberName="RenderContents"> 828 <MemberSignature Language="C#" Value="protected override void RenderContents (System.Web.UI.HtmlTextWriter writer);" /> 829 <MemberType>Method</MemberType> 830 <AssemblyInfo> 831 <AssemblyVersion>2.0.0.0</AssemblyVersion> 832 </AssemblyInfo> 833 <ReturnValue> 834 <ReturnType>System.Void</ReturnType> 835 </ReturnValue> 836 <Parameters> 837 <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" /> 838 </Parameters> 839 <Docs> 840 <remarks> 841 <attribution license="cc4" from="Microsoft" modified="false" /> 842 <para>Use the <see cref="M:System.Web.UI.WebControls.ListControl.RenderContents(System.Web.UI.HtmlTextWriter)" /> method to render the items in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control to the client.</para> 843 </remarks> 844 <summary> 845 <attribution license="cc4" from="Microsoft" modified="false" /> 846 <para>Renders the items in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control.</para> 847 </summary> 848 <param name="writer"> 849 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> that represents the output stream used to write content to a Web page. </param> 850 </Docs> 851 </Member> 852 <Member MemberName="SaveViewState"> 853 <MemberSignature Language="C#" Value="protected override object SaveViewState ();" /> 854 <MemberType>Method</MemberType> 855 <ReturnValue> 856 <ReturnType>System.Object</ReturnType> 857 </ReturnValue> 858 <Parameters /> 859 <Docs> 860 <remarks> 861 <attribution license="cc4" from="Microsoft" modified="false" /> 862 <para>The <see cref="M:System.Web.UI.WebControls.DetailsView.SaveViewState" /> method is a helper method called by the <see cref="T:System.Web.UI.WebControls.ListControl" /> control to save the state of the control.</para> 863 <block subset="none" type="note"> 864 <para>This method is used primarily by control developers when extending the <see cref="T:System.Web.UI.WebControls.ListControl" /> control.</para> 865 </block> 866 </remarks> 867 <summary> 868 <attribution license="cc4" from="Microsoft" modified="false" /> 869 <para>Saves the current view state of the <see cref="T:System.Web.UI.WebControls.ListControl" /> -derived control and the items it contains.</para> 870 </summary> 871 <returns> 872 <attribution license="cc4" from="Microsoft" modified="false" /> 873 <para>An <see cref="T:System.Object" /> that contains the saved state of the <see cref="T:System.Web.UI.WebControls.ListControl" /> control.</para> 874 </returns> 875 </Docs> 876 <AssemblyInfo> 877 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 878 <AssemblyVersion>2.0.0.0</AssemblyVersion> 879 </AssemblyInfo> 880 </Member> 881 <Member MemberName="SelectedIndex"> 882 <MemberSignature Language="C#" Value="public virtual int SelectedIndex { set; get; }" /> 883 <MemberType>Property</MemberType> 884 <ReturnValue> 885 <ReturnType>System.Int32</ReturnType> 886 </ReturnValue> 887 <Parameters /> 888 <Docs> 889 <value>To be added: an object of type 'int'</value> 890 <remarks> 891 <attribution license="cc4" from="Microsoft" modified="false" /> 892 <para>Use this property to determine the index of the currently selected item in the list if the list control allows only one selection. If the list control supports multiple selections, use this property to determine the lowest index of the selected items.</para> 893 <para>The value of the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedIndex" /> property is not specifically saved on postback. It is restored on postback using the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property. For example, if the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property is 4, on postback, the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedIndex" /> property is set to the index of the <see cref="T:System.Web.UI.WebControls.ListItem" /> object that has a <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of 4. If more than one <see cref="T:System.Web.UI.WebControls.ListItem" /> object has a <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of 4, the first item in the <see cref="P:System.Web.UI.WebControls.ListControl.Items" /> collection is selected.</para> 894 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 895 </remarks> 896 <summary> 897 <attribution license="cc4" from="Microsoft" modified="false" /> 898 <para>Gets or sets the lowest ordinal index of the selected items in the list.</para> 899 </summary> 900 </Docs> 901 <AssemblyInfo> 902 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 903 <AssemblyVersion>2.0.0.0</AssemblyVersion> 904 </AssemblyInfo> 905 <Attributes> 906 <Attribute> 907 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 908 </Attribute> 909 <Attribute> 910 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName> 911 </Attribute> 912 <Attribute> 913 <AttributeName>System.ComponentModel.DefaultValue(0)</AttributeName> 914 </Attribute> 915 <Attribute> 916 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName> 917 </Attribute> 918 <Attribute> 919 <AttributeName>System.ComponentModel.Bindable(true)</AttributeName> 920 </Attribute> 921 </Attributes> 922 </Member> 923 <Member MemberName="SelectedIndexChanged"> 924 <MemberSignature Language="C#" Value="public event EventHandler SelectedIndexChanged;" /> 925 <MemberType>Event</MemberType> 926 <ReturnValue> 927 <ReturnType>System.EventHandler</ReturnType> 928 </ReturnValue> 929 <Parameters /> 930 <Docs> 931 <remarks> 932 <attribution license="cc4" from="Microsoft" modified="false" /> 933 <para>The <see cref="E:System.Web.UI.WebControls.ListControl.SelectedIndexChanged" /> event is raised when the selection from the list control changes between posts to the server.</para> 934 <block subset="none" type="note"> 935 <para>A list control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for the list control.</para> 936 </block> 937 <para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para> 938 </remarks> 939 <summary> 940 <attribution license="cc4" from="Microsoft" modified="false" /> 941 <para>Occurs when the selection from the list control changes between posts to the server.</para> 942 </summary> 943 </Docs> 944 <AssemblyInfo> 945 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 946 <AssemblyVersion>2.0.0.0</AssemblyVersion> 947 </AssemblyInfo> 948 </Member> 949 <Member MemberName="SelectedItem"> 950 <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.ListItem SelectedItem { get; }" /> 951 <MemberType>Property</MemberType> 952 <ReturnValue> 953 <ReturnType>System.Web.UI.WebControls.ListItem</ReturnType> 954 </ReturnValue> 955 <Docs> 956 <value>To be added: an object of type 'ListItem'</value> 957 <remarks> 958 <attribution license="cc4" from="Microsoft" modified="false" /> 959 <para>If the list control allows only a single selection, use this property to get the individual properties of the selected item. If the list control allows multiple selections, use this property to get the properties of the lowest indexed item selected from the list control.</para> 960 </remarks> 961 <summary> 962 <attribution license="cc4" from="Microsoft" modified="false" /> 963 <para>Gets the selected item with the lowest index in the list control.</para> 964 </summary> 965 </Docs> 966 <AssemblyInfo> 967 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 968 <AssemblyVersion>2.0.0.0</AssemblyVersion> 969 </AssemblyInfo> 970 <Attributes> 971 <Attribute> 972 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName> 973 </Attribute> 974 <Attribute> 975 <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName> 976 </Attribute> 977 <Attribute> 978 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName> 979 </Attribute> 980 </Attributes> 981 </Member> 982 <Member MemberName="SelectedValue"> 983 <MemberSignature Language="C#" Value="public virtual string SelectedValue { set; get; }" /> 984 <MemberType>Property</MemberType> 985 <ReturnValue> 986 <ReturnType>System.String</ReturnType> 987 </ReturnValue> 988 <Parameters /> 989 <Docs> 990 <value>a <see cref="T:System.String" /></value> 991 <remarks> 992 <attribution license="cc4" from="Microsoft" modified="false" /> 993 <para>This property returns the <see cref="P:System.Web.UI.WebControls.ListItem.Value" /> property of the selected <see cref="T:System.Web.UI.WebControls.ListItem" />. The <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property is commonly used to determine the value of the selected item in the list control. If multiple items are selected, the value of the selected item with the lowest index is returned. If no item is selected, an empty string ("") is returned.</para> 994 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property can also be used to select an item in the list control by setting it with the value of the item. </para> 995 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 996 <para>When the selected value is not in the list of available values and a postback is performed, an <see cref="T:System.ArgumentOutOfRangeException" /> exception is thrown. The following example shows how to catch an invalid value before postback occurs:</para> 997 <code>Me.DropDownList1.Items.Add(New ListItem( Text="Hello", Value="1" )) 998If DropDownList1.Items.FindByValue("2") IsNot Nothing Then 999 Response.Write("Found") 1000End If</code> 1001 <code>this.DropDownList1.Items.Add(new ListItem{ Text="Hello", Value="1" }); 1002if(DropDownList1.Items.FindByValue("2") != null) { 1003 Response.Write("Found"); 1004}</code> 1005 </remarks> 1006 <summary> 1007 <attribution license="cc4" from="Microsoft" modified="false" /> 1008 <para>Gets the value of the selected item in the list control, or selects the item in the list control that contains the specified value.</para> 1009 </summary> 1010 </Docs> 1011 <AssemblyInfo> 1012 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 1013 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1014 </AssemblyInfo> 1015 <Attributes> 1016 <Attribute> 1017 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName> 1018 </Attribute> 1019 <Attribute> 1020 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 1021 </Attribute> 1022 <Attribute> 1023 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName> 1024 </Attribute> 1025 <Attribute> 1026 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 1027 </Attribute> 1028 <Attribute> 1029 <AttributeName>System.ComponentModel.Bindable(true, System.ComponentModel.BindingDirection.TwoWay)</AttributeName> 1030 </Attribute> 1031 </Attributes> 1032 </Member> 1033 <Member MemberName="SetPostDataSelection"> 1034 <MemberSignature Language="C#" Value="protected void SetPostDataSelection (int selectedIndex);" /> 1035 <MemberType>Method</MemberType> 1036 <AssemblyInfo> 1037 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1038 </AssemblyInfo> 1039 <ReturnValue> 1040 <ReturnType>System.Void</ReturnType> 1041 </ReturnValue> 1042 <Parameters> 1043 <Parameter Name="selectedIndex" Type="System.Int32" /> 1044 </Parameters> 1045 <Docs> 1046 <remarks> 1047 <attribution license="cc4" from="Microsoft" modified="false" /> 1048 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.SetPostDataSelection(System.Int32)" /> method is a helper method that maintains the selected item in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control after a page is posted.</para> 1049 </remarks> 1050 <summary> 1051 <attribution license="cc4" from="Microsoft" modified="false" /> 1052 <para>Sets the <see cref="P:System.Web.UI.WebControls.ListItem.Selected" /> property of a <see cref="T:System.Web.UI.WebControls.ListItem" /> control after a page is posted.</para> 1053 </summary> 1054 <param name="selectedIndex"> 1055 <attribution license="cc4" from="Microsoft" modified="false" />The index of the selected item in the <see cref="P:System.Web.UI.WebControls.ListControl.Items" /> collection.</param> 1056 </Docs> 1057 </Member> 1058 <Member MemberName="TagKey"> 1059 <MemberSignature Language="C#" Value="protected override System.Web.UI.HtmlTextWriterTag TagKey { get; }" /> 1060 <MemberType>Property</MemberType> 1061 <AssemblyInfo> 1062 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 1063 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1064 </AssemblyInfo> 1065 <ReturnValue> 1066 <ReturnType>System.Web.UI.HtmlTextWriterTag</ReturnType> 1067 </ReturnValue> 1068 <Docs> 1069 <value>To be added.</value> 1070 <remarks> 1071 <attribution license="cc4" from="Microsoft" modified="false" /> 1072 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.TagKey" /> property allows the output stream to write the appropriate HTML markup for the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class.</para> 1073 </remarks> 1074 <summary> 1075 <attribution license="cc4" from="Microsoft" modified="false" /> 1076 <para>Gets the <see cref="T:System.Web.UI.HtmlTextWriterTag" /> value for the <see cref="T:System.Web.UI.WebControls.ListControl" /> control. </para> 1077 </summary> 1078 </Docs> 1079 </Member> 1080 <Member MemberName="Text"> 1081 <MemberSignature Language="C#" Value="public virtual string Text { set; get; }" /> 1082 <MemberType>Property</MemberType> 1083 <AssemblyInfo> 1084 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1085 </AssemblyInfo> 1086 <Attributes> 1087 <Attribute> 1088 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName> 1089 </Attribute> 1090 <Attribute> 1091 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName> 1092 </Attribute> 1093 <Attribute> 1094 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 1095 </Attribute> 1096 <Attribute> 1097 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 1098 </Attribute> 1099 </Attributes> 1100 <ReturnValue> 1101 <ReturnType>System.String</ReturnType> 1102 </ReturnValue> 1103 <Docs> 1104 <value>To be added.</value> 1105 <remarks> 1106 <attribution license="cc4" from="Microsoft" modified="false" /> 1107 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.Text" /> property gets and sets the same value that the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" />e property does.</para> 1108 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property is commonly used to determine the value of the selected item in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control. If no item is selected, an empty string ("") is returned.</para> 1109 <para>You can also use the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property to select an item in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control by setting it with the value of the item. If no items in the <see cref="T:System.Web.UI.WebControls.ListControl" /> control contain the specified value, an <see cref="T:System.ArgumentOutOfRangeException" /> exception is thrown.</para> 1110 <para>Control developers can override the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property to support features that are not related to the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property. </para> 1111 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 1112 </remarks> 1113 <summary> 1114 <attribution license="cc4" from="Microsoft" modified="false" /> 1115 <para>Gets or sets the <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> property of the <see cref="T:System.Web.UI.WebControls.ListControl" /> control.</para> 1116 </summary> 1117 </Docs> 1118 </Member> 1119 <Member MemberName="TextChanged"> 1120 <MemberSignature Language="C#" Value="public event EventHandler TextChanged;" /> 1121 <MemberType>Event</MemberType> 1122 <AssemblyInfo> 1123 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1124 </AssemblyInfo> 1125 <ReturnValue> 1126 <ReturnType>System.EventHandler</ReturnType> 1127 </ReturnValue> 1128 <Docs> 1129 <remarks> 1130 <attribution license="cc4" from="Microsoft" modified="false" /> 1131 <para>The <see cref="E:System.Web.UI.WebControls.ListControl.TextChanged" /> event is raised when the <see cref="P:System.Web.UI.WebControls.ListControl.Text" /> and <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> properties change.</para> 1132 <para>Raising an event invokes the event handler through a delegate. For more information, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para> 1133 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.OnTextChanged(System.EventArgs)" /> method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.</para> 1134 </remarks> 1135 <summary> 1136 <attribution license="cc4" from="Microsoft" modified="false" /> 1137 <para>Occurs when the <see cref="P:System.Web.UI.WebControls.ListControl.Text" /> and <see cref="P:System.Web.UI.WebControls.ListControl.SelectedValue" /> properties change.</para> 1138 </summary> 1139 </Docs> 1140 </Member> 1141 <Member MemberName="TrackViewState"> 1142 <MemberSignature Language="C#" Value="protected override void TrackViewState ();" /> 1143 <MemberType>Method</MemberType> 1144 <ReturnValue> 1145 <ReturnType>System.Void</ReturnType> 1146 </ReturnValue> 1147 <Parameters /> 1148 <Docs> 1149 <remarks> 1150 <attribution license="cc4" from="Microsoft" modified="false" /> 1151 <para>This method is overridden to mark the starting point to begin tracking and saving changes to the control as part of the control's view state.</para> 1152 <block subset="none" type="note"> 1153 <para>This method is used primarily by control developers when extending <see cref="T:System.Web.UI.WebControls.ListControl" />.</para> 1154 </block> 1155 </remarks> 1156 <summary> 1157 <attribution license="cc4" from="Microsoft" modified="false" /> 1158 <para>Marks the starting point to begin tracking and saving view-state changes to a <see cref="T:System.Web.UI.WebControls.ListControl" /> -derived control.</para> 1159 </summary> 1160 </Docs> 1161 <AssemblyInfo> 1162 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 1163 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1164 </AssemblyInfo> 1165 </Member> 1166 <Member MemberName="ValidationGroup"> 1167 <MemberSignature Language="C#" Value="public virtual string ValidationGroup { set; get; }" /> 1168 <MemberType>Property</MemberType> 1169 <AssemblyInfo> 1170 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1171 </AssemblyInfo> 1172 <Attributes> 1173 <Attribute> 1174 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 1175 </Attribute> 1176 <Attribute> 1177 <AttributeName>System.Web.UI.Themeable(false)</AttributeName> 1178 </Attribute> 1179 </Attributes> 1180 <ReturnValue> 1181 <ReturnType>System.String</ReturnType> 1182 </ReturnValue> 1183 <Docs> 1184 <value>To be added.</value> 1185 <remarks> 1186 <attribution license="cc4" from="Microsoft" modified="false" /> 1187 <para>Validation groups allow you to assign validation controls on a page to a specific category. Each validation group can be validated independently from other validation groups on the page. Use the <see cref="P:System.Web.UI.WebControls.ListControl.ValidationGroup" /> property to specify the name of the validation group for which the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class causes validation when it posts back to the server.</para> 1188 <para>The <see cref="P:System.Web.UI.WebControls.ListControl.ValidationGroup" /> property has an effect only when the value of the <see cref="P:System.Web.UI.WebControls.ListControl.CausesValidation" /> property is set to true. When you specify a value for the <see cref="P:System.Web.UI.WebControls.ListControl.ValidationGroup" /> property, only the validation controls that are part of the specified group are validated when the <see cref="T:System.Web.UI.WebControls.ListControl" /> control posts back to the server. If you do not specify a value for the <see cref="P:System.Web.UI.WebControls.ListControl.ValidationGroup" /> property and the <see cref="P:System.Web.UI.WebControls.ListControl.CausesValidation" /> property is set to true, all validation controls on the page that are not assigned to a validation group are validated when the control posts back to the server.</para> 1189 <para>The value of this property is stored in view state.</para> 1190 <para>This property cannot be set by themes or style sheet themes. For more information, see <see cref="T:System.Web.UI.ThemeableAttribute" /> and <format type="text/html"><a href="5df3ebbd-d46c-4502-9406-02f9df4ef2c3">ASP.NET Themes Overview</a></format>.</para> 1191 </remarks> 1192 <summary> 1193 <attribution license="cc4" from="Microsoft" modified="false" /> 1194 <para>Gets or sets the group of controls for which the control that is derived from the <see cref="T:System.Web.UI.WebControls.ListControl" /> class causes validation when it posts back to the server. </para> 1195 </summary> 1196 </Docs> 1197 </Member> 1198 <Member MemberName="VerifyMultiSelect"> 1199 <MemberSignature Language="C#" Value="protected virtual void VerifyMultiSelect ();" /> 1200 <MemberType>Method</MemberType> 1201 <AssemblyInfo> 1202 <AssemblyVersion>2.0.0.0</AssemblyVersion> 1203 </AssemblyInfo> 1204 <ReturnValue> 1205 <ReturnType>System.Void</ReturnType> 1206 </ReturnValue> 1207 <Parameters /> 1208 <Docs> 1209 <remarks> 1210 <attribution license="cc4" from="Microsoft" modified="false" /> 1211 <para>The <see cref="M:System.Web.UI.WebControls.ListControl.VerifyMultiSelect" /> method does nothing if multiselection is supported. Otherwise, it throws an <see cref="T:System.Web.HttpException" /> exception.</para> 1212 </remarks> 1213 <summary> 1214 <attribution license="cc4" from="Microsoft" modified="false" /> 1215 <para>Determines whether the list control supports multiselection mode.</para> 1216 </summary> 1217 </Docs> 1218 </Member> 1219 </Members> 1220</Type>