Excel.HeaderFooterPicture class
Représente une image dans l’en-tête ou le pied de page d’une feuille de calcul.
- Extends
Propriétés
| brightness | Spécifie la luminosité de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (le plus sombre) et 1 (le plus clair). |
| color |
Spécifie le type de transformation de couleur de l’image. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| contrast | Spécifie le contraste de l’image. La valeur de cette propriété doit être un nombre compris entre 0,0 (contraste minimum) et 1,0 (contraste maximum). |
| crop |
Indique le nombre de points qui sont rognés en bas de l’image. |
| crop |
Spécifie le nombre de points qui sont rognés sur le côté gauche de l’image. |
| crop |
Spécifie le nombre de points qui sont rognés sur le côté droit de l’image. |
| crop |
Spécifie le nombre de points qui sont rognés du haut de l’image. |
| filename | Indique l’URL (sur l’intranet ou le web) ou le chemin (local ou réseau) de l’emplacement où l’objet source est enregistré. |
| height | Spécifie la hauteur de l’image en points. |
| lock |
Spécifie une valeur qui indique si l’image conserve ses proportions d’origine lorsqu’elle est redimensionnée.
|
| width | Spécifie la largeur de l’image en points. |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
brightness
Spécifie la luminosité de l’image. La valeur de cette propriété doit être un nombre compris entre 0.0 (le plus sombre) et 1 (le plus clair).
brightness: number;
Valeur de propriété
number
Remarques
colorType
Spécifie le type de transformation de couleur de l’image.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";
Valeur de propriété
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;
Valeur de propriété
contrast
Spécifie le contraste de l’image. La valeur de cette propriété doit être un nombre compris entre 0,0 (contraste minimum) et 1,0 (contraste maximum).
contrast: number;
Valeur de propriété
number
Remarques
cropBottom
Indique le nombre de points qui sont rognés en bas de l’image.
cropBottom: number;
Valeur de propriété
number
Remarques
cropLeft
Spécifie le nombre de points qui sont rognés sur le côté gauche de l’image.
cropLeft: number;
Valeur de propriété
number
Remarques
cropRight
Spécifie le nombre de points qui sont rognés sur le côté droit de l’image.
cropRight: number;
Valeur de propriété
number
Remarques
cropTop
Spécifie le nombre de points qui sont rognés du haut de l’image.
cropTop: number;
Valeur de propriété
number
Remarques
filename
Indique l’URL (sur l’intranet ou le web) ou le chemin (local ou réseau) de l’emplacement où l’objet source est enregistré.
filename: string;
Valeur de propriété
string
Remarques
height
Spécifie la hauteur de l’image en points.
height: number;
Valeur de propriété
number
Remarques
lockAspectRatio
Spécifie une valeur qui indique si l’image conserve ses proportions d’origine lorsqu’elle est redimensionnée.
true s’il conserve ses proportions ; sinon, false.
lockAspectRatio: boolean;
Valeur de propriété
boolean
Remarques
width
Spécifie la largeur de l’image en points.
width: number;
Valeur de propriété
number
Remarques
Détails de la méthode
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;
Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterPicture;
Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Excel.HeaderFooterPicture): void;
Paramètres
- properties
- Excel.HeaderFooterPicture
Retours
void
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.HeaderFooterPicture est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.HeaderFooterPictureDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.HeaderFooterPictureData;