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

   1 <Type Name="OptionContext" FullName="Mono.Options.OptionContext">
   2   <TypeSignature Language="C#" Value="public class OptionContext" />
   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   <Docs>
  13     <summary>Provides additional context information about the current
  14       <see cref="T:Mono.Options.Option" /> which is being parsed.</summary>
  15     <remarks>
  16       An instance of this class is provided via the registered callback when you
  17       override the
  18       <see cref="M:Mono.Options.Option.OnParseComplete(Mono.Options.OptionContext)" />
  19       method.
  20     </remarks>
  21   </Docs>
  22   <Members>
  23     <Member MemberName=".ctor">
  24       <MemberSignature Language="C#" Value="public OptionContext (Mono.Options.OptionSet set);" />
  25       <MemberType>Constructor</MemberType>
  26       <AssemblyInfo>
  27         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  28         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  29       </AssemblyInfo>
  30       <Parameters>
  31         <Parameter Name="set" Type="Mono.Options.OptionSet" />
  32       </Parameters>
  33       <Docs>
  34         <param name="set">
  35           The <see cref="T:Mono.Options.OptionSet" /> instance to use for
  36           message localization purposes.
  37         </param>
  38         <summary>Constructs and initializes a new instance of the
  39           <see cref="T:Mono.Options.OptionContext" /> class.</summary>
  40         <remarks>
  41           This constructor initializes the
  42           <see cref="P:Mono.Options.OptionContext.OptionSet" /> property of
  43           the new instance using <paramref name="set" />.
  44         </remarks>
  45       </Docs>
  46     </Member>
  47     <Member MemberName="Option">
  48       <MemberSignature Language="C#" Value="public Mono.Options.Option Option { set; get; }" />
  49       <MemberType>Property</MemberType>
  50       <AssemblyInfo>
  51         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  52         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  53       </AssemblyInfo>
  54       <ReturnValue>
  55         <ReturnType>Mono.Options.Option</ReturnType>
  56       </ReturnValue>
  57       <Docs>
  58         <summary>The <see cref="T:Mono.Options.Option" /> being parsed.</summary>
  59         <value>The <see cref="T:Mono.Options.Option" /> being parsed.</value>
  60         <remarks>
  61         </remarks>
  62       </Docs>
  63     </Member>
  64     <Member MemberName="OptionIndex">
  65       <MemberSignature Language="C#" Value="public int OptionIndex { set; get; }" />
  66       <MemberType>Property</MemberType>
  67       <AssemblyInfo>
  68         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  69         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  70       </AssemblyInfo>
  71       <ReturnValue>
  72         <ReturnType>System.Int32</ReturnType>
  73       </ReturnValue>
  74       <Docs>
  75         <summary>
  76           The index within the options list of the last value within
  77           <see cref="P:Mono.Options.OptionContext.OptionValues" />.
  78         </summary>
  79         <value>
  80           A <see cref="T:System.Int32" /> containing the index within the
  81           options list of the last value within
  82           <see cref="P:Mono.Options.OptionContext.OptionValues" />.
  83         </value>
  84         <remarks>
  85         </remarks>
  86         <altmember cref="M:Mono.Options.OptionSet.Parse(System.Collections.Generic.IEnumerable&lt;System.String&gt;)" />
  87       </Docs>
  88     </Member>
  89     <Member MemberName="OptionName">
  90       <MemberSignature Language="C#" Value="public string OptionName { set; get; }" />
  91       <MemberType>Property</MemberType>
  92       <AssemblyInfo>
  93         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  94         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  95       </AssemblyInfo>
  96       <ReturnValue>
  97         <ReturnType>System.String</ReturnType>
  98       </ReturnValue>
  99       <Docs>
 100         <summary>The actual option name used.</summary>
 101         <value>A <see cref="T:System.String" /> containing the actual option name used.</value>
 102         <remarks>
 103           A <see cref="P:Mono.Options.Option.Prototype" /> can contain multiple
 104           <c>|</c>-delimited aliases, e.g. <c>h|help</c>.  This property
 105           contains the actual option name specified, e.g. <c>-h</c> vs.
 106           <c>--help</c>.
 107         </remarks>
 108       </Docs>
 109     </Member>
 110     <Member MemberName="OptionSet">
 111       <MemberSignature Language="C#" Value="public Mono.Options.OptionSet OptionSet { get; }" />
 112       <MemberType>Property</MemberType>
 113       <AssemblyInfo>
 114         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 115         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 116       </AssemblyInfo>
 117       <ReturnValue>
 118         <ReturnType>Mono.Options.OptionSet</ReturnType>
 119       </ReturnValue>
 120       <Docs>
 121         <summary>
 122           The <see cref="T:Mono.Options.OptionSet" /> to use for message
 123           localizations.
 124         </summary>
 125         <value>
 126           The <see cref="T:Mono.Options.OptionSet" /> to use for message
 127           localizations.
 128         </value>
 129         <remarks>
 130           <para>
 131             This property is initialized in the
 132             <see cref="C:Mono.Options.OptionContext(Mono.Options.OptionSet)" />
 133             constructor.
 134           </para>
 135         </remarks>
 136       </Docs>
 137     </Member>
 138     <Member MemberName="OptionValues">
 139       <MemberSignature Language="C#" Value="public Mono.Options.OptionValueCollection OptionValues { get; }" />
 140       <MemberType>Property</MemberType>
 141       <AssemblyInfo>
 142         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 143         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 144       </AssemblyInfo>
 145       <ReturnValue>
 146         <ReturnType>Mono.Options.OptionValueCollection</ReturnType>
 147       </ReturnValue>
 148       <Docs>
 149         <summary>
 150           A collection of <see cref="T:System.String" /> values to provide to
 151           <see cref="P:Mono.Options.OptionContext.Option" />.
 152         </summary>
 153         <value>
 154           A <see cref="T:Mono.Options.OptionValueCollection" /> containing
 155           <see cref="T:System.String" /> values to provide to
 156           <see cref="P:Mono.Options.OptionContext.Option" />.
 157         </value>
 158         <remarks>
 159           <para>
 160             The <see cref="T:Mono.Options.OptionValueCollection" /> indexer
 161             makes use of the
 162             <see cref="P:Mono.Options.Option.OptionValueType" />
 163             and <see cref="P:Mono.Options.Option.MaxValueCount" /> properties.
 164             If the index does not have a value, the index is less than
 165             <see cref="P:Mono.Options.Option.MaxValueCount" />, and the
 166             <see cref="P:Mono.Options.OptionContext.Option" /> has a value
 167             type of <see cref="F:Mono.Options.OptionValueType.Optional" />,
 168             <see langword="null" /> is returned; otherwise an
 169             <see cref="T:Mono.Options.OptionException" /> is thrown.
 170           </para>
 171         </remarks>
 172       </Docs>
 173     </Member>
 174   </Members>
 175 </Type>