RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TDataSetAdapter Members

The following tables list the members exposed by TDataSetAdapter.

 
Name 
Description 
 
FComponentStyle is the field of the ComponentStyle read-only property. 
 
Name 
Description 
 
Called when an application uses a component interface. 
 
Called when an application releases a component interface. 
 
Defines a hidden field that passes the adapter's mode value in the HTTP request when an HTML form is submitted. 
 
Adds the default action components to this adapter. 
 
Adds default action components to this adapter. 
 
Adds default action components to this adapter. 
 
Adds the default field components to this adapter. 
 
Adds default field components to this adapter. 
 
Defines hidden field(s) that pass the original values of adapter fields in the HTTP request when an HTML form is submitted. 
 
Defines hidden field(s) that pass key values in the HTTP request when an HTML form is submitted. 
 
Copies the properties of an object to a destination object. 
 
Indicates whether a type of adapter action can be added to this adapter. 
 
Indicates whether a type of adapter field can be added to this adapter. 
 
Sets the private, internal storage for the Name property to the string passed in NewName. 
 
Checks end-user rights to modify the adapter's field values. 
 
Clears adapter state information. 
 
Clears the content of the adapter's Errors property. 
 
Creates an object that describes the adapter action parameters and adapter field values. 
 
Creates the object used to manage errors associated with this adapter. 
 
Notifies other components of changes to the list of default actions or fields. 
 
Designates methods for storing an object's unpublished data on a stream such as a form file. 
 
Provides an interface for a method that reads and writes otherwise unpublished data. 
 
Writes name/value pairs that represent adapter state. 
 
Writes name/value pairs that represent adapter state. 
 
Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter. 
 
Indicates whether the record index has gone past the last record in the current page. 
 
Reads name/value pairs from the HTTP request. 
 
Reads name/value pairs from the HTTP request. 
 
Returns an action component with a matching action name. 
 
Returns an adapter field component with a matching field name. 
 
Finds an action with a matching variable name. 
 
Finds an adapter field with a matching variable name. 
 
Finds a field or action with a matching variable name. 
 
Finds an adapter action or adapter field with the given variable name. 
 
Finds an adapter action or adapter field that is a container for other scriptable objects. 
 
Indicates whether the HTML input names must be qualified with the name of the adapter. 
 
Specifies the class to create as a container for adapter actions components. 
 
Specifies the class to create as a container for adapter actions components. 
 
Provides a list of action types that can be added to this adapter. 
 
Returns the adapter actions container object. 
 
Returns the adapter's errors object. 
 
<insert text here> 
 
Returns the adapter fields container object. 
 
Returns a list of hidden fields that hold adapter state information. 
 
Returns a list of hidden fields that associate HTML form fields and adapter field. 
 
Returns a string that represents the current value of the Mode property. 
 
Retrieves the strings for all the possible modes of this adapter. 
 
Returns the owner of a child component being read from a stream. 
 
Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream. 
 
Enumerates all child components. 
 
Provides the interface for a method that adapters use to return their child components. 
 
Specifies the class to create as a container for adapter fields components. 
 
Specifies the class to create as a container for adapter field components. 
 
Returns the value of the DataSet property. 
 
Returns the default mode for this adapter. 
 
Populates a design-time warnings object with any warnings that the dataset adapter needs to emit. 
 
Returns the value of the echo flag. 
 
Indicates whether the adapter is positioned at the end of its dataset. 
 
Indicates whether the record position has passed the last record. 
 
Provides a list of field types that can be added to this adapter. 
 
Positions the adapter on the first record of its dataset. 
 
Set the record position to the first record. 
 
Indicates the types of hidden fields that this adapter requires in a submitted HTML form. 
 
Indicates the types of hidden fields that this adapter requires in a submitted HTML form. 
 
Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs). 
 
Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter. 
 
Returns a string listing the fields that this adapter uses to locate records. 
 
Retrieves a list of fields that the dataset adapter uses to locate records, along with their current values. 
 
Retrieves a list of fields that the dataset adapter uses to locate records, along with their current values. 
 
Returns a list of all dataset adapters, including this one, linked to this adapter in a master/detail relationship. 
 
Indicates whether the adapter requires a Mode value. 
 
Positions the associated dataset on the next record. 
 
Increments the record position. 
 
Returns the owner of a component. 
 
Returns the owner of an object. 
 
Calculates the number of pages needed to display all adapter records. 
 
Returns the value of the RecordCount property. 
 
