Excel.HeaderFooterPicture class
Representa una imagen en el encabezado o pie de página de una hoja de cálculo.
- Extends
Comentarios
Propiedades
| brightness | Especifica el brillo de la imagen. El valor de esta propiedad debe ser un número de 0,0 (atenuación máxima) a 1,0 (brillo máximo). |
| color |
Especifica el tipo de transformación de color de la imagen. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| contrast | Especifica el contraste de la imagen. El valor de esta propiedad debe ser un número de 0,0 (mínimo contraste) a 1,0 (la mayoría del contraste). |
| crop |
Especifica el número de puntos que se recortan de la parte inferior de la imagen. |
| crop |
Especifica el número de puntos recortados del lado izquierdo de la imagen. |
| crop |
Especifica el número de puntos que se recortan del lado derecho de la imagen. |
| crop |
Especifica el número de puntos que se recortan de la parte superior de la imagen. |
| filename | Especifica la dirección URL (en la intranet o la web) o la ruta de acceso (local o de red) a la ubicación donde se guarda el objeto de origen. |
| height | Especifica el alto de la imagen en puntos. |
| lock |
Especifica un valor que indica si la imagen conserva sus proporciones originales al cambiar el tamaño.
|
| width | Especifica el ancho de la imagen en puntos. |
Métodos
| 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. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
brightness
Especifica el brillo de la imagen. El valor de esta propiedad debe ser un número de 0,0 (atenuación máxima) a 1,0 (brillo máximo).
brightness: number;
Valor de propiedad
number
Comentarios
colorType
Especifica el tipo de transformación de color de la imagen.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
Valor de propiedad
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Comentarios
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
contrast
Especifica el contraste de la imagen. El valor de esta propiedad debe ser un número de 0,0 (mínimo contraste) a 1,0 (la mayoría del contraste).
contrast: number;
Valor de propiedad
number
Comentarios
cropBottom
Especifica el número de puntos que se recortan de la parte inferior de la imagen.
cropBottom: number;
Valor de propiedad
number
Comentarios
cropLeft
Especifica el número de puntos recortados del lado izquierdo de la imagen.
cropLeft: number;
Valor de propiedad
number
Comentarios
cropRight
Especifica el número de puntos que se recortan del lado derecho de la imagen.
cropRight: number;
Valor de propiedad
number
Comentarios
cropTop
Especifica el número de puntos que se recortan de la parte superior de la imagen.
cropTop: number;
Valor de propiedad
number
Comentarios
filename
Especifica la dirección URL (en la intranet o la web) o la ruta de acceso (local o de red) a la ubicación donde se guarda el objeto de origen.
filename: string;
Valor de propiedad
string
Comentarios
height
Especifica el alto de la imagen en puntos.
height: number;
Valor de propiedad
number
Comentarios
lockAspectRatio
Especifica un valor que indica si la imagen conserva sus proporciones originales al cambiar el tamaño.
true si conserva sus proporciones; De lo contrario, false.
lockAspectRatio: boolean;
Valor de propiedad
boolean
Comentarios
width
Especifica el ancho de la imagen en puntos.
width: number;
Valor de propiedad
number
Comentarios
Detalles del método
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.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;
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.HeaderFooterPicture;
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.HeaderFooterPicture;
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.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
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.HeaderFooterPicture): void;
Parámetros
- properties
- Excel.HeaderFooterPicture
Devoluciones
void
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.HeaderFooterPicture es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.HeaderFooterPictureData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.HeaderFooterPictureData;