Parâmetros do editor

A janela do editor é totalmente programável por meio do uso de um conjunto de comandos, ações e parâmetros extensivos.  Esses comandos e parâmetros podem ser utilizados para personalizar a janela do editor, para procurar ou alterar um texto de um documento e para executar muitas outras funções.

Selecione um parâmetro na lista abaixo para exibir as informações de referência para esse parâmetro.  Os parâmetros podem ser definidos e consultados, a menos que seja indicado de outra maneira.

Nome do Parâmetro Descrição

actionArgument Define ou consulta o argumento de uso geral para ações do editor.
actionClass Define uma ação do usuário para a visualização atual.
actionKey Retorna a tecla principal atribuída a uma ação especificada. Somente consulta.
actionKeyText Obtém uma cadeia de texto convertida da tecla principal atribuída à ação especificada. Somente consulta.
actionRepeat Consulta uma interpretação numérica do parâmetro actionArgument.   Esse valor é utilizado por muitas ações como uma contagem repetida. Somente consulta.
actions Lista todas as ações dos usuários definidas para a visualização atual. Somente consulta.
autoCheck Define ou consulta se o editor está concluindo implicitamente as alterações no documento quando o cursor é removido de uma linha alterada.
baseProfile Retorna o perfil base utilizado na última vez que o comando updateProfile foi emitido. Somente consulta.
beep Define ou consulta se um sinal sonoro será emitido quando o comando screenShow for emitido.
block.anythingSelected Indica se há algum texto de seleção de bloco visível. Somente consulta.
block.bottomElement Retorna o número do último elemento visível na seleção de bloco. Somente consulta.
block.bottomPosition Retorna o número da última coluna do último elemento da seleção em bloco. Somente consulta.
block.defaultType Define ou consulta o tipo de bloco padrão.
block.inView Indica se a seleção de bloco está na visualização atual. Somente consulta.
block.text Retorna o texto selecionado atualmente. Somente consulta.
block.topElement Retorna o número do primeiro elemento visível na seleção de bloco. Somente consulta.
block.topPosition Retorna o número da primeira coluna do primeiro elemento da seleção em bloco. Somente consulta.
block.type Retorna o tipo de bloco atual. Somente consulta.
changes Retorna o número de alterações concluídas, que não podem ser desfeitas, desde a última gravação. Somente consulta.
class Registra ou cancela o registro das classes de elemento na visualização atual.
classes Retorna uma lista com todas as classes de elementos registradas atualmente para a visualização atual. Somente consulta.
commandClass Define um comando do usuário para a visualização atual.
commandLine Define ou consulta a visibilidade da linha de comandos.
commands Lista todos os comandos do usuário definidos para a visualização atual. Somente consulta.
compare.columns Define ou consulta se as operações de comparação estão restritas a um intervalo de colunas.
compare.endColumn Define ou consulta a coluna final utilizada quando as operações de comparação são restritas a um intervalo de colunas.
compare.ignoreAllBlanks Determina se as diferenças no número de espaços em branco de uma linha são significativas na comparação de arquivos com o comando compare.
compare.ignoreCase Determina se as diferenças nas letras maiúsculas/minúsculas dos caracteres são significativas na comparação de arquivos com o comando compare.
compare.ignoreComments Determina se as diferenças nos comentários são significantes ao comparar arquivos com o comando compare.
compare.ignoreLeadingBlanks Determina se as diferenças no número de espaços em branco no início de uma linha são significativas na comparação de arquivos com o comando compare.
compare.ignoreSequenceNumbers Determina se as diferenças nos números de seqüência são significativas ao comparar arquivos com o comando compare.
compare.ignoreTrailingBlanks Determina se as diferenças no número de espaços em branco no fim de uma linha são significativas na comparação de arquivos com o comando compare.
compare.startColumn Define ou consulta a coluna inicial utilizada quando as operações de comparação são restritas a um intervalo de colunas.
current Retorna a definição atual de um parâmetro. Somente consulta.
currentKey Retorna a última tecla emitida. Somente consulta.
currentMousePoint Retorna as coordenadas do ponteiro no momento em que o o último evento de mouse foi gravado. Somente consulta.
cursor.blinkTime Define ou consulta o intervalo de tempo no qual o cursor pisca.
cursor.width Define ou consulta a largura em pixels do cursor no modo de inserção.
cursorRow Define ou consulta a linha física da linha que contém o cursor.
default Define ou consulta a definição padrão de um parâmetro.
defaultActions Lista todas as ações padrão implementadas no editor. Somente consulta.
defaultProfile Define ou consulta o nome do arquivo utilizado para especificar as configurações padrão do editor.
dirty Indica se há uma alteração não concluída no documento atual.
displayPosition Define ou consulta a posição da coluna de exibição do cursor no elemento atual.
documentId Retorna um número inteiro exclusivo que pode ser utilizado para identificar o documento. Somente consulta.
editorLog Define ou consulta o nome do arquivo utilizado para registrar erros críticos.
element Retorna o número ordinal do documento atual. Somente consulta.
elementClasses Define ou consulta classes do documento atual.
elements Retorna o número total de elementos no documento atual. Somente consulta.
emphasisLength Define ou consulta o número de caracteres enfatizados.
emphasisPosition Define ou consulta o local de ênfase.
excludedClasses Define ou consulta as classes de elementos que devem ser excluídas da visualização atual.
expandHide Define ou consulta a visibilidade da área de expandir/ocultar.
expandHideAreaWidth Retorna a largura em pixels da área de expandir/ocultar. Somente consulta.
expandTabs Define ou consulta o estado da expansão de caracteres de tabulação.
expanded Define ou consulta a visibilidade dos elementos ocultos entre o elemento atual e o próximo elemento visível.
fields Define ou consulta os campos de edição atuais.
findText.asis Define ou consulta a definição de distinção entre maiúsculas e minúsculas para localizar operações.
findText.block Define ou consulta se as operações de localização são restritas ao texto selecionado.
findText.columns Define ou consulta se as operações de localização estão restritas a um intervalo das colunas.
findText.emphasis Define ou consulta se o texto encontrado deve ser enfatizado.
findText.endColumn Define ou consulta a coluna final utilizada quando as operações de localização são restritas a um intervalo de coluna.
findText.findText Define ou consulta o texto a ser localizado pelo comando findText.
findText.mark Define ou consulta se o texto localizado deve ser selecionado.
findText.regularExpression Define ou consulta se o comando findText deve tratar o texto de procura como um padrão de expressão comum.
findText.replaceText Define ou consulta o texto de substituição utilizado pelas operações de localização.
findText.startColumn Define ou consulta a coluna inicial utilizada quando as operações de localização são restritas a um intervalo de colunas.
findText.wholeWord Define ou consulta se as operações de localização devem ser restritas a palavras inteiras.
findText.wrap Define ou consulta a definição de agrupamento para as operações de localização.
font Define ou consulta a fonte utilizada para exibir o texto na janela de edição.
forceAllVisible Define ou consulta a visibilidade forçada para todos os elementos de documentos.
forceVisible Define ou consulta a visibilidade forçada do elemento atual.
formatLine Define ou consulta a visibilidade da linha de formato.
formatLineText Define ou consulta o texto exibido na linha de formato.
fullText Retorna o texto completo do elemento atual. Somente consulta.
headerMark Determina se o elemento atual é um elemento de cabeçalho de uma marcação excluída. Somente consulta.
hex Define ou consulta o valor hexadecimal do caractere na posição atual do cursor.
highlightCurrentLine Define ou consulta se a linha atual está destacada.
includedClasses Define ou consulta as classes de elementos que devem ser incluídas na visualização atual.
inPrefix Define ou consulta se o cursor está localizado na área de prefixo ou de texto.
insertMode Define ou consulta o modo de inserção atual.
install Retorna a definição de instalação de um parâmetro. Somente consulta.
installProfile Define ou consulta o nome do arquivo utilizado para especificar as configurações de instalação do editor.
keyAction Define ou consulta a atribuição de ações para uma tecla especificada.
keys Lista todas as teclas que tenham ações atribuídas. Somente consulta.
length Retorna o comprimento do elemento atual. Somente consulta.
line Retorna o número da linha do elemento atual. Somente consulta.
lineNumbers.length Define ou consulta o número de colunas utilizado para exibir os números de linha na área do prefixo.
lineNumbers.pad Define ou consulta o caractere de preenchimento à esquerda utilizado ao exibir os números de linhas na área do prefixo.
lines Retorna o número total de linhas no documento atual. Somente consulta.
maintainSequenceNumbers Define ou consulta se o editor mantém os números de seqüência do documento atual.
mark Define, consulta ou remove uma marcação nomeada.
markExcluded Define ou consulta o atributo excluído de uma marcação.
markExcludedHeader Define ou consulta se uma marcação especificada deve ter um elemento de cabeçalho quando for excluída.
markHighlight Define ou consulta se uma marcação especificada deve ser destacada.
markId Retorna o número de ID de uma marcação especificada. Somente consulta.
markIncluded Define ou consulta o atributo incluído de uma marcação.
markProtect Define ou consulta o atributo protegido de uma marcação.
markStyle Define ou consulta o caractere de estilo associado a uma marcação.
messageLine Define ou consulta a visibilidade da linha de mensagem.
messageText Define ou consulta o texto exibido na linha de mensagem.
mouseAction Define ou consulta a atribuição de ação de um determinado evento do mouse.
mouseEvents Lista todos os eventos do mouse para os quais foram atribuídas ações. Somente consulta.
multipleViews Define ou consulta se as visualizações adicionais de um documento podem ser abertas nos aplicativos do editor que implementam várias visualizações de documentos.
name Define ou consulta o nome do documento atual.
palette Retorna a paleta de cores utilizada na última vez que o comando updateProfile foi emitido. Somente consulta.
parseAfterEveryKey Define ou consulta se o analisador de documentos deve ser chamado após cada ação de tecla.
parser Retorna o nome do analisador de documentos utilizado pela visualização atual. Somente consulta.
parserProperty Define ou consulta as propriedades do analisador de documentos que está sendo executado na visualização atual.
pixelPosition Retorna o deslocamento em pixels da posição atual do cursor. Somente consulta.
popup Define ou consulta o conteúdo do menu popup.
position Define ou consulta a posição da coluna do cursor no elemento atual.
prefixArea Define ou consulta a visibilidade da área de prefixo.
prefixAreaMargin Define ou consulta a margem a ser exibida entre o texto da área do prefixo e a área de edição.
prefixAreaText Define ou consulta o tipo de texto que é exibido na área de prefixo.
prefixAreaWidth Retorna a largura em pixels da área de prefixo. Somente consulta.
prefixPosition Define ou consulta a posição da coluna do cursor na área de prefixo.
prefixProtect Define ou consulta se o cursor pode ser movido para a área de prefixo.
prefixText Define ou consulta o texto do prefixo do elemento atual.
print.bottomMargin Define ou consulta a margem inferior utilizada pelo comando print.
print.font Define ou consulta a fonte utilizada pelo comando print.
print.footer Define ou consulta o texto a ser impresso como a linha de rodapé em cada página.
print.header Define ou consulta o texto a ser impresso como a linha de cabeçalho em cada página.
print.leftMargin Define ou consulta a margem esquerda utilizada pelo comando print.
print.lineNumbers Define ou consulta se o comando print imprime números de linha.
print.rightMargin Define ou consulta a margem direita utilizada pelo comando print.
print.tokenized Define ou consulta se o comando print imprime os atributos sinalizados definidos pelo analisador de documentos.
print.topMargin Define ou consulta a margem superior utilizada pelo comando print.
readonly Define ou consulta se o documento pode ser editado na visualização atual.
recording Define ou consulta se o editor está registrando as alterações no documento.
rowHeight Retorna a altura em pixels de uma linha de texto. Somente consulta.
rows Retorna o número de linhas de texto que podem ser exibidas na janela de texto. Somente consulta.
save.lineSeparator Define ou consulta o separador de linhas utilizado pelas operações de salvamento.
save.textLimit Define ou consulta o comprimento máximo da linha utilizada pelo comando save.
save.trim Define ou consulta se o comando save deve cortar espaços em branco no final de todas as linhas do documento.
scroll Define ou consulta o número de pixels no qual a visualização atual é deslocada para a direita.
scrollWhileAdjusting Define ou consulta se a janela rolará enquanto a barra de rolagem vertical estiver sendo arrastada.
sequenceDefaultText Define ou consulta a parte de texto do padrão de números de seqüência.
sequenceNumber Define ou consulta o número de seqüência do elemento atual.
sequenceNumbers Define ou consulta a coluna inicial e a largura dos números de seqüência.
sequenceNumbersFormat Define ou consulta a cadeia de formato utilizada para exibir a área de números de seqüência.
sequenceText Define ou consulta a parte de texto dos números de seqüência do elemento atual.
shiftInCharacter Define ou consulta o caractere utilizado para exibir controles Shift-in emulados.
shiftOutCharacter Define ou consulta o caractere utilizado para exibir controles Shift-out emulados.
show Determina se o elemento atual da exibição é um elemento de exibição. Somente consulta.
showSosi Define ou consulta se o editor exibe caracteres de controle Shift-out e Shift-in emulados.
sourceCcsid Define ou consulta o CCSID do arquivo em sua plataforma original.
sourceEncoding Define ou consulta a codificação de caracteres do arquivo em sua plataforma de origem.
sourceName Define ou consulta um nome de documento alternado, por exemplo, o nome do membro remoto de destaque.
splitWindow Define ou consulta como novas visualizações são abertas nos aplicativos do editor que implementam janelas de divisão.
splitWindow.orientation Define ou consulta como várias visualizações na janela devem ser exibidas nos aplicativos do editor que implementam janelas de divisão.
status Define ou consulta o status do comando.
statusLine Define ou consulta a visibilidade da linha de status.
style Define ou consulta os caracteres de estilo que são utilizados para exibir o texto do elemento atual.
styleAttributes Define ou consulta os atributos de estilo para um caractere de estilo ou para um dos estilos internos.
tabs Define ou consulta as paradas de guia utilizadas pelas ações nextTabStop e prevTabStop.
text Define ou consulta o texto do elemento atual.
textAreaWidth Retorna a largura em pixels da área de texto. Somente consulta.
textWidth Retorna a largura em pixels to texto do elemento atual. Somente consulta.
topExpanded Define ou consulta a visibilidade dos elementos ocultos entre a parte superior do documento e o primeiro elemento visível.
updateProfile.baseProfile Define ou consulta o perfil base que será utilizado pelo comando updateProfile.
updateProfile.extensions Lista todas as extensões de nomes de arquivos que são associadas ao analisador de documentos. Somente consulta.
updateProfile.noParser Define ou consulta se o comando updateProfile deve definir um analisador de documentos.
updateProfile.palette Define ou consulta a paleta de cores que será utilizada pelo comando updateProfile.
updateProfile.paletteAttributes Define ou consulta os atributos de estilo utilizados para um estilo e uma paleta especificados quando o comando updateProfile é emitido.
updateProfile.palettes Lista as paletas de cores disponíveis para o comando updateProfile. Somente consulta.
updateProfile.parser Define ou consulta o analisador de documentos utilizado pelo comando updateProfile.
updateProfile.parserAssociation Define ou consulta o analisador de documentos associado à extensão do do nome de arquivo.
updateProfile.parserClass Define ou consulta o nome da classe para um analisador de documentos.
updateProfile.parsers Lista os analisadores de documento que estão disponíveis para o comando updateProfile. Somente consulta.
updateProfile.userActions Define ou consulta as ações do usuário utilizadas pelo comando updateProfile.
updateProfile.userCommands Define ou consulta os comandos do usuário utilizados pelo comando updateProfile.
updateProfile.userKeyActions Define ou consulta as ações de teclas do usuário utilizadas pelo comando updateProfile.
updateProfile.userMouseActions Define ou consulta as ações de mouse do usuário utilizadas pelo comando updateProfile.
updateProfile.userProfile Define ou consulta o perfil do usuário utilizado pelo comando updateProfile.
userParameter Define ou consulta as configurações definidas pelo usuário.
useSourceColumns Define ou consulta se o editor utiliza as características de coluna do arquivo em sua codificação de caracteres de origem.
version Retorna a versão do editor. Somente consulta.
viewId Retorna um número inteiro que identifica a visualização de um documento. Somente consulta.
visible Determina se o elemento atual da exibição é visível. Somente consulta.

Tarefas Relacionadas
Emitindo comandos do editor

Referência relacionada
Comandos, ações e parâmetros do editor
comando query
comando set