<value> (JavaScript)
Gibt Dokumentationsinformationen der für get und set Funktionen für ECMAScript 3 Eigenschaften.
<value type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID">description</value>
Parameter
type
Optional.Der Datentyp der Eigenschaft.Der Typ kann eine der folgenden sein:Eine ECMAScript-Sprachtyps an, die in der ECMAScript-5-Spezifikation, z. B. Number und Object.
A DOM object, such as HTMLElement, Window, and Document.
Eine Konstruktorfunktion für JavaScript.
integer
Optional.Wenn type ist Number, gibt an, ob die Eigenschaft eine ganze Zahl ist.Legen Sie auf true um anzugeben, dass die Eigenschaft eine ganze Zahl; Legen Sie andernfalls auf false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense Informationen bereitzustellen.domElement
Optional.Dieses Attribut ist veraltet; die type Attribut hat Vorrang vor diesem Attribut.Dieses Attribut gibt an, ob die dokumentierte-Eigenschaft eines DOM-Elements ist.Legen Sie auf true gibt an, dass die Eigenschaft ein DOM-Element; Legen Sie andernfalls auf false.Wenn die type -Attribut nicht festgelegt ist und domElement auf festgelegt ist true, IntelliSense dokumentierte Eigenschaft behandelt, als ein HTMLElement beim Anweisungsvervollständigung durchführen.mayBeNull
Optional.Gibt an, ob die dokumentierte-Eigenschaft festgelegt werden kann auf Null.Legen Sie auf true an, dass die Eigenschaft kann festgelegt werden auf Null; Legen Sie andernfalls auf false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense Informationen bereitzustellen.elementType
Optional.Wenn type ist Array, dieses Attribut gibt den Typ der Elemente im Array.elementInteger
Optional.Wenn type ist Array und elementType ist Number, dieses Attribut gibt an, ob die Elemente im Array mit Ganzzahlen sind.Legen Sie auf true bedeutet, dass die Elemente im Array Ganzzahlen; Legen Sie andernfalls auf false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense Informationen bereitzustellen.elementDomElement
Optional.Dieses Attribut ist veraltet; die elementType Attribut hat Vorrang vor diesem Attribut.Wenn type ist Array, dieses Attribut gibt an, ob die Elemente im Array die DOM-Elemente.Legen Sie auf true angegeben, dass die Elemente die DOM-Elemente; Legen Sie andernfalls auf false.Wenn die elementType -Attribut nicht festgelegt ist und elementDomElement soll true, IntelliSense behandelt jedes Element im Array als ein HTMLElement bei Anweisungsvervollständigung.elementMayBeNull
Optional.Wenn type ist Array, gibt an, ob die Elemente im Array können festgelegt werden auf Null.Legen Sie auf true an, dass die Elemente im Array können festgelegt werden auf Null; Legen Sie andernfalls auf false.Der Standardwert ist false.Dieses Attribut wird nicht von Visual Studio verwendet, um IntelliSense Informationen bereitzustellen.locid
Optional.Der Bezeichner für die von Lokalisierungsinformationen über die Eigenschaft.Der Bezeichner ist entweder ein Produkt-ID oder es entspricht der name Attributwert im Bundle Nachricht durch OpenAjax-Metadaten definiert.Der Typ des Bezeichners im angegebenen Format hängt von der <loc> (JavaScript) Element.description
Optional.Eine Beschreibung der Eigenschaft.
Hinweise
ECMAScript 5 Eigenschaften verwenden die <summary> (JavaScript) Element.
Verwendung der <value> Element unmittelbar vor dem get oder set Funktion.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie mithilfe der <value> Element auf eine get Funktion.
function Sys$CancelEventArgs$get_cancel() {
/// <value type="Boolean" locid="P:J#Sys.CancelEventArgs.cancel"></value>
if (arguments.length !== 0) throw Error.parameterCount();
return this._cancel();
}