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