Word. Range class

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

endnotes

Obtém a coleção de notas de extremidade no intervalo.

readonly endnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

fields

Obtém a coleção de objetos de campo no intervalo.

readonly fields: Word.FieldCollection;

Valor da propriedade

Word.FieldCollection

Comentários

font

Obtém o formato de texto do intervalo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.

readonly font: Word.Font;

Valor da propriedade

Word.Font

Comentários

footnotes

Obtém a coleção de notas de rodapé no intervalo.

readonly footnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml

// Gets the footnotes in the selected document range.
await Word.run(async (context) => {
  const footnotes = context.document.getSelection().footnotes;
  footnotes.load("length");
  await context.sync();

  console.log("Number of footnotes in the selected range: " + footnotes.items.length);
});

hyperlink

Obtém o primeiro hiperlink no intervalo ou define um hiperlink no intervalo. Todos os hiperlinks no intervalo são excluídos quando você configura um novo hiperlink no intervalo. Use um '#' para separar a parte do endereço da parte de localização opcional.

hyperlink: string;

Valor da propriedade

string

Comentários

inlinePictures

Obtém a coleção de objetos de imagem embutida presentes no intervalo.

readonly inlinePictures: Word.InlinePictureCollection;

Valor da propriedade

Word.InlinePictureCollection

Comentários

[ Conjunto de API: WordApi 1.2 ]

isEmpty

Verifica se o comprimento do intervalo é zero.

readonly isEmpty: boolean;

Valor da propriedade

boolean

Comentários

lists

Obtém a coleção de listas de objetos no intervalo.

readonly lists: Word.ListCollection;

Valor da propriedade

Word.ListCollection

Comentários

paragraphs

Obtém a coleção de objetos de parágrafo no intervalo.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

Importante: para os conjuntos de requisitos 1.1 e 1.2, parágrafos em tabelas totalmente contidas nesse intervalo não são retornados. Do conjunto de requisitos 1.3, parágrafos nessas tabelas também são retornados.

parentBody

Obtém o corpo pai do intervalo.

readonly parentBody: Word.Body;

Valor da propriedade

Word.Body

Comentários

parentContentControl

Obtém o controle de conteúdo com suporte no momento que contém o intervalo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

parentContentControlOrNullObject

Obtém o controle de conteúdo com suporte no momento que contém o intervalo. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

parentTable

Obtém a tabela que contém o intervalo. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.

readonly parentTable: Word.Table;

Valor da propriedade

Word.Table

Comentários

parentTableCell

Obtém a célula de tabela que contém o intervalo. Gerará um ItemNotFound erro se ele não estiver contido em uma célula de tabela.

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableCellOrNullObject

Obtém a célula de tabela que contém o intervalo. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableOrNullObject

Obtém a tabela que contém o intervalo. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Word.Table

Comentários

style

Especifica o nome de estilo para o intervalo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".

style: string;

Valor da propriedade

string

Comentários

styleBuiltIn

Especifica o nome de estilo interno para o intervalo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor da propriedade

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

await Word.run(async (context) => {
    const header = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
        "Start" /*this means at the beginning of the body */);
    header.styleBuiltIn = Word.BuiltInStyleName.heading1;

    await context.sync();
});

tables

Obtém a coleção de tabelas de objetos no intervalo.

readonly tables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

text

Obtém o texto do intervalo.

readonly text: string;

Valor da propriedade

string

Comentários

Detalhes do método

clear()

Limpa o conteúdo do objeto Range. O usuário pode executar a operação de desfazer no conteúdo limpo.

clear(): void;

Retornos

void

Comentários

OfficeExtension.ClientResult<Word.LocationRelation>

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to clear the contents of the proxy range object.
    range.clear();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Cleared the selection (range object)');
});

compareLocationWith(range)

Compara o local deste intervalo com a localização de outro intervalo.

compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;

Parâmetros

range: Word.Range

Obrigatório. O intervalo a ser comparado com esse intervalo.

