Word. Range class

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

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

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. Utilize 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, os parágrafos em tabelas totalmente contidas neste intervalo não são devolvidos. A partir do conjunto de requisitos 1.3, os parágrafos nessas tabelas também são devolvidos.

parentBody

Obtém o corpo pai do intervalo.

readonly parentBody: Word.Body;

Valor da propriedade

Word.Body

Comentários

parentContentControl

Obtém o controlo de conteúdo atualmente suportado que contém o intervalo. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

parentContentControlOrNullObject

Obtém o controlo de conteúdo atualmente suportado que contém o intervalo. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Word.ContentControl

Comentários

parentTable

Obtém a tabela que contém o intervalo. Gera um ItemNotFound erro se não estiver contido numa 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. Gera um ItemNotFound erro se não estiver contido numa 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 não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableOrNullObject

Obtém a tabela que contém o intervalo. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Word.Table

Comentários

style

Especifica o nome do estilo do 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 incorporado 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: Word.Range = 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 comparar com este 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: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

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

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

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

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. Este intervalo não foi alterado. Gera 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

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: Word.RangeCollection = 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: Word.RangeCollection = 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);
  }
});

expandToOrNullObject(range)

Retorna um novo intervalo que se estende a partir deste intervalo em qualquer direção para cobrir outro intervalo. Este intervalo não foi alterado. Se os dois intervalos não tiverem uma união, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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 de todos os marcadores ou sobrepõe-se ao intervalo. Um marcador será ocultado se o respetivo nome começar com o caráter de sublinhado.

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

Parâmetros

includeHidden: boolean

Opcional. Indica se deve incluir marcadores ocultos. A predefinição é falsa, o que indica que os marcadores ocultos estão excluídos.

includeAdjacent: boolean

Opcional. Indica se deve incluir marcadores adjacentes ao intervalo. A predefinição é false, o que indica que os marcadores adjacentes estã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: Word.CommentCollection = context.document.getSelection().getComments();

  // Load objects to log in the console.
  comments.load();
  await context.sync();

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

getHtml()

Obtém uma representação HTML do objeto de intervalo. Quando composta numa página Web ou visualizador de HTML, a formatação será uma correspondência próxima, mas não exata, da formatação do documento. Este método não devolve exatamente o mesmo HTML para o mesmo documento em diferentes plataformas (Windows, Mac, Word na Web, etc.). Se precisar de fidelidade exata ou consistência entre plataformas, utilize Range.getOoxml() e converta o XML devolvido 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 intervalo de texto seguinte com marcas de pontuação e/ou outras marcas finais. Gera um ItemNotFound erro se este 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.

trimSpacing: boolean

Opcional. Indica se pretende cortar carateres de espaçamento (espaços, separadores, quebras de coluna e marcas de fim de parágrafo) a partir do início e do fim do intervalo devolvido. A predefinição é false, o que indica que os carateres de espaçamento no início e no fim do intervalo estão incluídos.

Retornos

Word.Range

Comentários

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

Obtém o intervalo de texto seguinte com marcas de pontuação e/ou outras marcas finais. Se este intervalo de texto for o último, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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.

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. A localização do intervalo tem de ser "Inteiro", "Iniciar", "Terminar", "Depois" ou "Conteúdo".

Retornos

Word.Range

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/insert-and-change-dropdown-list-content-control.yaml

// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
  let selection = context.document.getSelection();
  selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
  await context.sync();

  console.log("Dropdown list content control inserted at the end of the selection.");
});

getReviewedText(changeTrackingVersion)

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

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

Parâmetros

changeTrackingVersion: Word.ChangeTrackingVersion

Opcional. O valor tem de ser "Original" ou "Atual". A predefinição é "Atual".

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: Word.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):", before.value, "Reviewed text (after):", after.value);
});

getReviewedText(changeTrackingVersionString)

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

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

Parâmetros

changeTrackingVersionString: "Original" | "Current"

Opcional. O valor tem de ser "Original" ou "Atual". A predefinição é "Atual".

Retornos

Comentários

getTextRanges(endingMarks, trimSpacing)

Obtém os intervalos subordinados de texto no intervalo com 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.

trimSpacing: boolean

