CompletionContext.xml

<Type Name="CompletionContext" FullName="System.CommandLine.Completions.CompletionContext">
  <TypeSignature Language="C#" Value="public abstract class CompletionContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit CompletionContext extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.CommandLine.Completions.CompletionContext" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class CompletionContext" />
  <TypeSignature Language="F#" Value="type CompletionContext = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class CompletionContext abstract" />
  <AssemblyInfo>
    <AssemblyName>System.CommandLine</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Supports command line completion operations.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetWordToComplete">
      <MemberSignature Language="C#" Value="protected static string GetWordToComplete (System.CommandLine.Parsing.ParseResult parseResult, int? position = default);" />
      <MemberSignature Language="ILAsm" Value=".method familystatic hidebysig string GetWordToComplete(class System.CommandLine.Parsing.ParseResult parseResult, valuetype System.Nullable`1&lt;int32&gt; position) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.CommandLine.Completions.CompletionContext.GetWordToComplete(System.CommandLine.Parsing.ParseResult,System.Nullable{System.Int32})" />
      <MemberSignature Language="VB.NET" Value="Protected Shared Function GetWordToComplete (parseResult As ParseResult, Optional position As Nullable(Of Integer) = Nothing) As String" />
      <MemberSignature Language="F#" Value="static member GetWordToComplete : System.CommandLine.Parsing.ParseResult * Nullable&lt;int&gt; -&gt; string" Usage="System.CommandLine.Completions.CompletionContext.GetWordToComplete (parseResult, position)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parseResult" Type="System.CommandLine.Parsing.ParseResult" />
        <Parameter Name="position" Type="System.Nullable&lt;System.Int32&gt;" />
      </Parameters>
      <Docs>
        <param name="parseResult">A parse result.</param>
        <param name="position">The position within the raw input, if available, at which to provide completions.</param>
        <summary>
            Gets the text to be matched for completion, which can be used to filter a list of completions.
            </summary>
        <returns>A string containing the user-entered text to be matched for completions.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ParseResult">
      <MemberSignature Language="C#" Value="public System.CommandLine.Parsing.ParseResult ParseResult { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.CommandLine.Parsing.ParseResult ParseResult" />
      <MemberSignature Language="DocId" Value="P:System.CommandLine.Completions.CompletionContext.ParseResult" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ParseResult As ParseResult" />
      <MemberSignature Language="F#" Value="member this.ParseResult : System.CommandLine.Parsing.ParseResult" Usage="System.CommandLine.Completions.CompletionContext.ParseResult" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::CommandLine::Parsing::ParseResult ^ ParseResult { System::CommandLine::Parsing::ParseResult ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.CommandLine.Parsing.ParseResult</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WordToComplete">
      <MemberSignature Language="C#" Value="public string WordToComplete { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string WordToComplete" />
      <MemberSignature Language="DocId" Value="P:System.CommandLine.Completions.CompletionContext.WordToComplete" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property WordToComplete As String" />
      <MemberSignature Language="F#" Value="member this.WordToComplete : string" Usage="System.CommandLine.Completions.CompletionContext.WordToComplete" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ WordToComplete { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>