Retornos

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/compare-location.yaml

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange = paragraphs.items[0].getRange();
  const secondParagraphAsRange = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  console.log(`Location of the first paragraph in relation to the second paragraph: ${comparedLocation.value}`);
});

delete()

Exclui o intervalo e o respectivo conteúdo do documento.

delete(): void;

Retornos

void

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to delete the range object.
    range.delete();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Deleted the selection (range object)');
});

expandTo(range)

Retorna um novo intervalo que se estende a partir deste intervalo em qualquer direção para cobrir outro intervalo. Esse intervalo não é alterado. Gerará um ItemNotFound erro se os dois intervalos não tiverem uma união.

expandTo(range: Word.Range): Word.Range;

Parâmetros

range: Word.Range

Obrigatório. Outro intervalo.

Retornos

Word.Range

Comentários

expandToOrNullObject(range)

Retorna um novo intervalo que se estende a partir deste intervalo em qualquer direção para cobrir outro intervalo. Esse intervalo não é alterado. Se os dois intervalos não tiverem uma união, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

expandToOrNullObject(range: Word.Range): Word.Range;

Parâmetros

range: Word.Range

Obrigatório. Outro intervalo.

Retornos

Word.Range

Comentários

getBookmarks(includeHidden, includeAdjacent)

Obtém os nomes em todos os indicadores ou sobrepondo o intervalo. Um indicador será oculto se seu nome começar com o caractere sublinhado.

getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult<string[]>;

Parâmetros

includeHidden: boolean

Opcional. Indica se deve incluir indicadores ocultos. O padrão é falso, o que indica que os indicadores ocultos são excluídos.

includeAdjacent: boolean

Opcional. Indica se deve incluir indicadores adjacentes ao intervalo. O padrão é falso, o que indica que os indicadores adjacentes são excluídos.

Retornos

OfficeExtension.ClientResult<string[]>

Comentários

getComments()

Obtém comentários associados ao intervalo.

getComments(): Word.CommentCollection;

Retornos

Word.CommentCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the comments in the selected content.
await Word.run(async (context) => {
  const comments = context.document.getSelection().getComments();

  // Load objects for display in Script Lab console.
  comments.load();
  await context.sync();

  console.log("Comments:");
  console.log(comments);
});

getContentControls(options)

Obtém os controles de conteúdo com suporte no momento no intervalo.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Parâmetros

options: Word.ContentControlOptions

Opcional. Opções que definem quais controles de conteúdo são retornados.

Retornos

Word.ContentControlCollection

Comentários

Importante: se tipos específicos forem fornecidos no parâmetro de opções, somente os controles de conteúdo dos tipos com suporte serão retornados. Lembre-se de que uma exceção será gerada no uso de métodos de uma Word genérica. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controles de conteúdo. Portanto, seu suplemento deve solicitar e manipular tipos específicos de controles de conteúdo.

getHtml()

Obtém uma representação HTML do objeto range. Quando renderizada em uma página da Web ou visualizador HTML, a formatação será uma correspondência próxima, mas não exata, para a formatação do documento. Esse método não retorna exatamente o mesmo HTML para o mesmo documento em plataformas diferentes (Windows, Mac, Word na Web, etc.). Se você precisar de fidelidade exata ou consistência entre plataformas, use Range.getOoxml() e converta o XML retornado em HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the HTML of the current selection.
    const html = range.getHtml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The HTML read from the document was: ' + html.value);
});

getHyperlinkRanges()

Obtém intervalos filho de hiperlink dentro do intervalo.

getHyperlinkRanges(): Word.RangeCollection;

Retornos

Word.RangeCollection

Comentários

Exemplos

await Word.run(async (context) => {
    // Get the entire document body.
    const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);

    // Get all the ranges that only consist of hyperlinks.
    const hyperLinks = bodyRange.getHyperlinkRanges();
    hyperLinks.load("hyperlink");
    await context.sync();

    // Log each hyperlink.
    hyperLinks.items.forEach((linkRange) => {
        console.log(linkRange.hyperlink);
    });
});