Returns the total number of records. 
 
Returns the value of the RecordIndex property. 
 
Returns the index of the current record. 
 
Retrieves a list of field values that the dataset adapter uses to locate records, along with information for formatting hidden parameters from this values. 
 
Retrieves the type information for an object. 
 
Returns the number of type information interfaces that an object provides (either 0 or 1). 
 
Returns an action or field. 
 
Returns the total count of actions and fields. 
 
Gets the name used to reference this adapter with server-side script. 
 
Returns a list of this adapter's action components. 
 
Returns a list of this adapter's field components. 
 
Returns the class type for this adapter field. 
 
Checks the end-user's right to execute this adapter's actions. 
 
Checks the end-user's right to modify this adapter's fields. 
 
Checks the end-user's right to view this adapter's fields. 
 
Provides the underlying implementation for the CanAddActionClass method. 
 
Indicates whether a type of adapter action can be added to this adapter. 
 
Indicates whether a type of adapter action can be added to this adapter. 
 
Provides the underlying implementation for the CanAddFieldClass method. 
 
Indicates whether a type of adapter field can be added to this adapter. 
 
Clears adapter state information. 
 
Implements IteratorSupport's EndIterator method to support iterating over the data records of the adapter. 
 
Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter. 
 
Implements IteratorSupport's EndIterator method to support iterating over the data records of the adapter. 
 
Finds an adapter action or adapter field child with a matching variable name. 
 
Finds an adapter action or adapter field that is a container for other scriptable objects. 
 
Provides the underlying implementation for the GetActionsList method. 
 
Provides a list of action types that can be added to this adapter. 
 
Provides a list of action types that can be added to this adapter. 
 
Returns the value of the echo flag. 
 
Provides the underlying implementation for the GetFieldsList method. 
 
Provides a list of field types that can be added to this adapter. 
 
Provides the underlying implementation for the GetIteratorIndex method. 
 
Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter. 
 
Retrieves a list of field values that the dataset adapter uses to locate records, along with information for formatting hidden parameters from this values. 
 
Returns an action or field. 
 
Returns the total count of actions and fields. 
 
Gets the name used to reference this adapter with server-side script. 
 
Returns a list of this adapter's action components. 
 
Returns a list of this adapter's action components. 
 
Returns a list of this adapter's field components. 
 
Returns a list of this adapter's field components. 
 
Checks the end-user's right to execute this adapter's actions. 
 
Checks the end-user's right to modify this adapter's fields. 
 
Checks the end-user's right to view this adapter's fields. 
 
Provides the underlying implementation for the InIterator method. 
 
Implements IIteratorIndex's InIterator to support iterating over the data records of the adapter. 
 
Implements IIteratorSupport's NextIteration method to support iterating over the records of the adapter. 
 
Implements IteratorSupport's NextIteration method to support iterating over the records of the adapter. 
 
Called when the web module is activated. 
 
Provides the underlying implementation for the NotifyDeactivate method. 
 
Called when the web module is deactivated. 
 
Clears the current page variable. 
 
Initializes the Actions property. 
 
Initializes the Actions property. 
 
Initializes the Data property. 
 
Initializes the Data property. 
 
Provides the underlying implementation for the SetEchoActionFieldValues method. 
 
Sets the echo flag for this adapter's fields. 
 
Implements IteratorSupport.StartIterator to support iterating over the records of the adapter. 
 
Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter. 
 
Implements IteratorSupport.StartIterator to support iterating over the records of the adapter. 
 
Implements IIteratorIndex's InIterator method to support iterating over the data records of the adapter. 
 
Provides access to Automation properties and methods when the component wraps an Automation object. 
 
Indicates whether a particular action has been added to the adapter. 
 
Indicates whether a particular field has been added to the adapter. 
 
Specifies the HTML form hidden fields needed by the adapter. 
 
Specifies the HTML form hidden fields needed by the adapter. 
 
Initializes the component after the form file has been read into memory. 
 
Positions the dataset based on a specified set of field values. 
 
Positions the dataset based on the parameters in the current request. 
 
Implements IIteratorSupport's NextIteration method to support iterating over the data records of the adapter. 
 
Forwards notification messages to all owned components. 
 
Responds when components are added to or deleted from the WebSnap application. 
 
Clears references to deleted components. 
 
Called when the web module is activated. 
 
Notifies components that the adapter has changed in some way. 
 
Called when the web module is deactivated. 
 
