Excel.RangeAreas class

RangeAreas représente une collection d’une ou plusieurs plages rectangulaires dans la même feuille de calcul. Pour apprendre à utiliser des plages peuigues, lisez Travailler avec plusieurs plages simultanément dans Excel des modules.

Extends

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Propriétés

address

Renvoie la RangeAreas référence en style A1. La valeur d’adresse contient le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuille1 ! A1:B4, Sheet1! 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 une collection de plages rectangulaires qui composent cet RangeAreas objet.

cellCount

Renvoie le nombre de cellules dans l’objet, récapitulant le nombre de cellules de toutes les RangeAreas 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 formats conditionnels qui se coupent avec les cellules de cet RangeAreas objet.

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

dataValidation

Renvoie un objet de validation de données pour toutes les plages dans le RangeAreas.

format

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

isEntireColumn

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

isEntireRow

Spécifie si toutes les plages de cet objet représentent des lignes RangeAreas 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 ils sont renvoyés. 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’enum BuiltInStyle est renvoyée.

worksheet

Renvoie la feuille de calcul pour l’actuel RangeAreas.

Méthodes

calculate()

Calcule toutes les cellules dans le RangeAreas.

clear(applyTo)

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

clear(applyToString)

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

convertDataTypeToText()

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

convertToLinkedDataType(serviceID, languageCulture)

Convertit toutes les cellules de l’ensemble 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 taille de la destination RangeAreas peut être différente de la plage source ou RangeAreas. La destination est automatiquement étendue 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 de la plage actuelle RangeAreas. La taille de la destination RangeAreas peut être différente de la plage source ou RangeAreas. La destination est automatiquement étendue si elle est plus petite que la source.

getEntireColumn()

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

getEntireRow()

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

getIntersection(anotherRange)

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

getIntersectionOrNullObject(anotherRange)

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

getOffsetRangeAreas(rowOffset, columnOffset)

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

getSpecialCells(cellType, cellValueType)

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

getSpecialCells(cellTypeString, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas 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 objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas spécifiés. Si aucune cellule spéciale ne correspond aux critères, cette méthode renvoie un objet dont la propriété isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas spécifiés. Si aucune cellule spéciale ne correspond aux critères, cette méthode renvoie un objet dont la propriété isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getTables(fullyContained)

Renvoie une collection étendue de tableaux qui chevauchent n’importe quelle plage de cet RangeAreas objet.

getUsedRangeAreas(valuesOnly)

Renvoie l’objet utilisé qui comprend toutes les zones utilisées RangeAreas de plages rectangulaires individuelles dans l’objet. RangeAreas S’il n’existe aucune cellule utilisée dans le RangeAreas, ItemNotFound l’erreur sera lancée.

getUsedRangeAreasOrNullObject(valuesOnly)

Renvoie l’objet utilisé qui comprend toutes les zones utilisées RangeAreas de plages rectangulaires individuelles dans l’objet. RangeAreas S’il n’existe aucune cellule utilisée dans le RangeAreas, puis cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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 transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

setDirty()

Définit les RangeAreas données à recalculer lors du recalcul suivant.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. Objet RangeAreas est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.RangeAreasData) qui contient des copies superficiels 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 les 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 avoir ajouté l’objet à la collection d’objets suivis lors de la première création de .sync 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 devrez appeler avant context.sync() que la libération de mémoire prenne effet.

Détails de la propriété

address

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

readonly address: string;

Valeur de propriété

string

Remarques

[Ensemble 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

[Ensemble 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

[Ensemble d’API : ExcelApi 1.9 ]

areas

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

readonly areas: Excel.RangeCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

cellCount

Renvoie le nombre de cellules dans l’objet, récapitulant le nombre de cellules de toutes les RangeAreas 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

Renvoie une collection de formats conditionnels qui se coupent avec les cellules de cet RangeAreas objet.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

dataValidation

Renvoie un objet de validation de données pour toutes les plages dans le RangeAreas.

readonly dataValidation: Excel.DataValidation;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

format

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

readonly format: Excel.RangeFormat;

Valeur de propriété

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 objet représentent des colonnes entières RangeAreas (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 objet représentent des lignes RangeAreas 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 ils sont renvoyés. 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’enum BuiltInStyle est renvoyée.

style: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

worksheet

Renvoie la feuille de calcul pour l’actuel RangeAreas.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Détails de la méthode

calculate()

Calcule toutes les cellules dans le RangeAreas.

calculate(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

clear(applyTo)

Cette propriété permet d’effacer les valeurs, le format, 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 d’informations, voir. La valeur par défaut est « All ».

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

clear(applyToString)

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

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

Paramètres

applyToString

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

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

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Convertit toutes les cellules de l’ensemble 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 de langue pour l’interrogation du 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 de la plage actuelle RangeAreas. La taille de la destination RangeAreas peut être différente de la plage source ou RangeAreas. La destination est automatiquement étendue 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 la copie. Lorsque la source possède plusieurs plages, leur formulaire doit pouvoir être créé en supprimant des lignes ou des RangeAreas 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 pour 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 de la plage actuelle RangeAreas. La taille de la destination RangeAreas peut être différente de la plage source ou RangeAreas. La destination est automatiquement étendue si elle est plus petite que la source.

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

Paramètres

sourceRange

Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à partir de la copie. Lorsque la source possède plusieurs plages, leur formulaire doit pouvoir être créé en supprimant des lignes ou des RangeAreas colonnes complètes d’une plage rectangulaire.

copyTypeString

"All" | "Formulas" | "Values" | "Formats"

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

skipBlanks

boolean

True si pour 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 objet qui représente les colonnes entières de l'(par exemple, si le courant représente les cellules RangeAreas « B4:E11, H2 », il renvoie un qui représente les RangeAreas RangeAreas RangeAreas colonnes « B:E, H:H »).

getEntireColumn(): Excel.RangeAreas;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getEntireRow()

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

getEntireRow(): Excel.RangeAreas;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getIntersection(anotherRange)

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

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

Paramètres

anotherRange

Excel.Range | Excel.RangeAreas | string

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

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

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

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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

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

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

Paramètres

rowOffset

number

Nombre de lignes (positif, négatif ou 0) par lequel RangeAreas 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 (positif, négatif ou 0) par lequel RangeAreas décaler. Les valeurs positives représentent un décalage vers la droite, et les valeurs négatives un décalage vers la gauche.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas 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 l’une ou constants l’autre de ces deux 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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas 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", cellValueType?: "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.

cellValueType

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

Si cellType l’une ou constants l’autre de ces deux 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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas spécifiés. Si aucune cellule spéciale ne correspond aux critères, cette méthode renvoie un objet dont la propriété isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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

Paramètres

cellType
Excel.SpecialCellType

Type de cellules à inclure.

cellValueType
Excel.SpecialCellValueType

Si cellType l’une ou constants l’autre de ces deux 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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Renvoie un objet qui représente toutes les cellules qui correspondent au type et à la valeur RangeAreas spécifiés. Si aucune cellule spéciale ne correspond aux critères, cette méthode renvoie un objet dont la propriété isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "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.

cellValueType

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

Si cellType l’une ou constants l’autre de ces deux 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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getTables(fullyContained)

Renvoie une collection étendue de tableaux qui chevauchent n’importe quelle plage de cet RangeAreas objet.

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

Paramètres

fullyContained

boolean

If true, renvoie uniquement les tableaux qui sont entièrement contenus dans les limites de la plage. La valeur par défaut est false.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

Renvoie l’objet utilisé qui comprend toutes les zones utilisées RangeAreas de plages rectangulaires individuelles dans l’objet. RangeAreas S’il n’existe aucune cellule utilisée dans le RangeAreas, ItemNotFound l’erreur sera lancée.

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

Paramètres

valuesOnly

boolean

S’il faut prendre en compte uniquement les cellules avec des valeurs en tant que cellules utilisées. La valeur par défaut est false.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

Renvoie l’objet utilisé qui comprend toutes les zones utilisées RangeAreas de plages rectangulaires individuelles dans l’objet. RangeAreas S’il n’existe aucune cellule utilisée dans le RangeAreas, puis cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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

Paramètres

valuesOnly

boolean

S’il faut prendre en compte uniquement les cellules avec des valeurs en tant que cellules utilisées.

Retours

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 lesquelles 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.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

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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple 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 structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés de 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 les RangeAreas données à recalculer lors du recalcul suivant.

setDirty(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. Objet RangeAreas est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.RangeAreasData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.RangeAreasData;

Retours

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 les 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 avoir ajouté l’objet à la collection d’objets suivis lors de la première création de .sync l’objet.

track(): Excel.RangeAreas;

Retours

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 devrez appeler avant context.sync() que la libération de mémoire prenne effet.

untrack(): Excel.RangeAreas;

Retours