Condividi tramite


<value> (JavaScript)

Specifica le informazioni di documentazione per get e set le funzioni per le proprietà di 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>

Parametri

  • type
    Parametro facoltativo.Il tipo di dati della proprietà.Il tipo può essere una delle seguenti operazioni:

    • Un tipo di linguaggio ECMAScript è ad esempio nella specifica ECMAScript 5 Number e Object.

    • A DOM object, such as HTMLElement, Window, and Document.

    • Una funzione di costruzione di JavaScript.

  • integer
    Parametro facoltativo.Se type è Number, specifica se la proprietà è un valore integer.Impostare su true per indicare che la proprietà è un valore integer; in caso contrario, false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • domElement
    Parametro facoltativo.Questo attributo è obsoleto; il type attributo ha la precedenza su questo attributo.Questo attributo specifica se la proprietà documentata è un elemento DOM.Impostare su true per specificare che la proprietà è un elemento DOM; in caso contrario, false.Se il type non è impostato l'attributo e domElement è impostata su true, IntelliSense considera la proprietà documentata come un HTMLElement quando si esegue il completamento.

  • mayBeNull
    Parametro facoltativo.Specifica se la proprietà documentata può essere impostata su null.Impostare su true per indicare che la proprietà può essere impostata su null. in caso contrario, false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • elementType
    Parametro facoltativo.Se type è Array, questo attributo specifica il tipo degli elementi nella matrice.

  • elementInteger
    Parametro facoltativo.Se type è Array e elementType è Number, questo attributo specifica se gli elementi della matrice sono valori integer.Impostare su true per indicare che gli elementi della matrice sono valori integer; in caso contrario, false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • elementDomElement
    Parametro facoltativo.Questo attributo è obsoleto; il elementType attributo ha la precedenza su questo attributo.Se type è Array, questo attributo specifica se gli elementi della matrice sono elementi DOM.Impostare su true per specificare che gli elementi sono gli elementi DOM; in caso contrario, false.Se il elementType non è impostato l'attributo e elementDomElement è impostata su true, IntelliSense considera ogni elemento della matrice come un HTMLElement durante l'esecuzione di completamento delle istruzioni.

  • elementMayBeNull
    Parametro facoltativo.Se type è Array, specifica se gli elementi della matrice possono essere impostati su null.Impostare su true per indicare che gli elementi della matrice possono essere impostati su null. in caso contrario, false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.

  • locid
    Parametro facoltativo.Identificatore di informazioni di localizzazione sulla proprietà.L'identificatore è un membro ID o corrisponde alla name valore in un raggruppamento di messaggi definito da metadati OpenAjax di attributo.Il tipo di identificatore dipende dal formato specificato nel <loc> (JavaScript) elemento.

  • description
    Parametro facoltativo.Una descrizione della proprietà.

Note

Utilizzare le proprietà di ECMAScript 5 il <summary> (JavaScript) elemento.

Utilizzare il <value> elemento immediatamente prima di get o set funzione.

Esempio

Nell'esempio di codice riportato di seguito viene illustrato come utilizzare il <value> elemento su un get funzione.

    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();
    }

Vedere anche

Concetti

Commenti relativi alla documentazione XML (JavaScript)