Responds to changes in the associated dataset. 
 
Responds when the component is created from the component palette. 
 
Sets up the associated dataset for use by this adapter. 
 
Returns a reference to a specified interface if the object supports that interface. 
 
Reads the state of the component. 
 
Returns the adapter to its default mode. 
 
Initializes the Actions property. 
 
Sets the Mode property based on a string that represents one of the available values. 
 
Clears or sets csAncestor state in the component's ComponentState property. 
 
Sets the visual ordering of a child control. 
 
Initializes the Data property. 
 
Sets the value of the DataSet property. 
 
Ensures that components inserted at design time have their design-mode flag set. 
 
Ensures that components inserted at design time have their design-mode flag set. 
 
Sets the echo flag for this adapter's fields. 
 
Sets the csInline bit of the component's ComponentState property 
 
Sets the value of the Mode property. 
 
Sets the value of the Name property. 
 
Updates the pagesize variable. 
 
Sets the parent component. 
 
Skips records until the current record is within the current page. 
 
Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter. 
 
Clears the csUpdating state in the component's ComponentState property when the component finishes updating. 
 
Executes the adapter's fields with values passed in the HTTP request. 
 
Executes the adapter's fields with values passed in the HTTP request. 
 
Indicates whether the values in the HTTP request change the value of any adapter fields. 
 
Determines whether the values in the HTTP request change any adapter fields. 
 
Updates the adapter's fields with values passed in the HTTP request. 
 
Updates the adapter's fields with values passed in the HTTP request. 
 
Validates the values passed in the current HTTP request for the adapter's fields. 
 
Validate the adapter's field values passed in the HTTP request. 
 
Determines whether values passed in the HTTP request will change any adapter fields. 
 
Updates adapter fields with values passed in the HTTP request. 
 
Validate the adapter's field values passed in the HTTP request. 
 
Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces. 
 
Sets the csUpdating state in the component's ComponentState property. 
 
Determines whether an object can be inserted into a container. 
 
Provides the interface for a method that validates an child component before it is inserted. 
 
Ensures that renaming an owned component does not create name conflict. 
 
WebComponentsChange is called when the list of adapter fields or adapter actions changes. 
 
Writes the state of the component. 
 
Name 
Description 
 
Indicates the dataset adapter for which this adapter could not locate the current record. 
 
Indicates whether the associated dataset has been properly set up for use by this adapter. 
 
Keeps track of components that are to be notified when the adapter is changed. 
 
Returns a list of this adapter's action components. 
 
Returns a list of this adapter's field components. 
 
Name 
Description 
 
Implement this event to indicate when the current record index has exceeded the total record count. 
 
Implement this method to initialize the iteration index to zero. 
 
Implement this method to increment the iteration index. 
 
Implement this event to identify the zero-based current record. 
 
Occurs when the adapter needs to iterate over its data records. 
 
Name 
Description 
 
Increments the reference count for this interface. 
 
Decrements the reference count for this interface. 
 
Registers an interest in change notifications. 
 
Responds after the last constructor has executed. 
 
Sets the Mode property to reflect the value that the current request specifies. 
 
Copies the contents of another, similar object. 
 
Performs any necessary actions before the first destructor is called. 
 
Responds before the first destructor executes. 
 
This is CanAddActionClass, a member of class IAdapterEditor. 
 
This is CanAddFieldClass, a member of class IAdapterEditor. 
 
Returns a pointer to the runtime type information (RTTI) table for the object type. 
 
Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument). 
 
Determines whether an object is of a specific type. 
 
Returns the type of the immediate ancestor of a class. 
 
Returns the class reference for the object's class. 
 
Performs finalization on long strings, variants, and interface variables within a class. 
 
This is ClearAdapterValues, a member of class IClearAdapterValues. 
 
Allocates memory and constructs a safely initialized instance of a component. 
 
Creates an initializes an instance of TCustomDataSetAdapter
 
Constructs an object and initializes its data before the object is first used. 
 
Constructor for TCustomAdapter
 
This is CreateActionRequestContext, a member of class ICreateActionRequestContext. 
 
Provides the interface for a method that processes message records. 
 
Disposes of the component and its owned components. 
 
Destroys the TPersistent instance and frees its memory. 
 
Frees an instance of TCustomDataSetAdapter
 
Disposes of an object instance. 
 
Destructor for TCustomAdapter
 
Destroys all owned components. 
 
Indicates that the component and its owned components are about to be destroyed. 
 