getNextTextRange(endingMarks, trimSpacing)

Obtém o próximo intervalo de texto usando marcas de pontuação e/ou outras marcas finais. Gerará um ItemNotFound erro se esse intervalo de texto for o último.

getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Parâmetros

endingMarks: string[]

Obrigatório. As marcas de pontuação e/ou outras marcas finais como uma matriz de cadeias de caracteres.

trimSpacing: boolean

Opcional. Indica se é necessário cortar caracteres de espaçamento (espaços, guias, quebras de coluna e marcas de extremidade do parágrafo) desde o início e o final do intervalo retornado. O padrão é falso, o que indica que os caracteres de espaçamento no início e no final do intervalo estão incluídos.

Retornos

Word.Range

Comentários

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

Obtém o próximo intervalo de texto usando marcas de pontuação e/ou outras marcas finais. Se esse intervalo de texto for o último, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Parâmetros

endingMarks: string[]

Obrigatório. As marcas de pontuação e/ou outras marcas finais como uma matriz de cadeias de caracteres.

trimSpacing: boolean

Retornos

Word.Range

Comentários

getOoxml()

Obtém a representação OOXML do objeto Range.

getOoxml(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the OOXML of the current selection.
    const ooxml = range.getOoxml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The OOXML read from the document was:  ' + ooxml.value);
});

getRange(rangeLocation)

Clona o intervalo, ou então, obtém os pontos inicial ou final do intervalo como um novo intervalo.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;

Parâmetros

rangeLocation: whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"

Opcional. O local de intervalo deve ser 'Whole', 'Start', 'End', 'After' ou 'Content'.

Retornos

Word.Range

Comentários

getReviewedText(changeTrackingVersion)

Obtém texto revisado com base na seleção ChangeTrackingVersion.

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

Parâmetros

changeTrackingVersion: Word.ChangeTrackingVersion

Opcional. O valor deve ser 'Original' ou 'Current'. O padrão é 'Current'.

Retornos

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the reviewed text.
await Word.run(async (context) => {
  const range = context.document.getSelection();
  const before = range.getReviewedText(Word.ChangeTrackingVersion.original);
  const after = range.getReviewedText(Word.ChangeTrackingVersion.current);

  await context.sync();

  console.log(`Reviewed text (before):\n${before.value}`);
  console.log(`Reviewed text (after):\n${after.value}`);
});

getReviewedText(changeTrackingVersionString)

Obtém texto revisado com base na seleção ChangeTrackingVersion.

getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

Parâmetros

changeTrackingVersionString: "Original" | "Current"

Opcional. O valor deve ser 'Original' ou 'Current'. O padrão é 'Current'.

Retornos

Comentários

getTextRanges(endingMarks, trimSpacing)

Obtém os intervalos filho de texto no intervalo usando marcas de pontuação e/ou outras marcas finais.

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Parâmetros

endingMarks: string[]

Obrigatório. As marcas de pontuação e/ou outras marcas finais como uma matriz de cadeias de caracteres.

trimSpacing: boolean

Opcional. Indica se é necessário cortar caracteres de espaçamento (espaços, guias, quebras de coluna e marcas de extremidade do parágrafo) desde o início e o final dos intervalos retornados na coleção de intervalos. O padrão é falso, o que indica que caracteres de espaçamento no início e no final dos intervalos são incluídos na coleção de intervalos.

Retornos

Word.RangeCollection

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  const sentences = context.document
    .getSelection()
    .getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
  sentences.load("$none");
  await context.sync();

  // Expand the range to the end of the paragraph to get all the complete sentences.
  const sentencesToTheEndOfParagraph = sentences.items[0]
    .getRange()
    .expandTo(
      context.document
        .getSelection()
        .paragraphs.getFirst()
        .getRange(Word.RangeLocation.end)
    )
    .getTextRanges(["."], false /* Don't trim spaces*/);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

