Excel.RangeAreas class

Paquet:

excel

RangeAreas représente une collection d’une ou plusieurs plages rectangulaires dans la même feuille de calcul. Pour savoir comment utiliser des plages décolorantes, consultez Utiliser plusieurs plages simultanément dans les compléments Excel.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

address	Retourne la référence dans le RangeAreas style A1. La valeur d’adresse contient le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Sheet1 ! A1 :B4, Feuille1 ! D1 :D4").
addressLocal	Retourne la RangeAreas référence dans les paramètres régionaux de l’utilisateur.
areaCount	Retourne le nombre de plages rectangulaires qui composent cet RangeAreas objet.
areas	Retourne une collection de plages rectangulaires qui composent cet RangeAreas objet.
cellCount	Renvoie le nombre de cellules dans l’objet RangeAreas , en additionnant le nombre de cellules de toutes les plages rectangulaires individuelles. Renvoie -1 si le nombre de cellules est supérieure à 2 ^ 31-1 (2 147 483 647).
conditionalFormats	Retourne une collection de formats conditionnels qui se croisent avec toutes les cellules de cet RangeAreas objet.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
dataValidation	Retourne un objet de validation de données pour toutes les plages du RangeAreas.
format	Retourne un RangeFormat objet, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés pour toutes les plages de l’objet RangeAreas .
isEntireColumn	Spécifie si toutes les plages de cet RangeAreas objet représentent des colonnes entières (par exemple, « A :C, Q :Z »).
isEntireRow	Spécifie si toutes les plages de cet RangeAreas objet représentent des lignes entières (par exemple, « 1:3, 5:7 »).
style	Représente le style de toutes les plages de cet RangeAreas objet. Si les styles des cellules sont incohérents, null est retourné. Pour les styles personnalisés, le nom du style est retourné. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est retournée.
worksheet	Retourne la feuille de calcul pour le actif RangeAreas.

Méthodes

