Word. Paragraph class

Conjunto de APIs: WordApiDesktop 1.3

Exemplos

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

// Centers the last paragraph between the document margins.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  const alignment: Word.Alignment = Word.Alignment.centered;
  lastParagraph.alignment = alignment;

  await context.sync();
});

borders

Retorna um BorderUniversalCollection objeto que representa todas as bordas do parágrafo.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Word.BorderUniversalCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/add-border-to-paragraph.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  // Insert a paragraph at the beginning of the document.
  const paragraph: Word.Paragraph =
    context.document.body.insertParagraph(
      "Note: Added a border to this paragraph.",
      Word.InsertLocation.start
    );

  // Load the paragraph borders so they can be formatted.
  const borders: Word.BorderUniversalCollection = paragraph.borders;
  borders.load("items");
  await context.sync();

  // Apply a visible double blue line to every side of the paragraph.
  borders.items.forEach((border: Word.BorderUniversal) => {
    border.isVisible = true;
    border.color = "#4472C4";
    border.lineStyle = Word.BorderLineStyle.double;
    border.lineWidth = Word.LineWidth.pt150;
  });

  await context.sync();

  console.log(
    `Applied the ${Word.BorderLineStyle.double} line style to ${borders.items.length} paragraph borders.`
  );
});

contentControls

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

readonly contentControls: Word.ContentControlCollection;

Valor da propriedade

Word.ContentControlCollection

Comentários

Conjunto de APIs: WordApi 1.5

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 fim no parágrafo.

readonly endnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

fields

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

readonly fields: Word.FieldCollection;

Valor da propriedade

Word.FieldCollection

Comentários

firstLineIndent

Especifica o valor, em pontos, para uma primeira linha ou recuo deslocado. Use um valor positivo para definir um recuo da primeira linha e use um valor negativo para definir um recuo deslocado.

firstLineIndent: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Indents only the first line of the first paragraph.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.firstLineIndent = 36;
  await context.sync();
});

font

Obtém o formato de texto do parágrafo. 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

Conjunto de APIs: WordApi 1.5

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/apply-bevel-to-text.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

footnotes

Obtém a coleção de notas de rodapé no parágrafo.

readonly footnotes: Word.NoteItemCollection;

Valor da propriedade

Word.NoteItemCollection

Comentários

inlinePictures

Obtém a coleção de InlinePicture objetos no parágrafo. A coleção não inclui imagens flutuantes.

readonly inlinePictures: Word.InlinePictureCollection;

Valor da propriedade

Word.InlinePictureCollection

Comentários

isLastParagraph

Indica que o parágrafo é o último dentro do corpo do pai.

readonly isLastParagraph: boolean;

Valor da propriedade

boolean

Comentários

isListItem

Verifica se o parágrafo é um item da lista.

readonly isListItem: boolean;

Valor da propriedade

boolean

Comentários

leftIndent

Especifica o valor de recuo à esquerda, em pontos, para o parágrafo.

leftIndent: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Indents the first paragraph from the left margin.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.leftIndent = 75;

  await context.sync();
});

lineSpacing

Especifica o espaçamento entre linhas, em pontos, para o parágrafo especificado. Na interface do usuário do Word, esse valor é dividido por 12.

lineSpacing: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Adjusts the spacing between lines in the first paragraph.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.lineSpacing = 20;

  await context.sync();
});

lineUnitAfter

Especifica a quantidade de espaçamento, em linhas de grade, após o parágrafo.

lineUnitAfter: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Adds space after the first paragraph, measured in grid lines.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.lineUnitAfter = 1;

  await context.sync();
});

lineUnitBefore

Especifica a quantidade de espaçamento, em linhas de grade, antes do parágrafo.

lineUnitBefore: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Adds space before the last paragraph, measured in grid lines.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  lastParagraph.lineUnitBefore = 1;

  await context.sync();
});

list

Obtém a lista à qual pertence esse parágrafo. Gera um ItemNotFound erro se o parágrafo não estiver em uma lista.

readonly list: Word.List;

Valor da propriedade

Word.List

Comentários

listItem

Obtém o ListItem para o parágrafo. Gera um ItemNotFound erro se o parágrafo não faz parte de uma lista.

readonly listItem: Word.ListItem;

Valor da propriedade

Word.ListItem

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.List = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

