Word.ShapeFill class

Especifica el color de fondo del relleno de forma. Puede proporcionar el valor en el formato "#RRGGBB" o en el nombre del color.

backgroundColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Especifica el color de primer plano de relleno de forma. Puede proporcionar el valor en el formato "#RRGGBB" o en el nombre del color.

foregroundColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Especifica el porcentaje de transparencia del relleno como un valor entre 0,0 (opaco) y 1,0 (borrado). Devuelve null si el tipo de forma no admite la transparencia o si el relleno de la forma tiene una transparencia incoherente, como con un tipo de relleno degradado.

transparency: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Devuelve el tipo de relleno de la forma. Vea Word.ShapeFillType para más información.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Desactiva el formato de relleno de esta forma y la establece en Word.ShapeFillType.noFill.

clear(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Word.ShapeFill;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ShapeFill;

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.ShapeFill): void;

Parámetros

Devoluciones

Establece el formato de relleno de la forma en un color uniforme. Esto cambia el tipo de relleno a Word.ShapeFillType.solid.

setSolidColor(color: string): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

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

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.ShapeFill es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.ShapeFillData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.ShapeFillData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.ShapeFill;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.ShapeFill;

Devoluciones