Sdílet prostřednictvím


<value> (JavaScript)

Určuje informace o dokumentaci pro get a set funkcí pro ECMAScript 3 Vlastnosti.

<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>

Parametry

  • type
    Nepovinné.Typ dat vlastnosti.Typ může být některý z následujících:

    • Typ jazyka ECMAScript je například specifikace ECMAScript 5 Number a Object.

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

    • Funkce konstruktoru jazyka JavaScript.

  • integer
    Nepovinné.Pokud type je Number, určuje, zda je vlastnost celé číslo.Nastavit na true označuje, že vlastnost je celé číslo; jinak je nastavena na false.Tento atribut není používán Visual Studio IntelliSense informace.

  • domElement
    Nepovinné.Tento atribut se již nepoužívá; type atribut přednost tomuto atributu.Tento atribut určuje, zda je vlastnost dokumentované DOM element.Nastavit na true určit, že je vlastnost modelu DOM element; jinak je nastavena na false.Pokud type není nastaven atribut a domElement je nastavena na true, IntelliSense zdokumentovaných vlastností považovány HTMLElement při dokončování příkazů.

  • mayBeNull
    Nepovinné.Určuje, zda dokumentované vlastnost lze nastavit na hodnotu null.Nastavit na true označuje vlastnost nastavit na hodnotu null; jinak je nastavena na false.Výchozí hodnota je false.Tento atribut není používán Visual Studio IntelliSense informace.

  • elementType
    Nepovinné.Pokud type je Array, tento atribut určuje typ prvků v poli.

  • elementInteger
    Nepovinné.Pokud type je Array a elementType je Number, tento atribut určuje, zda jsou prvky pole celých čísel.Nastavit na true označíte, že jsou prvky pole celých čísel; jinak je nastavena na false.Tento atribut není používán Visual Studio IntelliSense informace.

  • elementDomElement
    Nepovinné.Tento atribut se již nepoužívá; elementType atribut přednost tomuto atributu.Pokud type je Array, tento atribut určuje, zda jsou prvky pole DOM prvky.Nastavit na true že prvky jsou prvky DOM; jinak je nastavena na false.Pokud elementType není nastaven atribut a elementDomElement je nastavena na true, IntelliSense považuje každý prvek v poli jako HTMLElement při dokončování příkazů.

  • elementMayBeNull
    Nepovinné.Pokud type je Array, určuje, zda prvky pole lze nastavit na hodnotu null.Nastavit na true k označení prvků pole nastavit na hodnotu null; jinak je nastavena na false.Výchozí hodnota je false.Tento atribut není používán Visual Studio IntelliSense informace.

  • locid
    Nepovinné.Identifikátor lokalizační informace o vlastnosti.Identifikátor je buď členské ID, nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Typ identifikátoru závisí na formátu zadaném v <loc> (JavaScript) prvku.

  • description
    Nepovinné.Popis vlastnosti.

Poznámky

Použití vlastnosti ECMAScript 5 <summary> (JavaScript) prvku.

Použití <value> prvku bezprostředně před get nebo set funkce.

Příklad

Následující příklad kódu ukazuje, jak použít <value> prvek get funkce.

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

Viz také

Koncepty

Komentáře XML dokumentace (JavaScript)