TCustomAdapter Members

The following tables list the members exposed by TCustomAdapter.

	Name	Description
	FComponentStyle	FComponentStyle is the field of the ComponentStyle read-only property.

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.
	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	Checks end-user rights to modify the adapter's field values.
	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.
	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.
	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	Returns the adapter's errors object.
	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.
	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	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.
	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.
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	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	Returns a list of this adapter's action components.
	GetVisibleFields	Returns a list of this adapter's field components.
	GetWebSnapObjClass	Returns the class type for this adapter field.
	HasExecuteAccess	Checks the end-user's right to execute this adapter's actions.
	HasModifyAccess	Checks the end-user's right to modify this adapter's fields.
	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	Checks the end-user's right to view this adapter's fields.
	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.
	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	Specifies the HTML form hidden fields needed by the adapter.
	ListHiddenRecordFields	Specifies the HTML form hidden fields needed by the adapter.
	Loaded	Initializes the component after the form file has been read into memory.
	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.
	PaletteCreated	Responds when the component is created from the component palette.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	SetActions	Initializes the Actions property.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetChildOrder	Sets the visual ordering of a child control.
	SetData	Initializes the Data 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
	SetName	Sets the value of the Name property.
	SetParentComponent	Sets the parent component.
	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	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.
	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	Writes the state of the component.

Protected Properties

	Name	Description
	NotifyList	Keeps track of components that are to be notified when the adapter is changed.
	VisibleActions	Returns a list of this adapter's action components.
	VisibleFields	Returns a list of this adapter's field components.

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.
	OnIterateRecords	Occurs when the adapter needs to iterate over its data records.

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.
	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.
	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.
	Create	Constructor for TCustomAdapter.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Destructor for TCustomAdapter.
	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.
	Equals	Checks if the current instance and the parameter are equal.
	ExecuteAction	Executes an action.
	FieldAddress	This is the overview for the FieldAddress method overload.
	FindComponent	Indicates whether a given component is owned by the component.
	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.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetEnumerator	Returns a TComponent enumerator.
	GetHashCode	Returns an integer containing the hash code.
	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.
	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.
	HasParent	Verifies whether the component has a parent.
	InheritsFrom	Determines the relationship of two object types.
	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.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	MethodAddress	This is the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	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.
	SetSubComponent	Identifies whether the component is a subcomponent.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	UpdateAction	Updates the state of an action.
	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.
	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.
	Data	Data is the container for adapter field components.
	DesignInfo	Contains information used by the Form designer.
	EchoActionFieldValues	Modifies the adapter's echo flag.
	Errors	Returns an object used to track errors on behalf of this adapter.
	ExecuteAccess	Defines the rights required to execute this adapter's action.
	IteratorIndex	Indicates the index of the current item.
	ModifyAccess	Identifies the rights required to update this adapter's fields.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	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.

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!