listItemOrNullObject

Obtém o ListItem para o parágrafo. Se o parágrafo não fizer parte de uma lista, 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 listItemOrNullObject: Word.ListItem;

Valor da propriedade

Word.ListItem

Comentários

listOrNullObject

Obtém a lista à qual pertence esse parágrafo. Se o parágrafo não estiver em uma lista, 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 listOrNullObject: Word.List;

Valor da propriedade

Word.List

Comentários

outlineLevel

Especifica o nível da estrutura de tópicos do parágrafo.

outlineLevel: number;

Valor da propriedade

number

Comentários

parentBody

Obtém o corpo pai do parágrafo.

readonly parentBody: Word.Body;

Valor da propriedade

Word.Body

Comentários

parentContentControl

Obtém o controle de conteúdo que inclui o parágrafo. Lançará 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 que inclui o parágrafo. 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 parágrafo. Gera um ItemNotFound erro se 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 parágrafo. Gera um ItemNotFound erro se não estiver contido em uma célula da tabela.

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Word.TableCell

Comentários

parentTableCellOrNullObject

Obtém a célula de tabela que contém o parágrafo. Se ele não estiver contido em uma célula da 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 parágrafo. Se 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

rightIndent

Especifica o valor de recuo à direita, em pontos, para o parágrafo.

rightIndent: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Exemplos

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

// Narrows the first paragraph by adding a right indent.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.rightIndent = 72;
  await context.sync();
});

shading

Retorna um ShadingUniversal objeto que faz referência à formatação de sombreamento do parágrafo.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Word.ShadingUniversal

Comentários

shapes

Obtém a coleção de Shape objetos ancorados no parágrafo, incluindo formas embutidas e flutuantes. Atualmente, há suporte apenas para as seguintes formas: caixas de texto, formas geométricas, grupos, imagens e telas.

readonly shapes: Word.ShapeCollection;

Valor da propriedade

Word.ShapeCollection

Comentários

Importante: esteja ciente de que, com o tempo, outros tipos de formas podem ser suportados. Portanto, seu suplemento deve solicitar e lidar com tipos específicos de formas.

spaceAfter

Especifica o espaçamento, em pontos, após o parágrafo.

spaceAfter: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Adds space after the first paragraph, measured in points.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.spaceAfter = 20;

  await context.sync();
});

spaceBefore

Especifica o espaçamento, em pontos, antes do parágrafo.

spaceBefore: number;

Valor da propriedade

number

Comentários

Exemplos

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

// Adds space before the last paragraph, measured in points.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  lastParagraph.spaceBefore = 24;
  await context.sync();
});

style

Especifica o nome do estilo do parágrafo. 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

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name-to-use") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("isNullObject, nameLocal, type");
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    const paragraph: Word.Paragraph = body.insertParagraph(
      "This paragraph uses a custom style.",
      Word.InsertLocation.start
    );
    paragraph.style = style.nameLocal;
    await context.sync();

    console.log(`Applied '${styleName}' to the sample paragraph.`);
  }
});

styleBuiltIn

Especifica o nome do estilo interno para o parágrafo. 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 paragraph: Word.Paragraph = context.document.body.insertParagraph("Timeline", "End");
    paragraph.styleBuiltIn = "Heading2";
    const paragraph2: Word.Paragraph = context.document.body.insertParagraph("The Services shall commence on July 31, 2015, and shall continue through July 29, 2015.", "End");
    paragraph2.styleBuiltIn = "Normal";
    const paragraph3: Word.Paragraph = context.document.body.insertParagraph("Project Costs by Phase", "End");
    paragraph3.styleBuiltIn = "Heading2";
    // Note a content control with the title of "ProjectCosts" is added. Content will be replaced later.
    const paragraph4: Word.Paragraph = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
    paragraph4.styleBuiltIn = "Normal";
    paragraph4.font.highlightColor = "#FFFF00";
    const contentControl: Word.ContentControl = paragraph4.insertContentControl();
    contentControl.title = "ProjectCosts";
    const paragraph5: Word.Paragraph = context.document.body.insertParagraph("Project Team", "End");
    paragraph5.styleBuiltIn = "Heading2";
    paragraph5.font.highlightColor = "#FFFFFF";
    const paragraph6: Word.Paragraph = context.document.body.insertParagraph("Terms of Work", "End");
    paragraph6.styleBuiltIn = "Heading1";
    const paragraph7: Word.Paragraph = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
    paragraph7.styleBuiltIn = "Normal";
    const paragraph8: Word.Paragraph = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
    paragraph8.styleBuiltIn = "Heading2";
    const paragraph9 : Word.Paragraph= context.document.body.insertParagraph("Client will be invoiced monthly for the consulting services and T&L expenses. Standard Contractor invoicing is assumed to be acceptable. Invoices are due upon receipt. client will be invoiced all costs associated with out-of-pocket expenses (including, without limitation, costs and expenses associated with meals, lodging, local transportation and any other applicable business expenses) listed on the invoice as a separate line item. Reimbursement for out-of-pocket expenses in connection with performance of this SOW, when authorized and up to the limits set forth in this SOW, shall be in accordance with Client's then-current published policies governing travel and associated business expenses, which information shall be provided by the Client Project Manager.", "End");
    paragraph9.styleBuiltIn = "Normal";
    // Insert a page break at the end of the document.
    context.document.body.insertBreak("Page", "End");

    await context.sync();
});