getTrackedChanges()

Obtém a coleção dos objetos TrackedChange no intervalo.

getTrackedChanges(): Word.TrackedChangeCollection;

Retornos

Word.TrackedChangeCollection

Comentários

[ Conjunto de API: WordApi 1.6 ]

highlight()

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.

Realça o intervalo temporariamente sem alterar o conteúdo do documento. Para realçar o texto permanentemente, defina Font.HighlightColor do intervalo.

highlight(): void;

Retornos

void

Comentários

insertBookmark(name)

Insere um indicador no intervalo. Se um indicador do mesmo nome existir em algum lugar, ele será excluído primeiro.

insertBookmark(name: string): void;

Parâmetros

name: string

Obrigatório. O nome do indicador insensibilidade de maiúsculas de maiúsculas de minúsculas. Há suporte apenas para caracteres alfanuméricos e sublinhados. Ele deve começar com uma letra, mas se você quiser marcar o indicador como oculto, inicie o nome com um caractere sublinhado. Os nomes não podem ter mais de 40 caracteres.

Retornos

void

Comentários

Observação: as condições de inserir um indicador são semelhantes a fazê-lo na interface do usuário Word. Para saber mais sobre como gerenciar indicadores na interface do usuário Word, consulte Adicionar ou excluir indicadores em um documento Word ou mensagem do Outlook.

insertBreak(breakType, insertLocation)

Insere uma quebra no local especificado no documento principal.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

Parâmetros

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Obrigatório. O tipo de interrupção a ser adicionado.

insertLocation: before | after | "Before" | "After"

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

void

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert a page break after the selected text.
    range.insertBreak(Word.BreakType.page, Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted a page break after the selected text.');
});

insertComment(commentText)

Insira um comentário sobre o intervalo.

insertComment(commentText: string): Word.Comment;

Parâmetros

commentText: string

Obrigatório. O texto de comentário a ser inserido.

Retornos

Word.Comment

objeto comment

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Sets a comment on the selected content.
await Word.run(async (context) => {
  const text = $("#comment-text")
    .val()
    .toString();
  const comment = context.document.getSelection().insertComment(text);

  // Load object for display in Script Lab console.
  comment.load();
  await context.sync();

  console.log("Comment inserted:");
  console.log(comment);
});

insertContentControl(contentControlType)

Encapsula o objeto Range com um controle de conteúdo.

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;

Parâmetros

contentControlType: richText | plainText | checkBox | "RichText" | "PlainText" | "CheckBox"

Opcional. Tipo de controle de conteúdo a ser inserido. Deve ser 'RichText', 'PlainText' ou 'CheckBox'. O padrão é 'RichText'.

Retornos

Word.ContentControl

Comentários

