Word.Selection class

Pacote:: word

Representa um intervalo selecionado ou o ponto de inserção num documento Word.

Extends: OfficeExtension.ClientObject

Comentários

Nota: os objetos de intervalo partilham muitos dos mesmos métodos e propriedades que Selection os objetos. A utilização Range de objetos é preferível para manipular um documento quando não existe um motivo para alterar fisicamente a seleção atual.

Propriedades

borders	Devolve um `BorderUniversalCollection` objeto que representa todos os limites dos objetos na seleção.
characters	Devolve um `RangeScopedCollection` objeto que representa cada caráter na seleção.
comments	Devolve um `CommentCollection` objeto que representa todos os comentários na seleção.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
end	Especifica a posição do caráter final da seleção.
fields	Devolve um `FieldCollection` objeto que representa todos os campos na seleção.
fitTextWidth	Especifica a largura na qual Word se ajusta ao texto na seleção atual.
font	Devolve o `Font` objeto que representa a formatação de carateres da seleção.
formattedText	Especifica um `Range` objeto que inclui o texto formatado no intervalo ou seleção.
hasNoProofing	Devolve se o verificador ortográfico e gramatical ignora o texto selecionado. Se o texto selecionado contiver uma combinação de conteúdo comprovativo e não comprovativo, esta API devolve `null`.
isActive	Devolve se a seleção na janela ou painel especificado está ativa.
isColumnSelectModeActive	Especifica se o modo de seleção de colunas está ativo.
isEndOfRowMark	Devolve se a seleção está na marca de fim da linha numa tabela.
isExtendModeActive	Especifica se o Modo de expansão está ativo.
isInsertionPointAtEndOfLine	Devolve se o ponto de inserção está no fim de uma linha.
isStartActive	Especifica se o início da seleção está ativo.
languageDetected	Especifica se Word detetou o idioma do texto selecionado.
languageId	Devolve o idioma da seleção.
languageIdFarEast	Devolve o idioma do Leste Asiático para a seleção.
languageIdOther	Devolve o idioma da seleção que não é classificado como um idioma do Leste Asiático.
orientation	Especifica a orientação do texto na seleção.
paragraphs	Devolve um `ParagraphCollection` objeto que representa todos os parágrafos na seleção.
range	Devolve o `Range` objeto para a parte do documento contida na seleção.
sections	Devolve o `SectionCollection` objeto na seleção.
sentences	Devolve o `RangeScopedCollection` objeto para cada frase na seleção.
shading	Devolve o `ShadingUniversal` objeto para a formatação de sombreado da seleção.
start	Especifica a posição do caráter inicial da seleção.
storyLength	Devolve o número de carateres na história que contém a seleção.
storyType	Devolve o tipo de história para a seleção.
tables	Devolve o `TableCollection` objeto na seleção.
text	Especifica o texto na seleção.
topLevelTables	Devolve as tabelas no nível de aninhamento mais exterior na seleção atual.
type	Retorna o tipo de seleção.
words	Devolve o `RangeScopedCollection` objeto que representa cada palavra na seleção.

Métodos