tableNestingLevel

Obtém o nível da tabela do parágrafo. Ele retornará 0 se o parágrafo não estiver em uma tabela.

readonly tableNestingLevel: number;

Valor da propriedade

number

Comentários

text

Obtém o texto do parágrafo.

readonly text: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApi 1.6

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) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(`The first paragraph of the selected text: ${paragraph.text}`);
});

uniqueLocalId

Obtém uma cadeia de caracteres que representa o identificador de parágrafo na sessão atual. A ID está no formato GUID padrão 8-4-4-4-12 sem chaves e difere entre sessões e coautores.

readonly uniqueLocalId: string;

Valor da propriedade

string

Comentários

Essa API requer uma assinatura ativa do Microsoft 365. Não funciona com licenças de compra única.

Exemplos

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function paragraphChanged(args: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    const results = [];
    for (let id of args.uniqueLocalIds) {
      let para = context.document.getParagraphByUniqueLocalId(id);
      para.load("uniqueLocalId");

      results.push({ para: para, text: para.getText() });
    }

    await context.sync();

    for (let result of results) {
      console.log(`${args.type}: ID ${result.para.uniqueLocalId}:-`, result.text.value);
    }
  });
}

attachToList(listId, level)

Permite que o parágrafo ingresse em uma lista existente no nível especificado. Falhará se o parágrafo não puder ingressar na lista ou se o parágrafo já for um item da lista.

attachToList(listId: number, level: number): Word.List;

Parâmetros

listId: number

A ID de uma lista existente.

level: number

O nível na lista.

Retornos

Word.List

Comentários

clear()

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

clear(): void;

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Removes the first paragraph's content but keeps the paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    firstParagraph.clear();
    await context.sync();
    console.log("Cleared the first paragraph. Its empty paragraph remains.");
});

closeUp()

Remove qualquer espaçamento antes do parágrafo.

closeUp(): void;

Retornos

void

Comentários

delete()

Exclui o parágrafo e o respectivo conteúdo do documento.

delete(): void;

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Removes the first paragraph and its content from the document.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    firstParagraph.delete();
    await context.sync();
    console.log("Deleted the first paragraph and its content.");
});

detachFromList()

Move este parágrafo para fora de sua lista, caso o parágrafo seja um item da lista.

detachFromList(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.7

getAnnotations()

Obtém anotações definidas neste Paragraph objeto.

getAnnotations(): Word.AnnotationCollection;

Retornos

Word.AnnotationCollection

Comentários

Importante: essa API requer uma assinatura do Microsoft 365 para funcionar corretamente devido a um requisito do serviço subjacente. Para obter mais informações, consulte GitHub issue 4953.

getComments()

Obtém comentários associados ao parágrafo.

getComments(): Word.CommentCollection;

Retornos

Word.CommentCollection

Comentários

Conjunto de APIs: WordApi 1.5

getContentControls(options)

Obtém os controles de conteúdo com suporte no momento no parágrafo.

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 options, somente os controles de conteúdo dos tipos com suporte serão retornados. Esteja ciente de que uma exceção será lançada usando métodos de um Word genérico. ContentControl que não são relevantes para o tipo específico. Com o tempo, outros tipos de controles de conteúdo podem ser suportados. Portanto, seu suplemento deve solicitar e manipular tipos específicos de controles de conteúdo.

getHtml()

Obtém uma representação HTML do Paragraph objeto. 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 Paragraph.getOoxml() e converta o XML retornado em HTML.

getHtml(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-and-read-paragraph-markup.yaml

// Reads an HTML representation of the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const html: OfficeExtension.ClientResult<string> = firstParagraph.getHtml();
    await context.sync();
    console.log(`Paragraph HTML: ${html.value}`);
});

