Freigeben über

ExcelScript.NamedItem interface

  • Referenz
Paket:
ExcelScript

Stellt einen definierten Namen für einen Zellbereich oder einen Wert dar. Namen können primitive benannte Objekte (wie im folgenden Typ zu sehen), Bereichsobjekte oder ein Verweis auf einen Bereich sein. Dieses Objekt kann zum Abrufen des mit Namen verknüpften Bereichsobjekts verwendet werden.

Hinweise

Beispiele

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

Methoden

delete()

Löscht den angegebenen Namen.
getArrayValues()

Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.
getComment()

Gibt den Kommentar an, der diesem Namen zugeordnet ist.
getFormula()

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").
getName()

Der Name des Objekts.
getRange()

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, gibt diese Methode zurück undefined.
getScope()

Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt festgelegt ist. Mögliche Werte sind: Worksheet, Workbook.
getType()

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen finden Sie unter ExcelScript.NamedItemType .
getValue()

Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.
getVisible()

Gibt an, ob das Objekt sichtbar ist.
getWorksheet()

Gibt das Arbeitsblatt zurück, für das das benannte Element gültig ist. Wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist, gibt diese Methode zurück undefined.
setComment(comment)

Gibt den Kommentar an, der diesem Namen zugeordnet ist.
setFormula(formula)

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").
setVisible(visible)

Gibt an, ob das Objekt sichtbar ist.

Details zur Methode

delete()

Löscht den angegebenen Namen.

delete(): void;

Gibt zurück

void

getArrayValues()

Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.

getArrayValues(): NamedItemArrayValues;

Gibt zurück

ExcelScript.NamedItemArrayValues

getComment()

Gibt den Kommentar an, der diesem Namen zugeordnet ist.

getComment(): string;

Gibt zurück

string

getFormula()

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").

getFormula(): string;

Gibt zurück

string

getName()

Der Name des Objekts.

getName(): string;

Gibt zurück

string

getRange()

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, gibt diese Methode zurück undefined.

getRange(): Range;

Gibt zurück

ExcelScript.Range

getScope()

Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt festgelegt ist. Mögliche Werte sind: Worksheet, Workbook.

getScope(): NamedItemScope;

Gibt zurück

ExcelScript.NamedItemScope

getType()

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen finden Sie unter ExcelScript.NamedItemType .

getType(): NamedItemType;

Gibt zurück

ExcelScript.NamedItemType

Beispiele

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

getValue()

Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.

getValue(): string | number;

Gibt zurück

string | number

getVisible()

Gibt an, ob das Objekt sichtbar ist.

getVisible(): boolean;

Gibt zurück

boolean

getWorksheet()

Gibt das Arbeitsblatt zurück, für das das benannte Element gültig ist. Wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist, gibt diese Methode zurück undefined.

getWorksheet(): Worksheet | undefined;

Gibt zurück

ExcelScript.Worksheet | undefined

setComment(comment)

Gibt den Kommentar an, der diesem Namen zugeordnet ist.

setComment(comment: string): void;

Parameter

comment

string

Gibt zurück

void

setFormula(formula)

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").

setFormula(formula: string): void;

Parameter

formula

string

Gibt zurück

void

setVisible(visible)

Gibt an, ob das Objekt sichtbar ist.

setVisible(visible: boolean): void;

Parameter

visible

boolean

Gibt zurück

void