TCustomDataSetAdapter Members

The following tables list the members exposed by TCustomDataSetAdapter.

	Name	Description
	FComponentStyle	This is FComponentStyle, a member of class TComponent.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	AddAdapterModeHiddenField	Defines a hidden field that passes the adapter's mode value in the HTTP request when an HTML form is submitted.
	AddDefaultActions	Adds the default action components to this adapter.
	AddDefaultFields	Adds the default field components to this adapter.
	AddOrigValueHiddenFields	Defines hidden field(s) that pass the original values of adapter fields in the HTTP request when an HTML form is submitted.
	AddRecordKeysHiddenFields	Defines hidden field(s) that pass key values in the HTTP request when an HTML form is submitted.
	AssignTo	Copies the properties of an object to a destination object.
	CanAddActionClass	Indicates whether a type of adapter action can be added to this adapter.
	CanAddFieldClass	Indicates whether a type of adapter field can be added to this adapter.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	CheckModifyAccess	This is CheckModifyAccess, a member of class TCustomAdapter.
	ClearAdapterValues	Clears adapter state information.
	ClearErrors	Clears the content of the adapter's Errors property.
	CreateActionRequestContext	Creates an object that describes the adapter action parameters and adapter field values.
	CreateErrorsList	Creates the object used to manage errors associated with this adapter.
	DefaultWebComponentsChange	Notifies other components of changes to the list of default actions or fields.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	DefineProperties	Provides an interface for a method that reads and writes otherwise unpublished data.
	EndIterator	Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter.
	EndOfPage	Indicates whether the record index has gone past the last record in the current page.
	FindAction	Returns an action component with a matching action name.
	FindField	Returns an adapter field component with a matching field name.
	FindNamedAction	Finds an action with a matching variable name.
	FindNamedField	Finds an adapter field with a matching variable name.
	FindNamedVariable	Finds a field or action with a matching variable name.
	FindVariable	Finds an adapter action or adapter field with the given variable name.
	FindVariableContainer	Finds an adapter action or adapter field that is a container for other scriptable objects.
	FullyQualifyInputNames	Indicates whether the HTML input names must be qualified with the name of the adapter.
	GetActionsClass	Specifies the class to create as a container for adapter actions components.
	GetActionsClass	Specifies the class to create as a container for adapter actions components.
	GetActionsList	Provides a list of action types that can be added to this adapter.
	GetAdapterActions	Returns the adapter actions container object.
	GetAdapterErrors	This is GetAdapterErrors, a member of class TCustomAdapter.
	GetAdapterErrorsList	<insert text here>
	GetAdapterFields	Returns the adapter fields container object.
	GetAdapterHiddenFields	Returns a list of hidden fields that hold adapter state information.
	GetAdapterHiddenRecordFields	Returns a list of hidden fields that associate HTML form fields and adapter field.
	GetAdapterMode	Returns a string that represents the current value of the Mode property.
	GetAdapterModeNames	Retrieves the strings for all the possible modes of this adapter.
	GetChildOwner	Returns the owner of a child component being read from a stream.
	GetChildParent	Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.
	GetChildren	This is GetChildren, a member of class TComponent.
	GetChildren	Provides the interface for a method that adapters use to return their child components.
	GetDataClass	Specifies the class to create as a container for adapter fields components.
	GetDataClass	Specifies the class to create as a container for adapter field components.
	GetDataSet	Returns the value of the DataSet property.
	GetDefaultMode	Returns the default mode for this adapter.
	GetDesigntimeWarnings	Populates a design-time warnings object with any warnings that the dataset adapter needs to emit.
	GetEchoActionFieldValues	Returns the value of the echo flag.
	GetEOF	Indicates whether the adapter is positioned at the end of its dataset.
	GetFieldsList	Provides a list of field types that can be added to this adapter.
	GetFirstRecord	Positions the adapter on the first record of its dataset.
	GetHiddenFieldOptions	Indicates the types of hidden fields that this adapter requires in a submitted HTML form.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetIteratorIndex	Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter.
	GetKeyFields	Returns a string listing the fields that this adapter uses to locate records.
	GetKeyParams	Retrieves a list of fields that the dataset adapter uses to locate records, along with their current values.
	GetKeyParamStrings	Retrieves a list of fields that the dataset adapter uses to locate records, along with their current values.
	GetMasterDetailAdapters	Returns a list of all dataset adapters, including this one, linked to this adapter in a master/detail relationship.
	GetNeedAdapterMode	Indicates whether the adapter requires a Mode value.
	GetNextRecord	Positions the associated dataset on the next record.
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetPageCount	Calculates the number of pages needed to display all adapter records.
	GetRecordCount	Returns the value of the RecordCount property.
	GetRecordIndex	Returns the value of the RecordIndex property.
	GetRecordKeys	Retrieves a list of field values that the dataset adapter uses to locate records, along with information for formatting hidden parameters from this values.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	GetVariable	Returns an action or field.
	GetVariableCount	Returns the total count of actions and fields.
	GetVariableName	Gets the name used to reference this adapter with server-side script.
	GetVisibleActions	This is GetVisibleActions, a member of class TCustomAdapter.
	GetVisibleFields	This is GetVisibleFields, a member of class TCustomAdapter.
	GetWebSnapObjClass	Returns the class type for this adapter field.
	HasExecuteAccess	This is HasExecuteAccess, a member of class TCustomAdapter.
	HasModifyAccess	This is HasModifyAccess, a member of class TCustomAdapter.
	HasViewAccess	Checks the end-user's right to view this adapter's fields.
	ImplCanAddActionClass	Provides the underlying implementation for the CanAddActionClass method.
	ImplCanAddFieldClass	Provides the underlying implementation for the CanAddFieldClass method.
	ImplClearAdapterValues	Clears adapter state information.
	ImplEndIterator	Implements IteratorSupport's EndIterator method to support iterating over the data records of the adapter.
	ImplFindVariable	Finds an adapter action or adapter field child with a matching variable name.
	ImplFindVariableContainer	Finds an adapter action or adapter field that is a container for other scriptable objects.
	ImplGetActionsList	Provides the underlying implementation for the GetActionsList method.
	ImplGetEchoActionFieldValues	Returns the value of the echo flag.
	ImplGetFieldsList	Provides the underlying implementation for the GetFieldsList method.
	ImplGetIteratorIndex	Provides the underlying implementation for the GetIteratorIndex method.
	ImplGetRecordKeys	Retrieves a list of field values that the dataset adapter uses to locate records, along with information for formatting hidden parameters from this values.
	ImplGetVariable	Returns an action or field.
	ImplGetVariableCount	Returns the total count of actions and fields.
	ImplGetVariableName	Gets the name used to reference this adapter with server-side script.
	ImplGetVisibleActions	Returns a list of this adapter's action components.
	ImplGetVisibleActions	Returns a list of this adapter's action components.
	ImplGetVisibleFields	Returns a list of this adapter's field components.
	ImplGetVisibleFields	Returns a list of this adapter's field components.
	ImplHasExecuteAccess	Checks the end-user's right to execute this adapter's actions.
	ImplHasModifyAccess	Checks the end-user's right to modify this adapter's fields.
	ImplHasViewAccess	This is ImplHasViewAccess, a member of class TCustomAdapter.
	ImplInIterator	Provides the underlying implementation for the InIterator method.
	ImplNextIteration	Implements IIteratorSupport's NextIteration method to support iterating over the records of the adapter.
	ImplNextIteration	Implements IteratorSupport's NextIteration method to support iterating over the records of the adapter.
	ImplNotifyActivate	Called when the web module is activated.
	ImplNotifyDeactivate	Provides the underlying implementation for the NotifyDeactivate method.
	ImplSetActions	Initializes the Actions property.
	ImplSetActions	Initializes the Actions property.
	ImplSetData	Initializes the Data property.
	ImplSetData	Initializes the Data property.
	ImplSetEchoActionFieldValues	Provides the underlying implementation for the SetEchoActionFieldValues method.
	ImplStartIterator	Implements IteratorSupport.StartIterator to support iterating over the records of the adapter.
	InIterator	Implements IIteratorIndex's InIterator method to support iterating over the data records of the adapter.
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	IsActionInUse	Indicates whether a particular action has been added to the adapter.
	IsFieldInUse	Indicates whether a particular field has been added to the adapter.
	ListHiddenFields	This is ListHiddenFields, a member of class TCustomAdapter.
	ListHiddenRecordFields	Specifies the HTML form hidden fields needed by the adapter.
	Loaded	Initializes the component after the form file has been read into memory.
	LocateKeyParams	Positions the dataset based on a specified set of field values.
	LocateRequestRecord	Positions the dataset based on the parameters in the current request.
	NextIteration	Implements IIteratorSupport's NextIteration method to support iterating over the data records of the adapter.
	Notification	Responds when components are added to or deleted from the WebSnap application.
	NotifyActivate	Called when the web module is activated.
	NotifyAdapterChange	Notifies components that the adapter has changed in some way.
	NotifyDeactivate	Called when the web module is deactivated.
	OnDataSetStateChange	Responds to changes in the associated dataset.
	PaletteCreated	Responds when the component is created from the component palette.
	PrepareDataSet	Sets up the associated dataset for use by this adapter.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	This is ReadState, a member of class TComponent.
	RestoreDefaultAdapterMode	Returns the adapter to its default mode.
	SetActions	Initializes the Actions property.
	SetAdapterMode	Sets the Mode property based on a string that represents one of the available values.
	SetAncestor	This is SetAncestor, a member of class TComponent.
	SetChildOrder	This is SetChildOrder, a member of class TComponent.
	SetData	Initializes the Data property.
	SetDataSet	Sets the value of the DataSet property.
	SetDesigning	Ensures that components inserted at design time have their design-mode flag set.
	SetDesignInstance	Ensures that components inserted at design time have their design-mode flag set.
	SetEchoActionFieldValues	Sets the echo flag for this adapter's fields.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetMode	Sets the value of the Mode property.
	SetName	Sets the value of the Name property.
	SetPageSize	Updates the pagesize variable.
	SetParentComponent	This is SetParentComponent, a member of class TComponent.
	SkipToPage	Skips records until the current record is within the current page.
	StartIterator	Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	UpdateFieldsExecuteValues	Executes the adapter's fields with values passed in the HTTP request.
	UpdateFieldsGetAnyChanges	Indicates whether the values in the HTTP request change the value of any adapter fields.
	UpdateFieldsUpdateValues	Updates the adapter's fields with values passed in the HTTP request.
	UpdateFieldsValidateValues	Validates the values passed in the current HTTP request for the adapter's fields.
	UpdateRecordsGetAnyChanges	Determines whether values passed in the HTTP request will change any adapter fields.
	UpdateRecordsUpdateValues	Updates adapter fields with values passed in the HTTP request.
	UpdateRecordsValidateValues	Validate the adapter's field values passed in the HTTP request.
	UpdateRegistry	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
	Updating	Sets the csUpdating state in the component's ComponentState property.
	ValidateContainer	Determines whether an object can be inserted into a container.
	ValidateInsert	Provides the interface for a method that validates an child component before it is inserted.
	ValidateRename	Ensures that renaming an owned component does not create name conflict.
	WebComponentsChange	WebComponentsChange is called when the list of adapter fields or adapter actions changes.
	WriteState	This is WriteState, a member of class TComponent.

