Excel.WorkbookRangeAreas class

Renvoie un tableau d’adresses de style A1. Les valeurs Address contiennent le nom de la feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuil1 ! A1 :B4, Feuil1 ! D1 :D4"). En lecture seule.

readonly addresses: string[];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Renvoie l’objet RangeAreasCollection . Chacun RangeAreas des éléments de la collection représente une ou plusieurs plages de rectangles dans une feuille de calcul.

readonly areas: Excel.RangeAreasCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

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

/** Highlight the direct precedents of the active cell. */
async function getDirectPrecedents() {
  await Excel.run(async (context) => {
    // Precedents are cells referenced by the formula in a cell.
    // A "direct precedent" is a cell directly referenced by the selected formula.
    let range = context.workbook.getActiveCell();
    let directPrecedents = range.getDirectPrecedents();
    range.load("address");
    directPrecedents.areas.load("address");
    await context.sync();

    console.log(`Direct precedent cells of ${range.address} (yellow cells):`);

    for (let i = 0; i < directPrecedents.areas.items.length; i++) {
      // Highlight and print the address of each direct precedent cell.
      directPrecedents.areas.items[i].format.fill.color = "Yellow";
      console.log(`  ${directPrecedents.areas.items[i].address}`);
    }
    await context.sync();
  });

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é

Renvoie les plages qui composent cet objet dans un RangeCollection objet.

readonly ranges: Excel.RangeCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Renvoie l’objet en fonction de l’ID RangeAreas de feuille de calcul ou du nom dans la collection.

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Renvoie l’objet RangeAreas en fonction du nom de la feuille de calcul ou de l’ID de la collection. Si la feuille de calcul n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.12

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.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas;

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

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.WorkbookRangeAreas est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.WorkbookRangeAreasDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

Retours

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

Retours

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

Retours