Excel.RangeView class
RangeView représente un ensemble de cellules visibles de la plage parent.
- Extends
Remarques
Utilisateur
Propriétés
| cell |
Représente les adresses de cellules du |
| column |
Nombre de colonnes visibles. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| formulas | Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place. |
| formulas |
Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place. |
| formulasR1C1 | Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place. |
| index | Renvoie une valeur qui représente l’index de . |
| number |
Représente le code de format de nombre d’Excel pour une cellule donnée. |
| row |
Nombre de lignes visibles. |
| rows | Représente une collection d’affichages de plage associés à la plage. |
| text | Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API. |
| values | Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être de type chaîne, numérique ou booléen. Les cellules contenant une erreur renvoie la chaîne d’erreur. |
| values |
Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à |
| values |
Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à |
| value |
Représente le type de données de chaque cellule. |
Méthodes
| get |
Obtient la plage parente associée à l’actuel |
| 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é
cellAddresses
Représente les adresses de cellules du RangeViewfichier .
readonly cellAddresses: any[][];
Valeur de propriété
any[][]
Remarques
columnCount
Nombre de colonnes visibles.
readonly columnCount: number;
Valeur de propriété
number
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é
formulas
Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.
formulas: any[][];
Valeur de propriété
any[][]
Remarques
formulasLocal
Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.
formulasLocal: any[][];
Valeur de propriété
any[][]
Remarques
formulasR1C1
Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.
formulasR1C1: any[][];
Valeur de propriété
any[][]
Remarques
index
Renvoie une valeur qui représente l’index de .RangeView
readonly index: number;
Valeur de propriété
number
Remarques
numberFormat
Représente le code de format de nombre d’Excel pour une cellule donnée.
numberFormat: any[][];
Valeur de propriété
any[][]
Remarques
rowCount
Nombre de lignes visibles.
readonly rowCount: number;
Valeur de propriété
number
Remarques
rows
Représente une collection d’affichages de plage associés à la plage.
readonly rows: Excel.RangeViewCollection;
Valeur de propriété
Remarques
text
Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API.
readonly text: string[][];
Valeur de propriété
string[][]
Remarques
values
Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être de type chaîne, numérique ou booléen. Les cellules contenant une erreur renvoie la chaîne d’erreur.
values: any[][];
Valeur de propriété
any[][]
Remarques
valuesAsJson
Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à RangeView.values, RangeView.valuesAsJson prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées à partir de cette API s’alignent toujours sur les paramètres régionaux fr-FR. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez RangeView.valuesAsJsonLocal.
valuesAsJson: CellValue[][];
Valeur de propriété
Excel.CellValue[][]
Remarques
valuesAsJsonLocal
Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à RangeView.values, RangeView.valuesAsJsonLocal prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez RangeView.valuesAsJson.
valuesAsJsonLocal: CellValue[][];
Valeur de propriété
Excel.CellValue[][]
Remarques
valueTypes
Représente le type de données de chaque cellule.
readonly valueTypes: Excel.RangeValueType[][];
Valeur de propriété
Remarques
Détails de la méthode
getRange()
Obtient la plage parente associée à l’actuel RangeView.
getRange(): Excel.Range;
Retours
Remarques
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.RangeViewLoadOptions): Excel.RangeView;
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.RangeView;
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.RangeView;
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.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- Excel.Interfaces.RangeViewUpdateData
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.RangeView): void;
Paramètres
- properties
- Excel.RangeView
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.RangeView est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeViewDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.RangeViewData;