Observação: o contentControlType parâmetro foi introduzido no WordApi 1.5. PlainText o suporte foi adicionado no WordApi 1.5. CheckBox o suporte foi adicionado no WordApi 1.7.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) { 
        results.items[i].font.bold = true;
        let cc = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

insertEndnote(insertText)

Insere uma nota de extremidade. A referência de nota de extremidade é colocada após o intervalo.

insertEndnote(insertText?: string): Word.NoteItem;

Parâmetros

insertText: string

Opcional. Texto a ser inserido no corpo da nota de extremidade. O padrão é "".

Retornos

Word.NoteItem

Comentários

insertField(insertLocation, fieldType, text, removeFormatting)

Insere um campo no local especificado.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field;

Parâmetros

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O local relativo ao intervalo em que o campo será inserido. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

fieldType: Word.FieldType

Opcional. Pode ser qualquer constante FieldType. O valor padrão é Empty.

text: string

Opcional. Propriedades ou opções adicionais, se necessário, para o tipo de campo especificado.

removeFormatting: boolean

Opcional. truepara remover a formatação aplicada ao campo durante as atualizações, caso contrário. false O valor padrão é false.

Retornos

Word.Field

Comentários

Importante:

No Word no Windows e no Mac, a API dá suporte à inserção e gerenciamento de todos os tipos listados no Word. FieldType, exceto Word. FieldType.others.

Em Word na Web, a API dá suporte à inserção e gerenciamento dos seguintes tipos de campo.

Word. FieldType.addin
Word. FieldType.date
Word. FieldType.hyperlink
Word. FieldType.toc

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml

// Inserts a Date field before selection.
await Word.run(async (context) => {
  var range = context.document.getSelection().getRange();

  const field = range.insertField(Word.InsertLocation.before, Word.FieldType.date, '\\@ "M/d/yyyy h:mm am/pm"', true);

  field.load("result,code");
  await context.sync();

  if (field.isNullObject) {
    console.log("There are no fields in this document.");
  } else {
    console.log("Code of the field: " + field.code);
    console.log("Result of the field: " + JSON.stringify(field.result));
  }
});

insertField(insertLocation, fieldTypeString, text, removeFormatting)

Insere um campo no local especificado.

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldTypeString?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field;

Parâmetros

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O local relativo ao intervalo em que o campo será inserido. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

fieldTypeString: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"

Opcional. Pode ser qualquer constante FieldType. O valor padrão é Empty.

text: string

Opcional. Propriedades ou opções adicionais, se necessário, para o tipo de campo especificado.

removeFormatting: boolean

Opcional. truepara remover a formatação aplicada ao campo durante as atualizações, caso contrário. false O valor padrão é false.

Retornos

Word.Field

Comentários

Importante:

No Word no Windows e no Mac, a API dá suporte à inserção e gerenciamento de todos os tipos listados no Word. FieldType, exceto Word. FieldType.others.

Em Word na Web, a API dá suporte à inserção e gerenciamento dos seguintes tipos de campo.

Word. FieldType.addin
Word. FieldType.date
Word. FieldType.hyperlink
Word. FieldType.toc

insertFileFromBase64(base64File, insertLocation)

Insere um documento no local especificado.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parâmetros

base64File: string

Obrigatório. O conteúdo codificado em Base64 de um arquivo .docx.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.Range

Comentários

Observação: não há suporte para inserção se o documento inserido contiver um controle ActiveX (provavelmente em um campo de formulário). Considere substituir esse campo de formulário por um controle de conteúdo ou outra opção apropriada para seu cenário.

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert base64 encoded .docx at the beginning of the range.
    // You'll need to implement getBase64() to make this work.
    range.insertFileFromBase64(getBase64(), Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Added base64 encoded text to the beginning of the range.');
});

insertFootnote(insertText)

Insere uma nota de rodapé. A referência de nota de rodapé é colocada após o intervalo.

insertFootnote(insertText?: string): Word.NoteItem;

Parâmetros

insertText: string

Opcional. Texto a ser inserido no corpo da nota de rodapé. O padrão é "".

Retornos

Word.NoteItem

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml

// Sets a footnote on the selected content.
await Word.run(async (context) => {
  const text = $("#input-footnote")
    .val()
    .toString();
  const footnote = context.document.getSelection().insertFootnote(text);
  await context.sync();

  console.log("Inserted footnote.");
});

insertHtml(html, insertLocation)

Insere HTML no local especificado.

insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parâmetros

html: string

Obrigatório. O HTML a ser inserido.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.Range

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('HTML added to the beginning of the range.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insere uma imagem no local especificado.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;

Parâmetros

base64EncodedImage: string

Obrigatório. A imagem codificada base64 a ser inserida.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.InlinePicture

Comentários

[ Conjunto de API: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Insere um formato OOXML no local especificado.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parâmetros

ooxml: string

Obrigatório. O formato OOXML a inserir.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.Range

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert OOXML in to the beginning of the range.
    range.insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('OOXML added to the beginning of the range.');
});

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

insertParagraph(paragraphText, insertLocation)

Insere um parágrafo no local especificado.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Parâmetros

paragraphText: string

