Set-PSReadlineOption

Sintaxis

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

Ejemplos

Ejemplo 1: Establecer colores de primer plano y de fondo

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

Ejemplo 2: Establecer estilo de campana

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

Parámetros

-AddToHistoryHandler

Especifica un ScriptBlock que controla los comandos que se agregan al historial de PSReadline .

El ScriptBlock recibe la línea de comandos como entrada. Si el scriptBlock de devuelve , la línea de comandos se agrega al historial.

Propiedades de parámetro

Conjuntos de parámetros

-BackgroundColor

Especifica el color de fondo del token especificado por el parámetro TokenKind.

Los valores aceptables para este parámetro son los siguientes:

• Negro
• Azul oscuro
• Verde oscuro
• Cian oscuro
• Rojo oscuro
• Magenta oscuro
• Amarillo oscuro
• Gris
• Gris oscuro
• Azul
• Verde
• Cyan
• Rojo
• Magenta
• Amarillo
• Blanco

Propiedades de parámetro

Conjuntos de parámetros

-BellStyle

Especifica cómo responde PSReadline a diversas condiciones ambiguas y de error.

Los valores válidos son los siguientes:

• audible: un corto pitido.
• Visual: el texto parpadea brevemente.
• Ninguno: no hay comentarios.

Propiedades de parámetro

Conjuntos de parámetros

-CommandValidationHandler

Especifica un scriptBlock de al que se llama desde ValidateAndAcceptLine. Si se produce una excepción, se produce un error en la validación y se notifica el error.

Antes de iniciar una excepción, el controlador de validación puede colocar el cursor en el punto del error para facilitar la corrección. Un controlador de validación también puede cambiar la línea de comandos, como para corregir errores tipográficos comunes.

validateAndAcceptLine se usa para evitar desordenar el historial con comandos que no pueden funcionar.

Propiedades de parámetro

Conjuntos de parámetros

-CompletionQueryItems

Especifica el número máximo de elementos de finalización que se muestran sin preguntar.

Si el número de elementos que se van a mostrar es mayor que este valor, PSReadline pregunta sí/no antes de mostrar los elementos de finalización.

Propiedades de parámetro

Conjuntos de parámetros

-ContinuationPrompt

Especifica la cadena mostrada al principio de las líneas posteriores cuando se introduce la entrada de varias líneas. El valor predeterminado es double greater-than signs (>>). Una cadena vacía es válida.

Propiedades de parámetro

Conjuntos de parámetros

-ContinuationPromptBackgroundColor

Especifica el color de fondo del símbolo del sistema de continuación.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-ContinuationPromptForegroundColor

Especifica el color de primer plano del símbolo del sistema de continuación.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-DingDuration

Especifica la duración del pitido cuando se establece BellStyle en audible.

Propiedades de parámetro

Conjuntos de parámetros

-DingTone

Especifica el tono en Hertz (Hz) del pitido cuando BellStyle se establece en Audible.

Propiedades de parámetro

Conjuntos de parámetros

-EditMode

Especifica el modo de edición de la línea de comandos. El uso de este parámetro restablece los enlaces de clave establecidos por Set-PSReadlineKeyHandler.

Los valores válidos son los siguientes:

• Windows: los enlaces de claves emulan PowerShell, cmd y Visual Studio.
• Emacs: los enlaces de claves emulan Bash o Emacs.
• Vi: los enlaces clave emulan Vi.

Propiedades de parámetro

Conjuntos de parámetros

-EmphasisBackgroundColor

Especifica el color de fondo que se usa para resaltar el texto de búsqueda.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-EmphasisForegroundColor

Especifica el color de primer plano que se usa para el énfasis, como para resaltar el texto de búsqueda.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-ErrorBackgroundColor

Especifica el color de fondo que se usa para los errores.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-ErrorForegroundColor

Especifica el color de primer plano que se usa para los errores.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-ExtraPromptLineCount

Especifica el número de líneas adicionales.

Si el mensaje abarca más de una línea, especifique un valor para este parámetro. Utilice esta opción cuando desee que las líneas adicionales estén disponibles cuando PSReadline muestre el mensaje después de mostrar alguna salida. Por ejemplo, PSReadline devuelve una lista de finalizaciones.