Opcional. Indica se deve cortar carateres de espaçamento (espaços, separadores, quebras de coluna e marcas de fim de parágrafo) a partir do início e fim dos intervalos devolvidos na coleção de intervalos. A predefinição é false, o que indica que os carateres de espaçamento no início e no fim dos intervalos estão incluídos na coleção de intervalos.

Retornos

Word.RangeCollection

Comentários

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: Word.RangeCollection = 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: Word.RangeCollection = 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);
  }
});

insertBookmark(name)

Insere um marcador no intervalo. Se existir um marcador com o mesmo nome algures, é eliminado primeiro.

insertBookmark(name: string): void;

Parâmetros

name: string

Obrigatório. O nome do marcador não sensível a maiúsculas e minúsculas. Apenas são suportados carateres alfanuméricos e de sublinhado. Tem de começar com uma letra, mas se quiser marcar o marcador como oculto, inicie o nome com um caráter de sublinhado. Os nomes não podem ter mais de 40 carateres.

Retornos

void

Comentários

Nota: as condições de inserção de um marcador são semelhantes a fazê-lo na IU do Word. Para saber mais sobre a gestão de marcadores na IU do Word, consulte Adicionar ou eliminar marcadores num 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 quebra a adicionar.

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

Obrigatório. O valor tem de ser "Antes" ou "Depois".

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 no intervalo.

insertComment(commentText: string): Word.Comment;

Parâmetros

commentText: string

Obrigatório. O texto do comentário a inserir.

Retornos

Word.Comment

objeto de comentário

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: Word.Comment = context.document.getSelection().insertComment(text);

  // Load object to log in the console.
  comment.load();
  await context.sync();

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

insertContentControl(contentControlType)

Molda o objeto Intervalo com um controlo 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 controlo de conteúdo a inserir. Tem de ser "RichText", "PlainText" ou "CheckBox". A predefinição é "RichText".

Retornos

Word.ContentControl

Comentários

Nota: o contentControlType parâmetro foi introduzido no WordApi 1.5. PlainText o suporte foi adicionado no WordApi 1.5. CheckBox foi adicionado suporte 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: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = 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: Word.ContentControl = 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();
});

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 ficheiro .docx.

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

Obrigatório. O valor tem de ser "Substituir", "Iniciar", "Terminar", "Antes" ou "Depois".

Retornos

Word.Range

Comentários

Nota: a inserção não é suportada se o documento que está a ser inserido contiver um controlo ActiveX (provavelmente num campo de formulário). Considere substituir tal campo de formulário por um controlo de conteúdo ou outra opção adequada para o 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.');
});

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 inserir.

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

Obrigatório. O valor tem de ser "Substituir", "Iniciar", "Terminar", "Antes" ou "Depois".

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 com Base64 a inserir.

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

Obrigatório. O valor tem de ser "Substituir", "Iniciar", "Terminar", "Antes" ou "Depois".

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 tem de ser "Substituir", "Iniciar", "Terminar", "Antes" ou "Depois".

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 tem de ser "Antes" ou "Depois".

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 tem de ser "Antes" ou "Depois".

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 tem de ser "Substituir", "Iniciar", "Terminar", "Antes" ou "Depois".

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. Este intervalo não foi alterado. Gera 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. Este intervalo não foi alterado. Se os dois intervalos não estiverem sobrepostos ou adjacentes, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

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

Parâmetros

range: Word.Range

Obrigatório. Outro intervalo.

Retornos

Word.Range

Comentários

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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

search(searchText, searchOptions)

Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de intervalo. 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 tem de ser "Selecionar", "Iniciar" ou "Terminar". '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 tem de ser "Selecionar", "Iniciar" ou "Terminar". 'Select' é o padrão.

Retornos

void

Comentários

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num 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.

multiParagraphs: boolean

Opcional. Indica se um intervalo subordinado devolvido pode abranger vários parágrafos. A predefinição é falsa, o que indica que os limites de parágrafo também são utilizados como delimitadores.

trimDelimiters: boolean

Opcional. Indica se pretende cortar delimitadores dos intervalos na coleção de intervalos. A predefinição é falsa, o que indica que os delimitadores estão incluídos nos intervalos devolvidos na coleção de intervalos.

trimSpacing: boolean

Retornos

Word.RangeCollection

Comentários