TCustomApplicationAdapterAction Members

The following tables list the members exposed by TCustomApplicationAdapterAction.

	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.
	AssignTo	Copies the properties of an object to a destination object.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	CheckExecuteAccess	Checks end-user rights to execute this adapter action.
	CreateRequestContext	Creates an object that describes the adapter action parameters and adapter field values.
	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.
	DoAfterExecuteActionRequest	Calls event handlers after the adapter action is executed.
	DoAfterGetExecuteActionResponse	Calls event handlers after the adapter action response is formulated.
	DoBeforeExecuteActionRequest	Calls event handlers before the adapter action is executed.
	DoBeforeGetExecuteActionResponse	Calls event handlers before the adapter action response is formulated.
	EndIterator	Implements IIteratorSupport's EndIterator method.
	ExecuteActionRequest	Executes the adapter action using parameters passed in the HTTP request.
	GetActionName	Gets the name used to reference this adapter action with server-side script.
	GetAdapter	GetAdapter returns the parent adapter component.
	GetAdapterItemRequestParams	Provides the name/value pairs needed to execute this adapter action.
	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	Enumerates all child components.
	GetContainerList	Returns the TWebComponentList object that the Web parent uses to manage this and its other Web items.
	GetDefaultActionName	Gets the default name used to reference this adapter action with server-side script.
	GetDefaultDisplayLabel	Provides the default display label for this adapter action.
	GetDisplayLabel	Returns the suggested display label for this adapter action.
	GetDisplayStyle	Returns a string value to suggest an HTML display style for this adapter action.
	GetDisplayStyleType	Suggests an HTML display type for this adapter action.
	GetErrors	Returns the parent adapter's errors list.
	GetExecuteActionResponse	Generates a response after the adapter action has been executed.
	GetFailureOptions	Indicates whether to perform an HTTP redirect after execution of this adapter action fails.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetInputStyle	Returns a string value to suggest an HTML display style for this adapter action.
	GetIsAdapterActionList	Indicates whether this adapter action may have multiple commands.
	GetItemCount	Returns the number of commands defined by this adapter action.
	GetIteratorIndex	Implements IIteratorIndex's GetIteratorIndex method.
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetSuccessOptions	Indicates whether to perform an HTTP redirect after successfully executing this action.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	GetVariableName	Gets the name used to reference this adapter action with server-side script.
	GetViewMode	Returns a string value to suggest a view mode for this adapter action.
	GetViewModeType	Suggests a view mode for this adapter action.
	GetVisible	Indicates whether a button or hyperlink for this adapter action should be displayed on the HTML page.
	GetWebSnapObjClass	Returns the class type for this adapter field.
	HandleRequest	Executes the adapter action and generates a response.
	HasExecuteAccess	Checks the end-user's right to execute this adapter action.
	ImplCreateRequestContext	Creates an object that describes the action parameters and field values.
	ImplEndIterator	Implements IIteratorSupport's EndIterator method.
	ImplExecuteActionRequest	Executes the adapter action using parameters passed in the HTTP request.
	ImplExecuteActionRequest	Executes the adapter action using parameters passed in the HTTP request.
	ImplGetActionName	Gets the name used to reference this adapter action with server-side script.
	ImplGetActionName	Gets the name used to reference this adapter action with server-side script.
	ImplGetAdapterItemRequestParams	Provides the name/value pairs needed to execute this adapter action.
	ImplGetAdapterItemRequestParams	Provides the name/value pairs needed to execute this adapter action.
	ImplGetDisplayLabel	Returns the suggested display label for this adapter action.
	ImplGetExecuteActionResponse	Generates a response after the adapter action has been executed.
	ImplGetFailureOptions	Indicates whether to perform an HTTP redirect after execution of this adapter action fails.
	ImplGetIsAdapterActionList	Indicates whether this adapter action may have multiple commands.
	ImplGetIteratorIndex	Implements IIteratorIndex's GetIteratorIndex method.
	ImplGetSuccessOptions	Indicates whether to perform an HTTP redirect after successfully executing this action.
	ImplGetSuccessOptions	Indicates whether to perform an HTTP redirect after successfully executing this action.
	ImplGetVariableName	Gets the name used to reference this adapter action with server-side script.
	ImplGetVisible	Indicates whether a button or hyperlink for this adapter action should be displayed on the HTML page.
	ImplHandleRequest	Executes the adapter action and generates a response.
	ImplHasExecuteAccess	Checks the end-user's right to execute this adapter action.
	ImplInIterator	Implements IIteratorIndex's InIterator method.
	ImplIsDefaultAction	Indicates whether this adapter action should be added, by default, to the parent adapter.
	ImplNextIteration	Implements IIteratorSupport's NextIteration method.
	ImplSetActionName	Sets the name that is used to reference this adapter action with server-side script.
	ImplStartIterator	Implements IIteratorSupport's StartIterator method.
	ImplWebEnabled	Indicates whether a button or hyperlink for this adapter action should be enabled on the HTML page.
	ImplWebEnabled	Indicates whether a button or hyperlink for this adapter action should be enabled on the HTML page.
	InIterator	Implements IIteratorIndex's InIterator method.
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	IsDefaultAction	Indicates whether this adapter action should be added, by default, to the parent adapter.
	IsDefaultField	Indicates whether this component represents a Web item that is used by default when the parent's set of Web items is not explicitly assigned.
	Loaded	Initializes the component after the form file has been read into memory.
	NextIteration	Implements IIteratorSupport's NextIteration method.
	Notification	Forwards notification messages to all owned components.
	PaletteCreated	Responds when the component is created from the component palette.
	ParentChanged	Handles movement of the component to a different parent.
	ParentChanged	Responds when the WebParent property changes.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	ReadState	Reads the component's published properties, stored data, and owned components from a reader object.
	SetActionName	Sets the name that is used to reference this adapter action with server-side script.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetChildOrder	Sets the visual ordering of a child control.
	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.
	SetDisplayLabel	Set the value of the DisplayLabel property.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetParentComponent	Sets the parent component.
	SetParentComponent	Sets the WebParent property to be the same as this component's parent.
	SetWebParent	Sets the value of the WebParent property.
	StartIterator	Implements IIteratorSupport's StartIterator method.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	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.
	WebEnabled	Indicates whether a button or hyperlink for this adapter action should be enabled on the HTML page.
	WriteState	Writes the state of the component.

