Compartir a través de


Word.ShapeFill class

Representa el formato de relleno de un objeto de forma.

Extends

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Propiedades

backgroundColor

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

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

foregroundColor

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

transparency

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

type

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

Métodos

clear()

Borra el formato de relleno de esta forma y la Word.ShapeFillType.NoFillestablece en ;

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

setSolidColor(color)

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

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.ShapeFill es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeFillData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 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.

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

backgroundColor

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

backgroundColor: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

foregroundColor

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

foregroundColor: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

transparency

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

transparency: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

type

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

Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Detalles del método

clear()

Borra el formato de relleno de esta forma y la Word.ShapeFillType.NoFillestablece en ;

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

load(options)

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

options
Word.Interfaces.ShapeFillLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

set(properties, options)

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

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

Parámetros

properties
Word.Interfaces.ShapeFillUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.ShapeFill): void;

Parámetros

properties
Word.ShapeFill

Devoluciones

void

setSolidColor(color)

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

color

string

Cadena que representa el color de primer plano de relleno. Puede proporcionar el valor en el formato "#RRGGBB" o en el nombre del color.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.ShapeFill es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeFillData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.ShapeFillData;

Devoluciones

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 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

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.ShapeFill;

Devoluciones