Calls message-handling methods for the object, based on the contents of the Message parameter. 
 
Writes name/value pairs that represent this adapter's state. 
 
Writes name/value pairs that represent a specified type of information. 
 
Signals the end of the iterating operation. 
 
Checks if the current instance and the parameter are equal. 
 
Executes an action. 
 
Reads name/value pairs from the current HTTP request. 
 
Reads name/value pairs that represent a specified type of information from the current HTTP request. 
 
This is the overview for the FieldAddress method overload. 
 
This is FindAction, a member of class IWebActionsList. 
 
Indicates whether a given component is owned by the component. 
 
This is FindField, a member of class IWebDataFields. 
 
This is FindVariable, a member of class IWebVariablesContainer. 
 
This is FindVariableContainer, a member of class IWebVariablesContainer. 
 
Free 
Destroys an object and frees its associated memory, if necessary. 
 
Deallocates memory allocated by a previous call to the System::TObject::NewInstance method. 
 
Ensures that AComponent is notified that the component is going to be destroyed. 
 
Frees the interface reference for components that were created from COM classes. 
 
This is FullyQualifyInputNames, a member of class IFullyQualifyInputNames. 
 
This is GetActionsList, a member of class IWebActionsList. 
 
This is GetAdapterActions, a member of class IGetAdapterActions. 
 
This is GetAdapterErrors, a member of class IGetAdapterErrors. 
 
This is GetAdapterErrorsList, a member of class IGetAdapterErrorsList. 
 
This is GetAdapterFields, a member of class IGetAdapterFields. 
 
This is GetAdapterHiddenFields, a member of class IGetAdapterHiddenFields. 
 
This is GetAdapterHiddenRecordFields, a member of class IGetAdapterHiddenFields. 
 
This is GetAdapterMode, a member of class IAdapterMode. 
 
This is GetAdapterModeNames, a member of class IGetAdapterModeNames. 
 
Returns a reference to the component associated by the implementing class. 
 
This is GetDataSet, a member of class IAdapterDataSetComponent. 
 
Populates a design-time warnings object with any warnings that the dataset values list needs to emit. 
 
This is GetEchoActionFieldValues, a member of class IEchoAdapterFieldValues. 
 
Returns a TComponent enumerator. 
 
This is GetFieldsList, a member of class IWebDataFields. 
 
Returns an integer containing the hash code. 
 
Retrieves a specified interface. 
 
Returns the entry for a specific interface implemented in a class. 
 
Returns a pointer to a structure containing all of the interfaces implemented by a given class. 
 
Returns the value of the IteratorIndex property. 
 
Returns a string used by the Object Inspector. 
 
Returns the name of the object as it appears in the Object Inspector. 
 
This is GetNeedAdapterMode, a member of class IAdapterMode. 
 
Returns the containing Component. 
 
This is GetRecordKeys, a member of class IGetRecordKeys. 
 
This is GetVariable, a member of class IWebVariablesContainer. 
 
This is GetVariableCount, a member of class IWebVariablesContainer. 
 
This is GetVariableName, a member of class IWebVariableName. 
 
This is GetVisibleActions, a member of class IWebActionsList. 
 
This is GetVisibleFields, a member of class IWebDataFields. 
 
This is HasExecuteAccess, a member of class IAdapterAccess. 
 
This is HasModifyAccess, a member of class IAdapterAccess. 
 
Verifies whether the component has a parent. 
 
This is HasViewAccess, a member of class IAdapterAccess. 
 
Determines the relationship of two object types. 
 
Indicates whether the object is iterating over its items. 
 
Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer. 
 
Establishes the component as the owner of a specified component. 
 
Returns the size in bytes of each instance of the object type. 
 
This is IsActionInUse, a member of class IWebActionsList. 
 
This is IsFieldInUse, a member of class IWebDataFields. 
 
Indicates whether the component implements a specified interface. 
 
Positions the associated dataset on the record identified by the LocateParamsList property. 
 
Positions the dataset and updates the resulting record based on the parameters of the current request. 
 
This is the overview for the MethodAddress method overload. 
 
Returns the name of a class method by address. 
 
Allocates memory for an instance of an object type and returns a pointer to that new instance. 
 
Advances to the objects next item. 
 
This is NotifyActivate, a member of class INotifyWebActivate. 
 
This is NotifyAdapterChange, a member of class IAdapterNotifyAdapterChange. 
 
This is NotifyDeactivate, a member of class INotifyWebActivate. 
 
