| Module Name | Module Guid | Download Help Link | Help Version | Locale |
|---|---|---|---|---|
PowerShellEditorServices.Commands |
6064d846-0fa0-4b6d-afc1-11e5bed3c4a9 |
en-US |
Module to facilitate easy manipulation of script files and editor features.
The ConvertFrom-ScriptExtent function converts ScriptExtent objects to types used in methods found in the $psEditor API.
The ConvertTo-ScriptExtent function can be used to convert any object with position-related properties to a ScriptExtent object. You can also specify the parameters directly to manually create ScriptExtent objects.
The Find-Ast function can be used to easily find a specific AST within a script file. All ASTs following the initial starting AST will be searched, including those that are not part of the same tree.
The Get-Token function can retrieve tokens from the current editor context, or from a ScriptExtent object. You can then use the ScriptExtent functions to manipulate the text at its location.
The Import-EditorCommand function will search the specified module for functions tagged as editor commands and register them with PowerShell Editor Services. By default, if a module is specified only exported functions will be processed.
Alternatively, you can specify command info objects (like those from the Get-Command cmdlet) to be processed directly.
The Join-ScriptExtent function will combine all ScriptExtent objects piped to it into a single extent. This can be used to combine multiple ASTs, tokens, or other script elements into a single object that can then be manipulated or used for more targeted searches.
The Set-ScriptExtent function can insert or replace text at a specified position in a file open in PowerShell Editor Services.
You can use the Find-Ast function to easily find the desired extent.
The Test-ScriptExtent function can be used to determine if a ScriptExtent object is before, after, or inside another ScriptExtent object. You can also test for any combination of these with separate ScriptExtent objects to test against.