Protected Properties

	Name	Description
	Adapter	Returns the parent adapter of this adapter action.
	Errors	Returns the parent adapter's Errors list.
	WebContainedComponentHelper	Provides access to the helper object that implements the IWebComponent interface for this contained component.
	WebParent	Indicates the component that uses this TWebContainedComponent as one of its Web items.

Public Events

	Name	Description
	OnAfterExecute	Called after the adapter action has executed.
	OnAfterExecute	Called after the adapter action has executed.
	OnAfterGetResponse	Called after the adapter action response is generated.
	OnAfterGetResponse	Called after the adapter action response is generated.
	OnBeforeExecute	Called before the adapter action is executed.
	OnBeforeExecute	Called before the adapter action is executed.
	OnBeforeGetResponse	Called before the adapter action response is generated.
	OnBeforeGetResponse	Called before the adapter action response is generated.
	OnExecute	Called to execute this action using parameters passed in the HTTP request.
	OnGetEnabled	Indicates whether a button or hyperlink for this adapter action should be enabled on the HTML page.
	OnGetParams	Specifies name/value pairs needed to execute this adapter action.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	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	Allocates memory and constructs a safely initialized instance of a component.
	Create	Constructs an object and initializes its data before the object is first used.
	Create	Creates and initializes an instance of TWebContainedComponent.
	CreateRequestContext	Creates an object that describes the adapter action parameters and adapter field values.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Disposes of the component and its owned components.
	Destroy	Destroys the TPersistent instance and frees its memory.
	Destroy	Disposes of an object instance.
	Destroy	Frees an instance of TWebContainedComponent.
	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.
	EndIterator	Signals the end of the iterating operation.
	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.
	GetActionName	This is GetActionName, a member of class IWebGetActionName.
	GetAdapterItemRequestParams	This is GetAdapterItemRequestParams, a member of class IGetAdapterItemRequestParams.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetContainer	Returns the value of the Container property.
	GetDisplayLabel	This is GetDisplayLabel, a member of class IWebGetDisplayLabel.
	GetDisplayStyle	Returns the preferred display style for an adapter field or adapter action.
	GetEnumerator	Returns a TComponent enumerator.
	GetFailureOptions	This is GetFailureOptions, a member of class IGetAdapterActionRedirectOptions.
	GetHashCode	Returns an integer containing the hash code.
	GetIndex	Returns the value of the Index property.
	GetInputStyle	Returns the preferred editing style for an adapter field.
	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.
	GetIsAdapterActionList	This is GetIsAdapterActionList, a member of class IIsAdapterActionList.
	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.
	GetParentComponent	Returns the object that uses this component to generate HTML.
	GetSuccessOptions	This is GetSuccessOptions, a member of class IGetAdapterActionRedirectOptions.
	GetVariableName	This is GetVariableName, a member of class IWebVariableName.
	GetViewMode	Returns the preferred mode of an adapter field.
	GetVisible	This is GetVisible, a member of class IAdapterActionAttributes.
	HandleRequest	Executes the adapter action and generates a response.
	HasExecuteAccess	This is HasExecuteAccess, a member of class IAdapterActionAccess.
	HasParent	Verifies whether the component has a parent.
	HasParent	Indicates whether this component appears in another component's list of Web items.
	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.
	IsDefaultAction	This is IsDefaultAction, a member of class IWebIsDefaultAction.
	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.
	NextIteration	Advances to the objects next item.
	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
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetActionName	This is SetActionName, a member of class IWebSetActionName.
	SetComponentList	Sets the value of the ComponentList property.
	SetContainer	Sets the value of the Container property.
	SetIndex	Sets the value of the Index property.
	SetSubComponent	Identifies whether the component is a subcomponent.
	StartIterator	Positions the object on its first item and starts the iteration process.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	UpdateAction	Updates the state of an action.
	WebEnabled	This is WebEnabled, a member of class IWebEnabled.