calculate()	Calcula a primeira expressão matemática na seleção.
cancelMode()	Cancela um modo como expandir ou selecionar coluna. Isto é equivalente a premir a tecla Esc.
clearCharacterStyleFormatting()	Remove a formatação de carateres aplicada através de estilos de carateres.
clearFormatting()	Remove a formatação de carateres e parágrafos da seleção.
clearManualCharacterFormatting()	Remove a formatação de carateres aplicada manualmente do texto selecionado.
clearManualParagraphFormatting()	Remove a formatação de parágrafo aplicada manualmente do texto selecionado.
clearParagraphFormatting()	Remove toda a formatação de parágrafo do texto selecionado.
clearParagraphStyle()	Remove a formatação de parágrafo aplicada através de estilos de parágrafo.
collapse(direction)	Fecha a seleção para a posição inicial ou final.
collapse(direction)	Fecha a seleção para a posição inicial ou final.
convertToTable(options)	Converte o texto dentro de um intervalo em uma tabela.
copyAsPictureToClipboard()	Copia a seleção para a Área de Transferência como uma imagem.
copyFormat()	Copia a formatação de caractere do primeiro caractere do texto selecionado.
copyToClipboard()	Copia a seleção para a Área de Transferência.
createTextBox()	Adiciona uma caixa de texto de tamanho predefinido à volta da seleção.
cut()	Remove o conteúdo selecionado do documento e move-o para a Área de Transferência.
delete(options)	Sintaxe 3: Exclui o número especificado de caracteres ou palavras.
detectLanguage()	Analisa o texto selecionado para determinar o idioma em que está escrito.
expand(unit)	Expande a seleção.
expand(unit)	Expande a seleção.
expandToWholeStory()	Expande a seleção para incluir toda a história.
extend(character)	Ativa o modo de extensão, ou se este modo já estiver ativado, estende a seleção para próxima maior unidade do texto.
extend(character)	Ativa o modo de extensão, ou se este modo já estiver ativado, estende a seleção para próxima maior unidade do texto.
getNextRange(options)	Devolve um `Range` objeto que representa a unidade seguinte relativamente à seleção.
getPreviousRange(options)	Devolve um `Range` objeto que representa a unidade anterior relativamente à seleção.
goTo(options)	Devolve um `Range` objeto que representa a área especificada pelo `options` e move o ponto de inserção para a posição do caráter imediatamente antes do item especificado.
goToNext(what)	Devolve um `Range` objeto que se refere à posição inicial do item seguinte ou localização especificada pelo `what` argumento e move a seleção para o item especificado.
goToNext(what)	Devolve um `Range` objeto que se refere à posição inicial do item seguinte ou localização especificada pelo `what` argumento e move a seleção para o item especificado.
goToPrevious(what)	Devolve um `Range` objeto que se refere à posição inicial do item anterior ou localização especificada pelo `what` argumento e move a seleção para o item especificado.
goToPrevious(what)	Devolve um `Range` objeto que se refere à posição inicial do item anterior ou localização especificada pelo `what` argumento e move a seleção para o item especificado.
insertAfter(text)	Insere o texto especificado no final do intervalo ou seleção.
insertBefore(text)	Insere o texto especificado antes da seleção.
insertCells(shiftCells)	Adiciona células a uma tabela existente.
insertCells(shiftCells)	Adiciona células a uma tabela existente.
insertColumnsLeft()	Insere colunas à esquerda da coluna que contém a seleção.
insertColumnsRight()	Insere colunas à direita da seleção atual.
insertDateTime(options)	Insere a data ou hora atuais, ou ambas, como texto ou como um campo HORA.
insertFormula(options)	Insere um campo Fórmula na seleção.
insertNewPage()	Insere uma nova página na posição do ponto de inserção.
insertParagraphAfter()	Insere uma marca de parágrafo após a seleção.
insertParagraphBefore()	Insere um novo parágrafo antes da seleção ou intervalo.
insertParagraphStyleSeparator()	Insere uma marca de parágrafo oculta especial que permite aos Word associar parágrafos formatados com estilos de parágrafo diferentes.
insertRowsAbove(numRows)	Insere linhas acima da seleção atual.
insertRowsBelow(numRows)	Insere linhas abaixo da seleção atual.
insertSymbol(characterNumber, options)	Insere um símbolo no lugar da seleção especificada.
insertText(Text)	Insere o texto especificado.
insertXml(xml, transform)	Insere o XML especificado no documento no cursor, substituindo qualquer texto selecionado.
isEqual(range)	Devolve se a seleção é igual ao intervalo especificado.
isInRange(range)	Devolve `true` se a seleção estiver contida no intervalo especificado.
isInStory(range)	Devolve se a seleção está no mesmo bloco que o intervalo especificado.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
move(options)	Fecha a seleção para a respetiva posição de início ou de fim e, em seguida, move o objeto fechado pelo número especificado de unidades.
moveDown(options)	Move a seleção para baixo.
moveEnd(options)	Move a posição do caráter final do intervalo ou seleção.
moveEndUntil(characters, count)	Move a posição final da seleção até que qualquer um dos carateres especificados seja encontrado no documento.
moveEndWhile(characters, count)	Move a posição do caráter final da seleção enquanto qualquer um dos carateres especificados é encontrado no documento.
moveLeft(options)	Move a seleção para a esquerda.
moveRight(options)	Move a seleção para a direita.
moveStart(options)	Move a posição inicial da seleção.
moveStartUntil(characters, count)	Move a posição inicial da seleção até que um dos carateres especificados seja encontrado no documento.
moveStartWhile(characters, count)	Move a posição inicial da seleção enquanto qualquer um dos carateres especificados é encontrado no documento.
moveUntil(characters, count)	Move a seleção até que um dos carateres especificados seja encontrado no documento.
moveUp(options)	Move a seleção para cima.
moveWhile(characters, count)	Move a seleção enquanto qualquer um dos carateres especificados é encontrado no documento.
nextField()	Seleciona o próximo campo.
nextSubdocument()	Move a seleção para o próximo subdocumento.
pasteAndFormat(type)	Cola o conteúdo da área de transferência e formatará-os conforme especificado.
pasteAndFormat(type)	Cola o conteúdo da área de transferência e formatará-os conforme especificado.
pasteExcelTable(linkedToExcel, wordFormatting, rtf)	Cola e formata uma tabela do Microsoft Excel.
pasteFormat()	Aplica a formatação copiada com o `copyFormat` método para a seleção.
pasteTableCellsAppendTable()	Mescla as células coladas em uma tabela existente inserindo as linhas coladas entre as linhas selecionadas.
pasteTableCellsAsNestedTable()	Cola uma célula ou um grupo de células como uma tabela aninhada dentro da seleção.
previousField()	Seleciona e retorna o campo anterior.
previousSubdocument()	Move a seleção para o subdocumento anterior.
replaceParagraph()	Substitui a seleção por um novo parágrafo.
select()	Seleciona o texto atual.
selectCell()	Seleciona toda a célula que contém a seleção atual quando a seleção está numa tabela.
selectColumn()	Seleciona a coluna que contém o ponto de inserção ou seleciona todas as colunas que contêm a seleção quando a seleção está numa tabela.
selectCurrentAlignment()	Estende a seleção para frente até que seja encontrado um texto com um alinhamento de parágrafo diferente.
selectCurrentColor()	Estende a seleção para frente até encontrar texto com uma cor diferente.
selectCurrentFont()	Estende a seleção para frente até encontrar texto com uma fonte ou tamanho de fonte diferente.
selectCurrentIndent()	Estende a seleção para frente até encontrar texto com recuos de parágrafo esquerdo ou direito diferentes.
selectCurrentSpacing()	Estende a seleção para frente até que um parágrafo com um espaçamento entre linhas diferente seja encontrado.
selectCurrentTabs()	Estende a seleção para frente até encontrar um parágrafo com tabulações diferentes.
selectRow()	Seleciona a linha que contém o ponto de inserção ou seleciona todas as linhas que contêm a seleção quando a seleção está numa tabela.
setRange(start, end)	Define as posições de caractere inicial e final da seleção. Os valores de posição do caráter começam no início da história, com o primeiro valor a ser 0. Todos os caracteres são contados, incluindo os não imprimíveis. Os caracteres ocultos são contados mesmo quando não são exibidos.
shrink()	Diminui a seleção para a menor unidade de texto seguinte. A progressão da unidade para esse método é a seguinte: documento inteiro, seção, parágrafo, frase, palavra, ponto de inserção.
shrinkDiscontiguousSelection()	Cancela a seleção de todos, exceto o texto selecionado mais recentemente, quando a seleção atual contém múltiplas seleções não ligadas.
splitTable()	Insere um parágrafo vazio acima da primeira linha na seleção. Se a seleção não estiver na primeira linha da tabela, a tabela será dividida em duas tabelas. Se a seleção não estiver em uma tabela, ocorrerá um erro.
toggleCharacterCode()	Alterna a seleção entre um caráter Unicode e o respetivo valor hexadecimal correspondente.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Word.Selection` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Word.Interfaces.SelectionData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
typeBackspace()	Elimina o caráter anterior à seleção (se fechado) ou o ponto de inserção.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar `context.sync()` antes de a libertação da memória ser aplicada.

Detalhes da propriedade

borders

Devolve um BorderUniversalCollection objeto que representa todos os limites dos objetos na seleção.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Word.BorderUniversalCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

characters

Devolve um RangeScopedCollection objeto que representa cada caráter na seleção.

readonly characters: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

comments

Devolve um CommentCollection objeto que representa todos os comentários na seleção.

readonly comments: Word.CommentCollection;

Valor da propriedade

Word.CommentCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

end

Especifica a posição do caráter final da seleção.

end: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

fields

Devolve um FieldCollection objeto que representa todos os campos na seleção.

readonly fields: Word.FieldCollection;

Valor da propriedade

Word.FieldCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

fitTextWidth

Especifica a largura na qual Word se ajusta ao texto na seleção atual.

fitTextWidth: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

font

Devolve o Font objeto que representa a formatação de carateres da seleção.

readonly font: Word.Font;

Valor da propriedade

Word.Font

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

formattedText

Especifica um Range objeto que inclui o texto formatado no intervalo ou seleção.

formattedText: Word.Range;

Valor da propriedade

Word.Range

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

hasNoProofing

Devolve se o verificador ortográfico e gramatical ignora o texto selecionado. Se o texto selecionado contiver uma combinação de conteúdo comprovativo e não comprovativo, esta API devolve null.

readonly hasNoProofing: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isActive

Devolve se a seleção na janela ou painel especificado está ativa.

readonly isActive: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isColumnSelectModeActive

Especifica se o modo de seleção de colunas está ativo.

isColumnSelectModeActive: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isEndOfRowMark

Devolve se a seleção está na marca de fim da linha numa tabela.

readonly isEndOfRowMark: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isExtendModeActive

Especifica se o Modo de expansão está ativo.

isExtendModeActive: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isInsertionPointAtEndOfLine

Devolve se o ponto de inserção está no fim de uma linha.

readonly isInsertionPointAtEndOfLine: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isStartActive

Especifica se o início da seleção está ativo.

isStartActive: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

languageDetected

Especifica se Word detetou o idioma do texto selecionado.

languageDetected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

languageId

Devolve o idioma da seleção.

readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

languageIdFarEast

Devolve o idioma do Leste Asiático para a seleção.

readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

languageIdOther

Devolve o idioma da seleção que não é classificado como um idioma do Leste Asiático.

readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

orientation

Especifica a orientação do texto na seleção.

orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

paragraphs

Devolve um ParagraphCollection objeto que representa todos os parágrafos na seleção.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

range

Devolve o Range objeto para a parte do documento contida na seleção.

readonly range: Word.Range;

Valor da propriedade

Word.Range

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

sections

Devolve o SectionCollection objeto na seleção.

readonly sections: Word.SectionCollection;

Valor da propriedade

Word.SectionCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

sentences

Devolve o RangeScopedCollection objeto para cada frase na seleção.

readonly sentences: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

shading

Devolve o ShadingUniversal objeto para a formatação de sombreado da seleção.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Word.ShadingUniversal

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

start

Especifica a posição do caráter inicial da seleção.

start: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

storyLength

Devolve o número de carateres na história que contém a seleção.

readonly storyLength: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

storyType

Devolve o tipo de história para a seleção.

readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

tables

Devolve o TableCollection objeto na seleção.

readonly tables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

text

Especifica o texto na seleção.

text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

topLevelTables

Devolve as tabelas no nível de aninhamento mais exterior na seleção atual.

readonly topLevelTables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

type

Retorna o tipo de seleção.

readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

words

Devolve o RangeScopedCollection objeto que representa cada palavra na seleção.

readonly words: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Detalhes do método

calculate()

Calcula a primeira expressão matemática na seleção.

calculate(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

O resultado do cálculo.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

cancelMode()

Cancela um modo como expandir ou selecionar coluna. Isto é equivalente a premir a tecla Esc.

cancelMode(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearCharacterStyleFormatting()

Remove a formatação de carateres aplicada através de estilos de carateres.

clearCharacterStyleFormatting(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearFormatting()

Remove a formatação de carateres e parágrafos da seleção.

clearFormatting(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearManualCharacterFormatting()

Remove a formatação de carateres aplicada manualmente do texto selecionado.

clearManualCharacterFormatting(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearManualParagraphFormatting()

Remove a formatação de parágrafo aplicada manualmente do texto selecionado.

clearManualParagraphFormatting(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearParagraphFormatting()

Remove toda a formatação de parágrafo do texto selecionado.

clearParagraphFormatting(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

clearParagraphStyle()

Remove a formatação de parágrafo aplicada através de estilos de parágrafo.

clearParagraphStyle(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

collapse(direction)

Fecha a seleção para a posição inicial ou final.

collapse(direction?: Word.CollapseDirection): void;

Parâmetros

direction: Word.CollapseDirection

Opcional. Direção a fechar.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

collapse(direction)

Fecha a seleção para a posição inicial ou final.

collapse(direction?: "Start" | "End"): void;

Parâmetros

direction: "Start" | "End"

Opcional. Direção a fechar.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

convertToTable(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Converte o texto dentro de um intervalo em uma tabela.

convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table;

Parâmetros

options: Word.SelectionConvertToTableOptions

Opcional. Opções para converter texto numa tabela.

Retornos

Word.Table

Um Table objeto que representa a tabela recentemente criada.

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

copyAsPictureToClipboard()

Copia a seleção para a Área de Transferência como uma imagem.

copyAsPictureToClipboard(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

copyFormat()

Copia a formatação de caractere do primeiro caractere do texto selecionado.

copyFormat(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

copyToClipboard()

Copia a seleção para a Área de Transferência.

copyToClipboard(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

createTextBox()

Adiciona uma caixa de texto de tamanho predefinido à volta da seleção.

createTextBox(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

cut()

Remove o conteúdo selecionado do documento e move-o para a Área de Transferência.

cut(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

delete(options)

Sintaxe 3: Exclui o número especificado de caracteres ou palavras.

delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionDeleteOptions

Opcional. Opções para eliminar texto.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres eliminados.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

detectLanguage()

Analisa o texto selecionado para determinar o idioma em que está escrito.

detectLanguage(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

expand(unit)

Expande a seleção.

expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult<number>;

Parâmetros

unit: Word.OperationUnit

Opcional. A unidade a expandir.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres adicionados ao intervalo ou à seleção.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

expand(unit)

Expande a seleção.

expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult<number>;

Parâmetros

unit: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"

Opcional. A unidade a expandir.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres adicionados ao intervalo ou à seleção.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

expandToWholeStory()

Expande a seleção para incluir toda a história.

expandToWholeStory(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

extend(character)

Ativa o modo de extensão, ou se este modo já estiver ativado, estende a seleção para próxima maior unidade do texto.

extend(character?: Word.OperationUnit): void;

Parâmetros

character: Word.OperationUnit

Opcional. O caractere através do qual a seleção será estendida. Este argumento é sensível às maiúsculas e minúsculas e tem de ser avaliado como uma cadeia ou ocorre um erro. Além disso, se o valor desse argumento for maior que um único caractere, o Microsoft Word ignora o comando inteiramente.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

extend(character)

Ativa o modo de extensão, ou se este modo já estiver ativado, estende a seleção para próxima maior unidade do texto.

extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void;

Parâmetros

character: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

getNextRange(options)

Devolve um Range objeto que representa a unidade seguinte relativamente à seleção.

getNextRange(options?: Word.SelectionNextOptions): Word.Range;

Parâmetros

options: Word.SelectionNextOptions

Opcional. Opções para a next operação.

Retornos

Word.Range

Um Range objeto que representa a unidade seguinte relativamente à seleção.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

getPreviousRange(options)

Devolve um Range objeto que representa a unidade anterior relativamente à seleção.

getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range;

Parâmetros

options: Word.SelectionPreviousOptions

Opcional. Opções para a previous operação.

Retornos

Word.Range

Um Range objeto que representa a unidade anterior relativa à seleção.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

goTo(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve um Range objeto que representa a área especificada pelo options e move o ponto de inserção para a posição do caráter imediatamente antes do item especificado.

goTo(options?: Word.GoToOptions): Word.Range;

Parâmetros

options: Word.GoToOptions

Opcional. Opções para a goTo operação.

Retornos

Word.Range

Um Range objeto que está agora selecionado.

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

goToNext(what)

Devolve um Range objeto que se refere à posição inicial do item seguinte ou localização especificada pelo what argumento e move a seleção para o item especificado.

goToNext(what: Word.GoToItem): Word.Range;

Parâmetros

what: Word.GoToItem

O tipo de item a utilizar.

Retornos

Word.Range

Um Range objeto que se refere à posição inicial do item seguinte ou localização especificada pelo what argumento .

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

goToNext(what)

Devolve um Range objeto que se refere à posição inicial do item seguinte ou localização especificada pelo what argumento e move a seleção para o item especificado.

goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range;

Parâmetros

what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"

O tipo de item a utilizar.

Retornos

Word.Range

Um Range objeto que se refere à posição inicial do item seguinte ou localização especificada pelo what argumento .

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

goToPrevious(what)

Devolve um Range objeto que se refere à posição inicial do item anterior ou localização especificada pelo what argumento e move a seleção para o item especificado.

goToPrevious(what: Word.GoToItem): Word.Range;

Parâmetros

what: Word.GoToItem

O tipo de item a utilizar.

Retornos

Word.Range

Um Range objeto que se refere à posição inicial do item anterior ou localização especificada pelo what argumento .

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

goToPrevious(what)

Devolve um Range objeto que se refere à posição inicial do item anterior ou localização especificada pelo what argumento e move a seleção para o item especificado.

goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range;

Parâmetros

what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"

O tipo de item a utilizar.

Retornos

Word.Range

Um Range objeto que se refere à posição inicial do item anterior ou localização especificada pelo what argumento .

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertAfter(text)

Insere o texto especificado no final do intervalo ou seleção.

insertAfter(text: string): void;

Parâmetros

text: string

Texto a inserir.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertBefore(text)

Insere o texto especificado antes da seleção.

insertBefore(text: string): void;

Parâmetros

text: string

Texto a inserir.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertCells(shiftCells)

Adiciona células a uma tabela existente.

insertCells(shiftCells?: Word.TableCellInsertionLocation): void;

Parâmetros

shiftCells: Word.TableCellInsertionLocation

Opcional. Especifica como inserir as células nas colunas e linhas existentes da tabela. O valor predefinido é shiftDown.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertCells(shiftCells)

Adiciona células a uma tabela existente.

insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void;

Parâmetros

shiftCells: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"

insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void;

Parâmetros

options: Word.SelectionInsertDateTimeOptions

Opcional. Opções para inserir a data ou hora.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertFormula(options)

Insere um campo Fórmula na seleção.

insertFormula(options?: Word.SelectionInsertFormulaOptions): void;

Parâmetros

options: Word.SelectionInsertFormulaOptions

insertRowsAbove(numRows: number): void;

Parâmetros

numRows: number

Opcional. Número de linhas a inserir.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertRowsBelow(numRows)

Insere linhas abaixo da seleção atual.

insertRowsBelow(numRows: number): void;

Parâmetros

numRows: number

Opcional. Número de linhas a inserir.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertSymbol(characterNumber, options)

Insere um símbolo no lugar da seleção especificada.

insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void;

Parâmetros

characterNumber: number

O número de caráter do símbolo.

options: Word.SelectionInsertSymbolOptions

Opcional. Opções para inserir o símbolo.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertText(Text)

Insere o texto especificado.

insertText(Text: string): void;

Parâmetros

Text: string

O texto a inserir.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

insertXml(xml, transform)

Insere o XML especificado no documento no cursor, substituindo qualquer texto selecionado.

insertXml(xml: string, transform?: string): void;

Parâmetros

xml: string

A cadeia XML a inserir.

transform: string

Opcional. Transformação XSL a aplicar.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isEqual(range)

Devolve se a seleção é igual ao intervalo especificado.

isEqual(range: Word.Range): OfficeExtension.ClientResult<boolean>;

Parâmetros

range: Word.Range

O intervalo a comparar.

Retornos

OfficeExtension.ClientResult<boolean>

true se a seleção for igual ao intervalo especificado.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isInRange(range)

Devolve true se a seleção estiver contida no intervalo especificado.

isInRange(range: Word.Range): OfficeExtension.ClientResult<boolean>;

Parâmetros

range: Word.Range

O intervalo a comparar.

Retornos

OfficeExtension.ClientResult<boolean>

true se a seleção estiver contida no intervalo especificado.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

isInStory(range)

Devolve se a seleção está no mesmo bloco que o intervalo especificado.

isInStory(range: Word.Range): OfficeExtension.ClientResult<boolean>;

Parâmetros

range: Word.Range

O intervalo a comparar.

Retornos

OfficeExtension.ClientResult<boolean>

true se a seleção estiver no mesmo bloco que o intervalo especificado.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.SelectionLoadOptions): Word.Selection;

Parâmetros

options: Word.Interfaces.SelectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.Selection

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.Selection;

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.Selection

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Selection;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.Selection

move(options)

Fecha a seleção para a respetiva posição de início ou de fim e, em seguida, move o objeto fechado pelo número especificado de unidades.

move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveOptions

Opcional. Opções para mover a seleção.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveDown(options)

Move a seleção para baixo.

moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveUpDownOptions

Opcional. Opções para mover para baixo.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveEnd(options)

Move a posição do caráter final do intervalo ou seleção.

moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveStartEndOptions

Opcional. Opções para mover o fim.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveEndUntil(characters, count)

Move a posição final da seleção até que qualquer um dos carateres especificados seja encontrado no documento.

moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Por exemplo. Se especificar "a", a seleção move a posição de fim para antes do primeiro caráter "a".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveEndWhile(characters, count)

Move a posição do caráter final da seleção enquanto qualquer um dos carateres especificados é encontrado no documento.

moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Por exemplo. Se especificar "abcd", a seleção move a posição final quando é encontrada uma letra de "abcd".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveLeft(options)

Move a seleção para a esquerda.

moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveLeftRightOptions

Opcional. Opções para mover para a esquerda.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveRight(options)

Move a seleção para a direita.

moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveLeftRightOptions

Opcional. Opções para mover para a direita.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveStart(options)

Move a posição inicial da seleção.

moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveStartEndOptions

Opcional. Opções para a moveStart operação.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveStartUntil(characters, count)

Move a posição inicial da seleção até que um dos carateres especificados seja encontrado no documento.

moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Se especificar "a", a seleção move a posição de início para antes do primeiro caráter "a".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveStartWhile(characters, count)

Move a posição inicial da seleção enquanto qualquer um dos carateres especificados é encontrado no documento.

moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Por exemplo. Se especificar "abcd", a seleção move a posição de início quando é encontrada uma letra de "abcd".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveUntil(characters, count)

Move a seleção até que um dos carateres especificados seja encontrado no documento.

moveUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Por exemplo. Se especificar "a", a seleção move-se para a posição antes do primeiro caráter "a".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveUp(options)

Move a seleção para cima.

moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.SelectionMoveUpDownOptions

Opcional. Opções para avançar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

moveWhile(characters, count)

Move a seleção enquanto qualquer um dos carateres especificados é encontrado no documento.

moveWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

Parâmetros

characters: string

Carateres a procurar. Por exemplo. Se especificar "abcd", a seleção será movida para a posição quando for encontrada uma letra de "abcd".

count: number

Opcional. Número máximo de carateres a procurar.

Retornos

OfficeExtension.ClientResult<number>

O número de carateres pelos quais a seleção foi movida.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

nextField()

Seleciona o próximo campo.

nextField(): Word.Field;

Retornos

Word.Field

O campo seguinte.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

nextSubdocument()

Move a seleção para o próximo subdocumento.

nextSubdocument(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

pasteAndFormat(type)

Cola o conteúdo da área de transferência e formatará-os conforme especificado.

pasteAndFormat(type: Word.PasteFormatType): void;

Parâmetros

type: Word.PasteFormatType

O tipo de colagem de formato para células de tabela.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

pasteAndFormat(type)

Cola o conteúdo da área de transferência e formatará-os conforme especificado.

pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void;

Parâmetros

type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"

O tipo de colagem de formato para células de tabela.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

pasteExcelTable(linkedToExcel, wordFormatting, rtf)

Cola e formata uma tabela do Microsoft Excel.

pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void;

Parâmetros

linkedToExcel: boolean

Se a tabela está ligada ao Excel.

wordFormatting: boolean

Se pretende aplicar Word formatação.

rtf: boolean

previousField(): Word.Field;

Retornos

Word.Field

O campo anterior.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

previousSubdocument()

Move a seleção para o subdocumento anterior.

previousSubdocument(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

replaceParagraph()

Substitui a seleção por um novo parágrafo.

replaceParagraph(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

select()

Seleciona o texto atual.

select(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCell()

Seleciona toda a célula que contém a seleção atual quando a seleção está numa tabela.

selectCell(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectColumn()

Seleciona a coluna que contém o ponto de inserção ou seleciona todas as colunas que contêm a seleção quando a seleção está numa tabela.

selectColumn(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentAlignment()

Estende a seleção para frente até que seja encontrado um texto com um alinhamento de parágrafo diferente.

selectCurrentAlignment(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentColor()

Estende a seleção para frente até encontrar texto com uma cor diferente.

selectCurrentColor(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentFont()

Estende a seleção para frente até encontrar texto com uma fonte ou tamanho de fonte diferente.

selectCurrentFont(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentIndent()

Estende a seleção para frente até encontrar texto com recuos de parágrafo esquerdo ou direito diferentes.

selectCurrentIndent(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentSpacing()

Estende a seleção para frente até que um parágrafo com um espaçamento entre linhas diferente seja encontrado.

selectCurrentSpacing(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectCurrentTabs()

Estende a seleção para frente até encontrar um parágrafo com tabulações diferentes.

selectCurrentTabs(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

selectRow()

Seleciona a linha que contém o ponto de inserção ou seleciona todas as linhas que contêm a seleção quando a seleção está numa tabela.

selectRow(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

setRange(start, end)

Define as posições de caractere inicial e final da seleção. Os valores de posição do caráter começam no início da história, com o primeiro valor a ser 0. Todos os caracteres são contados, incluindo os não imprimíveis. Os caracteres ocultos são contados mesmo quando não são exibidos.

setRange(start: number, end: number): void;

Parâmetros

start: number

A posição de personagem inicial da história atual.

end: number

toJSON(): Word.Interfaces.SelectionData;

Retornos

Word.Interfaces.SelectionData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Selection;

Retornos

Word.Selection

typeBackspace()

Elimina o caráter anterior à seleção (se fechado) ou o ponto de inserção.

typeBackspace(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Selection;

Retornos

Word.Selection

Comentários

Esta página foi útil?

Compartilhar via

Word.Selection class

Comentários

Propriedades

Métodos

Detalhes da propriedade

borders

Valor da propriedade

Comentários

characters

Valor da propriedade

Comentários

comments

Valor da propriedade

Comentários

context

Valor da propriedade

end

Valor da propriedade

Comentários

fields

Valor da propriedade

Comentários

fitTextWidth

Valor da propriedade

Comentários

font

Valor da propriedade

Comentários

formattedText

Valor da propriedade

Comentários

hasNoProofing

Valor da propriedade

Comentários

isActive

Valor da propriedade

Comentários

isColumnSelectModeActive

Valor da propriedade

Comentários

isEndOfRowMark

Valor da propriedade

Comentários

isExtendModeActive

Valor da propriedade

Comentários

isInsertionPointAtEndOfLine

Valor da propriedade

Comentários

isStartActive

Valor da propriedade

Comentários

languageDetected

Valor da propriedade

Comentários

languageId

Valor da propriedade

Comentários

languageIdFarEast

Valor da propriedade

Comentários

languageIdOther

Valor da propriedade

Comentários

orientation

Valor da propriedade

Comentários

paragraphs

Valor da propriedade

Comentários

range

Valor da propriedade

Comentários

sections

Valor da propriedade

Comentários

sentences

Valor da propriedade

Comentários