getNext()

Obtém o próximo parágrafo. Gera um ItemNotFound erro se o parágrafo for o último.

getNext(): Word.Paragraph;

Retornos

Word.Paragraph

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Reads the paragraph immediately after the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const nextParagraph: Word.Paragraph = firstParagraph.getNext();
    nextParagraph.load("text");
    await context.sync();
    console.log(`Next paragraph: ${nextParagraph.text}`);
});

getNextOrNullObject()

Obtém o próximo parágrafo. Se o parágrafo 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.

getNextOrNullObject(): Word.Paragraph;

Retornos

Word.Paragraph

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Checks for a following paragraph without throwing at the end of the body.
await Word.run(async (context) => {
    const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
    const nextParagraph: Word.Paragraph = lastParagraph.getNextOrNullObject();
    nextParagraph.load("text");
    await context.sync();
    if (nextParagraph.isNullObject) {
        console.log("There is no paragraph after the last paragraph.");
    } else {
        console.log(`Next paragraph: ${nextParagraph.text}`);
    }
});

getOoxml()

Obtém a representação Paragraph do objeto Office Open XML (OOXML).

getOoxml(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-and-read-paragraph-markup.yaml

// Reads the first paragraph's Office Open XML representation.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const ooxml: OfficeExtension.ClientResult<string> = firstParagraph.getOoxml();
    await context.sync();
    console.log(`Paragraph OOXML: ${ooxml.value}`);
});

getPrevious()

Obtém o parágrafo anterior. Gera um ItemNotFound erro se o parágrafo for o primeiro.

getPrevious(): Word.Paragraph;

Retornos

Word.Paragraph

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Reads the paragraph immediately before the last paragraph.
await Word.run(async (context) => {
    const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
    const previousParagraph: Word.Paragraph = lastParagraph.getPrevious();
    previousParagraph.load("text");
    await context.sync();
    console.log(`Previous paragraph: ${previousParagraph.text}`);
});

getPreviousOrNullObject()

Obtém o parágrafo anterior. Se o parágrafo for o primeiro, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getPreviousOrNullObject(): Word.Paragraph;

Retornos

Word.Paragraph

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Checks for a preceding paragraph without throwing at the start of the body.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const previousParagraph: Word.Paragraph = firstParagraph.getPreviousOrNullObject();
    previousParagraph.load("text");
    await context.sync();
    if (previousParagraph.isNullObject) {
        console.log("There is no paragraph before the first paragraph.");
    } else {
        console.log(`Previous paragraph: ${previousParagraph.text}`);
    }
});

getRange(rangeLocation)

Obtém o parágrafo inteiro, ou então, os pontos inicial ou final do parágrafo, como um 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 do intervalo deve ser whole,start , end, afterou .content

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

