Help Center

Local Navigation

Object: HTMLCollection

Availability

BlackBerry® Device Software version 4.6 or later

The HTMLCollection object is an array that contains an ordered collection of nodes. HTMLCollection objects are automatically updated when the underlying document is changed.

You can access an individual node within a collection by its index position using HTMLCollection.item(), by its name or id attribute using HTMLCollection.namedItem(), or you can index the object directly. For example, if you create an instance of a HTMLCollection object called myHTMLNodes, then specifying

myHTMLNodes.item(2)

myHTMLNodes.namedItem(“item”)

is equivalent to specifying

myHTMLNodes[2]

myHTMLNodes[“item”]

HTMLCollection properties

Property name

Type

Description

Status

Availability

length

int

Returns the number of nodes in the list.

read only

4.6 or later

HTMLCollection methods

Method name

Description

Availability

item()

Returns the node at the specified index.

4.6 or later

namedItem()

Retrieves the node with the given name from the collection.

4.6 or later

Method: HTMLCollection.item()

Availability

BlackBerry® Device Software version 4.6 or later

The item() method returns the node at the specified index.

Syntax

HTMLCollection.item( index )

Parameters

Parameter

Type

Description

index

int

The index position of the node to be returned. Valid values are between 0 and HTMLCollection.length-1 inclusive.

Return values

Returns the node at the indexth position in the HTMLCollection array, or null if an invalid index position is specified.

Exceptions

None.

Method: HTMLCollection.namedItem()

Availability

BlackBerry® Device Software version 4.6 or later

The namedItem() method retrieves the node with the given name from the collection.

This method behaves differently depending on the document type:

  • If the document is an HTML document, this method first searches for a node with an id attribute that matches the given name, then searches for a node with a name attribute that matches the given name if no matching id attribute exists.

    When searching HTML documents, this method is case insensitive.

  • If the document is an XHTML document, this method only searches for nodes with an id attribute that matches the given name.

    When searching XHTML documents, this method is case sensitive.

Syntax

HTMLCollection.namedItem( name )

Parameters

Parameter

Type

Description

name

String

The name of the node to retrieve.

Return values

Returns the node with an id or name attribute of name, or null if no node with the given name exists.

Exceptions

None.


Was this information helpful? Send us your comments.