Excel.ShapeFill class
Representa el formato de relleno de un objeto de forma.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.9 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| foreground |
Representa el color de primer plano del relleno de formas en formato de color HTML, en el formulario #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja") |
| transparency | Especifica el porcentaje de transparencia del relleno como un valor de 0,0 (opaco) a 1,0 (claro). Devuelve |
| type | Devuelve el tipo de relleno de la forma. Vea |
Métodos
| clear() | Limpia el formato de relleno de esta forma. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| 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. |
| set |
Establece el formato de relleno de la forma en un color uniforme. Esto cambia el tipo de relleno a "Sólido". |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
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
Representa el color de primer plano del relleno de formas en formato de color HTML, en el formulario #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")
foregroundColor: string;Valor de propiedad
string
Comentarios
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
type
Devuelve el tipo de relleno de la forma. Vea Excel.ShapeFillType para más información.
readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";Valor de propiedad
Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"
Comentarios
Detalles del método
clear()
Limpia el formato de relleno de esta forma.
clear(): void;Devoluciones
void
Comentarios
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?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;Parámetros
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[]): Excel.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;
}): Excel.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
- Excel.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: Excel.ShapeFill): void;Parámetros
- properties
- Excel.ShapeFill
Devoluciones
void
setSolidColor(color)
Establece el formato de relleno de la forma en un color uniforme. Esto cambia el tipo de relleno a "Sólido".
setSolidColor(color: string): void;Parámetros
- color
-
string
Cadena que representa el color de relleno en formato de color HTML, en el formulario #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
Devoluciones
void
Comentarios
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 Excel.ShapeFill es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ShapeFillData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ShapeFillData;