Class DocumentNodeList<T>

Abstract base class for list-like document nodes. It contains standard System.Collections.Generic.IList methods to modify the collection.

Since

2.0

Type Parameters

Hierarchy (View Summary)

DocumentNodeListBase<T>
- DocumentNodeList

Index

Methods

[iterator]

"[iterator]"(): Iterator<JsType<T>>
Returns Iterator<JsType<T>>
Overrides DocumentNodeListBase.[iterator]

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNodeListBase.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNodeListBase.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNodeListBase.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNodeListBase.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNodeListBase.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNodeListBase.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, JsType<T>> & PropertySet<
    number
    | Int32,
    T | JsType<T>,
>

Gets or sets the element at the specified index.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index.

Since

2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from DocumentNodeListBase.Context

Count

get Count(): number
Gets the number of elements contained in this instance.

Returns number
Since
2.0

Inherited from DocumentNodeListBase.Count

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from DocumentNodeListBase.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from DocumentNodeListBase.Transactions

Add

Add(item: T | JsType<T>): void
Adds an item to this collection.
Parameters
- item: T | JsType<T>
  The item to add.
Returns void
Since
2.0

AddRange

AddRange(
collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>,
): void
Adds the elements of the specified collection to the end of this collection.
Parameters
- collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>
  The collection whose elements should be added to the end of this collection. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.
Returns void
Since
2.0

Clear

Clear(): void
Removes all items from this collection.

Returns void
Since
2.0

Contains

Contains(value: T | JsType<T>): boolean
Determines whether the specified value is in this collection.
Parameters
- value: T | JsType<T>
  The object to locate in this collection. The value can be null.
Returns boolean
true if value is found in this collection; otherwise, false.

Since
2.0

Inherited from DocumentNodeListBase.Contains

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNodeListBase.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<T>
Returns an enumerator that iterates through this collection.

Returns System.Collections.Generic.IEnumerator<T>
An System.Collections.Generic.IEnumerator for this collection.

Since
2.0

Inherited from DocumentNodeListBase.GetEnumerator

IndexOf

IndexOf(value: T | JsType<T>): number
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
Parameters
- value: T | JsType<T>
  The object to locate. The value can be null.
Returns number
The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

Since
2.0

Inherited from DocumentNodeListBase.IndexOf

Insert

Insert(index: number | Int32, item: T | JsType<T>): void
Inserts an element into this collection at the specified index.
Parameters
- index: number | Int32
  The zero-based index at which item should be inserted.
- item: T | JsType<T>
  The object to insert. The value can be null.
Returns void
Since
2.0

InsertRange

InsertRange(
index: number | Int32,
collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>,
): void
Inserts the elements of the specified collection at the specified index in this collection.
Parameters
- index: number | Int32
  The index where the first element shall be inserted.
- collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>
  The collection whose elements should be inserted in this collection. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.
Returns void
Since
2.0

Move

Move(fromIndex: number | Int32, toIndex: number | Int32): void
Moves the item at the specified index to a new location in the collection.
Parameters
- fromIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(item: T | JsType<T>): boolean
Removes the first occurrence of a specific object from this collection.
Parameters
- item: T | JsType<T>
  The object to remove.
Returns boolean
true if item was successfully removed from this collection; otherwise, false. This method also returns false if item is not found.

Since
2.0

RemoveAt

RemoveAt(index: number | Int32): void
Removes the element at the specified index.
Parameters
- index: number | Int32
  The zero-based index of the element to remove.
Returns void
Since
2.0

RemoveRange

RemoveRange(index: number | Int32, count: number | Int32): void
Removes a range of count elements starting at the specified index.
Parameters
- index: number | Int32
  The index of the first element to remove.
- count: number | Int32
  The number of elements to remove.
Returns void
Since
2.0

ReplaceAll

ReplaceAll(
collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>,
): void
Replaces the contents of the list with the elements in the specified collection.
Parameters
- collection: OrExplicit<System.Collections.Generic.IEnumerable<T>>
  The collection. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.
Returns void
Since
2.0

ToArray

ToArray(): TypedArray<JsType<T>>
Copies the elements of the collection to a new array.

Returns TypedArray<JsType<T>>
An array containing the elements.

Since
2.0

Inherited from DocumentNodeListBase.ToArray

Class DocumentNodeList<T>

Since

Type Parameters

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<JsType<T>>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

Add

Parameters

Returns void

Since

AddRange

Parameters

Returns void

Since

Clear

Returns void

Since

Contains

Parameters

Returns boolean

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<T>

Since

IndexOf

Parameters

Returns number

Since

Insert

Parameters

Returns void

Since

InsertRange

Parameters

Returns void

`Static`Equals

`Readonly`Item