Skip to content

Latest commit

 

History

History
158 lines (107 loc) · 4.19 KB

Import-EditorCommand.md

File metadata and controls

158 lines (107 loc) · 4.19 KB
Raw
external help file online version schema
PowerShellEditorServices.Commands-help.xml
2.0.0

Import-EditorCommand

SYNOPSIS

Imports commands with the EditorCommand attribute into PowerShell Editor Services.

SYNTAX

ByModule

Import-EditorCommand [-Module] <string[]> [-Force] [-PassThru] [<CommonParameters>]

ByCommand

Import-EditorCommand [-Command] <string[]> [-Force] [-PassThru] [<CommonParameters>]

DESCRIPTION

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.

To tag a command as an editor command, attach the attribute 'Microsoft.PowerShell.EditorServices.Services.PowerShellContext.EditorCommandAttribute' to the function like you would with 'CmdletBindingAttribute'. The attribute accepts the named parameters 'Name', 'DisplayName', and 'SuppressOutput'.

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

Import-EditorCommand -Module PowerShellEditorServices.Commands

Registers all editor commands in the module PowerShellEditorServices.Commands.

-------------------------- EXAMPLE 2 --------------------------

Get-Command *Editor* | Import-EditorCommand -PassThru

Registers all editor commands that contain "Editor" in the name and return all successful imports.

-------------------------- EXAMPLE 3 --------------------------

function Invoke-MyEditorCommand {
    [CmdletBinding()]
    [Microsoft.PowerShell.EditorServices.Services.PowerShellContext.EditorCommand(DisplayName='My Command', SuppressOutput)]
    param()
    end {
        ConvertTo-ScriptExtent -Offset 0 | Set-ScriptExtent -Text 'My Command!'
    }
}

Get-Command Invoke-MyEditorCommand | Import-EditorCommand

This example declares the function Invoke-MyEditorCommand with the EditorCommand attribute and then imports it as an editor command.

PARAMETERS

-Module

Specifies the module to search for exportable editor commands.

Type: string[]
Parameter Sets: ByModule
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Command

Specifies the functions to register as editor commands. If the function does not have the EditorCommand attribute it will be ignored.

Type: string[]
Parameter Sets: ByCommand
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Force

If specified will replace existing editor commands.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

If specified will return an EditorCommand object for each imported command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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).

INPUTS

System.Management.Automation.CommandInfo

You can pass commands to register as editor commands.

OUTPUTS

Microsoft.PowerShell.EditorServices.Services.PowerShellContext.EditorCommand

If the "PassThru" parameter is specified editor commands that were successfully registered will be returned. This function does not output to the pipeline otherwise.

NOTES

RELATED LINKS

Register-EditorCommand Unregister-EditorCommand