Aracılığıyla paylaş


<value> (JavaScript)

Belge bilgilerini belirtir get ve set ECMAScript 3 özellikleri işlevler.

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

Parametreler

  • type
    İsteğe Bağlı. Özelliğin veri türü. Tür, aşağıdakilerden biri olabilir:

    • ECMAScript 5 belirtiminde gibi olan ECMAScript dil türünü Number ve Object.

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

    • JavaScript yapıcı işlevi.

  • integer
    İsteğe Bağlı. type Olan Number, bu özellik bir tamsayı olup olmadığını belirtir. Ayarlamak true ; tamsayı özelliği olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, Visual Studio IntelliSense bilgi sağlamak için kullanılmaz.

  • domElement
    İsteğe Bağlı. Bu özniteliği önerilmiyor; type özniteliği bu özniteliği üzerinde göre önceliklidir. Bu öznitelik, belgelenen özelliğini dom öğesi olup olmadığını belirtir. Ayarlamak true dom öğesi; özelliği olduğunu belirtmek için Aksi takdirde set false. type Özniteliğinin ayarlanmadığından ve domElement ayarlamak true, IntelliSense belgelenen özelliğini değerlendirir bir HTMLElement deyimi tamamlama yaparken.

  • mayBeNull
    İsteğe Bağlı. Belgelenen özelliğini ayarlanıp ayarlanamadığını belirtir null. Ayarlamak true özellik kümesi belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, Visual Studio IntelliSense bilgi sağlamak için kullanılmaz.

  • elementType
    İsteğe Bağlı. type Olan Array, bu öznitelik, dizideki öğelerin türünü belirtir.

  • elementInteger
    İsteğe Bağlı. type Olan Array ve elementType olan Number, bu öznitelik, dizideki öğelerin tamsayılar olup olmadığını belirtir. Ayarlamak true Dizideki öğelerin tamsayılar; olduğunu belirtmek için Aksi takdirde set false. Bu öznitelik, Visual Studio IntelliSense bilgi sağlamak için kullanılmaz.

  • elementDomElement
    İsteğe Bağlı. Bu özniteliği önerilmiyor; elementType özniteliği bu özniteliği üzerinde göre önceliklidir. type Olan Array, bu öznitelik, dizideki öğelerin dom öğeler olup olmadığını belirtir. Ayarlamak true öğeleri dom öğeleri; olduğunu belirtmek için Aksi takdirde set false. elementType Özniteliğinin ayarlanmadığından ve elementDomElement ayarlamak true, IntelliSense her öğe olarak nitelendirir bir HTMLElement deyimi tamamlama yaparken.

  • elementMayBeNull
    İsteğe Bağlı. type Olan Array, dizideki öğelerin ayarlanıp ayarlanamadığını belirtir null. Ayarlamak true dizideki öğeler kümesi belirtmek için null; Aksi takdirde set false. false varsayılan değerdir. Bu öznitelik, Visual Studio IntelliSense bilgi sağlamak için kullanılmaz.

  • locid
    İsteğe Bağlı. Yerelleştirme özelliği hakkında bilgi için tanımlayıcı. Bir üye tanımlayıcısıdır kimliği veya karşılık gelen name OpenAjax meta veriler tarafından tanımlanan ileti paket değeri öznitelik. Belirtilen biçim tanımlayıcısı türü bağlıdır <loc> (JavaScript) öğesi.

  • description
    İsteğe Bağlı. Özellik açıklaması.

Notlar

ECMAScript 5 özelliklerini kullanmak <summary> (JavaScript) öğesi.

Use <value> öğe hemen önce get veya set işlevi.

Örnek

Aşağıdaki kod örneği nasıl kullanılacağını gösteren <value> öğesinde bir get işlevi.

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

Ayrıca bkz.

Kavramlar

xml belgesi açıklamalarının (JavaScript)