Excel.RangeAreas class

Paquet:
excel

RangeAreas Représente un ensemble d’une ou plusieurs plages rectangulaires dans la même feuille de calcul. Pour savoir comment utiliser des plages non contiguës, consultez Travailler avec plusieurs plages simultanément dans les compléments Excel.

Extends
OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.9

Utilisateur

Propriétés

address

Renvoie la référence dans le RangeAreas style A1. La valeur Address contient le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuil1 ! A1 :B4, Feuil1 ! D1 :D4").
addressLocal

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

Renvoie le nombre de plages rectangulaires qui composent cet RangeAreas objet.
areas

Renvoie un ensemble de plages rectangulaires qui composent cet RangeAreas objet.
cellCount

Renvoie le nombre de cellules de 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

Renvoie une collection de mises en forme conditionnelles qui intersectent les cellules de cet RangeAreas objet.
context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
dataValidation

Renvoie un objet de validation des données pour toutes les plages du RangeAreas.
format

Renvoie un RangeFormat objet en 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 et 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 renvoyée. Pour les styles personnalisés, le nom du style est renvoyé. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est renvoyée.
worksheet

Renvoie la feuille de calcul de l’instance .RangeAreas

Méthodes

calculate()

Calcule toutes les cellules du RangeAreasfichier .
clear(applyTo)

Efface les valeurs, la mise en forme, le remplissage, la bordure et d’autres propriétés de chacune des zones qui composent cet RangeAreas objet.
clear(applyTo)

Efface les valeurs, la mise en forme, le remplissage, la bordure et d’autres propriétés de chacune des zones qui composent cet RangeAreas objet.
clearOrResetContents()

Efface les valeurs des cellules des plages, en accordant une attention particulière aux cellules contenant des contrôles. Si les plages ne contiennent que des valeurs vides et des contrôles définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Dans le cas contraire, les cellules avec les contrôles sont définies sur leur valeur par défaut et efface les valeurs des autres cellules des plages.
convertDataTypeToText()

Convertit toutes les cellules du RangeAreas type de données avec en texte.
convertToLinkedDataType(serviceID, languageCulture)

Convertit toutes les cellules du RangeAreas en 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 de la plage actuelle RangeAreas. La destination RangeAreas peut être d’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, copyType, skipBlanks, transpose)

Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas de la plage actuelle RangeAreas. La destination RangeAreas peut être d’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 l’intégralité des colonnes de ( RangeAreas par exemple, si la cellule actuelle RangeAreas représente les cellules « B4 :E11, H2 », elle renvoie a RangeAreas qui représente les colonnes « B :E, H :H »).
getEntireRow()

Renvoie un RangeAreas objet qui représente les lignes entières de ( RangeAreas par exemple, si la cellule actuelle RangeAreas représente les cellules « B4 :E11 », il retourne un RangeAreas qui représente les lignes « 4:11 »).
getIntersection(anotherRange)

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

Renvoie l’objet qui représente l’intersection RangeAreas des plages données ou RangeAreas. Si aucune intersection n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getOffsetRangeAreas(rowOffset, columnOffset)

Renvoie un RangeAreas objet qui est décalé par le décalage de ligne et de colonne spécifique. La dimension de l’objet retourné correspondra à celle de l’objet d’origine RangeAreas . Si le résultat RangeAreas est forcé en dehors des limites de la grille de la 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(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.
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 correspondant aux critères n’est trouvée, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
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 correspondant aux critères n’est trouvée, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getTables(fullyContained)

Renvoie une collection étendue de tables qui chevauchent une plage dans cet RangeAreas objet.
getUsedRangeAreas(valuesOnly)

Renvoie la valeur utilisée RangeAreas qui comprend toutes les zones utilisées des plages rectangulaires individuelles de l’objet RangeAreas . Si aucune cellule n’est utilisée dans le RangeAreas, l’erreur ItemNotFound est générée.
getUsedRangeAreasOrNullObject(valuesOnly)

Renvoie la valeur utilisée RangeAreas qui comprend toutes les zones utilisées des plages rectangulaires individuelles de l’objet RangeAreas . S’il n’y a pas de cellules utilisées dans le RangeAreas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’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.
select()

Sélectionne les zones de plage spécifiées dans l’interface utilisateur d’Excel.
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.
setDirty()

Définit le RangeAreas à recalculer lors du prochain recalcul.
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.RangeAreas est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeAreasDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 entre 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 suivis lors de la création initiale de l’objet.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 mémoire prenne effet.

Détails de la propriété

address

Renvoie la référence dans le RangeAreas style A1. La valeur Address contient le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuil1 ! A1 :B4, Feuil1 ! D1 :D4").

readonly address: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

addressLocal

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

readonly addressLocal: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

areaCount

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

readonly areaCount: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

areas

Renvoie un ensemble de plages rectangulaires qui composent cet RangeAreas objet.

readonly areas: Excel.RangeCollection;

Valeur de propriété

Excel.RangeCollection

Remarques

Jeu d’API : ExcelApi 1.9

cellCount

Renvoie le nombre de cellules de 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

Jeu d’API : ExcelApi 1.9

conditionalFormats

Renvoie une collection de mises en forme conditionnelles qui intersectent les cellules de cet RangeAreas objet.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valeur de propriété

Excel.ConditionalFormatCollection

Remarques

Jeu d’API : ExcelApi 1.9

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é

Excel.RequestContext

dataValidation

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

readonly dataValidation: Excel.DataValidation;

Valeur de propriété

Excel.DataValidation

Remarques

Jeu d’API : ExcelApi 1.9

format

Renvoie un RangeFormat objet en 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

Jeu 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

Jeu 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 et 5:7 »).