Protected Properties

	Name	Description
	AdapterRowNotFound	Indicates the dataset adapter for which this adapter could not locate the current record.
	DataSetPrepared	Indicates whether the associated dataset has been properly set up for use by this adapter.
	NotifyList	Keeps track of components that are to be notified when the adapter is changed.
	VisibleActions	This is VisibleActions, a member of class TCustomAdapter.
	VisibleFields	This is VisibleFields, a member of class TCustomAdapter.

Public Events

	Name	Description
	OnAfterExecuteAction	Occurs after an adapter action has executed.
	OnAfterGetActionResponse	Occurs after the adapter action response is generated.
	OnAfterUpdateFields	Occurs after values in the HTTP request are used to update adapter fields.
	OnAfterValidateFields	Occurs after values in the HTTP request are validated by the adapter's fields.
	OnBeforeExecuteAction	Occurs before an adapter action is executed.
	OnBeforeGetActionResponse	Occurs before the adapter action response is generated.
	OnBeforeUpdateFields	Occurs before values in the HTTP request are used to update adapter fields.
	OnBeforeValidateFields	Occurs before values in the HTTP request are validated by the adapter's fields.
	OnGetActionParams	Supplies name/value pairs needed to execute an adapter action.
	OnGetEOF	Implement this event to indicate when the current record index has exceeded the total record count.
	OnGetFirstRecord	Implement this method to initialize the iteration index to zero.
	OnGetNextRecord	Implement this method to increment the iteration index.
	OnGetRecordCount	Implement this event to identify the total number of records that can be iterated.
	OnGetRecordIndex	Implement this event to identify the zero-based current record.
	OnIterateRecords	Occurs when the adapter needs to iterate over its data records.
	OnPrepareDataSet	Occurs before the dataset adapter uses any information from its associated dataset.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	AddNotify	Registers an interest in change notifications.
	AfterConstruction	Responds after the last constructor has executed.
	ApplyAdapterMode	Sets the Mode property to reflect the value that the current request specifies.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Performs any necessary actions before the first destructor is called.
	BeforeDestruction	Responds before the first destructor executes.
	CanAddActionClass	This is CanAddActionClass, a member of class IAdapterEditor.
	CanAddFieldClass	This is CanAddFieldClass, a member of class IAdapterEditor.
	ClassInfo	Returns a pointer to the runtime type information (RTTI) table for the object type.
	ClassName	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
	ClassNameIs	Determines whether an object is of a specific type.
	ClassParent	Returns the type of the immediate ancestor of a class.
	ClassType	Returns the class reference for the object's class.
	CleanupInstance	Performs finalization on long strings, variants, and interface variables within a class.
	ClearAdapterValues	This is ClearAdapterValues, a member of class IClearAdapterValues.
	Create	Creates an initializes an instance of TCustomDataSetAdapter.
	CreateActionRequestContext	This is CreateActionRequestContext, a member of class ICreateActionRequestContext.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Frees an instance of TCustomDataSetAdapter.
	DestroyComponents	Destroys all owned components.
	Destroying	Indicates that the component and its owned components are about to be destroyed.
	Dispatch	Calls message-handling methods for the object, based on the contents of the Message parameter.
	EncodeActionParams	Writes name/value pairs that represent this adapter's state.
	EncodeActionParamsFlags	Writes name/value pairs that represent a specified type of information.
	EndIterator	This is EndIterator, a member of class IIteratorSupport.
	ExecuteAction	This is ExecuteAction, a member of class TComponent.
	ExtractRequestParams	Reads name/value pairs from the current HTTP request.
	ExtractRequestParamsFlags	Reads name/value pairs that represent a specified type of information from the current HTTP request.
	FieldAddress	Returns the address of a published object field.
	FindAction	This is FindAction, a member of class IWebActionsList.
	FindComponent	Indicates whether a given component is owned by the component.
	FindField	This is FindField, a member of class IWebDataFields.
	FindVariable	This is FindVariable, a member of class IWebVariablesContainer.
	FindVariableContainer	This is FindVariableContainer, a member of class IWebVariablesContainer.
	Free	Destroys an object and frees its associated memory, if necessary.
	FreeInstance	Deallocates memory allocated by a previous call to the System::TObject::NewInstance method.
	FreeNotification	Ensures that AComponent is notified that the component is going to be destroyed.
	FreeOnRelease	Frees the interface reference for components that were created from COM classes.
	GetActionsList	This is GetActionsList, a member of class IWebActionsList.
	GetAdapterActions	This is GetAdapterActions, a member of class IGetAdapterActions.
	GetAdapterErrors	This is GetAdapterErrors, a member of class IGetAdapterErrors.
	GetAdapterErrorsList	This is GetAdapterErrorsList, a member of class IGetAdapterErrorsList.
	GetAdapterFields	This is GetAdapterFields, a member of class IGetAdapterFields.
	GetAdapterHiddenFields	This is GetAdapterHiddenFields, a member of class IGetAdapterHiddenFields.
	GetAdapterHiddenRecordFields	This is GetAdapterHiddenRecordFields, a member of class IGetAdapterHiddenFields.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetEchoActionFieldValues	This is GetEchoActionFieldValues, a member of class IEchoAdapterFieldValues.
	GetEnumerator	Returns a TComponent enumerator.
	GetFieldsList	This is GetFieldsList, a member of class IWebDataFields.
	GetInterface	Retrieves a specified interface.
	GetInterfaceEntry	Returns the entry for a specific interface implemented in a class.
	GetInterfaceTable	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
	GetIteratorIndex	Returns the value of the IteratorIndex property.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetParentComponent	Returns the containing Component.
	GetVariable	This is GetVariable, a member of class IWebVariablesContainer.
	GetVariableCount	This is GetVariableCount, a member of class IWebVariablesContainer.
	GetVariableName	This is GetVariableName, a member of class IWebVariableName.
	GetVisibleActions	This is GetVisibleActions, a member of class IWebActionsList.
	GetVisibleFields	This is GetVisibleFields, a member of class IWebDataFields.
	HasExecuteAccess	This is HasExecuteAccess, a member of class IAdapterAccess.
	HasModifyAccess	This is HasModifyAccess, a member of class IAdapterAccess.
	HasParent	This is HasParent, a member of class TComponent.
	HasViewAccess	This is HasViewAccess, a member of class IAdapterAccess.
	InheritsFrom	Determines the relationship of two object types.
	InIterator	Indicates whether the object is iterating over its items.
	InitInstance	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
	InsertComponent	Establishes the component as the owner of a specified component.
	InstanceSize	Returns the size in bytes of each instance of the object type.
	IsActionInUse	This is IsActionInUse, a member of class IWebActionsList.
	IsFieldInUse	This is IsFieldInUse, a member of class IWebDataFields.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	Locate	Positions the associated dataset on the record identified by the LocateParamsList property.
	LocateAndApply	Positions the dataset and updates the resulting record based on the parameters of the current request.
	MethodAddress	This is MethodAddress, a member of class TObject.
	MethodName	This is MethodName, a member of class TObject.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	NextIteration	Advances to the objects next item.
	NotifyActivate	This is NotifyActivate, a member of class INotifyWebActivate.
	NotifyAdapterChange	This is NotifyAdapterChange, a member of class IAdapterNotifyAdapterChange.
	NotifyDeactivate	This is NotifyDeactivate, a member of class INotifyWebActivate.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	RaiseFieldChangedByAnotherUser	Raises an EAdapterFieldException with a message indicating that another user changed a field value.
	RaiseFieldNotFound	Raises an EAdapterException with a message indicating that a specified field could not be found.
	RaiseNilDataSet	Raises an EAdapterException with a message indicating that the dataset is unassigned.
	RaiseRowNotFound	Raises an EAdapterException with a message indicating that a dataset record could not be located based on the current set of key fields.
	ReferenceInterface	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
	RemoveComponent	Removes a specified component specified from the component's Components list.
	RemoveFreeNotification	Disables destruction notification that was enabled by FreeNotification
	RemoveNotify	Unregisters interest in change notifications.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetEchoActionFieldValues	This is SetEchoActionFieldValues, a member of class IEchoAdapterFieldValues.
	SetSubComponent	Identifies whether the component is a subcomponent.
	SilentLocate	Positions the associated dataset on a specified record.
	StartIterator	This is StartIterator, a member of class IIteratorSupport.
	StringToMode	Converts a mode string to the corresponding TDataSetAdapterMode value.
	UpdateAction	This is UpdateAction, a member of class TComponent.
	UpdateRecords	Updates the adapter's fields with the field values passed in an HTTP request.

