IdbCursor Class

A cursor over the records of an object store or an index (https://w3c.github.io/IndexedDB/#idbcursor).

public class IdbCursor

Properties

NameDescription
DirectionGets the direction of the cursor.
KeyGets the key of the cursor (the same value until the cursor moves), or null (undefined).
PrimaryKeyGets the effective key of the cursor (the same value until the cursor moves), or null (undefined).
RequestGets the request of the cursor.
SourceGets the object store or the index of the cursor.

Direction

IdbCursor.cs

Gets the direction of the cursor.

public IdbCursorDirection Direction { get; }

Gets the key of the cursor (the same value until the cursor moves), or null (undefined).

public object? Key { get; }

PrimaryKey

IdbCursor.cs

Gets the effective key of the cursor (the same value until the cursor moves), or null (undefined).

public object? PrimaryKey { get; }

Gets the request of the cursor.

public IdbRequest Request { get; }

Gets the object store or the index of the cursor.

public object Source { get; }

Methods

NameDescription
Advance(uint)Advances the cursor by a number of records (https://w3c.github.io/IndexedDB/#dom-idbcursor-advance).
Continue(object?)Advances the cursor to the next record, or to the next record at or after a key (https://w3c.github.io/IndexedDB/#dom-idbcursor-continue).
ContinuePrimaryKey(object?, object?)Advances the cursor of an index to a key and a primary key (https://w3c.github.io/IndexedDB/#dom-idbcursor-continueprimarykey).
Delete()Deletes the record of the cursor (https://w3c.github.io/IndexedDB/#dom-idbcursor-delete).
Update(object?)Replaces the value of the record of the cursor (https://w3c.github.io/IndexedDB/#dom-idbcursor-update).

Advance(uint)

IdbCursor.cs

Advances the cursor by a number of records (https://w3c.github.io/IndexedDB/#dom-idbcursor-advance).

public void Advance(uint count)

Continue(object?)

IdbCursor.cs

Advances the cursor to the next record, or to the next record at or after a key (https://w3c.github.io/IndexedDB/#dom-idbcursor-continue).

public void Continue(object? key = null)

ContinuePrimaryKey(object?, object?)

IdbCursor.cs

Advances the cursor of an index to a key and a primary key (https://w3c.github.io/IndexedDB/#dom-idbcursor-continueprimarykey).

public void ContinuePrimaryKey(object? key, object? primaryKey)

Delete()

IdbCursor.cs

Deletes the record of the cursor (https://w3c.github.io/IndexedDB/#dom-idbcursor-delete).

public IdbRequest Delete()

Update(object?)

IdbCursor.cs

Replaces the value of the record of the cursor (https://w3c.github.io/IndexedDB/#dom-idbcursor-update).

public IdbRequest Update(object? value)