Word.ShapeFill class

Especifica a cor de fundo do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

backgroundColor: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

Especifica a cor de primeiro plano do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

foregroundColor: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Especifica a percentagem de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro). Devolve null se o tipo de forma não suportar transparência ou se o preenchimento da forma tiver transparência inconsistente, tal como com um tipo de preenchimento com gradação de cor.

transparency: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Retorna o tipo de preenchimento da forma. Veja Word.ShapeFillType para obter detalhes.

readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Limpa a formatação de preenchimento desta forma e define-a como Word.ShapeFillType.noFill.

clear(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Exemplos

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

await Word.run(async (context) => {
  // Sets color fill properties of the first moon found in the document body.
  const moon: Word.Shape = context.document.body.shapes
    .getByGeometricTypes([Word.GeometricShapeType.moon])
    .getFirstOrNullObject();
  moon.load("fill");
  await context.sync();

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

  const moonFill: Word.ShapeFill = moon.fill;
  console.log("Current fill properties of the first moon found in the document body:", moonFill);

  moonFill.setSolidColor("green");
  moonFill.load();
  await context.sync();

  console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});

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.ShapeFillLoadOptions): Word.ShapeFill;

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

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

Parâmetros

Retornos

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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Word.ShapeFill): void;

Parâmetros

Retornos

Define a formatação de preenchimento de um formato com uma cor uniforme. Esta ação altera o tipo de preenchimento para Word.ShapeFillType.solid.

setSolidColor(color: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Exemplos

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

await Word.run(async (context) => {
  // Sets color fill properties of the first moon found in the document body.
  const moon: Word.Shape = context.document.body.shapes
    .getByGeometricTypes([Word.GeometricShapeType.moon])
    .getFirstOrNullObject();
  moon.load("fill");
  await context.sync();

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

  const moonFill: Word.ShapeFill = moon.fill;
  console.log("Current fill properties of the first moon found in the document body:", moonFill);

  moonFill.setSolidColor("green");
  moonFill.load();
  await context.sync();

  console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});

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.ShapeFill é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShapeFillData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ShapeFillData;

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

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

Retornos