Public Properties

	Name	Description
	Actions	Actions is the container for adapter actions components.
	Actions	Container for adapter actions components.
	AdapterMode	This is AdapterMode, a member of class IAdapterMode.
	ComObject	Specifies the interface reference implemented by the component.
	ComponentCount	Indicates the number of components owned by the component.
	ComponentIndex	Indicates the position of the component in its owner's Components property array.
	Components	Lists all components owned by the component.
	ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
	ComponentStyle	Governs the behavior of the component.
	CurrentPage	Sets or gets the current page index.
	Data	Data is the container for adapter field components.
	Data	Container for adapter field components.
	DataSet	Specifies the dataset that this adapter represents.
	DesignInfo	Contains information used by the Form designer.
	DetailAdapters	Lists the dataset adapters for all datasets that are details of this one.
	EchoActionFieldValues	This is EchoActionFieldValues, a member of class IEchoAdapterFieldValues.
	EchoActionFieldValues	Modifies the adapter's echo flag.
	Errors	Returns an object used to track errors on behalf of this adapter.
	ExecuteAccess	This is ExecuteAccess, a member of class TCustomAdapter.
	InDefaultMode	Indicates whether the dataset adapter is in its default mode.
	IteratorIndex	Indicates the index of the current item.
	LocateParamsList	Lists the parameters that identify the current record of this dataset and all other datasets linked to it in a master/detail relationship.
	MasterAdapter	Indicates the dataset adapter, if any, to which this adapter is linked in a master/detail relationship.
	Mode	Indicates how forms built from this dataset adapter operate on the information it provides.
	ModifyAccess	This is ModifyAccess, a member of class TCustomAdapter.
	NeedAdapterMode	This is NeedAdapterMode, a member of class IAdapterMode.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	PageCount	Calculates the number of pages needed to display all adapter records.
	PageSize	Sets or gets the page size variable.
	RecordCount	Returns the total number of records.
	RecordIndex	Returns the index of the current record.
	RefreshAfterPost	Indicates whether the data set should be refreshed or not after posting..
	VariableCount	This is VariableCount, a member of class IWebVariablesContainer.
	VariableName	This is VariableName, a member of class IWebVariableName.
	Variables	This is Variables, a member of class IWebVariablesContainer.
	VCLComObject	Represents information used internally by components that support COM.
	ViewAccess	Identifies the rights required to view this adapter's fields.
	VisibleActions	This is VisibleActions, a member of class IWebActionsList.
	VisibleFields	This is VisibleFields, a member of class IWebDataFields.

Published Properties

	Name	Description
	Name	Specifies the name of the component as referenced in code.
	Tag	Stores an integer value as part of a component.

What do you think about this topic? Send feedback!