XMLList

套件	最上層
類別	public final dynamic class XMLList
繼承	XMLList Object

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

XMLList 類別包含用來處理一個或多個 XML 元素的方法。 XMLList 物件可以代表一個或多個 XML 物件或元素 (包括多個節點或特質)，所以您可以針對組成群組的元素或集合中的個別元素呼叫方法。

如果 XMLList 物件只有一個 XML 元素，您就可以直接針對 XMLList 物件使用 XML 類別方法。在下列範例中，example.two 是長度為 1 的 XMLList 物件，因此您可以針對該物件呼叫任何 XML 方法。

 var example2 = <example><two>2</two></example>;

如果您嘗試將 XML 類別方法搭配包含一個以上 XML 物件的 XMLList 物件一起使用，則會擲回例外；您要改用的方式是重複執行 XMLList 集合 (例如，使用 for each..in 陳述式)，並將該方法套用到集合中的每一個 XML 物件。

檢視範例

相關 API 元素

XML
for each..in
Namespace
QName

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		XMLList(value:Object) 會建立新的 XMLList 物件。	XMLList
		attribute(attributeName:*):XMLList 呼叫每個 XML 物件的 attribute() 方法，並傳回結果的 XMLList 物件。	XMLList
		attributes():XMLList 呼叫每個 XML 物件的 attributes() 方法，並傳回每個 XML 物件之屬性的 XMLList 物件。	XMLList
		child(propertyName:Object):XMLList 呼叫每個 XML 物件的 child() 方法，並傳回包含結果 (依序排列) 的 XMLList 物件。	XMLList
		children():XMLList 呼叫每個 XML 物件的 children() 方法，並傳回包含結果的 XMLList 物件。	XMLList
		comments():XMLList 呼叫每個 XML 物件的 comments() 方法，並傳回註解的 XMLList。	XMLList
		contains(value:XML):Boolean 檢查 XMLList 物件是否包含等於指定之 value 參數的 XML 物件。	XMLList
		copy():XMLList 會傳回指定之 XMLList 物件的副本。	XMLList
		descendants(name:Object = *):XMLList 傳回 XML 物件 (具有指定的 name 參數) 的所有後代 (子系、孫系、曾孫系等等)。	XMLList
		elements(name:Object = *):XMLList 呼叫每個 XML 物件的 elements() 方法。	XMLList
		hasComplexContent():Boolean 會檢查 XMLList 物件是否包含複雜內容。	XMLList
		hasOwnProperty(p:String):Boolean 檢查 p 所指定的屬性。	XMLList
		hasSimpleContent():Boolean 會檢查 XMLList 物件是否包含簡單內容。	XMLList
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		length():int 會傳回 XMLList 物件中的屬性數目。	XMLList
		normalize():XMLList 針對下列各項合併相鄰的文字節點，並移除空的文字節點：XMLList 中的所有文字節點、XMLList 中所含的所有 XML 物件，以及 XMLList 中所有 XML 物件的後代。	XMLList
		parent():Object 如果 XMLList 物件中的所有項目都有相同的父輩，則會傳回該 XMLList 物件的父輩。	XMLList
		processingInstructions(name:String = "*"):XMLList 如果有提供 name 參數，便會列出 XMLList 物件的所有子系 (其中包含具有該名稱的處理指示)。	XMLList
		propertyIsEnumerable(p:String):Boolean 檢查屬性 p 是否位於屬性組 (可在套用至 XMLList 物件之 for..in 陳述式中重複) 中。	XMLList
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		text():XMLList 呼叫每個 XML 物件的 text() 方法，並傳回包含結果的 XMLList 物件。	XMLList
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回 XMLList 物件中所有 XML 物件的字串形式。	XMLList
		toXMLString():String 會傳回 XMLList 物件中所有 XML 物件的字串形式。	XMLList
		valueOf():XMLList 會傳回 XMLList 物件。	XMLList

建構函式詳細資料

()

建構函式

public function XMLList(value:Object)

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會建立新的 XMLList 物件。

參數

value:Object — 可使用最上層 XMLList() 函數轉換成 XMLList 物件的任何物件。

相關 API 元素

top-level XMLList() function

方法詳細資訊

attribute

()

方法

AS3 function attribute(attributeName:*):XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 attribute() 方法，並傳回結果的 XMLList 物件。結果會符合指定的 attributeName 參數。如果沒有相符項目，attribute() 方法便會傳回空的 XMLList 物件。

參數

attributeName:* — 您要將其納入 XMLList 物件的特質名稱。

傳回值

XMLList — 相符之 XML 物件的 XMLList 物件，或是空的 XMLList 物件。

相關 API 元素

XML.attribute()
XML.attributes()

attributes

()

方法

