<value> (JavaScript)
Spécifie des informations de documentation pour get et set fonctions de ECMAScript 3 propriétés.
<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>
Paramètres
type
Facultatif.Le type de données de la propriété.Le type peut être une des opérations suivantes :Un type de langage ECMAScript qui se trouve dans la spécification ECMAScript 5, comme Number et Object.
A DOM object, such as HTMLElement, Window, and Document.
Une fonction constructeur JavaScript.
integer
Facultatif.Si type est Number, indique si la propriété est un entier.La valeur true pour indiquer que la propriété est un entier ; Sinon, la valeur false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations de IntelliSense.domElement
Facultatif.Cet attribut est désapprouvé ; le type attribut prévaut sur cet attribut.Cet attribut spécifie si la propriété documentée est un élément DOM.La valeur true pour spécifier que la propriété est un élément DOM ; Sinon, la valeur false.Si la type attribut n'est pas définie et domElement est défini sur true, IntelliSense traite la propriété documentée comme un HTMLElement lors de la saisie semi-automatique des instructions.mayBeNull
Facultatif.Spécifie si la propriété documentée peut être définie sur null.La valeur true pour indiquer que la propriété peut être définie à null ; Sinon, la valeur false.La valeur par défaut est false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations de IntelliSense.elementType
Facultatif.Si type est Array, cet attribut spécifie le type des éléments dans le tableau.elementInteger
Facultatif.Si type est Array et elementType est Number, cet attribut spécifie si les éléments du tableau sont des entiers.La valeur true pour indiquer que les éléments du tableau sont des entiers ; Sinon, la valeur false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations de IntelliSense.elementDomElement
Facultatif.Cet attribut est désapprouvé ; le elementType attribut prévaut sur cet attribut.Si type est Array, cet attribut spécifie si les éléments du tableau sont les éléments DOM.La valeur true pour spécifier que les éléments sont les éléments DOM ; Sinon, la valeur false.Si la elementType attribut n'est pas définie et elementDomElement est défini sur true, IntelliSense traite chaque élément dans le tableau comme un HTMLElement lors de la saisie semi-automatique des instructions.elementMayBeNull
Facultatif.Si type est Array, indique si les éléments du tableau peuvent être définies sur null.La valeur true pour indiquer que les éléments du tableau peuvent être définies à null ; Sinon, la valeur false.La valeur par défaut est false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations de IntelliSense.locid
Facultatif.L'identificateur pour les informations de localisation sur la propriété.L'identificateur est soit un membre ID ou elle correspond à la name valeur dans une offre groupée de message définie par les métadonnées de OpenAjax d'attribut.Le type d'identificateur dépend du format spécifié dans la <loc> (JavaScript) élément.description
Facultatif.Une description de la propriété.
Notes
Utilisation de propriétés ECMAScript 5 la <summary> (JavaScript) élément.
Utilisation du <value> élément immédiatement avant la get ou set fonction.
Exemple
L'exemple de code suivant montre comment utiliser la <value> élément sur un get fonction.
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();
}