Excel.RangeFormat class
Objet de format qui comprend les propriétés de police, de remplissage, de bordures, d’alignement et d’autres propriétés de la plage.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.1]
Propriétés
| auto |
Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale. |
| borders | Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage. |
| column |
Spécifie la largeur de toutes les colonnes dans la plage. Si la largeur des colonnes n’est pas uniforme, |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| fill | Renvoie l’objet de remplissage défini sur la plage globale. |
| font | Renvoie l’objet de police défini sur l’ensemble de la plage. |
| horizontal |
Représente l’alignement horizontal de l’objet spécifié. Pour |
| indent |
Entier compris entre 0 à 250 qui indique le niveau de retrait du style. |
| protection | Renvoie l’objet de protection du format pour une plage. |
| reading |
L’ordre de lecture de la plage. |
| row |
Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, |
| shrink |
Spécifie si le texte est automatiquement réduit pour s’adapter à la largeur de colonne disponible. |
| text |
Orientation du texte de toutes les cellules dans la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation à l’intérieur d’une plage n’est pas uniforme, elle |
| use |
Détermine si la hauteur de ligne de l’objet |
| use |
Indique si la largeur de colonne de l’objet |
| vertical |
Représente l’alignement vertical de l’objet spécifié. Pour |
| wrap |
Indique si Excel encapsule le texte dans l’objet. Une |
Méthodes
| adjust |
Ajuste le retrait de la mise en forme de la plage. La valeur de retrait comprise entre 0 et 250 est mesurée en caractères. |
| autofit |
Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes. |
| autofit |
Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes. |
| 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é
autoIndent
Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.
autoIndent: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.9]
borders
Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.
readonly borders: Excel.RangeBorderCollection;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.1]
columnWidth
Spécifie la largeur de toutes les colonnes dans la plage. Si la largeur des colonnes n’est pas uniforme, null est renvoyée.
columnWidth: number;
Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.2]
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é
fill
Renvoie l’objet de remplissage défini sur la plage globale.
readonly fill: Excel.RangeFill;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.1]
font
Renvoie l’objet de police défini sur l’ensemble de la plage.
readonly font: Excel.RangeFont;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.1]
horizontalAlignment
Représente l’alignement horizontal de l’objet spécifié. Pour Excel.HorizontalAlignment plus de détails.
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";
Valeur de propriété
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.1]
indentLevel
Entier compris entre 0 à 250 qui indique le niveau de retrait du style.
indentLevel: number;
Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.9]
protection
Renvoie l’objet de protection du format pour une plage.
readonly protection: Excel.FormatProtection;
Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.2]
readingOrder
L’ordre de lecture de la plage.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";
Valeur de propriété
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Remarques
[Jeu d’API : ExcelApi 1.9]
rowHeight
Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, null est renvoyée.
rowHeight: number;
Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.2]
shrinkToFit
Spécifie si le texte est automatiquement réduit pour s’adapter à la largeur de colonne disponible.
shrinkToFit: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.9]
textOrientation
Orientation du texte de toutes les cellules dans la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation à l’intérieur d’une plage n’est pas uniforme, elle null est renvoyée.
textOrientation: number;
Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
useStandardHeight
Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Renvoie true cette valeur si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Renvoie null si la plage contient plusieurs lignes et que les lignes n’ont pas toutes la même hauteur. Retourne false dans le cas contraire. Remarque : Cette propriété est uniquement destinée à être définie sur true. Le définir sur n’a false aucun effet.
useStandardHeight: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
useStandardWidth
Indique si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Affiche true une valeur indique que la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Renvoie des données null si la plage contient plusieurs colonnes et que les colonnes n’ont pas toutes la même hauteur. Retourne false dans le cas contraire. Remarque : Cette propriété est uniquement destinée à être définie sur true. Le définir sur n’a false aucun effet.
useStandardWidth: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
verticalAlignment
Représente l’alignement vertical de l’objet spécifié. Pour Excel.VerticalAlignment plus de détails.
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";
Valeur de propriété
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.1]
wrapText
Indique si Excel encapsule le texte dans l’objet. Une null valeur indique que toute la plage n’a pas de paramètre d’habillage uniforme
wrapText: boolean;
Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.1]
Détails de la méthode
adjustIndent(amount)
Ajuste le retrait de la mise en forme de la plage. La valeur de retrait comprise entre 0 et 250 est mesurée en caractères.
adjustIndent(amount: number): void;
Paramètres
- amount
-
number
Nombre d’espaces par lequel le retrait actif est ajusté. Cette valeur doit être comprise entre -250 et 250. Remarque : Si le montant augmente le niveau de retrait au-dessus de 250, le niveau de retrait reste à 250. De même, si le montant abaisse le niveau de retrait en dessous de 0, le niveau de retrait reste à 0.
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.11]
autofitColumns()
Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
autofitColumns(): void;
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.2]
autofitRows()
Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
autofitRows(): void;
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.2]
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.RangeFormatLoadOptions): Excel.RangeFormat;
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.RangeFormat;
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.RangeFormat;
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.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- Excel.Interfaces.RangeFormatUpdateData
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.RangeFormat): void;
Paramètres
- properties
- Excel.RangeFormat
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.RangeFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.RangeFormatData;