<value> (JavaScript)
Określa informacje dotyczące dokumentacji dla get i set funkcje dla właściwości 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>
Parametry
type
Opcjonalne.Typ danych właściwości.Typ może być jedną z następujących czynności:Typ języka ECMAScript, który jest w specyfikacji ECMAScript 5, takich jak Number i Object.
A DOM object, such as HTMLElement, Window, and Document.
Funkcja konstruktora kodu JavaScript.
integer
Opcjonalne.Jeśli type jest Number, określa, czy właściwość jest liczbą całkowitą.Ustaw true , aby wskazać, że właściwość jest liczbą całkowitą; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany przez program Visual Studio udzielenia informacji, technologii IntelliSense.domElement
Opcjonalne.Ten atrybut jest niezalecane; type atrybutu ma pierwszeństwo przed tego atrybutu.Ten atrybut określa, czy udokumentowane właściwości elementu modelu DOM.Ustaw true , aby określić, że właściwość jest DOM element; w przeciwnym razie jest ustawiona na false.Jeśli type atrybut nie jest ustawiony i domElement jest ustawiona true, IntelliSense traktuje udokumentowane właściwości jako HTMLElement podczas wykonywania instrukcji.mayBeNull
Opcjonalne.Określa, czy można ustawić właściwość udokumentowane na null.Ustawiona na true , aby wskazać, że można ustawić właściwość na wartość null; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany przez program Visual Studio udzielenia informacji, technologii IntelliSense.elementType
Opcjonalne.Jeśli type jest Array, ten atrybut określa typ elementów w tablicy.elementInteger
Opcjonalne.Jeśli type jest Array i elementType jest Number, ten atrybut określa, czy elementy w tablicy są liczby całkowite.Ustaw true , aby wskazać, że elementy w tablicy liczb całkowitych; w przeciwnym razie jest ustawiona na false.Ten atrybut nie jest stosowany przez program Visual Studio udzielenia informacji, technologii IntelliSense.elementDomElement
Opcjonalne.Ten atrybut jest niezalecane; elementType atrybutu ma pierwszeństwo przed tego atrybutu.Jeśli type jest Array, ten atrybut określa, czy elementy w tablicy są elementami DOM.Ustaw true elementy są elementami DOM; w przeciwnym razie jest ustawiona na false.Jeśli elementType atrybut nie jest ustawiony i elementDomElement jest ustawiona true, IntelliSense traktuje każdy element w tablicy jako HTMLElement podczas wykonywania instrukcji.elementMayBeNull
Opcjonalne.Jeśli type jest Array, określa, czy elementy w tablicy można ustawić na wartość null.Ustaw true aby wskazać, że elementów w tablicy można ustawić na wartość null; w przeciwnym razie jest ustawiona na false.Wartością domyślną jest false.Ten atrybut nie jest stosowany przez program Visual Studio udzielenia informacji, technologii IntelliSense.locid
Opcjonalne.Identyfikator lokalizacji informacji dotyczących właściwości.Identyfikator jest albo członkiem lub identyfikator odpowiada name wartość w wiązce wiadomości definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu, określonego w <loc> (JavaScript) element.description
Opcjonalne.Opis właściwości.
Uwagi
Użyj właściwości ECMAScript 5 <summary> (JavaScript) element.
Użyj <value> element bezpośrednio przed get lub set funkcji.
Przykład
Poniższy przykład kodu pokazuje, jak używać <value> elementu get funkcji.
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();
}