Excel.WorkbookRangeAreas class

  • Référence
Paquet:
excel

Représente une collection d’une ou plusieurs plages rectangulaires dans plusieurs feuilles de calcul.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Propriétés

addresses

Retourne un tableau d’adresses de style A1. Les valeurs d’adresse contiennent le nom de feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuille1 ! A1 :B4, Feuille1 ! D1 :D4 »). En lecture seule.
areas

Retourne l’objet RangeAreasCollection . Chaque RangeAreas dans la collection représente une ou plusieurs plages de rectangles dans une feuille de calcul.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
ranges

Retourne des plages qui composent cet objet dans un RangeCollection objet .

Méthodes

getRangeAreasBySheet(key)

Retourne l’objet en fonction de l’ID RangeAreas ou du nom de la feuille de calcul dans la collection.
getRangeAreasOrNullObjectBySheet(key)

Retourne l’objet RangeAreas en fonction du nom ou de l’ID de feuille de calcul dans la collection. Si la feuille de calcul n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés 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.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.WorkbookRangeAreas d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorkbookRangeAreasDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées 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 sur 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 suivie lors de la création de l’objet pour la première fois.
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 devez appeler context.sync() avant que la libération de la mémoire ne prenne effet.

Détails de la propriété

addresses

Retourne un tableau d’adresses de style A1. Les valeurs d’adresse contiennent le nom de feuille de calcul pour chaque bloc rectangulaire de cellules (par exemple, « Feuille1 ! A1 :B4, Feuille1 ! D1 :D4 »). En lecture seule.

readonly addresses: string[];

Valeur de propriété

string[]

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

areas

Retourne l’objet RangeAreasCollection . Chaque RangeAreas dans la collection représente une ou plusieurs plages de rectangles dans une feuille de calcul.

readonly areas: Excel.RangeAreasCollection;

Valeur de propriété

Excel.RangeAreasCollection

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

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

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}:`);

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

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

ranges

Retourne des plages qui composent cet objet dans un RangeCollection objet .

readonly ranges: Excel.RangeCollection;

Valeur de propriété

Excel.RangeCollection

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Détails de la méthode

getRangeAreasBySheet(key)

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

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Paramètres

key

string

Nom ou ID de la feuille de calcul.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

getRangeAreasOrNullObjectBySheet(key)

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

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Paramètres

key

string

Nom ou ID de la feuille de calcul.

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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

Paramètres

options
Excel.Interfaces.WorkbookRangeAreasLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.WorkbookRangeAreas

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.WorkbookRangeAreas

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

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

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.WorkbookRangeAreas d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorkbookRangeAreasDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

Retours

Excel.Interfaces.WorkbookRangeAreasData

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 sur 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 suivie lors de la création de l’objet pour la première fois.

track(): Excel.WorkbookRangeAreas;

Retours

Excel.WorkbookRangeAreas

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

untrack(): Excel.WorkbookRangeAreas;

Retours

Excel.WorkbookRangeAreas