WebAdapt.TEndUserSessionAdapter Methods

• Up to Parent: TEndUserSessionAdapter

InheritedProtected

_AddRef	protected	Called when an application uses a component interface.
_Release	protected	Called when an application releases a component interface.
AddAdapterModeHiddenField	protected	Defines a hidden field that passes the adapter's mode value in the HTTP request when an HTML form is submitted.
AddDefaultActions	protected	Adds default action components to this adapter.
AddDefaultFields	protected	Adds default field components to this adapter.
AddOrigValueHiddenFields	protected	Defines hidden field(s) that pass the original values of adapter fields in the HTTP request when an HTML form is submitted.
AddRecordKeysHiddenFields	protected	Defines hidden field(s) that pass key values in the HTTP request when an HTML form is submitted.
AfterConstruction	public	Responds after the last constructor has executed.
Assign	public	Copies the contents of another similar object.
AssignTo	protected	Copies the properties of an object to a destination object.
BeforeDestruction	public	Performs any necessary actions before the first destructor is called.
CanAddActionClass	protected	Indicates whether a type of adapter action can be added to this adapter.
CanAddFieldClass	protected	Indicates whether a type of adapter field can be added to this adapter.
CanExecuteLoginForm	protected	Determines if there is a static login page.
CanExecuteLogout	protected	Determines if the user is logged in.
CanObserve	protected
CanProduceLoginPage	protected	Determines whether there is a static login page or an automatically produced login page.
ChangeName	protected	Sets the private, internal storage for the Name property to the string passed in NewName.
CheckDisposed	protected
CheckModifyAccess	protected	Checks end-user rights to modify the adapter's field values.
ClassInfo	public	Returns a pointer to the run-time type information (RTTI) table for the object type.
ClassName	public	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIs	public	Determines whether an object is of a specific type.
ClassParent	public	Returns the type of the immediate ancestor of a class.
ClassType	public	Returns the class reference for the object's class.
CleanupInstance	public	Performs finalization on long strings, variants, and interface variables within a class.
ClearAdapterValues	protected	Clears adapter state information.
ClearErrors	protected	Clears the content of the adapter's Errors property.
Create	public
CreateActionRequestContext	protected	Creates an object that describes the adapter action parameters and adapter field values.
CreateErrorsList	protected	Creates the object used to manage errors associated with this adapter.
DefaultHandler	public	Provides the interface for a method that processes message records.
DefaultWebComponentsChange	protected	Notifies other components of changes to the list of default actions or fields.
DefineProperties	protected	Designates methods for storing an object's unpublished data on a stream such as a form file.
Destroy	public
DestroyComponents	public	Destroys all owned components.
Destroying	public	Indicates that the component and its owned components are about to be destroyed.
Dispatch	public	Calls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOf	public	DisposeOf forces the execution of the destructor code in an object.
DoOnHasRights	protected	Determines whether the user has view rights.
EncodeActionParams	protected	Writes name/value pairs that represent adapter state.
EndIterator	protected	Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter.
Equals	public	Checks whether the current instance and the parameter are equal.
ExecuteAction	public	Executes an action.
ExecuteLogin	protected	Logs in an end user.
ExecuteLoginForm	protected	Creates the HTML login page.
ExecuteLogout	protected	Logs out the current user.
ExtractRequestParams	protected	Reads name/value pairs from the HTTP request.
FieldAddress	public	Returns the address of a published object field.
FindAction	protected	Returns an action component with a matching action name.
FindComponent	public	Indicates whether a given component is owned by the component.
FindField	protected	Returns an adapter field component with a matching field name.
FindNamedAction	protected	Finds an action with a matching variable name.
FindNamedField	protected	Finds an adapter field with a matching variable name.
FindNamedVariable	protected	Finds a field or action with a matching variable name.
FindVariable	protected	Finds an adapter action or adapter field with the given variable name.
FindVariableContainer	protected	Finds an adapter action or adapter field that is a container for other scriptable objects.
Free	public	Destroys an object and frees its associated memory, if necessary.
FreeInstance	public	Deallocates memory allocated by a previous call to the NewInstance method.
FreeNotification	public	Ensures that AComponent is notified that the component is going to be destroyed.
FreeOnRelease	public	Frees the interface reference for components that were created from COM classes.
GetActionsClass	protected	Specifies the class to create as a container for adapter actions components.
GetActionsList	protected	Provides a list of action types that can be added to this adapter.
GetAdapterActions	protected	Returns the adapter actions container object.
GetAdapterErrors	protected	Returns the adapter's errors object.
GetAdapterErrorsList	protected	<insert text here>
GetAdapterFields	protected	Returns the adapter fields container object.
GetAdapterHiddenFields	protected	Returns a list of hidden fields that hold adapter state information.
GetAdapterHiddenRecordFields	protected	Returns a list of hidden fields that associate HTML form fields and adapter field.
GetChildOwner	protected	Returns the owner of a child component being read from a stream.
GetChildParent	protected	Returns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildren	protected	Provides the interface for a method that adapters use to return their child components.
GetDataClass	protected	Specifies the class to create as a container for adapter field components.
GetDisplayName	protected	Retrieves the display name string.
GetDisplayNameValue	protected	Returns the name of the current end user.
GetDisposed	protected
GetEchoActionFieldValues	protected	Returns the value of the echo flag.
GetEndUserAdapter	protected	Gets the end-user adapter.
GetEnumerator	public	Returns a TComponent enumerator.
GetFieldsList	protected	Provides a list of field types that can be added to this adapter.
GetHashCode	public	Returns an integer containing the hash code.
GetHiddenFieldOptions	protected	Indicates the types of hidden fields that this adapter requires in a submitted HTML form.
GetIDsOfNames	protected	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetInterface	public	Retrieves a specified interface.
GetInterfaceEntry	public	Returns the entry for a specific interface implemented in a class.
GetInterfaceTable	public	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
GetIteratorIndex	protected	Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter.
GetLoggedIn	protected	Determines if the user is logged in
GetLoggedInValue	protected	Indicates whether the current end user has logged in.
GetLoginFormAction	protected	Gets the action component for the login form.
GetLogoutAction	protected	Gets the action component for the logout form.
GetNamePath	public	Returns a string used by the Object Inspector.
GetObservers	protected
GetOwner	protected	Returns the owner of a component.
GetParentComponent	public	Returns the containing component.
GetTypeInfo	protected	Retrieves the type information for an object.
GetTypeInfoCount	protected	Returns the number of type information interfaces that an object provides (either 0 or 1).
GetUserID	protected	Returns the user ID of the current user.
GetVariable	protected	Returns an action or field.
GetVariableCount	protected	Returns the total count of actions and fields.
GetVariableName	protected	Gets the name used to reference this adapter with server-side script.
GetVisibleActions	protected	Returns a list of this adapter's action components.
GetVisibleFields	protected	Returns a list of this adapter's field components.
GetWebSnapObjClass	protected	Returns the class type for this adapter field.
HasExecuteAccess	protected	Checks the end-user's right to execute this adapter's actions.
HasExecuteRights	protected	Determines if the user has execute rights for the TBaseEndUserAdapter.
HasModifyAccess	protected	Checks the end-user's right to modify this adapter's fields.
HasModifyRights	protected	Determines if the user has modify rights for the TBaseEndUserAdapter.
HasParent	public	Verifies whether the component has a parent.
HasViewAccess	protected	Checks the end-user's right to view this adapter's fields.
HasViewRights	protected	Determine if the user has view rights to the TBaseEndUserAdapter.
ImplCanAddActionClass	protected	Determines if the given action class can be added.
ImplCanAddFieldClass	protected	Determines if the given action class can be added.
ImplClearAdapterValues	protected	Clears adapter state information.
ImplEndIterator	protected	Implements IIteratorSupport's EndIterator method to support iterating over the data records of the adapter.
ImplFindVariable	protected	Finds an adapter action or adapter field child with a matching variable name.
ImplFindVariableContainer	protected	Finds an adapter action or adapter field that is a container for other scriptable objects.
ImplGetActionsList	protected	Lists supported end-user adapter actions.
ImplGetDisplayName	protected	Gets the display name for this TBaseEndUserAdapter.
ImplGetEchoActionFieldValues	protected	Returns the value of the echo flag.
ImplGetEndUserAdapter	protected	Returns this TBaseEndUserAdapter.
ImplGetFieldsList	protected	Obtains the list of all of the fields for the end-user adapter.
ImplGetIteratorIndex	protected	Implements IIteratorIndex's GetIteratorIndex method to support iterating over the data records of the adapter.
ImplGetLoggedIn	protected	Checks the value of the LoggedIn field.
ImplGetLoginFormAction	protected	Gets the LoginForm action component for this TBaseEndUserAdapter.
ImplGetLogoutAction	protected	Gets the Logout action component for this TBaseEndUserAdapter.
ImplGetVariable	protected	Returns an action or field.
ImplGetVariableCount	protected	Returns the total count of actions and fields.
ImplGetVariableName	protected	Gets the name used to reference this adapter with server-side script.
ImplGetVisibleActions	protected	Returns a list of this adapter's action components.
ImplGetVisibleFields	protected	Returns a list of this adapter's field components.
ImplHasExecuteAccess	protected	Checks the end-user's right to execute this adapter's actions.
ImplHasExecuteRights	protected	Checks user rights and determines if the user has execute rights.
ImplHasModifyAccess	protected	Checks the end-user's right to modify this adapter's fields.
ImplHasModifyRights	protected	Checks user rights and determines if the user has modify rights.
ImplHasViewAccess	protected	Checks the end-user's right to view this adapter's fields.
ImplHasViewRights	protected	Checks user rights and determines if the user has view rights.
ImplInIterator	protected	Implements IIteratorIndex's InIterator to support iterating over the data records of the adapter.
ImplLogIn	protected	Processes the login for the given user.
ImplNextIteration	protected	Implements IIteratorSupport's NextIteration method to support iterating over the records of the adapter.
ImplNotifyActivate	protected	Called when the web module is activated.
ImplNotifyDeactivate	protected	Called when the web module is deactivated.
ImplProduceLoginPage	protected	Generate the HTML login page.
ImplSetActions	protected	Initializes the Actions property.
ImplSetData	protected	Initializes the Data property.
ImplSetEchoActionFieldValues	protected	Sets the echo flag for this adapter's fields.
ImplStartIterator	protected	Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter.
InheritsFrom	public	Determines the relationship of two object types.
InIterator	protected	Implements IIteratorIndex's InIterator method to support iterating over the data records of the adapter.
InitInstance	public	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertComponent	public	Establishes the component as the owner of a specified component.
InstanceSize	public	Returns the size in bytes of each instance of the object type.
Invoke	protected	Provides access to Automation properties and methods when the component wraps an Automation object.
IsActionInUse	protected	Indicates whether a particular action has been added to the adapter.
IsFieldInUse	protected	Indicates whether a particular field has been added to the adapter.
IsImplementorOf	public	Indicates whether the component implements a specified interface.
ListHiddenFields	protected	Specifies the HTML form hidden fields needed by the adapter.
ListHiddenRecordFields	protected	Specifies the HTML form hidden fields needed by the adapter.
Loaded	protected	Initializes the component after the form file has been read into memory.
LogIn	protected	Processes the server-side login for the given user.
MethodAddress	public	Returns the address of a class method by name.
MethodName	public	Returns the name of a class method by address.
NewInstance	public	Allocates memory for an instance of an object type and returns a pointer to that new instance.
NextIteration	protected	Implements IIteratorSupport's NextIteration method to support iterating over the data records of the adapter.
Notification	protected	Clears references to deleted components.
NotifyActivate	protected	Called when the web module is activated.
NotifyAdapterChange	protected	Notifies components that the adapter has changed in some way.
NotifyDeactivate	protected	Called when the web module is deactivated.
ObserverAdded	protected
operator ()	public
PaletteCreated	protected	Responds when the component is created from the component palette.
ProduceLoginPage	protected	Generates the login page.
QualifiedClassName	public	Returns the qualified name of the class.
QueryInterface	protected	Returns a reference to a specified interface if the current component supports that interface.
ReadState	protected	Reads the state of the component.
ReferenceInterface	public	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
RemoveComponent	public	Removes a specified component specified from the component's Components list.
RemoveFreeNotification	public	Disables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotifications	protected	Notifies all owned components of the owner component's imminent destruction.
SafeCallException	public	Handles exceptions in methods declared using the safecall calling convention.
SetActions	protected	Initializes the Actions property.
SetAncestor	protected	Clears or sets csAncestor state in the component's ComponentState property.
SetChildOrder	protected	Sets the visual ordering of a child control.
SetData	protected	Initializes the Data property.
SetDesigning	protected	Ensures that components inserted at design time have their design-mode flag set.
SetDesignInstance	protected	Ensures that components inserted at design time have their design-mode flag set.
SetEchoActionFieldValues	protected	Sets the echo flag for this adapter's fields.
SetInline	protected	Sets the csInline bit of the component's ComponentState property.
SetName	protected	Sets the value of the Name property.
SetParentComponent	protected	Sets the parent component.
SetSubComponent	public	Identifies whether the component is a subcomponent.
StartIterator	protected	Implements IIteratorSupport's StartIterator method to support iterating over the records of the adapter.
ToString	public	Returns a string containing the class name.
UnitName	public	Returns the name of the unit where the class is defined.
UnitScope	public	Returns the class's unit scope.
UpdateAction	public	Updates the state of an action.
Updated	protected	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateFieldsExecuteValues	protected	Executes the adapter's fields with values passed in the HTTP request.
UpdateFieldsGetAnyChanges	protected	Determines whether the values in the HTTP request change any adapter fields.
UpdateFieldsUpdateValues	protected	Updates the adapter's fields with values passed in the HTTP request.
UpdateFieldsValidateValues	protected	Validate the adapter's field values passed in the HTTP request.
UpdateRecords	public	Updates the adapter's fields with the field values passed in an HTTP request.
UpdateRecordsGetAnyChanges	protected	Determines whether values passed in the HTTP request will change any adapter fields.
UpdateRecordsUpdateValues	protected	Updates adapter fields with values passed in the HTTP request.
UpdateRecordsValidateValues	protected	Validate the adapter's field values passed in the HTTP request.
UpdateRegistry	protected	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
Updating	protected	Sets the csUpdating state in the component's ComponentState property.
UserList	protected	Gets the user list.
ValidateContainer	protected	Determines whether an object can be inserted into a container.
ValidateInsert	protected	Provides the interface for a method that validates a child component before it is inserted.
ValidateRename	protected	Ensures that renaming an owned component does not create a name conflict.
WebComponentsChange	protected	WebComponentsChange is called when the list of adapter fields or adapter actions changes.
WriteState	protected	Writes the state of the component.