mcs/class/Mono.Options/Documentation/en/Mono.Options/OptionValueCollection.xml

   1 <Type Name="OptionValueCollection" FullName="Mono.Options.OptionValueCollection">
   2   <TypeSignature Language="C#" Value="public class OptionValueCollection : System.Collections.Generic.IList&lt;string&gt;, System.Collections.IList" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Options</AssemblyName>
   5     <AssemblyVersion>0.2.0.0</AssemblyVersion>
   6     <AssemblyVersion>0.2.1.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Object</BaseTypeName>
  10   </Base>
  11   <Interfaces>
  12     <Interface>
  13       <InterfaceName>System.Collections.Generic.IList&lt;System.String&gt;</InterfaceName>
  14     </Interface>
  15     <Interface>
  16       <InterfaceName>System.Collections.IList</InterfaceName>
  17     </Interface>
  18   </Interfaces>
  19   <Docs>
  20     <summary>
  21       A collection of <see cref="T:System.String" /> values to use as values to
  22       <see cref="M:Mono.Options.Option.OnParseComplete(Mono.Options.OptionContext)" />.
  23     </summary>
  24     <remarks>
  25       <para>
  26         A <see cref="T:Mono.Options.OptionValueCollection" /> instance is
  27         tied to a controlling <see cref="T:Mono.Options.OptionContext" />
  28         instance, and its behavior is tied to the
  29         <see cref="T:Mono.Options.Option" /> that the
  30         <see cref="P:Mono.Options.OptionContext.Option" /> property returns.
  31       </para>
  32       <para>
  33         If <see cref="P:Mono.Options.OptionContext.Option" /> refers to an
  34         <see cref="T:Mono.Options.Option" /> with an
  35         <see cref="T:Mono.Options.OptionValueType" /> of
  36         <see cref="F:Mono.Options.OptionValueType.Optional" />, then the
  37         <see cref="P:Mono.Options.OptionValueCollection.Item(System.Int32)" />
  38         indexer will return <see langword="null" /> if
  39         <paramref name="index" /> is less than
  40         <see cref="P:Mono.Options.Option.MaxValueCount" /> and
  41         <paramref name="index" /> is otherwise invalid (i.e. there hasn't been
  42         a string <c>Add</c>ed for that <paramref name="index" />.
  43       </para>
  44       <para>
  45         Otherwise, this instance behaves like
  46         <see cref="T:System.Collections.Generic.List{System.String}" />.
  47       </para>
  48     </remarks>
  49   </Docs>
  50   <Members>
  51     <Member MemberName="Add">
  52       <MemberSignature Language="C#" Value="public void Add (string item);" />
  53       <MemberType>Method</MemberType>
  54       <AssemblyInfo>
  55         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  56         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  57       </AssemblyInfo>
  58       <ReturnValue>
  59         <ReturnType>System.Void</ReturnType>
  60       </ReturnValue>
  61       <Parameters>
  62         <Parameter Name="item" Type="System.String" />
  63       </Parameters>
  64       <Docs>
  65         <param name="item">To be added.</param>
  66         <summary>To be added.</summary>
  67         <remarks>To be added.</remarks>
  68       </Docs>
  69     </Member>
  70     <Member MemberName="Clear">
  71       <MemberSignature Language="C#" Value="public void Clear ();" />
  72       <MemberType>Method</MemberType>
  73       <AssemblyInfo>
  74         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  75         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  76       </AssemblyInfo>
  77       <ReturnValue>
  78         <ReturnType>System.Void</ReturnType>
  79       </ReturnValue>
  80       <Parameters />
  81       <Docs>
  82         <summary>To be added.</summary>
  83         <remarks>To be added.</remarks>
  84       </Docs>
  85     </Member>
  86     <Member MemberName="Contains">
  87       <MemberSignature Language="C#" Value="public bool Contains (string item);" />
  88       <MemberType>Method</MemberType>
  89       <AssemblyInfo>
  90         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  91         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  92       </AssemblyInfo>
  93       <ReturnValue>
  94         <ReturnType>System.Boolean</ReturnType>
  95       </ReturnValue>
  96       <Parameters>
  97         <Parameter Name="item" Type="System.String" />
  98       </Parameters>
  99       <Docs>
 100         <param name="item">To be added.</param>
 101         <summary>To be added.</summary>
 102         <returns>To be added.</returns>
 103         <remarks>To be added.</remarks>
 104       </Docs>
 105     </Member>
 106     <Member MemberName="CopyTo">
 107       <MemberSignature Language="C#" Value="public void CopyTo (string[] array, int arrayIndex);" />
 108       <MemberType>Method</MemberType>
 109       <AssemblyInfo>
 110         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 111         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 112       </AssemblyInfo>
 113       <ReturnValue>
 114         <ReturnType>System.Void</ReturnType>
 115       </ReturnValue>
 116       <Parameters>
 117         <Parameter Name="array" Type="System.String[]" />
 118         <Parameter Name="arrayIndex" Type="System.Int32" />
 119       </Parameters>
 120       <Docs>
 121         <param name="array">To be added.</param>
 122         <param name="arrayIndex">To be added.</param>
 123         <summary>To be added.</summary>
 124         <remarks>To be added.</remarks>
 125       </Docs>
 126     </Member>
 127     <Member MemberName="Count">
 128       <MemberSignature Language="C#" Value="public int Count { get; }" />
 129       <MemberType>Property</MemberType>
 130       <AssemblyInfo>
 131         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 132         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 133       </AssemblyInfo>
 134       <ReturnValue>
 135         <ReturnType>System.Int32</ReturnType>
 136       </ReturnValue>
 137       <Docs>
 138         <summary>To be added.</summary>
 139         <value>To be added.</value>
 140         <remarks>To be added.</remarks>
 141       </Docs>
 142     </Member>
 143     <Member MemberName="GetEnumerator">
 144       <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerator&lt;string&gt; GetEnumerator ();" />
 145       <MemberType>Method</MemberType>
 146       <AssemblyInfo>
 147         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 148         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 149       </AssemblyInfo>
 150       <ReturnValue>
 151         <ReturnType>System.Collections.Generic.IEnumerator&lt;System.String&gt;</ReturnType>
 152       </ReturnValue>
 153       <Parameters />
 154       <Docs>
 155         <summary>To be added.</summary>
 156         <returns>To be added.</returns>
 157         <remarks>To be added.</remarks>
 158       </Docs>
 159     </Member>
 160     <Member MemberName="IndexOf">
 161       <MemberSignature Language="C#" Value="public int IndexOf (string item);" />
 162       <MemberType>Method</MemberType>
 163       <AssemblyInfo>
 164         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 165         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 166       </AssemblyInfo>
 167       <ReturnValue>
 168         <ReturnType>System.Int32</ReturnType>
 169       </ReturnValue>
 170       <Parameters>
 171         <Parameter Name="item" Type="System.String" />
 172       </Parameters>
 173       <Docs>
 174         <param name="item">To be added.</param>
 175         <summary>To be added.</summary>
 176         <returns>To be added.</returns>
 177         <remarks>To be added.</remarks>
 178       </Docs>
 179     </Member>
 180     <Member MemberName="Insert">
 181       <MemberSignature Language="C#" Value="public void Insert (int index, string item);" />
 182       <MemberType>Method</MemberType>
 183       <AssemblyInfo>
 184         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 185         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 186       </AssemblyInfo>
 187       <ReturnValue>
 188         <ReturnType>System.Void</ReturnType>
 189       </ReturnValue>
 190       <Parameters>
 191         <Parameter Name="index" Type="System.Int32" />
 192         <Parameter Name="item" Type="System.String" />
 193       </Parameters>
 194       <Docs>
 195         <param name="index">To be added.</param>
 196         <param name="item">To be added.</param>
 197         <summary>To be added.</summary>
 198         <remarks>To be added.</remarks>
 199       </Docs>
 200     </Member>
 201     <Member MemberName="IsReadOnly">
 202       <MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" />
 203       <MemberType>Property</MemberType>
 204       <AssemblyInfo>
 205         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 206         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 207       </AssemblyInfo>
 208       <ReturnValue>
 209         <ReturnType>System.Boolean</ReturnType>
 210       </ReturnValue>
 211       <Docs>
 212         <summary>To be added.</summary>
 213         <value>To be added.</value>
 214         <remarks>To be added.</remarks>
 215       </Docs>
 216     </Member>
 217     <Member MemberName="Item">
 218       <MemberSignature Language="C#" Value="public string this[int index] { set; get; }" />
 219       <MemberType>Property</MemberType>
 220       <AssemblyInfo>
 221         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 222         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 223       </AssemblyInfo>
 224       <ReturnValue>
 225         <ReturnType>System.String</ReturnType>
 226       </ReturnValue>
 227       <Parameters>
 228         <Parameter Name="index" Type="System.Int32" />
 229       </Parameters>
 230       <Docs>
 231         <param name="index">To be added.</param>
 232         <summary>To be added.</summary>
 233         <value>To be added.</value>
 234         <remarks>To be added.</remarks>
 235       </Docs>
 236     </Member>
 237     <Member MemberName="Remove">
 238       <MemberSignature Language="C#" Value="public bool Remove (string item);" />
 239       <MemberType>Method</MemberType>
 240       <AssemblyInfo>
 241         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 242         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 243       </AssemblyInfo>
 244       <ReturnValue>
 245         <ReturnType>System.Boolean</ReturnType>
 246       </ReturnValue>
 247       <Parameters>
 248         <Parameter Name="item" Type="System.String" />
 249       </Parameters>
 250       <Docs>
 251         <param name="item">To be added.</param>
 252         <summary>To be added.</summary>
 253         <returns>To be added.</returns>
 254         <remarks>To be added.</remarks>
 255       </Docs>
 256     </Member>
 257     <Member MemberName="RemoveAt">
 258       <MemberSignature Language="C#" Value="public void RemoveAt (int index);" />
 259       <MemberType>Method</MemberType>
 260       <AssemblyInfo>
 261         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 262         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 263       </AssemblyInfo>
 264       <ReturnValue>
 265         <ReturnType>System.Void</ReturnType>
 266       </ReturnValue>
 267       <Parameters>
 268         <Parameter Name="index" Type="System.Int32" />
 269       </Parameters>
 270       <Docs>
 271         <param name="index">To be added.</param>
 272         <summary>To be added.</summary>
 273         <remarks>To be added.</remarks>
 274       </Docs>
 275     </Member>
 276     <Member MemberName="System.Collections.ICollection.CopyTo">
 277       <MemberSignature Language="C#" Value="void ICollection.CopyTo (Array array, int index);" />
 278       <MemberType>Method</MemberType>
 279       <AssemblyInfo>
 280         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 281         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 282       </AssemblyInfo>
 283       <ReturnValue>
 284         <ReturnType>System.Void</ReturnType>
 285       </ReturnValue>
 286       <Parameters>
 287         <Parameter Name="array" Type="System.Array" />
 288         <Parameter Name="index" Type="System.Int32" />
 289       </Parameters>
 290       <Docs>
 291         <param name="array">To be added.</param>
 292         <param name="index">To be added.</param>
 293         <summary>To be added.</summary>
 294         <remarks>To be added.</remarks>
 295       </Docs>
 296     </Member>
 297     <Member MemberName="System.Collections.ICollection.IsSynchronized">
 298       <MemberSignature Language="C#" Value="bool System.Collections.ICollection.IsSynchronized { get; }" />
 299       <MemberType>Property</MemberType>
 300       <AssemblyInfo>
 301         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 302         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 303       </AssemblyInfo>
 304       <ReturnValue>
 305         <ReturnType>System.Boolean</ReturnType>
 306       </ReturnValue>
 307       <Docs>
 308         <summary>To be added.</summary>
 309         <value>To be added.</value>
 310         <remarks>To be added.</remarks>
 311       </Docs>
 312     </Member>
 313     <Member MemberName="System.Collections.ICollection.SyncRoot">
 314       <MemberSignature Language="C#" Value="object System.Collections.ICollection.SyncRoot { get; }" />
 315       <MemberType>Property</MemberType>
 316       <AssemblyInfo>
 317         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 318         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 319       </AssemblyInfo>
 320       <ReturnValue>
 321         <ReturnType>System.Object</ReturnType>
 322       </ReturnValue>
 323       <Docs>
 324         <summary>To be added.</summary>
 325         <value>To be added.</value>
 326         <remarks>To be added.</remarks>
 327       </Docs>
 328     </Member>
 329     <Member MemberName="System.Collections.IEnumerable.GetEnumerator">
 330       <MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
 331       <MemberType>Method</MemberType>
 332       <AssemblyInfo>
 333         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 334         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 335       </AssemblyInfo>
 336       <ReturnValue>
 337         <ReturnType>System.Collections.IEnumerator</ReturnType>
 338       </ReturnValue>
 339       <Parameters />
 340       <Docs>
 341         <summary>To be added.</summary>
 342         <returns>To be added.</returns>
 343         <remarks>To be added.</remarks>
 344       </Docs>
 345     </Member>
 346     <Member MemberName="System.Collections.IList.Add">
 347       <MemberSignature Language="C#" Value="int IList.Add (object value);" />
 348       <MemberType>Method</MemberType>
 349       <AssemblyInfo>
 350         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 351         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 352       </AssemblyInfo>
 353       <ReturnValue>
 354         <ReturnType>System.Int32</ReturnType>
 355       </ReturnValue>
 356       <Parameters>
 357         <Parameter Name="value" Type="System.Object" />
 358       </Parameters>
 359       <Docs>
 360         <param name="value">To be added.</param>
 361         <summary>To be added.</summary>
 362         <returns>To be added.</returns>
 363         <remarks>To be added.</remarks>
 364       </Docs>
 365     </Member>
 366     <Member MemberName="System.Collections.IList.Contains">
 367       <MemberSignature Language="C#" Value="bool IList.Contains (object value);" />
 368       <MemberType>Method</MemberType>
 369       <AssemblyInfo>
 370         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 371         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 372       </AssemblyInfo>
 373       <ReturnValue>
 374         <ReturnType>System.Boolean</ReturnType>
 375       </ReturnValue>
 376       <Parameters>
 377         <Parameter Name="value" Type="System.Object" />
 378       </Parameters>
 379       <Docs>
 380         <param name="value">To be added.</param>
 381         <summary>To be added.</summary>
 382         <returns>To be added.</returns>
 383         <remarks>To be added.</remarks>
 384       </Docs>
 385     </Member>
 386     <Member MemberName="System.Collections.IList.IndexOf">
 387       <MemberSignature Language="C#" Value="int IList.IndexOf (object value);" />
 388       <MemberType>Method</MemberType>
 389       <AssemblyInfo>
 390         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 391         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 392       </AssemblyInfo>
 393       <ReturnValue>
 394         <ReturnType>System.Int32</ReturnType>
 395       </ReturnValue>
 396       <Parameters>
 397         <Parameter Name="value" Type="System.Object" />
 398       </Parameters>
 399       <Docs>
 400         <param name="value">To be added.</param>
 401         <summary>To be added.</summary>
 402         <returns>To be added.</returns>
 403         <remarks>To be added.</remarks>
 404       </Docs>
 405     </Member>
 406     <Member MemberName="System.Collections.IList.Insert">
 407       <MemberSignature Language="C#" Value="void IList.Insert (int index, object value);" />
 408       <MemberType>Method</MemberType>
 409       <AssemblyInfo>
 410         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 411         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 412       </AssemblyInfo>
 413       <ReturnValue>
 414         <ReturnType>System.Void</ReturnType>
 415       </ReturnValue>
 416       <Parameters>
 417         <Parameter Name="index" Type="System.Int32" />
 418         <Parameter Name="value" Type="System.Object" />
 419       </Parameters>
 420       <Docs>
 421         <param name="index">To be added.</param>
 422         <param name="value">To be added.</param>
 423         <summary>To be added.</summary>
 424         <remarks>To be added.</remarks>
 425       </Docs>
 426     </Member>
 427     <Member MemberName="System.Collections.IList.IsFixedSize">
 428       <MemberSignature Language="C#" Value="bool System.Collections.IList.IsFixedSize { get; }" />
 429       <MemberType>Property</MemberType>
 430       <AssemblyInfo>
 431         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 432         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 433       </AssemblyInfo>
 434       <ReturnValue>
 435         <ReturnType>System.Boolean</ReturnType>
 436       </ReturnValue>
 437       <Docs>
 438         <summary>To be added.</summary>
 439         <value>To be added.</value>
 440         <remarks>To be added.</remarks>
 441       </Docs>
 442     </Member>
 443     <Member MemberName="System.Collections.IList.Item">
 444       <MemberSignature Language="C#" Value="object System.Collections.IList.Item[int index] { set; get; }" />
 445       <MemberType>Property</MemberType>
 446       <AssemblyInfo>
 447         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 448         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 449       </AssemblyInfo>
 450       <ReturnValue>
 451         <ReturnType>System.Object</ReturnType>
 452       </ReturnValue>
 453       <Parameters>
 454         <Parameter Name="index" Type="System.Int32" />
 455       </Parameters>
 456       <Docs>
 457         <param name="index">To be added.</param>
 458         <summary>To be added.</summary>
 459         <value>To be added.</value>
 460         <remarks>To be added.</remarks>
 461       </Docs>
 462     </Member>
 463     <Member MemberName="System.Collections.IList.Remove">
 464       <MemberSignature Language="C#" Value="void IList.Remove (object value);" />
 465       <MemberType>Method</MemberType>
 466       <AssemblyInfo>
 467         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 468         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 469       </AssemblyInfo>
 470       <ReturnValue>
 471         <ReturnType>System.Void</ReturnType>
 472       </ReturnValue>
 473       <Parameters>
 474         <Parameter Name="value" Type="System.Object" />
 475       </Parameters>
 476       <Docs>
 477         <param name="value">To be added.</param>
 478         <summary>To be added.</summary>
 479         <remarks>To be added.</remarks>
 480       </Docs>
 481     </Member>
 482     <Member MemberName="System.Collections.IList.RemoveAt">
 483       <MemberSignature Language="C#" Value="void IList.RemoveAt (int index);" />
 484       <MemberType>Method</MemberType>
 485       <AssemblyInfo>
 486         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 487         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 488       </AssemblyInfo>
 489       <ReturnValue>
 490         <ReturnType>System.Void</ReturnType>
 491       </ReturnValue>
 492       <Parameters>
 493         <Parameter Name="index" Type="System.Int32" />
 494       </Parameters>
 495       <Docs>
 496         <param name="index">To be added.</param>
 497         <summary>To be added.</summary>
 498         <remarks>To be added.</remarks>
 499       </Docs>
 500     </Member>
 501     <Member MemberName="ToArray">
 502       <MemberSignature Language="C#" Value="public string[] ToArray ();" />
 503       <MemberType>Method</MemberType>
 504       <AssemblyInfo>
 505         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 506         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 507       </AssemblyInfo>
 508       <ReturnValue>
 509         <ReturnType>System.String[]</ReturnType>
 510       </ReturnValue>
 511       <Parameters />
 512       <Docs>
 513         <summary>To be added.</summary>
 514         <returns>To be added.</returns>
 515         <remarks>To be added.</remarks>
 516       </Docs>
 517     </Member>
 518     <Member MemberName="ToList">
 519       <MemberSignature Language="C#" Value="public System.Collections.Generic.List&lt;string&gt; ToList ();" />
 520       <MemberType>Method</MemberType>
 521       <AssemblyInfo>
 522         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 523         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 524       </AssemblyInfo>
 525       <ReturnValue>
 526         <ReturnType>System.Collections.Generic.List&lt;System.String&gt;</ReturnType>
 527       </ReturnValue>
 528       <Parameters />
 529       <Docs>
 530         <summary>To be added.</summary>
 531         <returns>To be added.</returns>
 532         <remarks>To be added.</remarks>
 533       </Docs>
 534     </Member>
 535     <Member MemberName="ToString">
 536       <MemberSignature Language="C#" Value="public override string ToString ();" />
 537       <MemberType>Method</MemberType>
 538       <AssemblyInfo>
 539         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 540         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 541       </AssemblyInfo>
 542       <ReturnValue>
 543         <ReturnType>System.String</ReturnType>
 544       </ReturnValue>
 545       <Parameters />
 546       <Docs>
 547         <summary>To be added.</summary>
 548         <returns>To be added.</returns>
 549         <remarks>To be added.</remarks>
 550       </Docs>
 551     </Member>
 552   </Members>
 553 </Type>