Set-PSReadlineOption

Sintaxe

OptionsSet

Set-PSReadlineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <String>]
    [-ContinuationPromptForegroundColor <ConsoleColor>]
    [-ContinuationPromptBackgroundColor <ConsoleColor>]
    [-EmphasisForegroundColor <ConsoleColor>]
    [-EmphasisBackgroundColor <ConsoleColor>]
    [-ErrorForegroundColor <ConsoleColor>]
    [-ErrorBackgroundColor <ConsoleColor>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <Func[string,bool]>]
    [-CommandValidationHandler <Action[CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <Int32>]
    [-MaximumKillRingCount <Int32>]
    [-ResetTokenColors]
    [-ShowToolTips]
    [-ExtraPromptLineCount <Int32>]
    [-DingTone <Int32>]
    [-DingDuration <Int32>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <Int32>]
    [-WordDelimiters <String>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <String>]
    [<CommonParameters>]

ColorSet

Set-PSReadlineOption
    [-TokenKind] <TokenClassification>
    [[-ForegroundColor] <ConsoleColor>]
    [[-BackgroundColor] <ConsoleColor>]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: Definir cores de primeiro plano e plano de fundo

Set-PSReadlineOption -TokenKind Comment -ForegroundColor Green -BackgroundColor Gray

Exemplo 2: Definir estilo de sino

Set-PSReadlineOption -BellStyle Audible -DingTone 1221 -DingDuration 60

Parâmetros

-AddToHistoryHandler

Especifica um ScriptBlock que controla quais comandos são adicionados ao histórico PSReadline .

O ScriptBlock recebe a linha de comando como entrada. Se o ScriptBlock retornar $True, a linha de comando será adicionada ao histórico.

Propriedades dos parâmetros

Conjuntos de parâmetros

-BackgroundColor

Especifica a cor do plano de fundo para o token especificado pelo parâmetro TokenKind.

Os valores aceitáveis para este parâmetro são os seguintes:

• Preto
• Azul-escuro
• Verde escuro
• DarkCyan
• Vermelho escuro
• DarkMagenta
• Amarelo escuro
• Cinzento
• Cinza escuro
• Azul
• Verde
• Ciano
• Vermelho
• Magenta
• Yellow
• Branco

Propriedades dos parâmetros

Conjuntos de parâmetros

-BellStyle

Especifica como PSReadline responde a vários erros e condições ambíguas.

Os valores válidos são os seguintes:

• audível: Um sinal sonoro curto.
• Visual: O texto pisca brevemente.
• Nenhum: Sem comentários.

Propriedades dos parâmetros

Conjuntos de parâmetros

-CommandValidationHandler

Especifica um ScriptBlock que é chamado de ValidateAndAcceptLine . Se uma exceção for lançada, a validação falhará e o erro será relatado.

Antes de lançar uma exceção, o manipulador de validação pode colocar o cursor no ponto do erro para facilitar a correção. Um manipulador de validação também pode alterar a linha de comando, como para corrigir erros tipográficos comuns.

ValidateAndAcceptLine é usado para evitar sobrecarregar seu histórico com comandos que não podem funcionar.

Propriedades dos parâmetros

Conjuntos de parâmetros

-CompletionQueryItems

Especifica o número máximo de itens de conclusão que são mostrados sem avisar.

Se o número de itens a serem exibidos for maior que esse valor, o PSReadline solicitará sim/não antes de exibir os itens de conclusão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ContinuationPrompt

Especifica a cadeia de caracteres exibida no início das linhas subsequentes quando a entrada de várias linhas é inserida. O padrão é o dobro de sinais maiores do que (>>). Uma cadeia de caracteres vazia é válida.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ContinuationPromptBackgroundColor

Especifica a cor do plano de fundo do prompt de continuação.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ContinuationPromptForegroundColor

Especifica a cor de primeiro plano do prompt de continuação.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-DingDuration

Especifica a duração do bipe quando BellStyle estiver definido como Audible.

Propriedades dos parâmetros

Conjuntos de parâmetros

-DingTone

Especifica o tom em Hertz (Hz) do bipe quando BellStyle estiver definido como Audible.

Propriedades dos parâmetros

Conjuntos de parâmetros

-EditMode

Especifica o modo de edição da linha de comando. O uso desse parâmetro redefine todas as ligações de chave definidas por Set-PSReadlineKeyHandler.

Os valores válidos são os seguintes:

• Windows: As ligações de chave emulam PowerShell, cmd e Visual Studio.
• Emacs: As ligações de teclas emulam Bash ou Emacs.
• Vi: As ligações de chave emulam Vi.

Propriedades dos parâmetros

Conjuntos de parâmetros

-EmphasisBackgroundColor

Especifica a cor de plano de fundo usada para ênfase, como para realçar o texto de pesquisa.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-EmphasisForegroundColor

Especifica a cor de primeiro plano usada para ênfase, como para realçar o texto de pesquisa.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ErrorBackgroundColor

Especifica a cor do plano de fundo usada para erros.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ErrorForegroundColor

Especifica a cor de primeiro plano usada para erros.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ExtraPromptLineCount

Especifica o número de linhas extras.

Se o prompt se estender por mais de uma linha, especifique um valor para esse parâmetro. Use esta opção quando quiser que linhas extras estejam disponíveis quando PSReadline exibir o prompt depois de mostrar alguma saída. Por exemplo, PSReadline retorna uma lista de conclusão.

Esta opção é menos necessária do que em versões anteriores do PSReadline, mas é útil quando a InvokePrompt função é usada.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ForegroundColor

Especifica a cor de primeiro plano para o token especificado pelo parâmetro TokenKind.

Os valores aceitáveis são os mesmos que o parâmetro BackgroundColor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistoryNoDuplicates

Esta opção controla o comportamento de recuperação. Comandos duplicados ainda são adicionados ao arquivo de histórico. Quando essa opção é definida, somente a invocação mais recente aparece ao chamar comandos.

Comandos repetidos são adicionados ao histórico para preservar a ordem durante a recuperação. No entanto, normalmente você não quer ver o comando várias vezes ao lembrar ou pesquisar o histórico.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySavePath

Especifica o caminho para o arquivo onde o histórico é salvo. O nome do arquivo é armazenado em uma variável $($host.Name)_history.txt, por exemplo, ConsoleHost_history.txt.

Se você não usar esse parâmetro, o caminho padrão será o seguinte:

$env:APPDATA\Microsoft\Windows\PowerShell\PSReadline\$($host.Name)_history.txt

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySaveStyle

Especifica como o PSReadline salva o histórico.

Os valores válidos são os seguintes:

• SaveIncrementally: salve o histórico depois que cada comando for executado e compartilhe em várias instâncias do PowerShell.
• SaveAtExit: Anexe o arquivo de histórico quando o PowerShell for encerrado.
• SaveNothing: Não use um arquivo de histórico.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySearchCaseSensitive

Especifica que a pesquisa de histórico diferencia maiúsculas de minúsculas em funções como ReverseSearchHistory ou HistorySearchBackward.

Propriedades dos parâmetros

Conjuntos de parâmetros

-HistorySearchCursorMovesToEnd

Indica que o cursor se move para o final dos comandos que você carrega do histórico usando uma pesquisa. Quando esse parâmetro é definido como $False, o cursor permanece na posição em que estava quando você pressionou as setas para cima ou para baixo.

Para desativar essa opção, você pode executar um dos seguintes comandos:

Set-PSReadlineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadlineOption).HistorySearchCursorMovesToEnd = $False

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumHistoryCount

Especifica o número máximo de comandos a serem salvos no histórico do PSReadline .

O histórico do PSReadline é separado do histórico do PowerShell.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumKillRingCount

Especifica o número máximo de itens armazenados no anel de eliminação.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ResetTokenColors

Indica que esse cmdlet restaura as cores do token para as configurações padrão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ShowToolTips

Ao exibir possíveis conclusão, as dicas de ferramentas são mostradas na lista de conclusão.

Esta opção está ativada por predefinição. Esta opção não estava habilitada por padrão em versões anteriores do PSReadline. Para desativar, defina esta opção como $False.

Propriedades dos parâmetros

Conjuntos de parâmetros

-TokenKind

Especifica o token quando você define opções de cor de token com os ForegroundColor e parâmetros de BackgroundColor.

Os valores aceitáveis para este parâmetro são os seguintes:

• Nenhum
• Comentário
• Palavra-chave
• Cordão
• Operador
• Variável
• Comando
• Parâmetro
• Tipo
• Número
• Membro

Propriedades dos parâmetros

Conjuntos de parâmetros

-WordDelimiters

Especifica os caracteres que delimitam palavras para funções como ForwardWord ou KillWord.

Propriedades dos parâmetros

Conjuntos de parâmetros

CommonParameters

Entradas

None

Saídas

None

Ligações Relacionadas

• about_PSReadline
• Get-PSReadlineKeyHandler
• Get-PSReadlineOption
• Remove-PSReadlineKeyHandler
• Set-PSReadlineKeyHandler