Returns a reference to a specified interface if the object supports that interface. 
 
Raises an EAdapterFieldException with a message indicating that another user changed a field value. 
 
Raises an EAdapterException with a message indicating that a specified field could not be found. 
 
Raises an EAdapterException with a message indicating that the dataset is unassigned. 
 
Raises an EAdapterException with a message indicating that a dataset record could not be located based on the current set of key fields. 
 
Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed. 
 
Removes a specified component specified from the component's Components list. 
 
Disables destruction notification that was enabled by FreeNotification 
 
Unregisters interest in change notifications. 
 
This is RestoreDefaultAdapterMode, a member of class IAdapterMode. 
 
Handles exceptions in methods declared using the safecall calling convention. 
 
Handles exceptions in methods declared using the safecall calling convention. 
 
This is SetAdapterMode, a member of class IAdapterMode. 
 
This is SetDataSet, a member of class IAdapterDataSetComponent. 
 
This is SetEchoActionFieldValues, a member of class IEchoAdapterFieldValues. 
 
Identifies whether the component is a subcomponent. 
 
Positions the associated dataset on a specified record. 
 
Positions the object on its first item and starts the iteration process. 
 
Converts a mode string to the corresponding TDataSetAdapterMode value. 
 
Returns a string containing the class name. 
 
Returns a string containing the unit name. 
 
Updates the state of an action. 
 
Updates the adapter's fields with the field values passed in an HTTP request. 
 
Name 
Description 
 
This is AdapterMode, a member of class IAdapterMode. 
 
Specifies the interface reference implemented by the component. 
 
Indicates the number of components owned by the component. 
 
Indicates the position of the component in its owner's Components property array. 
 
Lists all components owned by the component. 
 
Describes the current state of the component, indicating when a component needs to avoid certain actions. 
 
Governs the behavior of the component. 
 
Sets or gets the current page index. 
 
Contains information used by the Form designer. 
 
Lists the dataset adapters for all datasets that are details of this one. 
 
This is EchoActionFieldValues, a member of class IEchoAdapterFieldValues. 
 
Modifies the adapter's echo flag. 
 
Returns an object used to track errors on behalf of this adapter. 
 
Defines the rights required to execute this adapter's action. 
 
Indicates whether the dataset adapter is in its default mode. 
 
Indicates the index of the current item. 
 
Lists the parameters that identify the current record of this dataset and all other datasets linked to it in a master/detail relationship. 
 
Mode 
Indicates how forms built from this dataset adapter operate on the information it provides. 
 
This is NeedAdapterMode, a member of class IAdapterMode. 
 
Indicates the component that is responsible for streaming and freeing this component. 
 
Calculates the number of pages needed to display all adapter records. 
 
Returns the total number of records. 
 
Returns the index of the current record. 
 
This is VariableCount, a member of class IWebVariablesContainer. 
 
This is VariableName, a member of class IWebVariableName. 
 
This is Variables, a member of class IWebVariablesContainer. 
 
Represents information used internally by components that support COM. 
 
This is VisibleActions, a member of class IWebActionsList. 
 
This is VisibleFields, a member of class IWebDataFields. 
 
Name 
Description 
 
Occurs after an adapter action has executed. 
 
Occurs after the adapter action response is generated. 
 
Occurs after values in the HTTP request are used to update adapter fields. 
 
Occurs after values in the HTTP request are validated by the adapter's fields. 
 
Occurs before an adapter action is executed. 
 
Occurs before the adapter action response is generated. 
 
Occurs before values in the HTTP request are used to update adapter fields. 
 
Occurs before values in the HTTP request are validated by the adapter's fields. 
 
Supplies name/value pairs needed to execute an adapter action. 
 
Implement this event to identify the total number of records that can be iterated. 
 
Occurs before the dataset adapter uses any information from its associated dataset. 
 
Name 
Description 
 
Container for adapter actions components. 
 
Data 
Container for adapter field components. 
 
Specifies the dataset that this adapter represents. 
 
Indicates the dataset adapter, if any, to which this adapter is linked in a master/detail relationship. 
 
Identifies the rights required to update this adapter's fields. 
 
Name 
Specifies the name of the component as referenced in code. 
 
Sets or gets the page size variable. 
 
Indicates whether the data set should be refreshed or not after posting.. 
 
Tag 
Stores an integer value as part of a component. 
 
Identifies the rights required to view this adapter's fields. 
Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!