calculate()	Calcule toutes les cellules du RangeAreas.
clear(applyTo)	Efface les valeurs, le format, le remplissage, la bordure et d’autres propriétés sur chacune des zones qui composent cet RangeAreas objet.
clear(applyToString)	Efface les valeurs, le format, le remplissage, la bordure et d’autres propriétés sur chacune des zones qui composent cet RangeAreas objet.
clearOrResetContents()	Efface les valeurs des cellules dans les plages, avec une attention particulière accordée aux cellules contenant des contrôles. Si les plages contiennent uniquement des valeurs vides et que les contrôles sont définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Sinon, cela définit les cellules avec des contrôles sur leur valeur par défaut et efface les valeurs des autres cellules dans les plages.
convertDataTypeToText()	Convertit toutes les cellules du RangeAreas avec les types de données en texte.
convertToLinkedDataType(serviceID, languageCulture)	Convertit toutes les cellules du en RangeAreas types de données liés.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas vers le actuel RangeAreas. La destination RangeAreas peut avoir une taille différente de celle de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source.
copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)	Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas vers le actuel RangeAreas. La destination RangeAreas peut avoir une taille différente de celle de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source.
getEntireColumn()	Renvoie un RangeAreas objet qui représente les colonnes entières du RangeAreas (par exemple, si le actuel RangeAreas représente les cellules « B4 :E11, H2 », il retourne un RangeAreas qui représente les colonnes « B :E, H :H »).
getEntireRow()	Renvoie un RangeAreas objet qui représente les lignes entières du RangeAreas (par exemple, si le actuel RangeAreas représente les cellules « B4 :E11 », il renvoie un RangeAreas qui représente les lignes « 4:11 »).
getIntersection(anotherRange)	Renvoie l’objet RangeAreas qui représente l’intersection des plages ou RangeAreas. Si aucune intersection n’est trouvée, une ItemNotFound erreur est générée.
getIntersectionOrNullObject(anotherRange)	Renvoie l’objet RangeAreas qui représente l’intersection des plages ou RangeAreas. Si aucune intersection n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getOffsetRangeAreas(rowOffset, columnOffset)	Retourne un RangeAreas objet décalé par le décalage de ligne et de colonne spécifique. La dimension du retourné RangeAreas correspond à l’objet d’origine. Si le résultat RangeAreas est forcé en dehors des limites de la grille de feuille de calcul, une erreur est générée.
getSpecialCells(cellType, cellValueType)	Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Lève une erreur si aucune cellule spéciale n’est trouvée qui corresponde au critère.
getSpecialCells(cellTypeString, cellValueTypeString)	Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Lève une erreur si aucune cellule spéciale n’est trouvée qui corresponde au critère.
getSpecialCellsOrNullObject(cellType, cellValueType)	Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale qui correspond aux critères n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale qui correspond aux critères n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getTables(fullyContained)	Retourne une collection délimitée de tables qui chevauchent n’importe quelle plage de cet RangeAreas objet.
getUsedRangeAreas(valuesOnly)	Retourne le utilisé RangeAreas qui comprend toutes les zones utilisées de plages rectangulaires individuelles dans l’objet RangeAreas . Si aucune cellule n’est utilisée dans , RangeAreasl’erreur ItemNotFound est générée.
getUsedRangeAreasOrNullObject(valuesOnly)	Retourne le utilisé RangeAreas qui comprend toutes les zones utilisées de plages rectangulaires individuelles dans l’objet RangeAreas . Si aucune cellule n’est utilisée dans , RangeAreascette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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(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(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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou 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.
setDirty()	Définit le RangeAreas à recalculer lorsque le recalcul suivant se produit.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.RangeAreas est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.RangeAreasDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de la mémoire ne prenne effet.

Détails de la propriété

address

Retourne la référence dans le RangeAreas style A1. La valeur d’adresse contient le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Sheet1 ! A1 :B4, Feuille1 ! D1 :D4").

readonly address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

addressLocal

Retourne la RangeAreas référence dans les paramètres régionaux de l’utilisateur.

readonly addressLocal: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

areaCount

Retourne le nombre de plages rectangulaires qui composent cet RangeAreas objet.

readonly areaCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

areas

Retourne une collection de plages rectangulaires qui composent cet RangeAreas objet.

readonly areas: Excel.RangeCollection;

Valeur de propriété

Excel.RangeCollection

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

cellCount

Renvoie le nombre de cellules dans l’objet RangeAreas , en additionnant le nombre de cellules de toutes les plages rectangulaires individuelles. Renvoie -1 si le nombre de cellules est supérieure à 2 ^ 31-1 (2 147 483 647).

readonly cellCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

conditionalFormats

Retourne une collection de formats conditionnels qui se croisent avec toutes les cellules de cet RangeAreas objet.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valeur de propriété

Excel.ConditionalFormatCollection

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

dataValidation

Retourne un objet de validation de données pour toutes les plages du RangeAreas.

readonly dataValidation: Excel.DataValidation;

Valeur de propriété

Excel.DataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

format

Retourne un RangeFormat objet, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés pour toutes les plages de l’objet RangeAreas .

readonly format: Excel.RangeFormat;

Valeur de propriété

Excel.RangeFormat

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with formulas.
    const formulaRanges = usedRange.getSpecialCells("Formulas");
    formulaRanges.format.fill.color = "lightgreen";

    await context.sync();
});

isEntireColumn

Spécifie si toutes les plages de cet RangeAreas objet représentent des colonnes entières (par exemple, « A :C, Q :Z »).

readonly isEntireColumn: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

isEntireRow

Spécifie si toutes les plages de cet RangeAreas objet représentent des lignes entières (par exemple, « 1:3, 5:7 »).

readonly isEntireRow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

style

Représente le style de toutes les plages de cet RangeAreas objet. Si les styles des cellules sont incohérents, null est retourné. Pour les styles personnalisés, le nom du style est retourné. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est retournée.

style: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

worksheet

Retourne la feuille de calcul pour le actif RangeAreas.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Détails de la méthode

calculate()

Calcule toutes les cellules du RangeAreas.

calculate(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

clear(applyTo)

Efface les valeurs, le format, le remplissage, la bordure et d’autres propriétés sur chacune des zones qui composent cet RangeAreas objet.

clear(applyTo?: Excel.ClearApplyTo): void;

Paramètres

applyTo

Excel.ClearApplyTo

Optional. Détermine le type d’action de suppression. Pour plus d’informations, consultez Excel.ClearApplyTo . La valeur par défaut est « All ».

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

clear(applyToString)

Efface les valeurs, le format, le remplissage, la bordure et d’autres propriétés sur chacune des zones qui composent cet RangeAreas objet.

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Paramètres

applyToString

"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

Optional. Détermine le type d’action de suppression. Pour plus d’informations, consultez Excel.ClearApplyTo . La valeur par défaut est « All ».

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

clearOrResetContents()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Efface les valeurs des cellules dans les plages, avec une attention particulière accordée aux cellules contenant des contrôles. Si les plages contiennent uniquement des valeurs vides et que les contrôles sont définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Sinon, cela définit les cellules avec des contrôles sur leur valeur par défaut et efface les valeurs des autres cellules dans les plages.

clearOrResetContents(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

convertDataTypeToText()

Convertit toutes les cellules du RangeAreas avec les types de données en texte.

convertDataTypeToText(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Convertit toutes les cellules du en RangeAreas types de données liés.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Paramètres

serviceID

number

ID de service qui sera utilisé pour interroger les données.

languageCulture

string

Culture de langage pour laquelle interroger le service.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas vers le actuel RangeAreas. La destination RangeAreas peut avoir une taille différente de celle de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

sourceRange

Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à partir de laquelle effectuer la copie. Lorsque la source RangeAreas a plusieurs plages, sa forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyType

Excel.RangeCopyType

Type de données de cellule ou de mise en forme à copier. La valeur par défaut est « All ».

skipBlanks

boolean

True si vous souhaitez ignorer les cellules vides dans la plage source ou RangeAreas. La valeur par défaut est False.

transpose

boolean

True si pour transposer les cellules dans la destination RangeAreas. La valeur par défaut est False.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas vers le actuel RangeAreas. La destination RangeAreas peut avoir une taille différente de celle de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source.

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

sourceRange

Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à partir de laquelle effectuer la copie. Lorsque la source RangeAreas a plusieurs plages, sa forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyTypeString

"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

Type de données de cellule ou de mise en forme à copier. La valeur par défaut est « All ».

skipBlanks

boolean

True si vous souhaitez ignorer les cellules vides dans la plage source ou RangeAreas. La valeur par défaut est False.

transpose

boolean

True si pour transposer les cellules dans la destination RangeAreas. La valeur par défaut est False.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getEntireColumn()

Renvoie un RangeAreas objet qui représente les colonnes entières du RangeAreas (par exemple, si le actuel RangeAreas représente les cellules « B4 :E11, H2 », il retourne un RangeAreas qui représente les colonnes « B :E, H :H »).

getEntireColumn(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getEntireRow()

Renvoie un RangeAreas objet qui représente les lignes entières du RangeAreas (par exemple, si le actuel RangeAreas représente les cellules « B4 :E11 », il renvoie un RangeAreas qui représente les lignes « 4:11 »).

getEntireRow(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getIntersection(anotherRange)

Renvoie l’objet RangeAreas qui représente l’intersection des plages ou RangeAreas. Si aucune intersection n’est trouvée, une ItemNotFound erreur est générée.

getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Paramètres

anotherRange

Excel.Range | Excel.RangeAreas | string

Plage, RangeAreas objet ou adresse de plage qui sera utilisé pour déterminer l’intersection.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

Renvoie l’objet RangeAreas qui représente l’intersection des plages ou RangeAreas. Si aucune intersection n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;

Paramètres

anotherRange

Excel.Range | Excel.RangeAreas | string

Plage, RangeAreas objet ou adresse qui sera utilisé pour déterminer l’intersection.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

Retourne un RangeAreas objet décalé par le décalage de ligne et de colonne spécifique. La dimension du retourné RangeAreas correspond à l’objet d’origine. Si le résultat RangeAreas est forcé en dehors des limites de la grille de feuille de calcul, une erreur est générée.

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

Paramètres

rowOffset

number

Nombre de lignes (positives, négatives ou 0) par lesquelles doit RangeAreas être décalé. Les valeurs positives représentent un décalage vers le bas, et les valeurs négatives un décalage vers le haut.

columnOffset

number

Nombre de colonnes (positives, négatives ou 0) par lesquelles doit RangeAreas être décalé. Les valeurs positives représentent un décalage vers la droite, et les valeurs négatives un décalage vers la gauche.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Lève une erreur si aucune cellule spéciale n’est trouvée qui corresponde au critère.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Paramètres

cellType

Excel.SpecialCellType

Type de cellules à inclure.

cellValueType

Excel.SpecialCellValueType

Si cellType est constants ou formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour retourner plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueTypeString)

Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Lève une erreur si aucune cellule spéciale n’est trouvée qui corresponde au critère.

getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Type de cellules à inclure.

cellValueTypeString

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType est constants ou formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour retourner plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale qui correspond aux critères n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Paramètres

cellType

Excel.SpecialCellType

Type de cellules à inclure.

cellValueType

Excel.SpecialCellValueType

Si cellType est constants ou formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour retourner plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

Renvoie un RangeAreas objet qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale qui correspond aux critères n’est trouvée, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Type de cellules à inclure.

cellValueTypeString

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Si cellType est constants ou formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour retourner plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getTables(fullyContained)

Retourne une collection délimitée de tables qui chevauchent n’importe quelle plage de cet RangeAreas objet.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Paramètres

fullyContained

boolean

Si truela valeur est , retourne uniquement les tables qui sont entièrement contenues dans les limites de plage. La valeur par défaut est false.

Retours

Excel.TableScopedCollection

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

Retourne le utilisé RangeAreas qui comprend toutes les zones utilisées de plages rectangulaires individuelles dans l’objet RangeAreas . Si aucune cellule n’est utilisée dans , RangeAreasl’erreur ItemNotFound est générée.

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

Paramètres

valuesOnly

boolean

Indique s’il faut considérer uniquement les cellules avec des valeurs comme cellules utilisées. La valeur par défaut est false.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

Retourne le utilisé RangeAreas qui comprend toutes les zones utilisées de plages rectangulaires individuelles dans l’objet RangeAreas . Si aucune cellule n’est utilisée dans , RangeAreascette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

Paramètres

valuesOnly

boolean

Indique s’il faut considérer uniquement les cellules avec des valeurs comme cellules utilisées.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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.RangeAreasLoadOptions): Excel.RangeAreas;

Paramètres

options

Excel.Interfaces.RangeAreasLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.RangeAreas

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.RangeAreas;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.RangeAreas

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.RangeAreas;

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

Excel.RangeAreas

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.RangeAreasUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.RangeAreas): void;

Paramètres

properties

Excel.RangeAreas

Retours

void

setDirty()

Définit le RangeAreas à recalculer lorsque le recalcul suivant se produit.

setDirty(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.RangeAreas est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.RangeAreasDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.RangeAreasData;

Retours

Excel.Interfaces.RangeAreasData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet.

track(): Excel.RangeAreas;

Retours

Excel.RangeAreas

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de la mémoire ne prenne effet.

untrack(): Excel.RangeAreas;

Retours

Excel.RangeAreas