readonly isEntireRow: boolean;

Valeur de propriété

boolean

Remarques

Jeu 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 renvoyée. Pour les styles personnalisés, le nom du style est renvoyé. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est renvoyée.

style: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

worksheet

Renvoie la feuille de calcul de l’instance .RangeAreas

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

Jeu d’API : ExcelApi 1.9

Détails de la méthode

calculate()

Calcule toutes les cellules du RangeAreasfichier .

calculate(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.9

clear(applyTo)

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

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

Paramètres

applyTo
Excel.ClearApplyTo

Facultatif. Détermine le type d’action de suppression. Pour Excel.ClearApplyTo plus de détails. La valeur par défaut est « All ».

Retours

void

Remarques

Jeu d’API : ExcelApi 1.9

clear(applyTo)

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

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

Paramètres

applyTo

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

Facultatif. Détermine le type d’action de suppression. Pour Excel.ClearApplyTo plus de détails. La valeur par défaut est « All ».

Retours

void

Remarques

Jeu d’API : ExcelApi 1.9

clearOrResetContents()

Efface les valeurs des cellules des plages, en accordant une attention particulière aux cellules contenant des contrôles. Si les plages ne contiennent que des valeurs vides et des contrôles définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Dans le cas contraire, les cellules avec les contrôles sont définies sur leur valeur par défaut et efface les valeurs des autres cellules des plages.

clearOrResetContents(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.18

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.9

convertToLinkedDataType(serviceID, languageCulture)

Convertit toutes les cellules du RangeAreas en 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 linguistique pour interroger le service.

Retours

void

Remarques

Jeu 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 de la plage actuelle RangeAreas. La destination RangeAreas peut être d’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 à copier. Lorsque la source RangeAreas comporte plusieurs plages, leur 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 mise en forme à copier. La valeur par défaut est « All ».

skipBlanks

boolean

True si vous souhaitez ignorer les cellules vides de 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

Jeu 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 de la plage actuelle RangeAreas. La destination RangeAreas peut être d’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?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

sourceRange

Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à copier. Lorsque la source RangeAreas comporte plusieurs plages, leur forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyType

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

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

skipBlanks

boolean

True si vous souhaitez ignorer les cellules vides de 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

Jeu d’API : ExcelApi 1.9

getEntireColumn()

Renvoie un RangeAreas objet qui représente l’intégralité des colonnes de ( RangeAreas par exemple, si la cellule actuelle RangeAreas représente les cellules « B4 :E11, H2 », elle renvoie a RangeAreas qui représente les colonnes « B :E, H :H »).

getEntireColumn(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getEntireRow()

Renvoie un RangeAreas objet qui représente les lignes entières de ( RangeAreas par exemple, si la cellule actuelle RangeAreas représente les cellules « B4 :E11 », il retourne un RangeAreas qui représente les lignes « 4:11 »).

getEntireRow(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getIntersection(anotherRange)

Renvoie l’objet qui représente l’intersection RangeAreas des plages données 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

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

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getIntersectionOrNullObject(anotherRange)

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

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

Paramètres

anotherRange

Excel.Range | Excel.RangeAreas | string

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

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getOffsetRangeAreas(rowOffset, columnOffset)

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

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

Paramètres

rowOffset

number

Nombre de lignes (positif, négatif ou 0) dont le RangeAreas doit ê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) dont le RangeAreas doit ê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

Jeu 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 la valeur est l’un ou constants l’autre formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour renvoyer plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

Excel.RangeAreas

Remarques

Jeu 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: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

cellType

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

Type de cellules à inclure.

cellValueType

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

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

Retours

Excel.RangeAreas

Remarques

Jeu 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 correspondant aux critères n’est trouvée, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

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

Paramètres

cellType
Excel.SpecialCellType

Type de cellules à inclure.

cellValueType
Excel.SpecialCellValueType

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

Retours

Excel.RangeAreas

Remarques

Jeu 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 correspondant aux critères n’est trouvée, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

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

Paramètres

cellType

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

Type de cellules à inclure.

cellValueType

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

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

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getTables(fullyContained)

Renvoie une collection étendue de tables qui chevauchent une plage dans cet RangeAreas objet.

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

Paramètres

fullyContained

boolean

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

Retours

Excel.TableScopedCollection

Remarques

Jeu d’API : ExcelApi 1.9

getUsedRangeAreas(valuesOnly)

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

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

Paramètres

valuesOnly

boolean

Considère uniquement les cellules contenant des valeurs comme cellules utilisées. La valeur par défaut est false.

Retours

Excel.RangeAreas

Remarques

Jeu d’API : ExcelApi 1.9

getUsedRangeAreasOrNullObject(valuesOnly)

Renvoie la valeur utilisée RangeAreas qui comprend toutes les zones utilisées des plages rectangulaires individuelles de l’objet RangeAreas . S’il n’y a pas de cellules utilisées dans le RangeAreas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

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

Paramètres

valuesOnly

boolean

Considère uniquement les cellules contenant des valeurs comme cellules utilisées.

Retours

Excel.RangeAreas

Remarques

Jeu 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 spécifiant 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

select()

Sélectionne les zones de plage spécifiées dans l’interface utilisateur d’Excel.

select(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.18

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.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.RangeAreasUpdateData

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

Paramètres

properties
Excel.RangeAreas

Retours

void

setDirty()

Définit le RangeAreas à recalculer lors du prochain recalcul.

setDirty(): void;

Retours

void

Remarques

Jeu 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.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.RangeAreasDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 entre 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 suivis lors de la création initiale 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 l’abréviation de 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 mémoire prenne effet.

untrack(): Excel.RangeAreas;

Retours

Excel.RangeAreas