Esta opción es menos necesaria que en versiones anteriores de PSReadline, pero es útil cuando se usa la InvokePrompt función.

Propiedades de parámetro

Conjuntos de parámetros

-ForegroundColor

Especifica el color de primer plano del token especificado por el parámetro TokenKind.

Los valores aceptables son los mismos que el parámetro BackgroundColor.

Propiedades de parámetro

Conjuntos de parámetros

-HistoryNoDuplicates

Esta opción controla el comportamiento de recuperación. Los comandos duplicados se siguen agregando al archivo de historial. Cuando se establece esta opción, solo aparece la invocación más reciente al recuperar comandos.

Los comandos repetidos se agregan al historial para conservar la ordenación durante la recuperación. Sin embargo, normalmente no desea ver el comando varias veces al recuperar o buscar en el historial.

Propiedades de parámetro

Conjuntos de parámetros

-HistorySavePath

Especifica la ruta de acceso al archivo donde se guarda el historial. El nombre de archivo se almacena en una variable $($host.Name)_history.txt, por ejemplo, ConsoleHost_history.txt.

Si no usa este parámetro, la ruta de acceso predeterminada es la siguiente:

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

Propiedades de parámetro

Conjuntos de parámetros

-HistorySaveStyle

Especifica cómo PSReadline guarda el historial.

Los valores válidos son los siguientes:

• SaveIncrementally: Guardar historial después de ejecutar cada comando y compartirlo en varias instancias de PowerShell.
• SaveAtExit: anexar el archivo de historial cuando se cierra PowerShell.
• saveNothing: no use un archivo de historial.

Propiedades de parámetro

Conjuntos de parámetros

-HistorySearchCaseSensitive

Especifica que la búsqueda de historial distingue mayúsculas de minúsculas en funciones como ReverseSearchHistory o HistorySearchBackward.

Propiedades de parámetro

Conjuntos de parámetros

-HistorySearchCursorMovesToEnd

Indica que el cursor se mueve al final de los comandos que se cargan desde el historial mediante una búsqueda. Cuando este parámetro se establece en $False, el cursor permanece en la posición que estaba cuando se presionaban las flechas arriba o abajo.

Para desactivar esta opción, puede ejecutar cualquiera de los siguientes comandos:

Set-PSReadlineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadlineOption).HistorySearchCursorMovesToEnd = $False

Propiedades de parámetro

Conjuntos de parámetros

-MaximumHistoryCount

Especifica el número máximo de comandos que se van a guardar en el historial de PSReadline .

El historial de PSReadline es independiente del historial de PowerShell.

Propiedades de parámetro

Conjuntos de parámetros

-MaximumKillRingCount

Especifica el número máximo de elementos almacenados en el anillo de eliminación.

Propiedades de parámetro

Conjuntos de parámetros

-ResetTokenColors

Indica que este cmdlet restaura los colores del token a la configuración predeterminada.

Propiedades de parámetro

Conjuntos de parámetros

-ShowToolTips

Al mostrar posibles finalizaciones, la información sobre herramientas se muestra en la lista de finalizaciones.

Esta opción está habilitada de forma predeterminada. Esta opción no estaba habilitada de forma predeterminada en versiones anteriores de PSReadline. Para deshabilitar, establezca esta opción en $False.

Propiedades de parámetro

Conjuntos de parámetros

-TokenKind

Especifica el token al establecer opciones de color de token con los parámetros ForegroundColor y BackgroundColor.

Los valores aceptables para este parámetro son los siguientes:

• Ninguno
• Comentario
• Palabra clave
• Cuerda
• Operador
• Variable
• Comando
• Parámetro
• Tipo
• Número
• Miembro

Propiedades de parámetro

Conjuntos de parámetros

-WordDelimiters

Especifica los caracteres que delimitan palabras para funciones como forwardWord o KillWord.

Propiedades de parámetro

Conjuntos de parámetros

CommonParameters

Entradas

None

Salidas

None

Vínculos relacionados

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