SimpleDS.TSimpleDataSet Methods
From RAD Studio API Documentation
InheritedProtected
_AddRef protected Called when an application uses a component interface.
_Release protected Called when an application releases a component interface.
ActivateBuffers protected Activates the buffers for the active record.
ActivateFilters protected
ActiveBuffer public Returns a pointer to the buffer for the active record.
AddDataPacket protected
AddFieldDesc protected
AddIndex public Creates a new index for the client dataset.
AfterConstruction public Responds after the last constructor has executed.
AllocConnection protected
AllocDataSet protected
AllocKeyBuffers protected
AllocProvider protected
AllocRecordBuffer protected
Append public Adds a new, empty record to the end of the dataset.
AppendData public Adds a newly fetched packet of records to those already stored in the client dataset.
AppendRecord public Adds a new, populated record to the end of the dataset and posts it.
ApplyRange public Applies a range to the dataset.
ApplyUpdates public Sends all updated, inserted, and deleted records from the client dataset to the provider for writing to the database.
Assign public Copies the contents of another similar object.
AssignTo protected Copies the properties of an object to a destination object.
AsyncSchedule protected Schedules asynch method calls.
BeforeDestruction public Performs any necessary actions before the first destructor is called.
BindFields protected Binds the TField components to the physical fields.
BlockReadNext protected Moves to the record from the next block and reads it.
BookmarkAvailable protected Verifies whether there is a bookmark available.
BookmarkValid public Tests the validity of a specified bookmark.
CalculateFields (deprecated) protected Calculates the lookup fields.
Cancel public Cancels unposted changes to the current record.
CancelRange public Removes any ranges currently in effect for the client dataset.
CancelUpdates public Clears all pending edits and clears the change log.
CanObserve protected
ChangeName protected Sets the private, internal storage for the Name property to the string passed in
NewName. Check protected
CheckActive protected Checks whether the dataset is active.
CheckBiDirectional protected Checks whether the dataset is bidirectional.
CheckBrowseMode public Automatically posts or cancels data changes when the active record changes.
CheckDetailRecords protected
CheckDisposed protected
CheckFieldCompatibility protected Checks the compatibility of a field.
CheckInactive protected Checks whether the dataset is inactive.
CheckProviderEOF protected
CheckSetKeyMode protected
ClassInfo public Returns a pointer to the run-time type information (RTTI) table for the object type.
ClassName public Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIs public Determines whether an object is of a specific type.
ClassParent public Returns the type of the immediate ancestor of a class.
ClassType public Returns the class reference for the object's class.
CleanupInstance public Performs finalization on long strings, variants, and interface variables within a class.
ClearBuffers protected Clears the buffers for the active record.
ClearCalcFields protected
ClearFields public Clears the contents of all fields for the active record.
CloneCursor public Shares the data belonging to another client dataset.
CloseBlob protected Closes a binary large object field.
CloseCursor protected
CompareBookmarks public Compares two bookmarks.
ConstraintsDisabled public Indicates whether constraints are enabled for a client dataset.
ConstraintsStored protected
ControlsDisabled public Indicates whether data-aware controls update their display to reflect changes to the dataset.
CopyFields public CopyFields copies the field definition structure of another dataset.
CreateBlobStream public Returns a TClientBlobStream object for reading or writing the data in a specified blob field.
CreateDataSet public Creates a new, empty client dataset.
CreateFields protected Creates the automatic fields.
CreateNestedDataSet protected Creates a nested dataset.
CursorPosChanged public Marks the internal cursor position as invalid.
DataConvert (deprecated) protected
DataEvent protected
DataRequest public Generates an OnDataRequest event on the associated provider.
DeactivateFilters protected
DefaultFields (deprecated) public Indicates whether a dataset's underlying field components are generated dynamically when the dataset is opened.
DefaultHandler public Provides the interface for a method that processes message records.
DefChanged protected
DefineProperties protected
DeleteIndex public Deletes an index for the client dataset.
DestroyComponents public Destroys all owned components.
DestroyFields protected Destroys the dataset automatic fields.
Destroying public Indicates that the component and its owned components are about to be destroyed.
DestroyLookupCursor protected
DisableConstraints public Disables the enforcement of constraints.
DisableControls public Disables data display in data-aware controls associated with the dataset.
Dispatch public Calls message-handling methods for the object, based on the contents of the Message parameter.
DoAfterApplyUpdates protected
DoAfterCancel protected AfterCancel event dispatcher.
DoAfterClose protected AfterClose event dispatcher.
DoAfterDelete protected AfterDelete event dispatcher.
DoAfterEdit protected AfterEdit event dispatcher.
DoAfterExecute protected
DoAfterGetParams protected
DoAfterGetRecords protected
DoAfterInsert protected AfterInsert event dispatcher.
DoAfterOpen protected AfterOpen event dispatcher.
DoAfterPost protected AfterPost event dispatcher.
DoAfterRefresh protected AfterRefresh event dispatcher.
DoAfterRowRequest protected
DoAfterScroll protected AfterScroll event dispatcher.
DoApplyUpdates protected
DoBeforeApplyUpdates protected
DoBeforeCancel protected BeforeCancel event dispatcher.
DoBeforeClose protected BeforeClose event dispatcher.
DoBeforeDelete protected BeforeDelete event dispatcher.
DoBeforeEdit protected BeforeEdit event dispatcher.
DoBeforeExecute protected
DoBeforeGetParams protected
DoBeforeGetRecords protected
DoBeforeInsert protected
DoBeforeOpen protected BeforeOpen event dispatcher.
DoBeforePost protected BeforePost event dispatcher.
DoBeforeRefresh protected BeforeRefresh event dispatcher.
DoBeforeRowRequest protected
DoBeforeScroll protected BeforeScroll event dispatcher.
DoExecute protected
DoGetRecords protected
DoOnCalcFields protected OnCalcFields event dispatcher.
DoOnNewRecord protected
DoRowRequest protected
Edit public Enables editing of data in the dataset.
EditKey public Enables modification of the search key buffer.
EditRangeEnd public Enables changing the ending value for an existing range.
EditRangeStart public Enables changing the starting value for an existing range.
EmptyDataSet public Removes all records from the dataset.
EnableConstraints public Reenables enforcement of constraints when records are posted.
EnableControls public Re-enables data display in data-aware controls associated with the dataset.
EndFunctionInvoke public Blocks the caller until the specified
ASyncResult completes. EndInvoke public Blocks the caller until the specified
ASyncResult completes. Equals public Checks whether the current instance and the Obj parameter are equal.
Execute public Executes an SQL command by the provider's dataset.
ExecuteAction public Executes an action.
ExecuteCommand protected Executes an extended command of a TDataSet descendant.
FetchBlobs public Retrieves BLOB field values from the provider.
FetchDetails public Retrieves nested detail datasets from the provider.
FetchMoreData protected
FetchParams public
FieldAddress public Returns the address of a published object field.
FieldByName public Finds a field based on its name.
FieldByNumber protected Finds a field based on the ordinal position of its column in the underlying table or query.
FindComponent public Indicates whether a given component is owned by the component.
FindField public Searches for a specified field in the dataset.
FindFirst public Implements a virtual method for positioning the dataset on the first record, respecting any filters.
FindKey public Searches for a record containing specified field values.
FindLast public Implements a virtual method for positioning the dataset on the last record, respecting any filters.
FindNearest public Moves the cursor to the record that most closely matches a specified set of key values.
FindNext public Implements a virtual method for positioning the dataset on the next record, respecting any filters.
FindPrior public Implements a virtual method for positioning the dataset on the previous record, respecting any filters.
FindRecord protected
First public Moves to the first record in the dataset.
Free public Destroys an object and frees its associated memory, if necessary.
FreeBookmark public Frees the resources allocated for a specified bookmark (somewhat obsolete).
FreeFieldBuffers protected Frees the field buffers.
FreeInstance public Deallocates memory allocated by a previous call to the NewInstance method.
FreeKeyBuffers protected
FreeNotification public Ensures that
AComponent is notified that the component is going to be destroyed. FreeOnRelease public Frees the interface reference for components that were created from COM classes.
FreeRecordBuffer protected
GetAggFieldsClass protected Returns the metaclass for the aggregate fields.
GetAggRecordCount protected Returns the number of aggregate fields.
GetAggregateValue protected
GetAppServer protected
GetBlobFieldData public Reads BLOB data into a buffer.
GetBookmark public Allocates a bookmark for the active record in the dataset.
GetBookmarkData (deprecated) protected
GetBookmarkFlag (deprecated) protected
GetBookmarkStr (deprecated) protected Gets a bookmark represented as a string.
GetCalcFields (deprecated) protected Computes the lookup and calculated fields and updates the status.
GetCalcFieldTypes protected
GetCanModify protected
GetCanRefresh protected
GetCheckConstraintsClass protected Returns the metaclass for TCheckConstraints.
GetChildOwner protected Returns the owner of a child component being read from a stream.
GetChildParent protected Returns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildren protected Enumerates all the owned datasets that are also owned by the specified TComponent.
GetClonedDataSet public
GetCommandStates protected Checks whether an extended command is supported and enabled or not.
GetCurrentRecord (deprecated) public Retrieves the current record into a buffer.
GetDataSource protected
GetDeltaStreams protected
GetDetailDataSets (deprecated) public Fills a list with a dataset for every detail dataset that is not the value of a nested dataset field.
GetDetailLinkFields (deprecated) public Introduces a method to list the field components that link this dataset as a detail of a master dataset.
GetDisposed protected Getter for the Disposed property.
GetEnumerator public Returns a TComponent enumerator.
GetFieldClass protected Returns the metaclass for a field class.
GetFieldData (deprecated) public Retrieves the current value of a field.
GetFieldDefListClass protected Returns the metaclass for a field definition list class.
GetFieldDefsClass protected Returns the metaclass of the TFieldDefs class.
GetFieldFullName protected Returns the full name of the field.
GetFieldList (deprecated) public Retrieves a specified set of field objects into a list.
GetFieldListClass protected Returns the metaclass for a field list class.
GetFieldNames public Retrieves a list of names for all fields in a dataset.
GetFieldsClass protected Returns the TFields descendant metaclass.
GetGroupState public Indicates where the current record sits within a specified group of records.
GetHashCode public Returns an integer containing the hash code.
GetIDsOfNames protected Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetIndexDefs protected Returns the definitions of all specified indexes defined for the dataset.
GetIndexDefsClass protected Returns the metaclass for an index definition list.
GetIndexField protected
GetIndexFieldCount protected
GetIndexInfo public Retrieves information about the current index.
GetIndexNames public Retrieves a list of available indexes for a client dataset.
GetInterface public Retrieves a specified interface.
GetInterfaceEntry public Returns the entry for a specific interface implemented in a class.
GetInterfaceTable public Returns a pointer to a structure containing all of the interfaces implemented by a given class.
GetIsClone protected
GetIsIndexField protected
GetKeyBuffer protected
GetKeyExclusive protected
GetKeyFieldCount protected
GetLookupListClass protected Returns the metaclass for a lookup field list class.
GetNamePath public Returns a string used by the Object Inspector.
GetNextPacket public Retrieves the next block of records from the provider.
GetNextRecord protected Moves to the next record.
GetNextRecords protected Moves to the last record of the dataset.
GetObservers protected Getter of Observers.
GetOptionalParam public Retrieves a custom parameter from the data packet.
GetOwner protected Returns the owner of a component.
GetParamsClass protected Returns the metaclass for a list of field parameters.
GetParentComponent public Returns the containing component.
GetPriorRecord protected Moves to the prior record.
GetPriorRecords protected Moves to the first record of the dataset.
GetRecNo protected
GetRecord (deprecated) protected
GetRecordCount protected
GetRecordSize protected
GetRemoteServer protected
GetStateFieldValue protected
GetTypeInfo protected Retrieves the type information for an object.
GetTypeInfoCount protected Returns the number of type information interfaces that an object provides (either 0 or 1).
GotoBookmark public Implements a virtual method to position the dataset on the record to which a specified bookmark points.
GotoCurrent public Sets the current record in this dataset the same as the current record in another, cloned dataset.
GotoKey public Moves the cursor to a record specified by the current key.
GotoNearest public Moves the cursor to the record that most closely matches the current key.
HasParent public Verifies whether the component has a parent.
InheritsFrom public Determines the relationship of two object types.
InitFieldDefs protected Initializes the field definitions.
InitFieldDefsFromFields protected Initializes the field definitions from persistent fields.
InitInstance public Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InitKeyBuffer protected
InitRecord (deprecated) protected
InsertComponent public Establishes the component as the owner of a specified component.
InsertRecord public Inserts a new, populated record to the dataset and posts it.
InstanceSize public Returns the size in bytes of each instance of the object type.
InternalAddRecord (deprecated) protected
InternalCancel protected
InternalClose protected
InternalDelete protected
InternalEdit protected
InternalFirst protected
InternalGetOptionalParam protected
InternalGotoBookmark (deprecated) protected
InternalHandleException protected
InternalInitFieldDefs protected
InternalInitRecord (deprecated) protected
InternalInsert protected
InternalLast protected
InternalOpen protected
InternalPost protected
InternalRefresh protected
InternalSetOptionalParam protected
InternalSetToRecord (deprecated) protected
Invoke protected Provides access to Automation properties and methods when the component wraps an Automation object.
IsCursorOpen protected
IsEmpty public Indicates whether the dataset contains no records.
IsImplementorOf public Indicates whether the component implements a specified interface.
IsLinkedTo public Indicates whether a dataset is linked to a specified data source.
IsSequenced public Indicates whether the underlying database table uses record numbers to indicate the order of records.
Last public Moves to the last record in the dataset.
Loaded protected
LoadFromFile public Loads a client dataset's data from a file.
LoadFromStream public Loads a client dataset's data from a stream.
Locate public Searches the dataset for a specified record and makes that record current.
LocateRecord protected Searches the dataset for a specified record.
Lookup public Retrieves field values from a record that matches specified search values.
MergeChangeLog public Merges any data changes in the change log into the client dataset, overwriting existing values.
MethodAddress public Returns the address of a class method by name.
MethodName public Returns the name of a class method by address.
MoveBy public Moves to another record relative to the active record in the dataset.
NewInstance public Allocates memory for an instance of an object type and returns a pointer to that new instance.
Next public Moves to the next record in the dataset.
Notification protected
ObserverAdded protected
OpenCursor protected
OpenCursorComplete protected Opens the database cursor and triggers an AfterOpen event.
OpenParentDataSet protected Opens the parent dataset.
operator [] public
operator () public
PaletteCreated protected Responds when the component is created from the component palette.
ParamByName public
PostKeyBuffer protected
Prior public Moves to the previous record in the dataset.
PSEndTransaction protected Ends a transaction that was started by a call to PSStartTransaction.
PSExecute protected Executes the SQL command associated with the dataset.
PSExecuteStatement (deprecated) protected Executes a specified SQL command.
PSGetAttributes protected Returns information that is stored in data packets as Name/Value pairs.
PSGetCommandText protected
PSGetCommandType protected
PSGetDefaultOrder protected Returns the definition of an index that imposes the default order on the data included in data packets.
PSGetIndexDefs protected
PSGetKeyFields protected Returns the names of all fields required to uniquely identify records in the data packet.
PSGetParams protected Returns the current parameter values of the dataset.
PSGetQuoteChar protected Returns the character or characters to use in generated SQL statements to enclose quoted strings.
PSGetTableName protected Returns the name of the dataset table that appears in generated SQL statements.
PSGetUpdateException protected Generates an EUpdateError object based on another exception object.
PSInTransaction protected Indicates whether actions against the dataset occur in the context of a transaction.
PSIsSQLBased protected Indicates whether the dataset includes native SQL support.
PSIsSQLSupported protected Indicates whether the dataset can execute SQL statements.
PSReset protected Resets the dataset so that it is positioned on the first record.
PSSetCommandText protected Assigns a specified SQL command to be executed by PSExecute.
PSSetParams protected Assigns the specified parameter values to the dataset.
PSStartTransaction protected Starts a transaction that encapsulates all activity until a call to PSEndTransaction.
PSUpdateRecord protected Applies a single update to the underlying database table or tables.
QualifiedClassName public Returns the qualified name of the class.
QueryInterface protected Returns a reference to a specified interface if the current component supports that interface.
ReadDataPacket protected
ReadState protected Reads the state of the component.
Reconcile public Clears successfully updated records from the client dataset's cache of changes.
ReferenceInterface public Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
Refresh public Re-fetches data from the database to update a dataset's view of data.
RefreshInternalCalcFields (deprecated) protected
RefreshRecord public Updates the base values of the current record to match the current values of the provider's dataset.
RemoveComponent public Removes a specified component specified from the component's Components list.
RemoveFreeNotification public Disables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotifications protected Notifies all owned components of the owner component's imminent destruction.
ResetAggField protected
ResetCursorRange protected
RestoreState protected Restores the operating mode of the dataset to the given value.
Resync public Re-fetches the active record and the records that precede and follow it.
RevertRecord public Undoes edits to the current record.
SafeCallException public Handles exceptions in methods declared using the safecall calling convention.
SaveToFile public Saves a client dataset's data to an external file.
SaveToStream public Saves a client dataset's data to a stream.
SetActive protected Changes the dataset's state to active.
SetAggregates protected
SetAltRecBuffers protected Sets record buffers when accessing field values.
SetAncestor protected Clears or sets csAncestor state in the component's ComponentState property.
SetAppServer protected
SetBlockReadSize protected Setter method for BlockReadSize.
SetBookmarkData (deprecated) protected
SetBookmarkFlag (deprecated) protected
SetBookmarkStr (deprecated) protected Sets a bookmark represented as a string.
SetBufListSize protected Sets the size of the buffer list.
SetChildOrder protected Sets the visual ordering of a child dataset.
SetCommandText protected
SetConnection protected
SetCurrentRecord protected Moves to the record given by the index.
SetCursorRange protected
SetDataSetField protected
SetDefaultFields (deprecated) protected Specifies whether a dataset's underlying field components are generated dynamically when the dataset is opened.
SetDesigning protected Ensures that components inserted at design time have their design-mode flag set.
SetDesignInstance protected Ensures that components inserted at design time have their design-mode flag set.
SetFieldData (deprecated) protected
SetFields public Sets the values for all fields in a record
SetFilterData protected
SetFiltered protected
SetFilterOptions protected
SetFilterText protected
SetFound protected Sets a "found" flag.
SetIndexField protected
SetInline protected Sets the csInline bit of the component's ComponentState property.
SetKey public Enables setting of keys and ranges for a dataset prior to a search.
SetKeyBuffer protected
SetKeyExclusive protected
SetKeyFieldCount protected
SetKeyFields protected
SetLinkRanges protected
SetModified protected Used internally to set the Modified property.
SetName protected
SetObjectView protected Sets the ObjectView property.
SetOnFilterRecord protected
SetOptionalParam public Saves a custom parameter with the data packet.
SetParentComponent protected Sets the parent component.
SetProvider public Associates the client dataset with a provider in the same process space.
SetProviderEOF protected
SetRange public Sets the starting and ending values of a range, and applies it.
SetRangeEnd public Indicates that subsequent assignments to field values specify the end of the range of rows to include in the dataset.
SetRangeStart public Indicates that subsequent assignments to field values specify the start of the range of rows to include in the dataset.
SetRecNo protected
SetRemoteServer protected
SetState protected Sets the dataset's state.
SetSubComponent public Identifies whether the component is a subcomponent.
SetTempState protected Restores the operating mode of the dataset to the given value.
SetUniDirectional protected Sets the dataset type: unidirectional or not.
SetValidatingField protected
SwitchToIndex protected
SyncCursors protected
TempBuffer protected Returns a temporary buffer.
ToString public Returns a string containing the class name.
Translate public Implements a virtual procedure to copy a data string from a source to a destination, optionally performing character translation during the copy.
UndoLastChange public Undoes the last edit, insert, or delete operation to a record in the client dataset.
UnitName public Returns the name of the unit where the class is defined.
UnitScope public Returns the class's unit scope.
UpdateAction public Updates the state of an action.
UpdateBufferCount protected Updates the buffer count.
UpdateCursorPos public Positions the cursor on the active record.
Updated protected Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateIndexDefs protected
UpdateRecord public Ensures that data-aware controls and detail datasets reflect record updates.
UpdateRegistry protected Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateStatus public Reports the update status for the current record in the dataset.
ValidateContainer protected Determines whether an object can be inserted into a container.
ValidateInsert protected Provides the interface for a method that validates a child component before it is inserted.
ValidateRename protected Ensures that renaming an owned component does not create a name conflict.
WriteDataPacket protected
WriteState protected Writes the state of the component.