CLASS:

 

 

 

 

 

 

 

 

DESCRIPTION:

 

 

 

Represents the entire set of records from the results of an executed command.

 

 

 

 

 

SYNTAX:

 

 

 

These objects are created automatically by the ADO component.

 

 

 

 

 

 

 

PROPERTY:

DEFAULT:

DESCRIPTION:

 

 

baseClassName

ADOROWSET

Identifies the object as an instance of the ADORowset class 

 

 

className

ADOROWSET

Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName

 

 

parent

Object

Reference to ADO component that contains this object. 

 

 

affectOptions

0 - Current Row

Available options that can be used to the affect rows operations.

 

 

chapters

Object

A reference to an array that contains the ADOChapter objects.

 

 

constrained

false

Whether the rows are constrained by setRange().

 

 

endOfSet

false

Whether the row cursor is at either end of the set.

 

 

fields

Object

A reference to an array that contains the ADOField objects.

 

 

filter

Empty string 

Filter SQL expression.

 

 

filtered

false

Whether the rows are filtered.

 

 

filterGroup

0 - None

Enum specifies the group of rows to be filtered.

 

 

indexName

Empty string 

Name of the index to be used.

 

 

live

true

Whether the data can be modified.

 

 

marschalOptions

0 - All Rows

Available options that can be used to the marshaling operations.

 

 

masteFields

Empty string 

Field list for master-detail link.

 

 

masterChild

0 – Constrained

In a master-detail link, enum specifying whether or not the child table’s rowset is constrained.

 

 

masterRowset

null

A reference to the master Rowset object.

 

 

modified

false

Indicate whether the current row has been modified.

 

 

notifyControls

true

Whether to automatically update dataLinked controls.

 

 

optimizeFields

Empty string 

One or more field names that will be optimized.

 

 

sort

Empty string 

One or more field names on which the rows is sorted.

 

 

state

0 - Closed

Enum that indicates the rowset's current mode.

 

 

tableDriver

Empty string 

The name of the driver currently being used to access a table.

 

 

tableName

Empty string 

The name of the table the current rowset is based on.

 

 

autoEdit

true

Whether the rowset automatically switches to Edit mode 

 

 

handle

0

ADO statement handle.

 

 

 

 

 

EVENT:

PARAMETERS:

DESCRIPTION:

 

 

canAbandon

 

When abandon() is called; return value allows or disallows abandoning of row.

 

 

canAppend

 

When beginAppend() is called; return value allows or disallows start of append.

 

 

canDelete

 

When delete() is called; return value allows or disallows deletion.

 

 

canEdit

 

When beginEdit() is called; return value allows or disallows switch to Edit mode.

 

 

canGetRow

 

When attempting to read row; return value acts as an additional filter

 

 

canNavigate

 

When attempting row navigation; return value allows or disallows navigation.

 

 

canSave

 

When save() is called; return value allows or disallows saving of row.

 

 

onAbandon

 

After successful abandon().

 

 

onAppend

 

After successful beginAppend().

 

 

onDelete

 

After successful delete().

 

 

onEdit

 

After successful beginEdit().

 

 

onNavigate

<method expN>,<rows expN>

After rowset navigation.

 

 

onSave

 

After successful save().

 

 

 

 

 

METHOD:

PARAMETERS:

DESCRIPTION:

 

 

abandon

 

Abandons pending changes to current row.

 

 

applyFilter

[<filter expC>][<bookmarks expA>] 

Applies filter set during rowset’s Filter mode.

 

 

applyLocate

[<locate expC>]

Finds first row that matches specified criteria.

 

 

atFirst

 

Returns true if current row is first row in rowset.

 

 

atLast

 

Returns true if current row is last row in rowset.

 

 

beginAppend

 

Starts append of new row.

 

 

beginEdit

 

Puts rowset in Edit mode, allowing changes to fields.

 

 

beginFilter

 

Puts rowset in Filter mode, allowing entry of filter criteria.

 

 

beginLocate

 

Puts rowset in Locate mode, allowing entry of search criteria.

 

 

bookmark

 

Returns bookmark for current row.

 

 

bookmarksEqual

<bookmark 1>[,<bookmark 2>]

Compares two bookmarks or one bookmark with current row to see if they refer to same row.

 

 

clearFilter

 

Disables filter created by applyFilter() and clears filter property.

 

 

clearRange

 

Disables constraint created by setRange().

 

 

clone

 

Creates a duplicate rowset.

 

 

count

 

Returns number of rows in rowset, honoring filters.

 

 

delete

 

Deletes current row.

 

 

findKey

<key exp> or <keys expA>

Finds the row with the exact matching key value.

 

 

findKeyNearest

<key exp> or <keys expA>

Finds the row with the nearest matching key value.

 

 

first

 

Moves row cursor to first row in set.

 

 

flush

 

Commits the rowset buffer to disk.

 

 

goto

<bookmark>

Moves row cursor to specified row.

 

 

last

 

Moves row cursor to last row in set.

 

 

locateNext

[<rows expN>]

Finds other rows that match search criteria.

 

 

next

[<rows expN>]

Navigates to adjacent rows.

 

 

refresh

 

Refreshes entire rowset.

 

 

refreshControls

 

Refreshes dataLinked controls.

 

 

refreshRow

 

Refreshes current row only.

 

 

rowCount

 

Returns logical row count if known.

 

 

rowNo

 

Returns logical row number if known.

 

 

save

 

Saves current row.

 

 

saveToFile

<file expC>[,<format expC>]

Saves the contents of a rowset to a file.

 

 

saveToStream

<stream expO>[,<format expC>]

Saves the contents of a rowset to stream object.

 

 

setRange

<key exp> or <startKey exp> | null, <endKey exp> | null 

Constrains the rowset to those rows whose key field values falls within a range.

 

 

supports

 

 

 

 

schema

 

Returns an ADORowset object containing metadata for the rowset.

 

 

show

 

 

 

 

 

 

 

 

 

 

DESCRIPTION: