PowerTab

1.0.0

TabExpansionCore-Help.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<helpItems schema="maml">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Invoke-TabExpansion</command:name>
      <maml:description>
        <maml:para>Invokes the tab expansion logic of PowerTab.</maml:para>
      </maml:description>
      <maml:copyright/>
      <command:verb>Invoke</command:verb>
      <command:noun>TabExpansion</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>This function should be called just like the built-in TabExpansion() function of PowerShell.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <command:name>Invoke-TabExpansion</command:name>
        <command:parameter require="true" postion="1">
          <maml:name>Line</maml:name>
          <maml:description/>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
        <command:parameter require="true" postion="2">
          <maml:name>LastWord</maml:name>
          <maml:description/>
          <command:parameterValue required="true">String</command:parameterValue>
        </command:parameter>
        <command:parameter require="false" postion="named">
          <maml:name>ForceList</maml:name>
          <maml:description/>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ForceList</maml:name>
        <maml:description>
          <maml:para>Forces ConsoleList to display the list control regardless of the value of MinimumListItems. This is intended for recursive tab expansion support.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:defaultValue />
      </command:parameter>
      <command:parameter required="true" globbing="true" pipelineInput="false" position="2">
        <maml:name>LastWord</maml:name>
        <maml:description>
          <maml:para>Specifies the last word, or the text that should be replaced by tab expansion.</maml:para>
        </maml:description>
        <command:parameterValue required="true">String</command:parameterValue>
        <dev:defaultValue />
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="1">
        <maml:name>Line</maml:name>
        <maml:description>
          <maml:para>Specifies the whole command line string.</maml:para>
        </maml:description>
        <command:parameterValue required="true">String</command:parameterValue>
        <dev:defaultValue />
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri />
          <maml:description/>
        </dev:type>
        <maml:description/>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
          <maml:description/>
        </dev:type>
        <maml:description>
          <maml:para>
            Zero, one or more tab expansion results.
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <maml:alertSet>
      <maml:title />
      <maml:alert>
        <maml:para />
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
        <maml:introduction>
          <maml:para>C:\PS&gt;</maml:para>
        </maml:introduction>
        <dev:code>Invoke-TabExpansion "Get-Process -" "-"</dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>In this example, PowerTab will interpret the query as looking for a parameter name to Get-Process.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>about_PowerTab</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>