Sign in Join
FPDoc Onlineexperiment

TDOMElementList.NodeFilter function

Member of TDOMElementListprotectedIn unit Laz2_DOM

Determines if the node can be used in the DOM element list.

Declaration

pascal
function NodeFilter(aNode: TDOMNode): TFilterResult; override

Arguments

aNode

DOM Node to include or exclude using the Filter value.

Function result

True if the specified node matches the tag name filter for the list.

Description

NodeFilter is an overridden TFilterResult function used to determine if the DOM node specified in ANode can be included in the DOM Element list. The return value indicates whether the node is allowed in the element list.

NodeFilter re-implements the method defined in the ancestor class to check whether the DOM Node in ANode has ELEMENT_NODE in its NodeType property.

If the Element list was created with a Namespace URI argument, the Namespace Information for the list is used to get the return value. It is set to True when the LocalName for the node matches the qualified name in the Namespace Information.

If the Element list was created using a tag name as a filter, the return value is True when the TagName property in the node contains the same value. It is also True when the filter value was set to '*' for any element.

The return value is always False if the specified node is not a DOM Element.

NodeFilter is called from the inherited BuildList method.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.