InteractiveSelect

0.9.0

InteractiveSelect.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Select-Interactive</command:name>
      <command:verb>Select</command:verb>
      <command:noun>Interactive</command:noun>
      <maml:description>
        <maml:para>Filter and select items interactively.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Filter and select items interactively.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Select-Interactive</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the displayed UI. If it is an absolute number (e.g. `50`) then the UI will take the exact number of rows. If it's a percentage (e.g. `25%`) then the height will be calculated based on total window height.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
          <dev:type>
            <maml:name>DimensionParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
          <maml:name>InputObject</maml:name>
          <maml:description>
            <maml:para>Input objects that will be presented in the list. `-Property` parameter controls the text that will be presented for each item.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
          <dev:type>
            <maml:name>PSObject</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>KeyBindings</maml:name>
          <maml:description>
            <maml:para>Custom key binding that allow the user to define custom actions.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">KeyBindings</command:parameterValue>
          <dev:type>
            <maml:name>KeyBindings</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Preview</maml:name>
          <maml:description>
            <maml:para>Property name or script block that defines what is shown in the preview pane. If not specified then the preview pane won't be shown at all.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
          <dev:type>
            <maml:name>PSPropertyExpression</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Property</maml:name>
          <maml:description>
            <maml:para>Property or script block that returns text displayed in item list. If not specified then `ToString()` method is called on each item to get the text.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
          <dev:type>
            <maml:name>PSPropertyExpression</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>SplitOffset</maml:name>
          <maml:description>
            <maml:para>Controls the sizes of list and preview panes. If it's an absolute value (e.g. `50`) then list pane will take this exact size. If it's a percentage (e.g. `25%`) then list pane will take given percentage of total UI size and preview will take the rest.</maml:para>
            <maml:para>By default list pane width matches the length of the longest item but not more than 50%.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
          <dev:type>
            <maml:name>DimensionParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Vertical</maml:name>
          <maml:description>
            <maml:para>If set then panes are displayed vertically - list on top, preview on bottom.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Select-Interactive</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>Items</maml:name>
          <maml:description>
            <maml:para>Input objects that will be presented in the list. `-Property` parameter controls the text that will be presented for each item.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue>
          <dev:type>
            <maml:name>PSObject[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Height</maml:name>
          <maml:description>
            <maml:para>Height of the displayed UI. If it is an absolute number (e.g. `50`) then the UI will take the exact number of rows. If it's a percentage (e.g. `25%`) then the height will be calculated based on total window height.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
          <dev:type>
            <maml:name>DimensionParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>KeyBindings</maml:name>
          <maml:description>
            <maml:para>Custom key binding that allow the user to define custom actions.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">KeyBindings</command:parameterValue>
          <dev:type>
            <maml:name>KeyBindings</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Preview</maml:name>
          <maml:description>
            <maml:para>Property name or script block that defines what is shown in the preview pane. If not specified then the preview pane won't be shown at all.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
          <dev:type>
            <maml:name>PSPropertyExpression</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Property</maml:name>
          <maml:description>
            <maml:para>Property or script block that returns text displayed in item list. If not specified then `ToString()` method is called on each item to get the text.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
          <dev:type>
            <maml:name>PSPropertyExpression</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>SplitOffset</maml:name>
          <maml:description>
            <maml:para>Controls the sizes of list and preview panes. If it's an absolute value (e.g. `50`) then list pane will take this exact size. If it's a percentage (e.g. `25%`) then list pane will take given percentage of total UI size and preview will take the rest.</maml:para>
            <maml:para>By default list pane width matches the length of the longest item but not more than 50%.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
          <dev:type>
            <maml:name>DimensionParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Vertical</maml:name>
          <maml:description>
            <maml:para>If set then panes are displayed vertically - list on top, preview on bottom.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Height</maml:name>
        <maml:description>
          <maml:para>Height of the displayed UI. If it is an absolute number (e.g. `50`) then the UI will take the exact number of rows. If it's a percentage (e.g. `25%`) then the height will be calculated based on total window height.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
        <dev:type>
          <maml:name>DimensionParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">
        <maml:name>InputObject</maml:name>
        <maml:description>
          <maml:para>Input objects that will be presented in the list. `-Property` parameter controls the text that will be presented for each item.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
        <dev:type>
          <maml:name>PSObject</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>Items</maml:name>
        <maml:description>
          <maml:para>Input objects that will be presented in the list. `-Property` parameter controls the text that will be presented for each item.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue>
        <dev:type>
          <maml:name>PSObject[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>KeyBindings</maml:name>
        <maml:description>
          <maml:para>Custom key binding that allow the user to define custom actions.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">KeyBindings</command:parameterValue>
        <dev:type>
          <maml:name>KeyBindings</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Preview</maml:name>
        <maml:description>
          <maml:para>Property name or script block that defines what is shown in the preview pane. If not specified then the preview pane won't be shown at all.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
        <dev:type>
          <maml:name>PSPropertyExpression</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Property</maml:name>
        <maml:description>
          <maml:para>Property or script block that returns text displayed in item list. If not specified then `ToString()` method is called on each item to get the text.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSPropertyExpression</command:parameterValue>
        <dev:type>
          <maml:name>PSPropertyExpression</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>SplitOffset</maml:name>
        <maml:description>
          <maml:para>Controls the sizes of list and preview panes. If it's an absolute value (e.g. `50`) then list pane will take this exact size. If it's a percentage (e.g. `25%`) then list pane will take given percentage of total UI size and preview will take the rest.</maml:para>
          <maml:para>By default list pane width matches the length of the longest item but not more than 50%.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DimensionParameter</command:parameterValue>
        <dev:type>
          <maml:name>DimensionParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Vertical</maml:name>
        <maml:description>
          <maml:para>If set then panes are displayed vertically - list on top, preview on bottom.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.Management.Automation.PSObject</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Any object can be piped into the command.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.Object</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns selected object from the input collection.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-ChildItem | Select-Interactive -Property Name | Remove-Item</dev:code>
        <dev:remarks>
          <maml:para>Select items from current directory and delete them.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-Process | Select-Interactive -Property Name | Stop-Process</dev:code>
        <dev:remarks>
          <maml:para>Kill selected processes.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://github.com/lpatalas/InteractiveSelect/blob/v0.9.0/help/Select-Interactive.md</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>GitHub</maml:linkText>
        <maml:uri>https://github.com/lpatalas/InteractiveSelect</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>