// Gets complete sentences from the insertion point to the end of its paragraph.
await Word.run(async (context) => {
  const selection: Word.Range = context.document.getSelection();
  const sentences: Word.RangeCollection = selection.getTextRanges(["."], false);
  sentences.load("$none");
  await context.sync();

  const firstSentence: Word.Range = sentences.items[0];
  const paragraphEnd: Word.Range = selection.paragraphs.getFirst().getRange(Word.RangeLocation.end);
  const remainingRange: Word.Range = firstSentence.expandTo(paragraphEnd);
  const sentencesToTheEndOfParagraph: Word.RangeCollection = remainingRange.getTextRanges(["."], false);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  console.log("Sentences from the current sentence to the paragraph end:");
  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

getReviewedText(changeTrackingVersion)

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

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

getReviewedText(changeTrackingVersion)

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

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

Parâmetros

changeTrackingVersion: "Original" | "Current"

Opcional. O valor deve ser original ou current. O padrão é current.

Retornos

Comentários

getText(options)

Retorna o texto do parágrafo. Excluir equações, elementos gráficos (por exemplo, imagens, vídeos, desenhos) e caracteres especiais que marcam vários tipos de conteúdo (por exemplo, para controles de conteúdo, campos, comentários, notas de rodapé, notas de fim). Por padrão, o texto oculto e o texto marcado como excluído são excluídos.

getText(options?: Word.GetTextOptions | {
            IncludeHiddenText?: boolean;
            IncludeTextMarkedAsDeleted?: boolean;
        }): OfficeExtension.ClientResult<string>;

Parâmetros

options: Word.GetTextOptions | { IncludeHiddenText?: boolean; IncludeTextMarkedAsDeleted?: boolean; }

Opcional. Opções que definem se o resultado final deve incluir texto oculto e texto marcado como excluído.

Retornos

Conjunto de APIs: WordApi 1.7

Comentários

Exemplos

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

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();

  const text = paragraph.getText();
  const textIncludingHidden = paragraph.getText({ IncludeHiddenText: true });
  const textIncludingDeleted = paragraph.getText({ IncludeTextMarkedAsDeleted: true });

  await context.sync();

  console.log(`Text: ${text.value}`);
  console.log(`Including hidden text: ${textIncludingHidden.value}`);
  console.log(`Including text marked as deleted: ${textIncludingDeleted.value}`);
});

getTextRanges(endingMarks, trimSpacing)

Obtém os intervalos de texto no parágrafo usando marcas de pontuação e outras marcas de terminação.

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

Parâmetros

endingMarks: string[]

Os sinais de pontuação e outros sinais de terminação como uma matriz de cadeias de caracteres.

trimSpacing: boolean

Opcional. Indica se deseja cortar caracteres de espaçamento (espaços, tabulações, quebras de coluna e marcas de fim de parágrafo) do início e do fim dos intervalos retornados na coleção de intervalos. O padrão é false que indica que os caracteres de espaçamento no início e no final dos intervalos estão incluídos na coleção de intervalos.

Retornos

Word.RangeCollection

Comentários

Conjunto de APIs: WordApi 1.6

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/basic-paragraph-operations.yaml

// Reads sentence ranges delimited by periods in the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const sentences: Word.RangeCollection = firstParagraph.getTextRanges(["."], true);
    sentences.load("items/text");
    await context.sync();
    console.log(`Sentences found: ${sentences.items.length}`);
    for (const sentence of sentences.items) {
        console.log(`Sentence: ${sentence.text}`);
    }
});

getTrackedChanges()

Obtém a coleção dos TrackedChange objetos no parágrafo.

getTrackedChanges(): Word.TrackedChangeCollection;

Retornos

Word.TrackedChangeCollection

Comentários

indent()

Recua o parágrafo em um nível.

indent(): void;

Retornos

void

Comentários

indentCharacterWidth(count)

Recua o parágrafo em um número especificado de caracteres.

indentCharacterWidth(count: number): void;

Parâmetros

count: number

O número de caracteres do recuo.

Retornos

void

Comentários

indentFirstLineCharacterWidth(count)

Recua a primeira linha do parágrafo pelo número especificado de caracteres.

indentFirstLineCharacterWidth(count: number): void;

Parâmetros

count: number

O número de caracteres para o recuo da primeira linha.

Retornos

void

Comentários

Conjunto de APIs: WordApi 1.7

insertAnnotations(annotations)

Insere anotações neste Paragraph objeto.

insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;

Parâmetros

annotations: Word.AnnotationSet

Anotações a definir.

Retornos

OfficeExtension.ClientResult<string[]>

Uma matriz dos identificadores de anotações inseridas.

Comentários

Importante: essa API requer uma assinatura do Microsoft 365 para funcionar corretamente devido a um requisito do serviço subjacente. Para obter mais informações, consulte GitHub issue 4953.

Exemplos

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

// Adds annotations to the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const options: Word.CritiquePopupOptions = {
    brandingTextResourceId: "PG.TabLabel",
    subtitleResourceId: "PG.HelpCommand.TipTitle",
    titleResourceId: "PG.HelpCommand.Label",
    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"]
  };
  const critique1: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3,
    popupOptions: options
  };
  const critique2: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1,
    popupOptions: options
  };
  const critique3: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3,
    popupOptions: options
  };
  const critique4: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3,
    popupOptions: options
  };
  const critique5: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10,
    popupOptions: options
  };
  const annotationSet: Word.AnnotationSet = {
    critiques: [critique1, critique2, critique3, critique4, critique5]
  };

  const annotationIds = paragraph.insertAnnotations(annotationSet);

  await context.sync();

  console.log("Annotations inserted:", annotationIds.value);
});

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"