AS3 function attributes():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 attributes() 方法，並傳回每一個 XML 物件之特質的 XMLList 物件。

傳回值

XMLList — 每個 XML 物件之特質的 XMLList 物件。

相關 API 元素

XML.attribute()
XML.attributes()

child

()

方法

AS3 function child(propertyName:Object):XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 child() 方法，並傳回包含結果 (依序排列) 的 XMLList 物件。

參數

propertyName:Object — XML 子系的元素名稱或整數。

傳回值

XMLList — 子節點的 XMLList 物件，與輸入參數相符。

相關 API 元素

XML.child()

children

()

方法

AS3 function children():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 children() 方法，並傳回包含結果的 XMLList 物件。

傳回值

XMLList — XML 物件中子系的 XMLList 物件。

相關 API 元素

XML.children()

comments

()

方法

AS3 function comments():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 comments() 方法，並傳回註解的 XMLList。

傳回值

XMLList — XML 物件中註解的 XMLList。

相關 API 元素

XML.comments()

contains

()

方法

AS3 function contains(value:XML):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會檢查 XMLList 物件是否包含等於指定之 value 參數的 XML 物件。

參數

value:XML — 要與目前的 XMLList 物件進行比較的 XML 物件。

傳回值

Boolean — 如果 XMLList 包含在 value 參數中宣告的 XML 物件，則為 true，否則為 false。

copy

()

方法

AS3 function copy():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會傳回指定之 XMLList 物件的副本。此副本為整個節點樹狀結構的重製。複製的 XML 物件沒有父輩，而且會在您嘗試呼叫 parent() 方法時傳回 null。

傳回值

XMLList — XMLList 物件的副本。

descendants

()

方法

AS3 function descendants(name:Object = *):XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

傳回 XML 物件 (具有指定的 name 參數) 的所有後代 (子系、孫系、曾孫系等等)。 name 參數可以是 QName 物件、String 資料類型，或是會在之後轉換成 String 資料類型的其他任何資料類型。

若要傳回所有後代，請使用星號 (*) 參數。如果沒有傳遞任何參數，便會傳遞 "*" 字串，並傳回 XML 物件的所有後代。

參數

name:Object (default = *) — 要相符的元素名稱。

傳回值

XMLList — 原始清單中 XML 物件之相符後代 (子系、孫系等等) 的 XMLList 物件。如果沒有後代，便會傳回空的 XMLList 物件。

相關 API 元素

XML.descendants()

elements

()

方法

AS3 function elements(name:Object = *):XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 elements() 方法。 name 參數會傳遞給 descendants() 方法。如果沒有傳遞任何參數，便會將字串 "*" 傳遞給 descendants() 方法。

參數

name:Object (default = *) — 要相符的元素名稱。

傳回值

XMLList — XML 物件之相符子系元素的 XMLList 物件。

相關 API 元素

XML.elements()

hasComplexContent

()

方法

AS3 function hasComplexContent():Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會檢查 XMLList 物件是否包含複雜內容。如果 XMLList 物件不是空的，而且下列條件成立，便會將其視為含有複雜的內容：

XMLList 物件包含具有複雜內容的單一 XML 項目。
XMLList 物件包含多個元素。

傳回值

Boolean — 如果 XMLList 物件包含複雜內容，則為 true，否則為 false。

hasOwnProperty

()

方法

AS3 function hasOwnProperty(p:String):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會檢查 p 所指定的屬性。

參數

p:String — 要相符的屬性。

傳回值

Boolean — 如果此參數存在，則為 true，否則為 false。

hasSimpleContent

()

方法

AS3 function hasSimpleContent():Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會檢查 XMLList 物件是否包含簡單內容。如果下列一個或多個條件成立，便會將 XMLList 物件視為含有簡單內容：

XMLList 是空的物件
XMLList 物件包含具有簡單內容的單一 XML 項目
XMLList 物件不包含任何元素

傳回值

Boolean — 如果 XMLList 物件包含簡單內容，則為 true，否則為 false。

length

()

方法

AS3 function length():int

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會傳回 XMLList 物件中的屬性數目。

傳回值

int — XMLList 物件中的屬性數目。

normalize

()

方法

AS3 function normalize():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

針對下列各項合併相鄰的文字節點，並移除空的文字節點：XMLList 中的所有文字節點、XMLList 中所含的所有 XML 物件，以及 XMLList 中所有 XML 物件的後代。

傳回值

XMLList — 一般化的 XMLList 物件。

parent

()

方法

AS3 function parent():Object

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

如果 XMLList 物件中的所有項目都有相同的父輩，則會傳回該 XMLList 物件的父輩。如果 XMLList 物件沒有父輩或有不同的父輩，此方法便會傳回 undefined。

傳回值

Object — 傳回父輩 XML 物件。

processingInstructions

