<value> (JavaScript)
Gibt Dokumentationsinformationen für get- und set-Funktionen für ECMAScript 3-Eigenschaften an.
<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.Als Typ kann eines der folgenden Elemente verwendet werden:Ein ECMAScript-Sprachentyp in der ECMAScript 5-Spezifikation, wie Number und Object
Ein DOM-Objekt, wie HTMLElement, Window und Document
Eine JavaScript-Konstruktorfunktion
integer
Optional.Wenn type auf Number festgelegt ist, wird angegeben, ob die Eigenschaft eine ganze Zahl ist.Legen Sie das Attribut auf true fest, um anzugeben, dass die Eigenschaft eine ganze Zahl ist; andernfalls ist es auf false festzulegen.Dieses Attribut wird von nicht Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.domElement
Optional.Dieses Attribut ist veraltet; das Attribut type hat Vorrang vor diesem Attribut.Dieses Attribut gibt an, ob die dokumentierte Eigenschaft ein DOM-Element ist.Legen Sie es auf true fest, um anzugeben, dass die Eigenschaft ein DOM-Element ist; andernfalls ist es auf false festzulegen.Wenn das type-Attribut nicht festgelegt ist und domElement auf true festgelegt wurde, behandelt IntelliSense die dokumentierte Eigenschaft bei Ausführung einer Anweisungsvervollständigung als HTMLElement.mayBeNull
Optional.Gibt an, ob die dokumentierte Eigenschaft auf NULL festgelegt werden kann.Legen Sie das Attribut auf true fest, um anzugeben, dass die Eigenschaft auf NULL festgelegt werden kann; andernfalls ist es auf false festzulegen.Der Standardwert ist false.Dieses Attribut wird von nicht Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementType
Optional.Wenn das type-Attribut Array lautet, wird der Typ des Elements im Array angegeben.elementInteger
Optional.Wenn das type-Attribut Array und das elementType-Attribut Number lautet, wird angegeben, ob die Elemente im Array ganze Zahlen sind.Wenn Sie das Attribut auf true festlegen, wird angegeben, dass die Elemente im Array ganze Zahlen sind; andernfalls ist das Attribut auf false festzulegen.Dieses Attribut wird von nicht Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.elementDomElement
Optional.Dieses Attribut ist veraltet; das Attribut elementType hat Vorrang vor diesem Attribut.Wenn das type-Attribut Array lautet, wird angegeben, ob die Elemente im Array DOM-Elemente sind.Wenn Sie Attribut auf true festlegen, wird angegeben, dass die Elemente DOM-Elemente sind; andernfalls ist das Attribut auf false festzulegen.Wenn das elementType-Attribut nicht festgelegt ist und elementDomElement auf true festgelegt wird, behandelt IntelliSense jedes Element im Array bei Ausführung einer Anweisungsvervollständigung als HTMLElement.elementMayBeNull
Optional.Wenn das type-Attribut Array lautet, wird angegeben, ob die Elemente im Array auf NULL festgelegt werden können.Wenn Sie das Attribut auf true festlegen, wird angegeben, dass die Elemente im Array auf NULL festgelegt werden können; andernfalls ist das Attribut auf false festzulegen.Der Standardwert ist false.Dieses Attribut wird von nicht Visual Studio verwendet, um IntelliSense-Informationen bereitzustellen.locid
Optional.Der Bezeichner für Lokalisierungsinformationen über die Eigenschaft.Der Bezeichner ist entweder eine Member-ID, oder er entspricht dem name-Attributwert in einem Meldungsbündel, das von OpenAjax-Metadaten definiert wird.Der Bezeichnertyp hängt vom Format ab, das im <loc> (JavaScript)-Element angegeben ist.description
Optional.Eine Beschreibung der Eigenschaft.
Hinweise
ECMAScript 5-Eigenschaften verwenden das <summary> (JavaScript)-Element.
Verwenden Sie das <value>-Element direkt vor der get- oder set-Funktion.
Beispiel
Im folgenden Codebeispiel wird die Verwendung des <value>-Elements in einer get-Funktion veranschaulicht.
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();
}