ExcelScript.RangeAreas interface

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

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Paramètres

Retours

Calcule toutes les cellules du RangeAreas.

calculate(): void;

Retours

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

Retours

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();
  }
}

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

clearAllConditionalFormats(): void;

Retours

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

convertDataTypeToText(): void;

Retours

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

Retours

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

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

getAddressLocal(): string;

Retours

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

getAreaCount(): number;

Retours

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

getAreas(): Range[];

Retours

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

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

Retours

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

getConditionalFormats(): ConditionalFormat[];

Retours

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

getDataValidation(): DataValidation;

Retours

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

Renvoie un RangeAreas objet qui représente les lignes entières de l’objet 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

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

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");
}

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

Retours

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

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

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

Retours

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

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

Retours

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

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

Paramètres

Retours

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

Retours

Retourne la feuille de calcul pour le actif RangeAreas.

getWorksheet(): Worksheet;

Retours

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

setDirty(): void;

Retours

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.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Paramètres

Retours

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