TCustomAdapter Methods

The methods of the TCustomAdapter class are listed here.

	Name	Description
	AddAdapterModeHiddenField	Defines a hidden field that passes the adapter's mode value in the HTTP request when an HTML form is submitted.
	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.
	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.
	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.
	EncodeActionParams	Writes name/value pairs that represent adapter state.
	EndIterator	Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter.
	ExtractRequestParams	Reads name/value pairs from the HTTP request.
	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.
	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.
	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.
	GetEchoActionFieldValues	Returns the value of the echo flag.
	GetFieldsList	Provides a list of field types that can be added to this adapter.
	GetHiddenFieldOptions	Indicates the types of hidden fields that this adapter requires in a submitted HTML form.
	GetIteratorIndex	Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter.
	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	Indicates whether a type of adapter action can be added to this adapter.
	ImplCanAddFieldClass	Indicates whether a type of adapter field can be added to this adapter.
	ImplClearAdapterValues	Clears adapter state information.
	ImplEndIterator	Implements IIteratorSupport'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 a list of action types that can be added to this adapter.
	ImplGetEchoActionFieldValues	Returns the value of the echo flag.
	ImplGetFieldsList	Provides a list of field types that can be added to this adapter.
	ImplGetIteratorIndex	Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter.
	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.
	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	Implements IIteratorIndex's InIterator to support iterating over the data records of the adapter.
	ImplNextIteration	Implements IIteratorSupport's NextIteration method to support iterating over the records of the adapter.
	ImplNotifyActivate	Called when the web module is activated.
	ImplNotifyDeactivate	Called when the web module is deactivated.
	ImplSetActions	Initializes the Actions property.
	ImplSetData	Initializes the Data property.
	ImplSetEchoActionFieldValues	Sets the echo flag for this adapter's fields.
	ImplStartIterator	Implements IIteratorSupport's StartIterator method 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.
	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.
	NextIteration	Implements IIteratorSupport's NextIteration method to support iterating over the data records of the adapter.
	Notification	Clears references to deleted components.
	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.
	SetActions	Initializes the Actions property.
	SetData	Initializes the Data property.
	SetEchoActionFieldValues	Sets the echo flag for this adapter's fields.
	StartIterator	Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter.
	UpdateFieldsExecuteValues	Executes the adapter's fields with values passed in the HTTP request.
	UpdateFieldsGetAnyChanges	Determines whether the values in the HTTP request change any adapter fields.
	UpdateFieldsUpdateValues	Updates the adapter's fields with values passed in the HTTP request.
	UpdateFieldsValidateValues	Validate the adapter's field values passed in the HTTP request.
	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.
	WebComponentsChange	WebComponentsChange is called when the list of adapter fields or adapter actions changes.

Public Methods

	Name	Description
	UpdateRecords	Updates the adapter's fields with the field values passed in an HTTP request.

What do you think about this topic? Send feedback!