Public Properties

	Name	Description
	ActionName	This is ActionName, a member of class IWebGetActionName.
	ActionName	Identifies the name of this action when using server-side script.
	ActionName	Identifies the name of this action when using server-side script.
	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.
	ComponentList	Indicates the component list that contains the Web item.
	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.
	Container	Specifies the component that uses content generated by this Web item.
	DesignInfo	Contains information used by the Form designer.
	DisplayLabel	Suggests a display label for this adapter action.
	ExecuteAccess	Defines the rights required to execute this action.
	FailureOptions	This is FailureOptions, a member of class IGetAdapterActionRedirectOptions.
	Index	Indicates where the Web item appears in the Web component list's array of Web items.
	IsAdapterActionList	This is IsAdapterActionList, a member of class IIsAdapterActionList.
	ItemCount	Returns the number of items defined by an adapter action.
	ItemIndex	Returns the index of the current item of an adapter action.
	IteratorIndex	Indicates the index of the current item.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	RedirectOptions	Indicates whether to perform an HTTP redirect after successfully executing this action.
	SuccessOptions	This is SuccessOptions, a member of class IGetAdapterActionRedirectOptions.
	VariableName	This is VariableName, a member of class IWebVariableName.
	VCLComObject	Represents information used internally by components that support COM.
	Visible	This is Visible, a member of class IAdapterActionAttributes.

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!