Word.Canvas class

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

Obtém um número inteiro que representa o identificador de tela.

readonly id: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém o Shape objeto associado à tela.

readonly shape: Word.Shape;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém a coleção do Word. Formar objetos. Atualmente, há suporte apenas para caixas de texto, imagens e formas geométricas.

readonly shapes: Word.ShapeCollection;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Exemplos

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

await Word.run(async (context) => {
  // Gets the first canvas found in the document body.
  const canvasShape: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.canvas])
    .getFirstOrNullObject();
  canvasShape.load();
  canvasShape.load("canvas/shapes");
  await context.sync();

  if (canvasShape.isNullObject) {
    console.log("No canvases found in the document body.");
    return;
  }

  console.log("First canvas found in the document body:", canvasShape);
  console.log("Shapes associated with the first canvas:", canvasShape.canvas.shapes);
  canvasShape.select();
});

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.CanvasLoadOptions): Word.Canvas;

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(propertyNames?: string | string[]): Word.Canvas;

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?: {
            select?: string;
            expand?: string;
        }): Word.Canvas;

Parâmetros

Retornos

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

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

Parâmetros

Retornos

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

set(properties: Word.Canvas): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Canvas é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CanvasData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.CanvasData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Canvas;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Canvas;

Retornos