SS.CliMenu.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-CliMenu --> <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>New-CliMenu</command:name> <command:verb>New</command:verb> <command:noun>CliMenu</command:noun> <maml:description> <maml:para>Create a new Menu</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can create as many menus you like, however you may only have one main Menu. The Menu must have a name, hence the Name parameter is Mandatory. The first Menu you create will become the main Menu even if you do not specify the IsMainMenu switch.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CliMenu</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Normally you would like to specify a name without space and Camel-case the name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Normally you would like to specify a name without space and Camel-case the name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MenuObject --> <command:returnValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-CliMenu -Name "MainMenu"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-CliMenu --> <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>Show-CliMenu</command:name> <command:verb>Show</command:verb> <command:noun>CliMenu</command:noun> <maml:description> <maml:para>Show a Menu.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Show the menu that is passed into the cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Show-CliMenu</maml:name> <!-- Parameter: Menu --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Menu</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">MenuObject</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultOption --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultOption</maml:name> <maml:description> <maml:para>The default option for the menu.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Q</dev:defaultValue> </command:parameter> <!-- Parameter: HeaderFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeaderFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`2</command:parameterValue> <dev:type> <maml:name>System.Action`2[[SS.CliMenu.Models.MenuObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeaderScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Header"> <maml:name>HeaderScript</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InvokeItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvokeItem</maml:name> <maml:description> <maml:para>The index of the menu item to invoke.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MetricData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetricData</maml:name> <maml:description> <maml:para>Metric data used for metric logging.</maml:para> </maml:description> <command:parameterValue required="true">MetricData</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MetricData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SS.CliMenu.Models.MetricData</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InvokeItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvokeItem</maml:name> <maml:description> <maml:para>The index of the menu item to invoke.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Menu --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Menu</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">MenuObject</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultOption --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultOption</maml:name> <maml:description> <maml:para>The default option for the menu.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Q</dev:defaultValue> </command:parameter> <!-- Parameter: HeaderScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Header"> <maml:name>HeaderScript</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Header"> <maml:name>Header</maml:name> <maml:description> <maml:para></maml:para> <maml:para>This is an alias of the HeaderScript parameter.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeaderFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeaderFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`2</command:parameterValue> <dev:type> <maml:name>System.Action`2[[SS.CliMenu.Models.MenuObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetricData</maml:name> <maml:description> <maml:para>Metric data used for metric logging.</maml:para> </maml:description> <command:parameterValue required="true">MetricData</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MetricData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SS.CliMenu.Models.MetricData</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$menu | Show-Menu</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CliMenuItem --> <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>New-CliMenuItem</command:name> <command:verb>New</command:verb> <command:noun>CliMenuItem</command:noun> <maml:description> <maml:para>Create a new Menu-Item for a Menu.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Menu-Items are the action elements of the Menu. You add Menu-Items to a Menu.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: MenuItem --> <command:syntaxItem> <maml:name>New-CliMenuItem</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The displayed value for this menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MenuObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>MenuObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">MenuObject</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConfirmTargetData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConfirmTargetData</maml:name> <maml:description> <maml:para>The target value passed to ShouldProcess.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Is this menu item the default option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Currently not used, possibly used for help menu at some point.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableConfirm --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableConfirm</maml:name> <maml:description> <maml:para>When true the menu will run without asking confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ForegroundColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForegroundColor</maml:name> <maml:description> <maml:para>Text color of menu item.</maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Func --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Func</maml:name> <maml:description> <maml:para>.Net Func to run when menu is selected. This is to support calling and building native .Net lambda methods from within a Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Func`3</command:parameterValue> <dev:type> <maml:name>System.Func`3[[SS.CliMenu.Models.MenuItemObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FuncArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FuncArgs</maml:name> <maml:description> <maml:para>Arguments to pass to Func when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InsertAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InsertAt</maml:name> <maml:description> <maml:para>The zero-based index at which the menu item should be inserted.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this menu item, for debug/logging purposes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OptionKey --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Option"> <maml:name>OptionKey</maml:name> <maml:description> <maml:para>The key(s) to use to select this menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Action"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to run when menu is selected.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ActionArgs"> <maml:name>ScriptArgs</maml:name> <maml:description> <maml:para>Arguments to pass to Script when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFunc</maml:name> <maml:description> <maml:para>.Net Func to run to evaluate if the menu item is visible or not. This is to support calling and building native .Net lambda methods from within a Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Func`3</command:parameterValue> <dev:type> <maml:name>System.Func`3[[SS.CliMenu.Models.MenuItemObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFuncArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFuncArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible Func when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleAction"> <maml:name>VisibleScript</maml:name> <maml:description> <maml:para>Script to run to evaluate if the menu item is visible or not.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScriptArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleActionArgs"> <maml:name>VisibleScriptArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible script when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: MenuItemSpace --> <command:syntaxItem> <maml:name>New-CliMenuItem</maml:name> <!-- Parameter: MenuObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>MenuObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">MenuObject</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Currently not used, possibly used for help menu at some point.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ForegroundColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForegroundColor</maml:name> <maml:description> <maml:para>Text color of menu item.</maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InsertAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InsertAt</maml:name> <maml:description> <maml:para>The zero-based index at which the menu item should be inserted.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSpace --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSpace</maml:name> <maml:description> <maml:para>Is this menu item a blank line space.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this menu item, for debug/logging purposes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFunc</maml:name> <maml:description> <maml:para>.Net Func to run to evaluate if the menu item is visible or not. This is to support calling and building native .Net lambda methods from within a Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Func`3</command:parameterValue> <dev:type> <maml:name>System.Func`3[[SS.CliMenu.Models.MenuItemObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFuncArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFuncArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible Func when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleAction"> <maml:name>VisibleScript</maml:name> <maml:description> <maml:para>Script to run to evaluate if the menu item is visible or not.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScriptArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleActionArgs"> <maml:name>VisibleScriptArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible script when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MenuObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>MenuObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">MenuObject</command:parameterValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this menu item, for debug/logging purposes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The displayed value for this menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Currently not used, possibly used for help menu at some point.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Action"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to run when menu is selected.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Action"> <maml:name>Action</maml:name> <maml:description> <maml:para>Script to run when menu is selected.</maml:para> <maml:para>This is an alias of the Script parameter.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ActionArgs"> <maml:name>ScriptArgs</maml:name> <maml:description> <maml:para>Arguments to pass to Script when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="ActionArgs"> <maml:name>ActionArgs</maml:name> <maml:description> <maml:para>Arguments to pass to Script when ran.</maml:para> <maml:para>This is an alias of the ScriptArgs parameter.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Func --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Func</maml:name> <maml:description> <maml:para>.Net Func to run when menu is selected. This is to support calling and building native .Net lambda methods from within a Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Func`3</command:parameterValue> <dev:type> <maml:name>System.Func`3[[SS.CliMenu.Models.MenuItemObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FuncArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FuncArgs</maml:name> <maml:description> <maml:para>Arguments to pass to Func when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleAction"> <maml:name>VisibleScript</maml:name> <maml:description> <maml:para>Script to run to evaluate if the menu item is visible or not.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleAction"> <maml:name>VisibleAction</maml:name> <maml:description> <maml:para>Script to run to evaluate if the menu item is visible or not.</maml:para> <maml:para>This is an alias of the VisibleScript parameter.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleScriptArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleActionArgs"> <maml:name>VisibleScriptArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible script when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="VisibleActionArgs"> <maml:name>VisibleActionArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible script when ran.</maml:para> <maml:para>This is an alias of the VisibleScriptArgs parameter.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFunc</maml:name> <maml:description> <maml:para>.Net Func to run to evaluate if the menu item is visible or not. This is to support calling and building native .Net lambda methods from within a Cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Func`3</command:parameterValue> <dev:type> <maml:name>System.Func`3[[SS.CliMenu.Models.MenuItemObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[System.Object[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VisibleFuncArgs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VisibleFuncArgs</maml:name> <maml:description> <maml:para>Arguments to pass to visible Func when ran.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableConfirm --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableConfirm</maml:name> <maml:description> <maml:para>When true the menu will run without asking confirmation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ForegroundColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForegroundColor</maml:name> <maml:description> <maml:para>Text color of menu item.</maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OptionKey --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Option"> <maml:name>OptionKey</maml:name> <maml:description> <maml:para>The key(s) to use to select this menu item.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Option"> <maml:name>Option</maml:name> <maml:description> <maml:para>The key(s) to use to select this menu item.</maml:para> <maml:para>This is an alias of the OptionKey parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSpace --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSpace</maml:name> <maml:description> <maml:para>Is this menu item a blank line space.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConfirmTargetData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConfirmTargetData</maml:name> <maml:description> <maml:para>The target value passed to ShouldProcess.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Is this menu item the default option.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InsertAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InsertAt</maml:name> <maml:description> <maml:para>The zero-based index at which the menu item should be inserted.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The key(s) to use to select this menu item.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: MenuObject --> <command:returnValue> <dev:type> <maml:name>SS.CliMenu.Models.MenuObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$menu | New-MenuItem -Name "UnlockUser" -DisplayName "Unlock a user" -Script { Unlock-UserObject } -DisableConfirm $true</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Write-CliMenuLine --> <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>Write-CliMenuLine</command:name> <command:verb>Write</command:verb> <command:noun>CliMenuLine</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByText --> <command:syntaxItem> <maml:name>Write-CliMenuLine</maml:name> <!-- Parameter: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Text</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Color</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsMenuItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsMenuItem</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByScript --> <command:syntaxItem> <maml:name>Write-CliMenuLine</maml:name> <!-- Parameter: Script --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Color</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsMenuItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsMenuItem</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFunc --> <command:syntaxItem> <maml:name>Write-CliMenuLine</maml:name> <!-- Parameter: Func --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Func</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> <dev:type> <maml:name>System.Action`1[[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Color</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsMenuItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsMenuItem</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Text</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Func --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Func</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`1</command:parameterValue> <dev:type> <maml:name>System.Action`1[[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Color</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>White</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsMenuItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsMenuItem</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Write-CliMenuLine "Menu line item"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Write-CliMenuLine -Script { Write-Host "test" }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CliMenuOption --> <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>Get-CliMenuOption</command:name> <command:verb>Get</command:verb> <command:noun>CliMenuOption</command:noun> <maml:description> <maml:para>Get a list menu options</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a CliMenuOptions object with all menu options. This CmdLet has no parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CliMenuOption</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: CliMenuOptions --> <command:returnValue> <dev:type> <maml:name>SS.CliMenu.Models.CliMenuOptions</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$opts = Get-CliMenuOption</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CliMenuOption --> <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>Set-CliMenuOption</command:name> <command:verb>Set</command:verb> <command:noun>CliMenuOption</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CliMenuOption</maml:name> <!-- Parameter: FooterText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FooterText</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FooterTextColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FooterTextColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: HeaderFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeaderFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`2</command:parameterValue> <dev:type> <maml:name>System.Action`2[[SS.CliMenu.Models.MenuObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeaderScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="HeaderAction"> <maml:name>HeaderScript</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Heading --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Heading</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeadingColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeadingColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MaxWidth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxWidth</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MenuFillChar --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuFillChar</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">char</command:parameterValue> <dev:type> <maml:name>System.Char</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: MenuFillColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuFillColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MenuItemColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuItemColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MenuNameColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuNameColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SubHeading --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubHeading</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubHeadingColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubHeadingColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ViewOnlyColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewOnlyColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MenuFillChar --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuFillChar</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">char</command:parameterValue> <dev:type> <maml:name>System.Char</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: MenuFillColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuFillColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Heading --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Heading</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeadingColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeadingColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SubHeading --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubHeading</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubHeadingColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubHeadingColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FooterText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FooterText</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FooterTextColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FooterTextColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MenuItemColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuItemColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ViewOnlyColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewOnlyColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MenuNameColor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MenuNameColor</maml:name> <maml:description> <maml:para></maml:para> <maml:para>Possible values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White</maml:para> </maml:description> <command:parameterValue required="true">ConsoleColor</command:parameterValue> <dev:type> <maml:name>System.ConsoleColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Black</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkBlue</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGreen</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkCyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkRed</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkMagenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkYellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Gray</command:parameterValue> <command:parameterValue required="false" variableLength="false">DarkGray</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Green</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cyan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Red</command:parameterValue> <command:parameterValue required="false" variableLength="false">Magenta</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yellow</command:parameterValue> <command:parameterValue required="false" variableLength="false">White</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MaxWidth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxWidth</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: HeaderScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="HeaderAction"> <maml:name>HeaderScript</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="HeaderAction"> <maml:name>HeaderAction</maml:name> <maml:description> <maml:para></maml:para> <maml:para>This is an alias of the HeaderScript parameter.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HeaderFunc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeaderFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">Action`2</command:parameterValue> <dev:type> <maml:name>System.Action`2[[SS.CliMenu.Models.MenuObject, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null],[SS.CliMenu.Models.CliMenuOptions, SS.CliMenu.Models, Version=1.0.2001.34, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CliMenuOptions --> <command:returnValue> <dev:type> <maml:name>SS.CliMenu.Models.CliMenuOptions</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-CliMenuOption -Heading 'PowerShell Menu'</dev:code> </command:example> </command:examples> </command:command> </helpItems> |