en-US/PSTuiTools-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>Get-PSTuiTools</command:name> <command:verb>Get</command:verb> <command:noun>PSTuiTools</command:noun> <maml:description> <maml:para>Get Sample TUI tools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the sample TUI tools from the PSTuiTools module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSTuiTools</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>psTuiTool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PSTuiTools Module: PSTuiTools [v0.4.0] Name Alias Synopsis ---- ----- -------- Get-PSTuiTools Get Sample TUI tools. Get-TuiCredential Prompt for credentials in a TUI. Invoke-HelloWorld HelloWorld Run a Hello World demo. Invoke-ProcessPeeker ProcessPeeker A TUI process viewer. Invoke-PSTuiTools PSTuiTools Show module commands in a TUI Invoke-ServiceInfo ServiceInfo A TUI for displaying service information. Invoke-SystemStatus TuiStatus Run a system status TUI monitor. Invoke-TuiColorDemo TuiColorDemo Run the TUI color demo. Invoke-TuiMp3 tuimp3 Launch a TUI MP3 player. Invoke-TuiTemplate TuiTemplate Run the TUI template script. Save-TuiAssembly Download Terminal.GUI and NStack assemblies.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/a41bfd</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSTuiTools</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/jdhitsolutions/PSTuiTools</maml:linkText> <maml:uri>https://github.com/jdhitsolutions/PSTuiTools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Get-TuiCredential</command:name> <command:verb>Get</command:verb> <command:noun>TuiCredential</command:noun> <maml:description> <maml:para>Prompt for credentials in a TUI.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is an alternative to Get-Credential that prompts for credentials in a TUI. Use Show to display the password in plaintext in the TUI. The output will be a PSCredential object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TuiCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Enter the username in the format <machine>|<domain>\username</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Enter the username in the format <machine>|<domain>\username</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $cred = Get-TuiCredential</dev:code> <dev:remarks> <maml:para>This will prompt for credentials in a TUI. Use Show to display the password in plaintext in the TUI.The output will be a PSCredential object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/0f96c5</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-HelloWorld</command:name> <command:verb>Invoke</command:verb> <command:noun>HelloWorld</command:noun> <maml:description> <maml:para>Run a Hello World demo.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Every project like this needs a Hello World example. This is a simple TUI that displays a label and a button. When the button is clicked, the label text will change. It will revert to the original text after 5 seconds.</maml:para> <maml:para>This function has an alias of HelloWorld.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-HelloWorld</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> HelloWorld</dev:code> <dev:remarks> <maml:para>Launch the TUI using its alias.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/dcd55e</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-ProcessPeeker</command:name> <command:verb>Invoke</command:verb> <command:noun>ProcessPeeker</command:noun> <maml:description> <maml:para>A TUI process viewer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch a TUI that can be used to display process information. Select a process from the left-hand list to display process details in the right-hand pane.</maml:para> <maml:para>This command has an alias of ProcessPeeker.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ProcessPeeker</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ProcessPeeker</dev:code> <dev:remarks> <maml:para>This command has an alias of ProcessPeeker.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/9590c0</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-PSTuiTools</command:name> <command:verb>Invoke</command:verb> <command:noun>PSTuiTools</command:noun> <maml:description> <maml:para>Show module commands in a TUI</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is a TUI version of Get-PSTuiTools. It shows the module commands in a TUI. You can scroll through the list of commands and the help description. You can also press Enter on a selected command to run it. When the command finishes, this TUI will be re-displayed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PSTuiTools</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of pstuitools.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-PSTuiTools</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/defc27</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSTuiTools</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-ServiceInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>ServiceInfo</command:noun> <maml:description> <maml:para>A TUI for displaying service information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this TUI to display information about services on the local or a remote computer. The TUI uses PowerShell remoting over WsMan to retrieve the service information and supports alternate credentials.</maml:para> <maml:para>This command has an alias of ServiceInfo.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ServiceInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ServiceInfo</dev:code> <dev:remarks> <maml:para>Click Get Info to retrieve the service information from the specified computer. You can also filter on the service status. Click Get Info after changing the filter to retrieve the updated service information.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/cc0520</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-SystemStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>SystemStatus</command:noun> <maml:description> <maml:para>Run a system status TUI monitor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will launch a system status monitor TUI. Enter a computer name and alternate credentials if necessary. Click the Refresh button or the Alt+R shortcut to manually refresh information.</maml:para> <maml:para>You can also set an automatic refresh interval. Click the Timer button to stop and start. If you change the computer, you should stop the timer first. Restart it after changing the computer name.</maml:para> <maml:para>Use the Quit button or Alt+Q to exit.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-SystemStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="CN"> <maml:name>Computername</maml:name> <maml:description> <maml:para>The name of the computer to monitor. You must have admin rights.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Alternate credentials for a remote computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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="color"> <maml:name>WindowColor</maml:name> <maml:description> <maml:para>Specify the window foreground color. The background will be Black.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Brown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightBlue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightGreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightCyan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightRed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightMagenta</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BrightYellow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">White</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Color</command:parameterValue> <dev:type> <maml:name>Color</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="CN"> <maml:name>Computername</maml:name> <maml:description> <maml:para>The name of the computer to monitor. You must have admin rights.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="RunAs"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Alternate credentials for a remote computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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="color"> <maml:name>WindowColor</maml:name> <maml:description> <maml:para>Specify the window foreground color. The background will be Black.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Color</command:parameterValue> <dev:type> <maml:name>Color</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></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></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of tuiStatus.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-SystemStatus</dev:code> <dev:remarks> <maml:para>Launch the system status monitor for the local computer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-SystemStatus -Computername SRV1 -credential administrator -color Cyan</dev:code> <dev:remarks> <maml:para>Launch the system status monitor for the remote computer SRV1 using alternate credentials. Use Cyan as the TUI foreground color.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/cdf5f3</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-TuiColorDemo</command:name> <command:verb>Invoke</command:verb> <command:noun>TuiColorDemo</command:noun> <maml:description> <maml:para>Run the TUI color demo.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will display a simple TUI that allows you to see the various color combinations for the main window. Select the foreground and background colors, then click the Try It button. You can use Reset to return to the default colors.</maml:para> <maml:para>The TUI also includes a small code snippet that shows how to set the colors in your own TUI. You can't edit the code in the TUI, but you should be able to copy and paste it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TuiColorDemo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-TuiColorDemo</dev:code> <dev:remarks> <maml:para>This command has an alias of TuiColorDemo</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/6cc500</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-TuiMp3</command:name> <command:verb>Invoke</command:verb> <command:noun>TuiMp3</command:noun> <maml:description> <maml:para>Launch a TUI MP3 player.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will launch a TUI MP3 player. You can specify the path to an MP3 file to play or open a file from the menu. You can set a default library folder to open to simplify navigation. Use the buttons to control playback. Selected metadata and lyrics will be displayed if found in the MP3 file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TuiMp3</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Path"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the path to an MP3 file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>DefaultLibrary</maml:name> <maml:description> <maml:para>Specify the default folder to open for MP3 files. UNC paths are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Title</maml:name> <maml:description> <maml:para>Specify the window title.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>DefaultLibrary</maml:name> <maml:description> <maml:para>Specify the default folder to open for MP3 files. UNC paths are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Path"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specify the path to an MP3 file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Title</maml:name> <maml:description> <maml:para>Specify the window title.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command has an alias of tuimp3.</maml:para> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-TuiMp3 -FilePath "C:\Music\MySong.mp3"</dev:code> <dev:remarks> <maml:para>Launch the TUI MP3 player and load the specified MP3 file. You will need to click the Play button.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-TuiMp3 -DefaultLibrary "C:\Music"</dev:code> <dev:remarks> <maml:para>Launch the TUI MP3 player and set the default library to the specified folder. You can then navigate to your MP3 files more easily.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/d411aa</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Invoke-TuiTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>TuiTemplate</command:noun> <maml:description> <maml:para>Run the TUI template script.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The PSTuiTools module includes a TUI template script that can be used as a starting point for creating your own TUI applications. The Invoke-TuiTemplate cmdlet runs the TUI template script. You can click the Copy Code to Clipboard button to copy the template script code to the Windows clipboard, and then paste it into a new PowerShell script file to customize it for your needs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TuiTemplate</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-TuiTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/edd54a</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Save-TuiAssembly</command:name> <command:verb>Save</command:verb> <command:noun>TuiAssembly</command:noun> <maml:description> <maml:para>Download Terminal.GUI and NStack assemblies.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To create a TUI application in PowerShell, you will need the Terminal.Gui and NStack assemblies. This function will download the latest versions of these assemblies from NuGet and save them to a specified location on your computer. You can specify which assemblies to download by using the -Package parameter, or you can download both assemblies by omitting the parameter.</maml:para> <maml:para>The DestinationPath should be the top level folder where you want the assemblies to be saved. The function will create a subfolder for each assembly and save the corresponding DLL files in that subfolder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-TuiAssembly</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:description> <maml:para>The name of the related assembly.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Terminal.Gui</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NStack</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specify the location to save the downloaded assemblies. It will be created for you.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specify the location to save the downloaded assemblies. It will be created for you.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:description> <maml:para>The name of the related assembly.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/yourls/newsletter</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Save-TuiAssembly -DestinationPath "C:\Tools\"</dev:code> <dev:remarks> <maml:para>This will download and save the NStack and Terminal.Gui assemblies to the C:\Tools folder. There will be two sub-folders created: C:\Tools\Terminal.Gui and C:\Tools\NStack, each containing the respective DLL files.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://jdhitsolutions.com/yourls/c2f989</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |