Erstellen benutzerdefinierter Enumerationen für Ihre benutzerdefinierten Funktionen

Benutzerdefinierte Enumerationen bieten Benutzern Excel AutoVervollständigen-Optionen für Ihre benutzerdefinierten Funktionen. Die Elemente in Ihrer Enumeration werden in der Bearbeitungsleiste als Vorschläge angezeigt. Die Planeten im vorherigen Screenshot sind ein Beispiel für eine benutzerdefinierte Enumeration, die eine Set-Liste bereitstellt. In diesem Artikel wird beschrieben, wie Sie benutzerdefinierte Enumerationen erstellen und als Parameter in Ihren benutzerdefinierten Funktionen verwenden.

Definieren der benutzerdefinierten Enumeration

Definieren Sie Ihre Enumeration mit dem JSDoc-Tag @customenum. Die entsprechenden JSON-Eigenschaften werden dann automatisch in Ihren metadaten der benutzerdefinierten Funktion generiert. Weitere Informationen zu JSDoc-Tags und benutzerdefinierten Funktionen finden Sie unter Grundlagen von JSDoc-Tags.

Hinweis

Benutzerdefinierte Enumerationen, die mit dem @customenum JSDoc-Tag erstellt wurden, werden nur in TypeScript unterstützt. Sie werden in JavaScript nicht unterstützt. Um benutzerdefinierte Enumerationen mit JavaScript-Funktionen verwenden zu können, müssen Sie ihre eigenen JSON-Metadaten manuell erstellen. Weitere Informationen finden Sie unter Manuelles Erstellen von JSON-Metadaten: Enumerationen.

Der folgende Codeausschnitt zeigt, wie Eine einfache benutzerdefinierte Enumeration als Parameter definiert und verwendet wird.

/** 
 * A custom enum with descriptions and tooltips. 
 * @customenum {string} 
 */
enum PLANETS { 
  /** Mercury is the first planet from the sun. */ 
  mercury = "Mercury", 

  /** Venus is the second planet from the sun. */ 
  venus = "Venus", 

  /** Earth is the third planet from the sun. */ 
  earth = "Earth", 
} 

/** 
 * A sample function that uses the custom enum as a parameter.
 * @customfunction 
 */ 
function getPlanets(value: PLANETS): any { 
  return value; 
} 

Mehrfaches Verwenden einer benutzerdefinierten Enumeration

Eine benutzerdefinierte Enumeration kann in mehreren Funktionen wiederverwendet und als mehrere Parameter einer einzelnen Funktion verwendet werden. Eine Funktion kann auch mehrere Enumerationen als Parameter gleichzeitig haben. Ein Enumerationsparameter kann wiederholt oder optional sein.

Das folgende Codebeispiel zeigt eine NUMBERS Enumeration und eine benutzerdefinierte Funktion, die die Enumeration mehrmals als Eingabewert verwendet.

/**
* Enum of numbers with descriptions and tooltips.
* @customenum {number}
*/ 
enum NUMBERS {
  /** One */
  One = 1,

  /** Two */
  Two = 2,

  /** Three */
  Three = 3, 

  /** Four */
  Four = 4,

  /** Five */
  Five = 5
} 

/**
* Enter multiple numbers from the NUMBERS enum and get the sum.
* @customfunction
* @param input Enter enum numbers.
* @returns
*/
function addNumbers(input: NUMBERS[]): any {
  const sum = input.reduce((acc, num) => acc + num, 0); 
  return "Sum: " + sum; 
}

Lokalisieren Ihrer benutzerdefinierten Enumerationen

Das Lokalisieren benutzerdefinierter Enumerationen ähnelt dem Lokalisieren benutzerdefinierter Funktionen. Sie müssen Ihre JSON-Metadaten manuell erstellen und dann eine neue JSON-Metadatendatei für jede Sprache erstellen.

Beachten Sie, dass nur die name Eigenschaften und tooltip innerhalb einer Enumeration in die Zielsprache lokalisiert werden sollten. Die value -Eigenschaft sollte unverändert bleiben, um die Verarbeitung mehrerer Sprachen innerhalb des Funktionstexts zu vermeiden.

Der folgende JSON-Codeausschnitt zeigt das lokalisierte values Chinesische Objekt für den Planeten Merkur.

"enums": [
    {
        "id": "PLANETS",
        "type": "string",
        "values": [
            {
                "name": "水星", 
                "value": "mercury",
                "tooltip": "水星是距离太阳最近的行星"
            }
        ]
    }
],

Abwärtskompatibilität

Benutzerdefinierte Enumerationen bieten Abwärtskompatibilität. In älteren Versionen von Excel funktionieren Parameter, die eine benutzerdefinierte Enumeration verwenden, als Standardparameter, ohne in der Excel AutoVervollständigen-Liste angezeigt zu werden.

Siehe auch

• Manuelles Erstellen von JSON-Metadaten für benutzerdefinierte Funktionen
• Automatisches Erstellen von JSON-Metadaten für benutzerdefinierte Funktionen