O objeto ISEEditor
Um objeto ISEEditor é uma instância da classe Microsoft.PowerShell.Host.ISE.ISEEditor. O painel Console é um objeto ISEEditor. Cada objeto ISEFile tem um objeto ISEEditor associado. As seções a seguir listam os métodos e as propriedades de um objeto ISEEditor.
Métodos
Clear()
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Limpa o texto no editor.
# Clears the text in the Console pane.
$psISE.CurrentPowerShellTab.ConsolePane.Clear()
EnsureVisible(int lineNumber)
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Rola o editor para que a linha que corresponde ao valor do parâmetro lineNumber especificado fique visível. Ele gerará uma exceção se o número de linha especificado estiver fora do intervalo de 1, último número de linha, que define os números de linha válidos.
lineNumber O número da linha que deve ficar visível.
# Scrolls the text in the Script pane so that the fifth line is in view.
$psISE.CurrentFile.Editor.EnsureVisible(5)
Focus()
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Define o foco para o editor.
# Sets focus to the Console pane.
$psISE.CurrentPowerShellTab.ConsolePane.Focus()
GetLineLength(int lineNumber )
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Obtém o comprimento da linha como um inteiro para a linha especificada pelo número de linha.
lineNumber O número da linha da qual obter o comprimento.
Retorna O comprimento da linha no número de linha especificado.
# Gets the length of the first line in the text of the Command pane.
$psISE.CurrentPowerShellTab.ConsolePane.GetLineLength(1)
GoToMatch()
Com suporte no ISE 3.0 do Windows PowerShell e posterior e não presente em versões anteriores.
Move o cursor para o caractere correspondente se a propriedade CanGoToMatch do objeto editor for $true, que ocorre quando o cursor é imediatamente antes de um parêntese de abertura, colchete ou chave - (,[,{ - ou imediatamente após um parêntese de fechamento, colchete ou chave - ),],}. O cursor é colocado antes de um caractere de abertura ou após um caractere de fechamento. Se a propriedade CanGoToMatch for $false, esse método não fará nada.
# Goes to the matching character if CanGoToMatch() is $true
$psISE.CurrentPowerShellTab.ConsolePane.GoToMatch()
InsertText( texto )
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Substitui a seleção por texto ou insere texto na posição de cursor atual.
texto – Cadeia de caracteres O texto a ser inserido.
Consulte o exemplo de script mais adiante neste tópico.
Select( startLine, startColumn, endLine, endColumn )
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Seleciona o texto nos parâmetros startLine, startColumn, endLinee endColumn.
startLine – Inteiro A linha em que a seleção começa.
startColumn – Inteiro A coluna dentro da linha inicial em que a seleção é iniciada.
endLine – Inteiro A linha em que a seleção termina.
endColumn – Inteiro A coluna dentro da linha final em que a seleção termina.
Consulte o exemplo de script mais adiante neste tópico.
SelectCaretLine()
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Seleciona toda a linha de texto que atualmente contém o cursor.
# First, set the caret position on line 5.
$psISE.CurrentFile.Editor.SetCaretPosition(5,1)
# Now select that entire line of text
$psISE.CurrentFile.Editor.SelectCaretLine()
SetCaretPosition( lineNumber, columnNumber )
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
Define a posição do cursor no número da linha e no número da coluna. Ele gerará uma exceção se o número da linha de cuidado ou o número da coluna careta estiverem fora de seus respectivos intervalos válidos.
lineNumber – Inteiro O número da linha de cuidado.
columnNumber – Inteiro O número da coluna de cursor.
# Set the CaretPosition.
$psISE.CurrentFile.Editor.SetCaretPosition(5,1)
ToggleOutliningExpansion()
Com suporte no ISE 3.0 do Windows PowerShell e posterior e não presente em versões anteriores.
Faz com que todas as seções de estrutura de tópicos se expandam ou entrem em colapso.
# Toggle the outlining expansion
$psISE.CurrentFile.Editor.ToggleOutliningExpansion()
Propriedades
CanGoToMatch
Com suporte no ISE 3.0 do Windows PowerShell e posterior e não presente em versões anteriores.
A propriedade Boolean somente leitura para indicar se o cursor está ao lado de um parêntese, colchete ou chave - (), [], {}. Se o cursor estiver imediatamente antes do caractere de abertura ou imediatamente após o caractere de fechamento de um par, esse valor de propriedade será $true. Caso contrário, será $false.
# Test to see if the caret is next to a parenthesis, bracket, or brace
$psISE.CurrentFile.Editor.CanGoToMatch
CaretColumn
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade somente leitura que obtém o número da coluna que corresponde à posição do cursor.
# Get the CaretColumn.
$psISE.CurrentFile.Editor.CaretColumn
CaretLine
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade somente leitura que obtém o número da linha que contém o cursor.
# Get the CaretLine.
$psISE.CurrentFile.Editor.CaretLine
CaretLineText
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade somente leitura que obtém a linha completa de texto que contém o cursor.
# Get all of the text on the line that contains the caret.
$psISE.CurrentFile.Editor.CaretLineText
LineCount
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade somente leitura que obtém a contagem de linhas do editor.
# Get the LineCount.
$psISE.CurrentFile.Editor.LineCount
SelectedText
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade somente leitura que obtém o texto selecionado do editor.
Consulte o exemplo de script mais adiante neste tópico.
Texto
Com suporte no ISE 2.0 do Windows PowerShell e posterior.
A propriedade de leitura/gravação que obtém ou define o texto no editor.
Consulte o exemplo de script mais adiante neste tópico.
Exemplo de script
# This illustrates how you can use the length of a line to
# select the entire line and shows how you can make it lowercase.
# You must run this in the Console pane. It will not run in the Script pane.
# Begin by getting a variable that points to the editor.
$myEditor = $psISE.CurrentFile.Editor
# Clear the text in the current file editor.
$myEditor.Clear()
# Make sure the file has five lines of text.
$myEditor.InsertText("LINE1 `n")
$myEditor.InsertText("LINE2 `n")
$myEditor.InsertText("LINE3 `n")
$myEditor.InsertText("LINE4 `n")
$myEditor.InsertText("LINE5 `n")
# Use the GetLineLength method to get the length of the third line.
$endColumn = $myEditor.GetLineLength(3)
# Select the text in the first three lines.
$myEditor.Select(1, 1, 3, $endColumn + 1)
$selection = $myEditor.SelectedText
# Clear all the text in the editor.
$myEditor.Clear()
# Add the selected text back, but in lower case.
$myEditor.InsertText($selection.ToLower())
