ExcelScript.RangeAreas interface

Référence

Paquet:: ExcelScript

RangeAreas représente une collection d’une ou plusieurs plages rectangulaires dans la même feuille de calcul.

Remarques

Exemples

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

Méthodes

addConditionalFormat(type)	Ajoute un nouveau format conditionnel à la collection à la première/première priorité.
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.
clearAllConditionalFormats()	Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle.
convertDataTypeToText()	Convertit toutes les cellules du `RangeAreas` avec les types de données en texte.
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.
getAddress()	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").
getAddressLocal()	Retourne la `RangeAreas` référence dans les paramètres régionaux de l’utilisateur.
getAreaCount()	Retourne le nombre de plages rectangulaires qui composent cet `RangeAreas` objet.
getAreas()	Retourne une collection de plages rectangulaires qui composent cet `RangeAreas` objet.
getCellCount()	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).
getConditionalFormat(id)	Retourne un format conditionnel identifié par son ID. Si l’objet de format conditionnel n’existe pas, cette méthode retourne `undefined`.
getConditionalFormats()	Retourne une collection de formats conditionnels qui se croisent avec toutes les cellules de cet `RangeAreas` objet.
getDataValidation()	Retourne un objet de validation de données pour toutes les plages du `RangeAreas`.
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 »).
getFormat()	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` .
getIntersection(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 `undefined`.
getIsEntireColumn()	Spécifie si toutes les plages de cet `RangeAreas` objet représentent des colonnes entières (par exemple, « A :C, Q :Z »).
getIsEntireRow()	Spécifie si toutes les plages de cet `RangeAreas` objet représentent des lignes entières (par exemple, « 1:3, 5:7 »).
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.
getPredefinedCellStyle()	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.
getSpecialCells(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 ne correspond aux critères, cette méthode retourne `undefined`.
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 , `RangeAreas`cette méthode retourne `undefined`.
getWorksheet()	Retourne la feuille de calcul pour le actif `RangeAreas`.
setDirty()	Définit le `RangeAreas` à recalculer lorsque le recalcul suivant se produit.
setPredefinedCellStyle(predefinedCellStyle)	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.

Détails de la méthode

addConditionalFormat(type)

Ajoute un nouveau format conditionnel à la collection à la première/première priorité.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Paramètres

type: ExcelScript.ConditionalFormatType

Type de format conditionnel ajouté. Pour plus d’informations, consultez ExcelScript.ConditionalFormatType .

Retours

ExcelScript.ConditionalFormat

calculate()

Calcule toutes les cellules du RangeAreas.

calculate(): void;

Retours

void

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?: ClearApplyTo): void;

Paramètres

applyTo: ExcelScript.ClearApplyTo

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

Retours

void

Exemples

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

clearAllConditionalFormats()

Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle.

clearAllConditionalFormats(): void;

Retours

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

Retours

void

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?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Paramètres

sourceRange: ExcelScript.Range | ExcelScript.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: ExcelScript.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

getAddress()

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").

getAddress(): string;

Retours

string

getAddressLocal()

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

getAddressLocal(): string;

Retours

string

getAreaCount()

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

getAreaCount(): number;

Retours

number

getAreas()

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

getAreas(): Range[];

Retours

ExcelScript.Range[]

getCellCount()

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

getCellCount(): number;

Retours

number

getConditionalFormat(id)

Retourne un format conditionnel identifié par son ID. Si l’objet de format conditionnel n’existe pas, cette méthode retourne undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Paramètres

id: string

ID du format conditionnel.

Retours

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

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

getConditionalFormats(): ConditionalFormat[];

Retours

ExcelScript.ConditionalFormat[]

getDataValidation()

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

getDataValidation(): DataValidation;

Retours

ExcelScript.DataValidation

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

Retours

ExcelScript.RangeAreas

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

Retours

ExcelScript.RangeAreas

getFormat()

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 .

getFormat(): RangeFormat;

Retours

ExcelScript.RangeFormat

Exemples

/**
 * This script finds and highlights all the cells in the current worksheet that contain a formula.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula.
  const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);

  // Add a light blue background to the cells containing formulas.
  formulaCells.getFormat().getFill().setColor("#ADD8E6");
}

getIntersection(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 undefined.

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

Paramètres

anotherRange: ExcelScript.Range | ExcelScript.RangeAreas | string

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

Retours

ExcelScript.RangeAreas

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Retours

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Retours

boolean

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
        ): 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

ExcelScript.RangeAreas

getPredefinedCellStyle()

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.

getPredefinedCellStyle(): string;

Retours

string

getSpecialCells(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 ne correspond aux critères, cette méthode retourne undefined.

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

Paramètres

cellType: ExcelScript.SpecialCellType

Type de cellules à inclure.

cellValueType: ExcelScript.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

ExcelScript.RangeAreas

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

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

ExcelScript.Table[]

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 , RangeAreascette méthode retourne undefined.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Paramètres

valuesOnly: boolean

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

Retours

ExcelScript.RangeAreas

getWorksheet()

Retourne la feuille de calcul pour le actif RangeAreas.

getWorksheet(): Worksheet;

Retours

ExcelScript.Worksheet

setDirty()

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

setDirty(): void;

Retours

void

setPredefinedCellStyle(predefinedCellStyle)

setPredefinedCellStyle(predefinedCellStyle: string): void;

Paramètres

predefinedCellStyle: string

Retours

void

Exemples

/**
 * This script sets the cell style to "warning text"
 * on every cell with a formula error.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get any cells that are displaying errors.
  const errorCells = usedRange.getSpecialCells(
    ExcelScript.SpecialCellType.formulas,
    ExcelScript.SpecialCellValueType.errors
  );

  // Check if there are error cells before proceeding.
  if (errorCells) {
    // Use the built-in warning text style on the error cells.
    errorCells.setPredefinedCellStyle(
      ExcelScript.BuiltInStyle.warningText.toString()
    );
  } else {
    console.log("No formula errors in the worksheet.");
  }
}

Partager via

ExcelScript.RangeAreas interface

Remarques

Exemples

Méthodes

Détails de la méthode

addConditionalFormat(type)

Paramètres

Retours

calculate()

Retours

clear(applyTo)

Paramètres

Retours

Exemples

clearAllConditionalFormats()

Retours

convertDataTypeToText()

Retours

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Paramètres

Retours

getAddress()

Retours

getAddressLocal()

Retours

getAreaCount()

Retours

getAreas()

Retours

getCellCount()

Retours

getConditionalFormat(id)

Paramètres

Retours

getConditionalFormats()

Retours

getDataValidation()

Retours

getEntireColumn()

Retours

getEntireRow()

Retours

getFormat()

Retours

Exemples

getIntersection(anotherRange)

Paramètres

Retours

getIsEntireColumn()

Retours

getIsEntireRow()

Retours

getOffsetRangeAreas(rowOffset, columnOffset)

Paramètres

Retours

getPredefinedCellStyle()

Retours

getSpecialCells(cellType, cellValueType)

Paramètres

Retours

getTables(fullyContained)

Paramètres

Retours

getUsedRangeAreas(valuesOnly)

Paramètres

Retours

getWorksheet()

Retours

setDirty()

Retours

setPredefinedCellStyle(predefinedCellStyle)

Paramètres

Retours

Exemples

Ressources supplémentaires