()

方法

AS3 function processingInstructions(name:String = "*"):XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

如果有提供 name 參數，便會列出 XMLList 物件 (其中包含具有該名稱的處理指示) 的所有子系。如果沒有任何參數，此方法便會列出 XMLList 物件的所有子系 (其中包含任何處理指示)。

參數

name:String (default = "*") — 要符合的處理指示名稱。

傳回值

XMLList — 包含每個 XML 物件之處理指示的 XMLList 物件。

相關 API 元素

XML.processingInstructions()

propertyIsEnumerable

()

方法

AS3 function propertyIsEnumerable(p:String):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

檢查屬性 p 是否位於屬性組 (可在套用至 XMLList 物件之 for..in 陳述式中重複) 中。只有在 toNumber(p) 大於或等於 0，並小於 XMLList 物件的長度時，才為 true。

參數

p:String — 要檢查之屬性的索引。

傳回值

Boolean — 如果此屬性可以在 for..in 陳述式中重複，則為 true，否則為 false。

text

()

方法

AS3 function text():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會呼叫每一個 XML 物件的 text() 方法，並傳回包含結果的 XMLList 物件。

傳回值

XMLList — XMLList 物件之所有 XML 屬性 (代表 XML 文字節點) 的 XMLList 物件。

相關 API 元素

XML.text()

toString

()

方法

AS3 function toString():String

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會傳回 XMLList 物件中所有 XML 物件的字串形式。這項轉換的規則，取決於 XML 物件具有簡單內容還是複雜內容而定：

如果 XML 物件具有簡單內容，toString() 便會傳回 XML 物件的字串內容，並去除下列各項：開始標籤、特質、命名空間宣告及結束標籤。

如果 XML 物件具有複雜內容，toString() 會傳回代表整個 XML 物件的 XML 編碼字串，其中包含開始標籤、特質、命名空間宣告及結束標籤。

若要每次都傳回整個 XML 物件，請使用 toXMLString() 方法。

傳回值

String — XML 物件的字串形式。

範例 ( 如何使用本範例 )

下列範例會示範當 XML 物件具有簡單內容時，toString() 方法所傳回的內容：

var test:XML = <type name="Joe">example</type>;
trace(test.toString()); //example

下列範例會示範當 XML 物件具有複雜內容時，toString() 方法所傳回的內容：

var test:XML = 
<type name="Joe">
    <base name="Bob"></base>
    example
</type>;
trace(test.toString());
  // <type name="Joe">
  // <base name="Bob"/>
  // example
  // </type>

toXMLString

()

方法

AS3 function toXMLString():String

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會傳回 XMLList 物件中所有 XML 物件的字串形式。無論 XML 物件具有簡單內容還是複雜內容，toXMLString() 方法永遠都會傳回 XML 物件的開始標籤、特質及結束標籤，與 toString() 方法不同。 (toString() 方法會針對包含簡單內容的 XML 物件去除這些項目)。

傳回值

String — XML 物件的字串形式。

相關 API 元素

toString()

valueOf

()

方法

AS3 function valueOf():XMLList

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9

會傳回 XMLList 物件。

傳回值

XMLList — 傳回目前的 XMLList 物件。

範例如何使用本範例

XMLListExample.as

下列範例會建立名為 books 的 XML 屬性，並將具有 book publisher 和 name 標籤的幾個項目加入到名為 books 的節點中。然後會呼叫 showBooksByPublisher() 方法，此方法會使用 XMLList，並傳回與發行者 "Addison-Wesley" 相符的每一個項目。

package {
    import flash.display.Sprite;

    public class XMLListExample extends Sprite {
        private var books:XML;

        public function XMLListExample() {
            books =    <books>
                        <book publisher="Addison-Wesley" name="Design Patterns" />
                        <book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
                        <book publisher="Addison-Wesley" name="Test Driven Development" />
                        <book publisher="Addison-Wesley" name="Refactoring to Patterns" />
                        <book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
                        <book publisher="O'Reilly Media" name="Unit Test Frameworks" />
                    </books>;

            showBooksByPublisher("Addison-Wesley");
        }

        private function showBooksByPublisher(name:String):void {
            var results:XMLList = books.book.(@publisher == name);
            showList(results);
        }

        private function showList(list:XMLList):void {
            var item:XML;
            for each(item in list) {
                trace("item: " + item.toXMLString());
            }
        }
    }
}

法律聲明 | 線上隱私權政策

XMLList - AS3

套件x

語言元素

附錄

類別 x

XMLList

attribute

attributes

child

children

comments

contains

copy

descendants

elements

hasComplexContent

hasOwnProperty

hasSimpleContent

length

normalize

parent

processingInstructions

propertyIsEnumerable

text

toString

toXMLString

valueOf