<value> (JavaScript)
Especifica la información de la documentación de get y set funciones para las propiedades de ECMAScript 3.
<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>
Parámetros
type
Opcional.Tipo de datos de la propiedadEl tipo puede ser una de las siguientes:Un tipo de lenguaje ECMAScript que está en la especificación ECMAScript 5, tales como Number y Object.
A DOM object, such as HTMLElement, Window, and Document.
Una función constructora de JavaScript.
integer
Opcional.Si type es Number, especifica si la propiedad es un entero.Establece en true para indicar que la propiedad es un entero; de lo contrario, se establece en false.Este atributo no se utiliza por Visual Studio para proporcionar información de IntelliSense.domElement
Opcional.Este atributo está obsoleto; el type tiene prioridad sobre este atributo.Este atributo especifica si la propiedad documentada es un elemento de DOM.Establece en true para especificar que la propiedad es un elemento de DOM; de lo contrario, se establece en false.Si el type no se establece el atributo y domElement se establece en true, IntelliSense trata de la propiedad documentada como un HTMLElement al realizar la finalización de instrucciones.mayBeNull
Opcional.Especifica si se puede establecer la propiedad documentada en null.Establece en true para indicar que se puede establecer la propiedad null; de lo contrario, se establece en false.El valor predeterminado es false.Este atributo no se utiliza por Visual Studio para proporcionar información de IntelliSense.elementType
Opcional.Si type es Array, este atributo especifica el tipo de los elementos de la matriz.elementInteger
Opcional.Si type es Array y elementType es Number, este atributo especifica si los elementos de la matriz son enteros.Establece en true para indicar que los elementos de la matriz son enteros; de lo contrario, se establece en false.Este atributo no se utiliza por Visual Studio para proporcionar información de IntelliSense.elementDomElement
Opcional.Este atributo está obsoleto; el elementType tiene prioridad sobre este atributo.Si type es Array, este atributo especifica si los elementos de la matriz son los elementos del DOM.Establece en true para especificar que los elementos son los elementos del DOM; de lo contrario, se establece en false.Si el elementType no se establece el atributo y elementDomElement se establece en true, IntelliSense trata cada elemento de la matriz como un HTMLElement al realizar la finalización de instrucciones.elementMayBeNull
Opcional.Si type es Array, especifica si los elementos de la matriz se pueden establecer en null.Establece en true para indicar que los elementos de la matriz se pueden establecer en null; de lo contrario, se establece en false.El valor predeterminado es false.Este atributo no se utiliza por Visual Studio para proporcionar información de IntelliSense.locid
Opcional.El identificador de localización información acerca de la propiedad.El identificador es miembro ID o corresponde a la name valor en un paquete de mensaje definido por los metadatos de OpenAjax de atributo.El tipo de identificador depende del formato especificado en el <loc> (JavaScript) elemento.description
Opcional.Una descripción de la propiedad.
Comentarios
Uso de las propiedades de ECMAScript 5 el <summary> (JavaScript) elemento.
Uso del <value> elemento inmediatamente antes de la get o set función.
Ejemplo
En el ejemplo de código siguiente se muestra cómo utilizar el <value> elemento de un get función.
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();
}