Obrigatório. O texto do parágrafo a ser inserido.

insertLocation: before | after | "Before" | "After"

Obrigatório. O valor deve ser 'Before' ou 'After'.

Retornos

Word.Paragraph

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph after the range.
    range.insertParagraph('Content of a new paragraph', Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph added to the end of the range.');
});

insertTable(rowCount, columnCount, insertLocation, values)

Insere uma tabela com a quantidade especificada de linhas e colunas.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Parâmetros

rowCount: number

Obrigatório. A quantidade de linhas na tabela.

columnCount: number

Obrigatório. A quantidade de colunas na tabela.

insertLocation: before | after | "Before" | "After"

Obrigatório. O valor deve ser 'Before' ou 'After'.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

Word.Table

Comentários

insertText(text, insertLocation)

Insere um texto no local especificado.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Parâmetros

text: string

Obrigatório. Texto a inserir.

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.Range

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph at the end of the range.
    range.insertText('New text inserted into the range.', Word.InsertLocation.end);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Text added to the end of the range.');
});

intersectWith(range)

Retorna um novo intervalo como ponto de interseção deste intervalo com outro intervalo. Esse intervalo não é alterado. Gerará um ItemNotFound erro se os dois intervalos não estiverem sobrepostos ou adjacentes.

intersectWith(range: Word.Range): Word.Range;

Parâmetros

range: Word.Range

Obrigatório. Outro intervalo.

Retornos

Word.Range

Comentários

intersectWithOrNullObject(range)

Retorna um novo intervalo como ponto de interseção deste intervalo com outro intervalo. Esse intervalo não é alterado. Se os dois intervalos não estiverem sobrepostos ou adjacentes, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

intersectWithOrNullObject(range: Word.Range): Word.Range;

Parâmetros

range: Word.Range

Obrigatório. Outro intervalo.

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

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.RangeLoadOptions): Word.Range;

Parâmetros

options: Word.Interfaces.RangeLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.Range

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.Range;

Parâmetros

propertyNames: string | string[]

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

Retornos

Word.Range

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.Range;

Parâmetros

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

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

Retornos

Word.Range

removeHighlight()

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.

Remove o destaque adicionado pela função Highlight, se houver.

removeHighlight(): void;

Retornos

void

Comentários

search(searchText, searchOptions)

Executa uma pesquisa com as SearchOptions especificadas no escopo do objeto range. Os resultados da pesquisa são uma coleção de objetos Range.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parâmetros

searchText: string

Obrigatório. O texto da pesquisa.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opções da pesquisa.

Retornos

Word.RangeCollection

Comentários

select(selectionMode)

Seleciona e navega na interface do usuário do Word até o intervalo.

select(selectionMode?: Word.SelectionMode): void;

Parâmetros

selectionMode: Word.SelectionMode

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Queue a command to select the HTML that was inserted.
    range.select();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Selected the range.');
});

select(selectionModeString)

Seleciona e navega na interface do usuário do Word até o intervalo.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Parâmetros

selectionModeString: "Select" | "Start" | "End"

Opcional. O modo de seleção deve ser 'Select', 'Start' ou 'End'. 'Select' é o padrão.

Retornos

void

Comentários

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.RangeUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Range): void;

Parâmetros

properties: Word.Range

Retornos

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

Divide o intervalo em intervalos filho usando delimitadores.

split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Parâmetros

delimiters: string[]

Obrigatório. Os delimitadores como uma matriz de cadeias de caracteres.

multiParagraphs: boolean

Opcional. Indica se um intervalo filho retornado pode cobrir vários parágrafos. O padrão é falso, o que indica que os limites do parágrafo também são usados como delimitadores.

trimDelimiters: boolean

Opcional. Indica se é necessário cortar delimitadores dos intervalos na coleção de intervalos. O padrão é falso, o que indica que os delimitadores estão incluídos nos intervalos retornados na coleção de intervalos.

trimSpacing: boolean

Retornos

Word.RangeCollection

Comentários