Word.ParagraphChangedEventArgs interface

Pacote:
word

Fornece informações sobre os parágrafos que geraram o paragraphChanged evento.

Comentários

Conjunto de APIs: WordApi 1.6

Usada por

Exemplos

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

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

Propriedades

source

Especifica a origem do evento. Pode ser local ou remoto (por meio de coautoria).
type

Especifica o tipo de evento. Consulte Word.EventType para obter detalhes.
uniqueLocalIds

Obtém as IDs exclusivas dos parágrafos envolvidos. As IDs estão no formato GUID padrão 8-4-4-4-12 sem chaves e diferem entre sessões e coautores.

Detalhes da propriedade

source

Especifica a origem do evento. Pode ser local ou remoto (por meio de coautoria).

source: Word.EventSource | "Local" | "Remote";

Valor da propriedade

Word.EventSource | "Local" | "Remote"

Comentários

Conjunto de APIs: WordApi 1.6

type

Especifica o tipo de evento. Consulte Word.EventType para obter detalhes.

type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";

Valor da propriedade

Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"

Comentários

Conjunto de APIs: WordApi 1.6

uniqueLocalIds

Obtém as IDs exclusivas dos parágrafos envolvidos. As IDs estão no formato GUID padrão 8-4-4-4-12 sem chaves e diferem entre sessões e coautores.

uniqueLocalIds: 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/50-document/manage-annotations.yaml

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