O tipo de quebra a adicionar ao documento.

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

O valor deve ser before ou after.

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml

Word.run(async (context) => {
  context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");

  await context.sync();
  console.log("Inserted a line break after the first paragraph.");
});

insertCanvas(insertShapeOptions)

Insere uma tela flutuante na frente do texto com sua âncora no início do parágrafo.

insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Parâmetros

insertShapeOptions: Word.InsertShapeOptions

Opcional. O local e o tamanho da tela. O local e o tamanho padrão são (0, 0, 300, 200).

Retornos

Word.Shape

Comentários

insertContentControl(contentControlType)

Envolve o Paragraph objeto com um controle de conteúdo.

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl;

Parâmetros

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | buildingBlockGallery | datePicker | repeatingSection | picture | group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"

Opcional. Tipo de controle de conteúdo a ser inserido. Deve ser richText, plainText,checkBox , dropDownListcomboBoxbuildingBlockGallerydatePickerrepeatingSection, ,picture , , ou .group O padrão é richText.

Retornos

Word.ContentControl

Comentários

Observação: O parâmetro foi introduzido contentControlType no WordApi 1.5. plainText o suporte foi adicionado no WordApi 1.5. checkBox o suporte foi adicionado no WordApi 1.7. dropDownList e comboBox o suporte foi adicionado no WordApi 1.9. O suporte para buildingBlockGallery,datePicker ,group , picturee repeatingSection foi adicionado no WordApiDesktop 1.3.

Exemplos

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

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

insertFileFromBase64(base64File, insertLocation)

Insere um documento no parágrafo no local especificado. O tamanho máximo do documento que está sendo inserido é de 4 MB.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

base64File: string

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

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

Retornos

Word.Range

Comentários

Não há suporte para a inserção se o documento que está sendo 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.

Não há suporte para inserção se o documento que está sendo inserido contiver conteúdo vinculado ou externo. Se isso acontecer, esse método retornará um InvalidArgument erro.

As configurações do documento não são preservadas ao inserir um documento.

insertGeometricShape(geometricShapeType, insertShapeOptions)

Insere uma forma geométrica na frente do texto com sua âncora no início do parágrafo.

insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Parâmetros

geometricShapeType: Word.GeometricShapeType

O tipo geométrico da forma a ser inserida.

insertShapeOptions: Word.InsertShapeOptions

Opcional. O local e o tamanho da forma geométrica. O local e o tamanho padrão são (0, 0, 100, 100).

Retornos

Word.Shape

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/group-ungroup.yaml

await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  body.clear();
  const lastParagraph: Word.Paragraph = body.paragraphs.getLast();

  // Inserts a text box.
  const textBoxOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100,
  };
  lastParagraph.insertTextBox("placeholder text", textBoxOptions);

  // Inserts a geometric shape.
  const geometricShapeOptions: Word.InsertShapeOptions = {
    height: 120,
    width: 120,
    left: 120,
  };
  lastParagraph.insertGeometricShape(Word.GeometricShapeType.star24, geometricShapeOptions);

  // Inserts a picture.
  const pictureOptions: Word.InsertShapeOptions = {
    top: 120,
    left: 60,
    height: 150,
    width: 150,
  };
  lastParagraph.insertPictureFromBase64(getPictureBase64(), pictureOptions);

  await context.sync();
});

insertGeometricShape(geometricShapeType, insertShapeOptions)

Insere uma forma geométrica na frente do texto com sua âncora no início do parágrafo.

insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Parâmetros

geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

O tipo geométrico da forma a ser inserida.

insertShapeOptions: Word.InsertShapeOptions

Opcional. O local e o tamanho da forma geométrica. O local e o tamanho padrão são (0, 0, 100, 100).

Retornos

Word.Shape

Comentários

insertHtml(html, insertLocation)

Insere HTML no local especificado dentro do parágrafo.

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

html: string

O HTML a inserir no parágrafo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

Retornos

Word.Range

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-and-read-paragraph-markup.yaml

// Replaces the first paragraph's content with bold and italic text from HTML.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const insertedRange: Word.Range = firstParagraph.insertHtml(
        "<b>Project update:</b> <i>ready for review.</i>",
        Word.InsertLocation.replace
    );
    await context.sync();
    console.log("Replaced the first paragraph's content with formatted HTML.");
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insere uma imagem no local especificado dentro do parágrafo.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Parâmetros

base64EncodedImage: string

A imagem codificada em Base64 a ser inserida.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

Retornos

Word.InlinePicture

Comentários

Exemplos

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

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";

    // Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
    paragraph.insertInlinePictureFromBase64(b64encodedImg, 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 an image to the first paragraph.');
});

insertOoxml(ooxml, insertLocation)

Insere OOXML no parágrafo no local especificado.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

ooxml: string

O OOXML a ser inserido no parágrafo.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

Retornos

Word.Range

Comentários

Não há suporte para inserção se o conteúdo que está sendo inserido contiver conteúdo vinculado ou externo. Se isso acontecer, esse método retornará um InvalidArgument erro.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-and-read-paragraph-markup.yaml

// Replaces the first paragraph's content with a bold update from an OOXML package.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const ooxml: string =
        `<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: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:r><w:rPr><w:b/></w:rPr><w:t>Project update from OOXML.</w:t></w:r></w:p></w:body>
                </w:document></pkg:xmlData>
            </pkg:part>
        </pkg:package>`;
    const insertedRange: Word.Range = firstParagraph.insertOoxml(ooxml, Word.InsertLocation.replace);
    await context.sync();
    console.log("Replaced the first paragraph's content with a bold OOXML update.");
});

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

O texto do parágrafo a ser inserido.

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

O valor deve ser before ou after.

Retornos

Word.Paragraph

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml

// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
  context.document.body.paragraphs
    .getLast()
    .insertParagraph("", "After")
    .insertInlinePictureFromBase64(base64Image, "End");

  await context.sync();
});

insertPictureFromBase64(base64EncodedImage, insertShapeOptions)

Insere uma imagem flutuante na frente do texto com sua âncora no início do parágrafo.

insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Parâmetros

base64EncodedImage: string

A imagem codificada em Base64 a ser inserida.

insertShapeOptions: Word.InsertShapeOptions

Opcional. O local e o tamanho da imagem. O local padrão é (0, 0) e o tamanho padrão é o tamanho original da imagem.

Retornos

Word.Shape

Comentários

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

O número de linhas na tabela.

columnCount: number

O número de colunas na tabela.

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

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 texto no local especificado dentro do parágrafo.

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Parâmetros

text: string

Texto a inserir.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

Retornos

Word.Range

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml

await Word.run(async (context) => {
  // Replace the last paragraph.
  const range: Word.Range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
  range.font.highlightColor = "black";
  range.font.color = "white";

  await context.sync();
});

insertTextBox(text, insertShapeOptions)

Insere uma caixa de texto flutuante na frente do texto com sua âncora no início do parágrafo.

insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Parâmetros

text: string

Opcional. O texto a ser inserido na caixa de texto.

insertShapeOptions: Word.InsertShapeOptions

Opcional. O local e o tamanho da caixa de texto. O local e o tamanho padrão são (0, 0, 100, 100).

Retornos

Word.Shape

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Inserts a text box at the beginning of the first paragraph in the header.
  const headerFooterBody: Word.Body = context.document.sections.getFirst().getHeader(Word.HeaderFooterType.primary);
  headerFooterBody.load("paragraphs");
  const firstParagraph: Word.Paragraph = headerFooterBody.paragraphs.getFirst();
  const insertShapeOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100
  };
  const newTextBox: Word.Shape = firstParagraph.insertTextBox("placeholder text", insertShapeOptions);
  newTextBox.select();
  await context.sync();

  console.log("Inserted a text box at the beginning of the first paragraph in the header.");
});

joinList()

Une um parágrafo de lista com a lista mais próxima acima ou abaixo desse parágrafo. Esse método só funciona com listas com marcadores, não com listas numeradas.

joinList(): void;

Retornos

void

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.ParagraphLoadOptions): Word.Paragraph;

Parâmetros

options: Word.Interfaces.ParagraphLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Word.Paragraph

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

Parâmetros

propertyNames: string | string[]

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

Retornos

Word.Paragraph

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

Parâmetros

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

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

Retornos

Word.Paragraph

next(count)

Retorna um Paragraph objeto que representa o próximo parágrafo.

next(count: number): Word.Paragraph;

Parâmetros

count: number

previous(count: number): Word.Paragraph;

Parâmetros

count: number

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

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 parágrafo.

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

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

// Selects the final paragraph and scrolls it into view.
await Word.run(async (context) => {
  const lastRange: Word.Range = context.document.body.paragraphs.getLast().getRange();
  lastRange.select();

  await context.sync();
});

...

// Moves the insertion point to the end of the final paragraph.
await Word.run(async (context) => {
  const lastRange: Word.Range = context.document.body.paragraphs.getLast().getRange();
  const selectionMode: Word.SelectionMode = Word.SelectionMode.end;
  lastRange.select(selectionMode);

  await context.sync();
});

select(selectionMode)

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

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

Parâmetros

selectionMode: "Select" | "Start" | "End"

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

Parâmetros

properties: Word.Interfaces.ParagraphUpdateData

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 de propriedades tentar definir propriedades somente leitura.

Retornos

void

Exemplos

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

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  paragraph.set({
    leftIndent: 30,
    font: {
      bold: true,
      color: "red"
    }
  });

  await context.sync();
});

...

await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const secondParagraph: Word.Paragraph = firstParagraph.getNext();
  firstParagraph.load("text, font/color, font/bold, leftIndent");

  await context.sync();

  secondParagraph.set(firstParagraph);

  await context.sync();
});

set(properties)

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

set(properties: Word.Paragraph): void;

Parâmetros

properties: Word.Paragraph

Retornos

void

space1()

Define o parágrafo com espaçamento simples.

space1(): void;

Retornos

void

Comentários

space1Pt5()

Define o parágrafo como espaçamento entre linhas de 1,5.

space1Pt5(): void;

Retornos

void

Comentários

space2()

Define o parágrafo com espaçamento duplo.

space2(): void;

Retornos

void

Comentários

split(delimiters, trimDelimiters, trimSpacing)

Divide o parágrafo em intervalos filho usando delimitadores.

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

Parâmetros

delimiters: string[]

Os delimitadores como uma matriz de cadeias de caracteres.

trimDelimiters: boolean

Opcional. Indica se os delimitadores devem ser cortados dos intervalos na coleção de intervalos. O padrão é false que indica que os delimitadores estão incluídos nos intervalos retornados na coleção de intervalos.

trimSpacing: boolean

Opcional. Indica se deseja cortar caracteres de espaçamento (espaços, tabulações, quebras de coluna e marcas de fim de parágrafo) do início e do fim dos intervalos retornados na coleção de intervalos. O padrão é false que indica que os caracteres de espaçamento no início e no final 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/35-ranges/split-words-of-first-paragraph.yaml

// Splits the first paragraph into words and highlights them in sequence.
await Word.run(async (context) => {
  const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
  const words: Word.RangeCollection = paragraphRange.split([" "], false, true, true);
  words.load("text");

  await context.sync();

  for (let i = 0; i < words.items.length; i++) {
    if (i >= 1) {
      words.items[i - 1].font.highlightColor = "#FFFFFF";
    }
    words.items[i].font.highlightColor = "#FFFF00";

    await context.sync();
    await new Promise((resolve) => setTimeout(resolve, 200));
  }
});

startNewList()

Inicia uma nova lista com este parágrafo. Falhará se o parágrafo já for um item da lista.

startNewList(): Word.List;

Retornos

Word.List

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list: Word.List = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  const listItem: Word.ListItem = paragraph.listItem;
  listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

tabHangingIndent(count)

Define um recuo deslocado conforme um número especificado de paradas de tabulação.

tabHangingIndent(count: number): void;

Parâmetros

count: number

O número de paradas de tabulação para o recuo deslocado.

Retornos

void

Comentários

tabIndent(count)

Define o recuo à esquerda do parágrafo como um número especificado de paradas de tabulação.

tabIndent(count: number): void;

Parâmetros

count: number

O número de paradas de tabulação para o recuo esquerdo.

Retornos

void

Comentários