You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
_Note:_ A module named `Microsoft.PowerShell.GraphicalTools` used to be built and published out of this repo, but per [#101](https://github.com/PowerShell/GraphicalTools/issues/101) it is deprecated and unmaintained until such time that it can be rewritten on top of [.NET MAUI](https://devblogs.microsoft.com/dotnet/introducing-net-multi-platform-app-ui/).
8
8
@@ -20,14 +20,109 @@ to view and filter objects graphically.
20
20
21
21
22
22
23
-
###Examples
23
+
## Examples
24
24
25
-
Get a process ID:
26
-
```powershell
27
-
gps | ocgv -OutputMode Single
25
+
### Example 1: Output processes to a grid view
26
+
27
+
```PowerShell
28
+
PS C:\> Get-Process | Out-ConsoleGridView
29
+
```
30
+
31
+
This command gets the processes running on the local computer and sends them to a grid view window.
32
+
33
+
### Example 2: Use a variable to output processes to a grid view
34
+
35
+
```PowerShell
36
+
PS C:\> $P = Get-Process
37
+
PS C:\> $P | Out-ConsoleGridView -OutputMode Single
28
38
```
29
39
30
-
See the [F7 History](https://github.com/gui-cs/F7History) script to show the PowerShell command history when F7 is pressed.
40
+
This command also gets the processes running on the local computer and sends them to a grid view window.
41
+
42
+
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.
43
+
44
+
The second command uses a pipeline operator to send the $P variable to **Out-ConsoleGridView**.
45
+
46
+
By specifying `-OutputMode Single` the grid view window will be restricted to a single selection, ensuring no more than a single object is returned.
47
+
48
+
### Example 3: Display a formatted table in a grid view
This command displays a formatted table in a grid view window.
55
+
56
+
It uses the Get-Process cmdlet to get the processes on the computer.
57
+
58
+
Then, it uses a pipeline operator (|) to send the process objects to the Select-Object cmdlet.
59
+
The command uses the **Property** parameter of **Select-Object** to select the Name, WorkingSet, and PeakWorkingSet properties to be displayed in the table.
60
+
61
+
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.
62
+
63
+
The final part of the command uses a pipeline operator (|) to send the formatted table to **Out-ConsoleGridView**.
64
+
65
+
You can now use the features of the grid view to search, sort, and filter the data.
66
+
67
+
### Example 4: Save output to a variable, and then output a grid view
This command saves its output in a variable and sends it to **Out-ConsoleGridView**.
74
+
75
+
The command uses the Get-ChildItem cmdlet to get the files in the Windows PowerShell installation directory and its subdirectories.
76
+
The path to the installation directory is saved in the $pshome automatic variable.
77
+
78
+
The command uses the assignment operator (=) to save the output in the $A variable and the pipeline operator (|) to send the output to **Out-ConsoleGridView**.
79
+
80
+
The parentheses in the command establish the order of operations.
81
+
As a result, the output from the Get-ChildItem command is saved in the $A variable before it is sent to **Out-ConsoleGridView**.
82
+
83
+
### Example 5: Output processes for a specified computer to a grid view
This command displays the processes that are running on the Server01 computer in a grid view window.
90
+
91
+
The command uses `ocgv`, which is the built-in alias for the **Out-ConsoleGridView** cmdlet, it uses the *Title* parameter to specify the window title.
92
+
93
+
### Example 6: Define a function to kill processes using a graphical chooser
94
+
95
+
```PowerShell
96
+
PS C:\> function killp { Get-Process | Out-ConsoleGridView -OutputMode Single -Filter $args[0] | Stop-Process -Id {$_.Id} }
97
+
PS C:\> killp note
98
+
```
99
+
This example shows defining a function named `killp` that shows a grid view of all running processes and allows the user to select one to kill it.
100
+
101
+
The example uses the `-Filter` paramter to filter for all proceses with a name that includes `note` (thus highlighting `Notepad` if it were running. Selecting an item in the grid view and pressing `ENTER` will kill that process.
102
+
103
+
### Example 7: Pass multiple items through Out-ConsoleGridView
- ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView
105
200
- OutGridView.Models - Contains data contracts between the GUI & Cmdlet
106
201
107
-
_Note:_ Previously, GraphicalTools also included the Avalonia-based `Out-GridView`which was implemented in `.\Microsoft.PowerShell.GraphicalTools` and `.\OutGridView.Gui`. These components have been deprecated (see note above).
202
+
_Note:_ Previously, this repo included `Microsoft.PowerShell.GraphicalTools` which included the Avalonia-based `Out-GridView`(implemented in `.\Microsoft.PowerShell.GraphicalTools` and `.\OutGridView.Gui`). These components have been deprecated (see note above).
@@ -27,7 +27,7 @@ The **Out-ConsoleGridView** cmdlet sends the output from a command to a grid vie
27
27
28
28
You can use the following features of the table to examine your data:
29
29
30
-
- 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. You can use the `-Filter` command to pre-populate the Filter box.
30
+
- 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. You can use the `-Filter` command to pre-populate the Filter box. The filter uses regular expressions.
31
31
32
32
For instructions for using these features, type `Get-Help Out-ConsoleGridView -Full` and see How to Use the Grid View Window Features in the Notes section.
Specifies the items that the interactive window sends down the pipeline as input to other commands.
178
-
By default, this cmdlet does not generate any output.
178
+
By default, this cmdlet generates zero, one, or many items.
179
179
180
180
To send items from the interactive window down the pipeline, click to select the items (either the the mouse in terminals that support mouse or the `SPACE` key) and then press `ENTER`. `ESC` cancels.
181
181
@@ -215,6 +215,21 @@ Accept pipeline input: False
215
215
Accept wildcard characters: False
216
216
```
217
217
218
+
### -MinUi
219
+
If specified no window frame, filter box, or status bar will be displayed in the **Out-ConsoleGridView** window.
220
+
221
+
```yaml
222
+
Type: SwitchParameter
223
+
Parameter Sets: (All)
224
+
Aliases:
225
+
226
+
Required: False
227
+
Position: Named
228
+
Default value: None
229
+
Accept pipeline input: False
230
+
Accept wildcard characters: False
231
+
```
232
+
218
233
### CommonParameters
219
234
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
220
235
@@ -238,8 +253,6 @@ By default `Out-ConsoleGridView` returns objects representing the selected rows
/// Gets/sets the title of the Out-GridView window.
37
37
/// </summary>
38
-
[Parameter]
38
+
[Parameter(HelpMessage="Specifies the text that appears in the title bar of the Out-ConsoleGridView window. y default, the title bar displays the command that invokes Out-ConsoleGridView.")]
39
39
[ValidateNotNullOrEmpty]
40
40
publicstringTitle{get;set;}
41
41
42
42
/// <summary>
43
43
/// Get or sets a value indicating whether the selected items should be written to the pipeline
44
44
/// and if it should be possible to select multiple or single list items.
45
45
/// </summary>
46
-
[Parameter()]
46
+
[Parameter(HelpMessage="Determines whether a single item (Single), multiple items (Multiple; default), or no items (None) will be written to the pipeline. Also determines selection behavior in the GUI.")]
/// gets or sets the initial value for the filter in the GUI
51
51
/// </summary>
52
-
[Parameter()]
52
+
[Parameter(HelpMessage="Pre-populates the Filter edit box, allowing filtering to be specified on the command line. The filter uses regular expressions.")]
53
53
publicstringFilter{set;get;}
54
54
55
55
/// <summary>
56
56
/// gets or sets the whether "minimum UI" mode will be enabled
57
57
/// </summary>
58
-
[Parameter()]
58
+
[Parameter(HelpMessage="If specified no window frame, filter box, or status bar will be displayed in the GUI.")]
0 commit comments