en-US/GraphicalToolsModule.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-GridView</command:name> <command:verb>Out</command:verb> <command:noun>GridView</command:noun> <maml:description> <maml:para>Sends output to an interactive table in a separate window.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Out-GridView cmdlet sends the output from a command to a grid view window where the output is displayed in an interactive table.</maml:para> <maml:para>You can use the following features of the table to examine your data:</maml:para> <maml:para>- Hide, Show, and Reorder Columns: To hide, show, use the columns dropdown. Drag and drop column headers to reorder.</maml:para> <maml:para>- Sort. To sort the data, click a column header. Click again to toggle from ascending to descending order.</maml:para> <maml:para>- Quick Filter. Use the Filter box at the top of the window to search the text in the table. You can search for text in a particular column, search for literals, and search for multiple words.</maml:para> <maml:para>- Column Filter. Use the Add Column Filter drop-down to create rules to filter the data. This is very useful for very large data sets, such as event logs.</maml:para> <maml:para></maml:para> <maml:para>For instructions for using these features, type `Get-Help Out-GridView -Full` and see How to Use the Grid View Window Features in the Notes section.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-GridView</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies that the cmdlet accepts input for Out-GridView .</maml:para> <maml:para>When you use the InputObject parameter to send a collection of objects to Out-GridView , Out-GridView treats the collection as one collection object, and it displays one row that represents the collection. To display the each object in the collection, use a pipeline operator (|) to send objects to Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputMode</maml:name> <maml:Description> <maml:para>Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK.</maml:para> <maml:para>The values of this parameter determine how many items you can send down the pipeline.</maml:para> <maml:para>- None. No items. This is the default value.</maml:para> <maml:para>- Single. Zero items or one item. Use this value when the next command can take only one input object.</maml:para> <maml:para>- Multiple. Zero, one, or many items. Use this value when the next command can take multiple input objects. This value is equivalent to the Passthru parameter.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Multiple</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputModeOption</command:parameterValue> <dev:type> <maml:name>OutputModeOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Specifies the text that appears in the title bar of the Out-GridView window.</maml:para> <maml:para>By default, the title bar displays the command that invokes Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Out-GridView</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies that the cmdlet accepts input for Out-GridView .</maml:para> <maml:para>When you use the InputObject parameter to send a collection of objects to Out-GridView , Out-GridView treats the collection as one collection object, and it displays one row that represents the collection. To display the each object in the collection, use a pipeline operator (|) to send objects to Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sends items from the interactive window down the pipeline as input to other commands. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the OutputMode parameter.</maml:para> <maml:para>To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Specifies the text that appears in the title bar of the Out-GridView window.</maml:para> <maml:para>By default, the title bar displays the command that invokes Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Out-GridView</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies that the cmdlet accepts input for Out-GridView .</maml:para> <maml:para>When you use the InputObject parameter to send a collection of objects to Out-GridView , Out-GridView treats the collection as one collection object, and it displays one row that represents the collection. To display the each object in the collection, use a pipeline operator (|) to send objects to Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Specifies the text that appears in the title bar of the Out-GridView window.</maml:para> <maml:para>By default, the title bar displays the command that invokes Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet suppresses the command prompt and prevents Windows PowerShell from closing until the Out-GridView window is closed. By default, the command prompt returns when the Out-GridView window opens.</maml:para> <maml:para>This feature lets you use the Out-GridView cmdlets in Windows shortcuts. When Out-GridView is used in a shortcut without the Wait parameter, the Out-GridView window appears only momentarily before Windows PowerShell closes.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies that the cmdlet accepts input for Out-GridView .</maml:para> <maml:para>When you use the InputObject parameter to send a collection of objects to Out-GridView , Out-GridView treats the collection as one collection object, and it displays one row that represents the collection. To display the each object in the collection, use a pipeline operator (|) to send objects to Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputMode</maml:name> <maml:Description> <maml:para>Specifies the items that the interactive window sends down the pipeline as input to other commands. By default, this cmdlet does not generate any output. To send items from the interactive window down the pipeline, click to select the items and then click OK.</maml:para> <maml:para>The values of this parameter determine how many items you can send down the pipeline.</maml:para> <maml:para>- None. No items. This is the default value.</maml:para> <maml:para>- Single. Zero items or one item. Use this value when the next command can take only one input object.</maml:para> <maml:para>- Multiple. Zero, one, or many items. Use this value when the next command can take multiple input objects. This value is equivalent to the Passthru parameter.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OutputModeOption</command:parameterValue> <dev:type> <maml:name>OutputModeOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet sends items from the interactive window down the pipeline as input to other commands. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the OutputMode parameter.</maml:para> <maml:para>To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>Specifies the text that appears in the title bar of the Out-GridView window.</maml:para> <maml:para>By default, the title bar displays the command that invokes Out-GridView .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet suppresses the command prompt and prevents Windows PowerShell from closing until the Out-GridView window is closed. By default, the command prompt returns when the Out-GridView window opens.</maml:para> <maml:para>This feature lets you use the Out-GridView cmdlets in Windows shortcuts. When Out-GridView is used in a shortcut without the Wait parameter, the Out-GridView window appears only momentarily before Windows PowerShell closes.</maml:para> <maml:para>This parameter was introduced in Windows PowerShell 3.0.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>You can send any object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>Out-GridView does not return any objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>* You cannot use a remote command to open a grid view window on another computer. The command output that you send to Out-GridView * cannot be formatted, such as by using the Format-Table or Format-Wide cmdlets. To select properties, use the Select-Object cmdlet.</maml:para> <maml:para>* Deserialized output from remote commands might not be formatted correctly in the grid view window.</maml:para> <maml:para> How to Use the Grid View Window Features</maml:para> <maml:para> The following topics explain how to use the features of the window that Out-GridView displays. How to Hide, Show, and Reorder Columns To hide or show a column: 1. Click on the Columns expander.</maml:para> <maml:para> 2. In the Columns expander, toggle Columns that should appear. Only selected columns appear in the grid view window. To reorder columns: - Drag and drop the column into the desired location. How to Sort Table Data - To sort the data, click a column header.</maml:para> <maml:para> - To change the sort order, click the column header again. Each time you click the same header, the sort order toggles between ascending to descending order. The current order is indicated by a triangle in the column header. How to Search in the Table (Quick Filter) Use the Filter box to search for data in the table. When you type in the box, only items that include the typed text appear in the table.</maml:para> <maml:para> - Search for text. To search for text in the table, in the Filter box, type the text to find.</maml:para> <maml:para> - Search for multiple words. To search for multiple words in the table, type the words separated by spaces. Out-GridView displays rows that include all of the words (logical AND).</maml:para> <maml:para> - Search for literal phrases. To search for phrases that include spaces or special characters, enclose the phrase in quotation marks. Out-GridView displays rows that include an exact match for the phrase. Use Column Filters to Filter the Table You can use column filters to determine which items are displayed in the table. Items appear only when they satisfy all of the column filters that you establish.</maml:para> <maml:para> Each column filter has the following format:</maml:para> <maml:para> <column> <operator> <value></maml:para> <maml:para> Column filters for different properties are connected by AND. Column filters for the same property are connected by OR. You cannot change the logical connectors.</maml:para> <maml:para> The column filters only affects the display. It does not delete items from the table. How to Add Column Filters 1. Click the Add Column Filters menu button.</maml:para> <maml:para> 2. Click the column (property) you wish to add. How to Edit a Column Filter - To change an operator, click the operator drop down, and then click to select a different operator from the drop-down list.</maml:para> <maml:para> - To enter or change a value, type a value in the value box.</maml:para> <maml:para> - To create an OR statement, add a column filter with the same property. How to Delete Column Filters - To delete selected column filters, click the remove button beside each column filter.</maml:para> <maml:para> - To delete all column filters, click the Clear Filters button.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Output processes to a grid view ----------</maml:title> <dev:code>PS C:\> Get-Process | Out-GridView</dev:code> <dev:remarks> <maml:para>This command gets the processes running on the local computer and sends them to a grid view window.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 2: Use a variable to output processes to a grid view -</maml:title> <dev:code>PS C:\> $P = Get-Process PS C:\> $P | Out-GridView</dev:code> <dev:remarks> <maml:para>This command also gets the processes running on the local computer and sends them to a grid view window.</maml:para> <maml:para>The first command uses the Get-Process cmdlet to get the processes on the computer and then saves the process objects in the $P variable.</maml:para> <maml:para>The second command uses a pipeline operator to send the $P variable to Out-GridView .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 3: Display a formatted table in a grid view -----</maml:title> <dev:code>PS C:\> Get-Process | Select-Object -Property Name, WorkingSet, PeakWorkingSet | Sort-Object -Property WorkingSet -Descending | Out-GridView</dev:code> <dev:remarks> <maml:para>This command displays a formatted table in a grid view window.</maml:para> <maml:para>It uses the Get-Process cmdlet to get the processes on the computer.</maml:para> <maml:para>Then, it uses a pipeline operator (|) to send the process objects to the Select-Object cmdlet. The command uses the Property parameter of Select-Object to select the Name, WorkingSet, and PeakWorkingSet properties to be displayed in the table.</maml:para> <maml:para>Another pipeline operator sends the filtered objects to the Sort-Object cmdlet, which sorts them in descending order by the value of the WorkingSet property.</maml:para> <maml:para>The final part of the command uses a pipeline operator (|) to send the formatted table to Out-GridView .</maml:para> <maml:para>You can now use the features of the grid view to search, sort, and filter the data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Save output to a variable, and then output a grid view</maml:title> <dev:code>PS C:\> ($A = Get-ChildItem -Path $pshome -Recurse) | Out-GridView</dev:code> <dev:remarks> <maml:para>This command saves its output in a variable and sends it to Out-GridView .</maml:para> <maml:para>The command uses the Get-ChildItem cmdlet to get the files in the Windows PowerShell installation directory and its subdirectories. The path to the installation directory is saved in the $pshome automatic variable.</maml:para> <maml:para>The command uses the assignment operator (=) to save the output in the $A variable and the pipeline operator (|) to send the output to Out-GridView .</maml:para> <maml:para>The parentheses in the command establish the order of operations. As a result, the output from the Get-ChildItem command is saved in the $A variable before it is sent to Out-GridView .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 5: Output processes for a specified computer to a grid view</maml:title> <dev:code>PS C:\> Get-Process -ComputerName "Server01" | ogv -Title "Processes - Server01"</dev:code> <dev:remarks> <maml:para>This command displays the processes that are running on the Server01 computer in a grid view window.</maml:para> <maml:para>The command uses `ogv`, which is the built-in alias for the Out-GridView cmdlet, it uses the Title parameter to specify the window title.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 6: Output data from remote computers to a grid view -</maml:title> <dev:code>PS C:\> Invoke-Command -ComputerName S1, S2, S3 -ScriptBlock {Get-Culture} | Out-GridView</dev:code> <dev:remarks> <maml:para>This example shows the correct format for sending data collected from remote computers to the Out-GridView cmdlet.</maml:para> <maml:para>The command uses the Invoke-Command cmdlet to run a Get-Culture command on three remote computers. It uses a pipeline operator to send the data that is returned to the Out-GridView cmdlet.</maml:para> <maml:para>Notice that the script block that contains the commands that are run remotely does not include the Out-GridView command. If it did, the command would fail when it tried to open a grid view window on each of the remote computers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 7: Pass multiple items through Out-GridView -----</maml:title> <dev:code>PS C:\> Get-Process | Out-GridView -PassThru | Export-Csv -Path .\ProcessLog.csv</dev:code> <dev:remarks> <maml:para>This command lets you select multiple processes from the Out-GridView window. The processes that you select are passed to the Export-Csv command and written to the ProcessLog.csv file.</maml:para> <maml:para>The command uses the PassThru parameter of Out-GridView , which lets you send multiple items down the pipeline. The PassThru parameter is equivalent to using the Multiple value of the OutputMode parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 8: Create a Windows shortcut to Out-GridView -----</maml:title> <dev:code>PS C:\> Powershell.exe -Command "Get-Service | Out-GridView -Wait"</dev:code> <dev:remarks> <maml:para>This command shows how to use the Wait parameter of Out-GridView to create a Windows shortcut to the Out-GridView window. Without the Wait parameter, Windows PowerShell would exit as soon as the Out-GridView window opened, which would close the Out-GridView window almost immediately.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-File</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-Printer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-String</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |