Word.ParagraphCollection class

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

Obtém os itens filhos carregados nesta coleção.

readonly items: Word.Paragraph[];

Valor da propriedade

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.
  paragraph.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();
});

Devolve um Paragraph objeto que representa um novo parágrafo em branco adicionado ao documento.

add(range: Word.Range): Word.Paragraph;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove qualquer espaçamento antes dos parágrafos especificados.

closeUp(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Diminui o espaçamento antes e depois dos parágrafos em incrementos de seis pontos.

decreaseSpacing(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o primeiro parágrafo nesta coleção. Gera um ItemNotFound erro se a coleção estiver vazia.

getFirst(): Word.Paragraph;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

Exemplos

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

// Gets annotations found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations: Word.AnnotationCollection = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  console.log("Annotations found:");

  for (let i = 0; i < annotations.items.length; i++) {
    const annotation: Word.Annotation = annotations.items[i];

    console.log(`ID ${annotation.id} - state '${annotation.state}':`, annotation.critiqueAnnotation.critique);
  }
});

Obtém o primeiro parágrafo nesta coleção. Se a coleção estiver vazia, 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).

getFirstOrNullObject(): Word.Paragraph;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

Obtém o último parágrafo nesta coleção. Gera um ItemNotFound erro se a coleção estiver vazia.

getLast(): Word.Paragraph;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

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();
});

Obtém o último parágrafo nesta coleção. Se a coleção estiver vazia, 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).

getLastOrNullObject(): Word.Paragraph;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

Aumenta o espaçamento antes e depois de parágrafos, em incrementos de seis pontos.

increaseSpacing(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Avançar os parágrafos por um nível.

indent(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Avançar os parágrafos na coleção pelo número especificado de carateres.

indentCharacterWidth(count: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Avançar a primeira linha dos parágrafos na coleção pelo número especificado de carateres.

indentFirstLineCharacterWidth(count: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection;

Parâmetros

Retornos

Exemplos

// This example shows how to get the paragraphs in the Word document
// along with their text and font size properties.
// 
// 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 text and font properties.
    // It is best practice to always specify the property set. Otherwise, all properties are
    // returned in on the object.
    paragraphs.load('text, font/size');

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

    // Insert code that works with the paragraphs loaded by paragraphs.load().
});

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

Parâmetros

Retornos

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection;

Parâmetros

Retornos

Comuta o espaçamento antes dos parágrafos.

openOrCloseUp(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define como 12 pontos o espaçamento antes dos parágrafos especificados.

openUp(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove um nível de avanço para os parágrafos.

outdent(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aplica o próximo estilo de nível de título (Título 1 até Título 8) aos parágrafos especificados.

outlineDemote(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Despromover os parágrafos especificados para o corpo de texto ao aplicar o estilo Normal.

outlineDemoteToBody(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aplica o estilo de nível de cabeçalho anterior (Cabeçalho 1 a Título 8) aos parágrafos da coleção.

outlinePromote(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define os parágrafos especificados como espaçamento simples.

space1(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define os parágrafos especificados como espaçamento de 1,5 linhas.

space1Pt5(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define os parágrafos especificados como espaçamento duplo.

space2(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define um avanço pendente para o número especificado de tabulações.

tabHangingIndent(count: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define o avanço esquerdo dos parágrafos especificados para o número especificado de tabulações.

tabIndent(count: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.ParagraphCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ParagraphCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Word.Interfaces.ParagraphCollectionData;

Retornos

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

track(): Word.ParagraphCollection;

Retornos

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

untrack(): Word.ParagraphCollection;

Retornos