WebAdapt Namespace

This is namespace WebAdapt.

Name	Description
Classes	The following table lists classes in this documentation.
Interfaces	The following table lists interfaces in this documentation.
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Constants	The following table lists constants in this documentation.

Classes

	Name	Description
	EAdapterException	EAdapterException is raised by WebSnap adapter objects.
	EAdapterFieldException	EAdapterFieldException is an exception class for errors by adapters using fields.
	TAbstractFieldValuesAdapter	TAbstractFieldValuesAdapter is the base class for adapters that have a single default field.
	TAdapter	TAdapter defines a scriptable interface to event handlers that return data items or execute commands in your application.
	TAdapterAction	TAdapterAction is a generic adapter action that relies on event handlers.
	TAdapterActions	TAdapterActions manages the list of actions that belong to an adapter.
	TAdapterApplicationField	TAdapterApplicationField is a base class for adapter field components that are children of a TApplicationAdapter component.
	TAdapterApplicationTitleField	TAdapterApplicationTitleField is an adapter field used to access the application title.
	TAdapterBooleanField	TAdapterBooleanField is an event handler based adapter field that works with a Boolean value.
	TAdapterDefaultActions	TAdapterDefaultActions manages the list of actions that belong to an adapter that supports a default set of actions.
	TAdapterDefaultFields	TAdapterDefaultFields manages the list of fields that belong to an adapter that supports a default set of fields.
	TAdapterEndUserDisplayNameField	TAdapterEndUserDisplayNameField is an adapter field used to access the end-user's name.
	TAdapterEndUserField	TAdapterEndUserField is a base class for adapter field components that are children of an end-user adapter component.
	TAdapterEndUserLoggedInField	TAdapterEndUserLoggedInField is an adapter field used to access the end-user logged in flag.
	TAdapterError	TAdapterError is the implementation of IAdapterError.
	TAdapterErrorsList	TAdapterErrorsList keeps track of errors that an adapter encounters.
	TAdapterField	TAdapterField is an event handler based adapter field that provides a single value.
	TAdapterFields	TAdapterFields manages the list of fields that belong to an adapter.
	TAdapterFileField	TAdapterFileField is an event handler based adapter field that can accept uploaded files.
	TAdapterGotoPageAction	TAdapterGotoPageAction is an adapter action that supports commands to go to a page of a TDefaultFieldsPagedAdapter.
	TAdapterHiddenField	This is class WebAdapt.TAdapterHiddenField.
	TAdapterHiddenFieldsList	TAdapterHiddenFieldsList maintains a collection of name/value pairs that an adapter includes as hidden fields in an HTML form.
	TAdapterImageField	TAdapterImageField is an event handler based adapter field that can provide the URL of an image file and also accept an uploaded image file.
	TAdapterLoginField	TAdaperLoginField is a base class for adapter field components that are children of a TLoginFormAdapter component.
	TAdapterMemoField	TAdapterMemoField is an event handler based adapter field that supports a multi-line text value.
	TAdapterMultiValueField	TAdapterMultiValueField is an event handler based adapter field that provides zero or more values.
	TAdapterNamedDisplayField	The AdapterNamedDisplayField is a base class for adapter fields.
	TAdapterNamedField	TAdapterNamedField is a based class for adapter field components.
	TAdapterNextPageAction	TAdapterNextPageAction implements the next page command for TDefaultFieldsPagedAdapter.
	TAdapterNextPageField	The TAdapterNextPageField navigates to the next page of data.
	TAdapterObjectErrorsList	This is class WebAdapt.TAdapterObjectErrorsList.
	TAdapterPasswordField	TAdapterPasswordField is an adapter field used to access the password entered by the end-user.
	TAdapterPrevPageAction	TAdapterPrevPageAction implements the previous page command for TDefaultFieldsPagedAdapter.
	TAdapterSubComponent	TAdapterSubComponent is the base class for objects that represent a collection of actions or fields that belong to an adapter.
	TAdapterUpdateField	TAdapterUpdateField is a base class for adapter field components that support data entry into an HTML form.
	TAdapterUserNameField	TAdapterUserNameField is an adapter field used to access the user name entered by the end-user.
	TApplicationAdapter	TApplicationAdapter is a container for field and action components that are available through the Application script variable.
	TBaseAdapterAction	TBaseAdapterAction is a based class for adapter action components.
	TBaseAdapterErrorsList	TBaseAdapterErrorsList is the base class for adapter error object managers.
	TBaseAdapterMultiValueField	TBaseAdapterMultiValueField is a base class for adapter fields that have zero or more values.
	TBaseEndUserAdapter	TBaseEndUserAdapter contains user information.
	TBaseValuesListAdapter	TBaseValuesListAdapter is a base class for adapters that provide a list of name/value pairs.
	TBaseValuesListField	TBaseValuesListField is a base class for adapter field components that are children of a values list adapter component.
	TCustomAdapter	TCustomAdapter is a base class for adapter components.
	TCustomAdapterAction	TCustomAdapterAction is a base class for adapter actions.
	TCustomAdapterBooleanField	TCustomAdapterBooleanField is a base class for adapter fields that provide a single Boolean value.
	TCustomAdapterField	TCustomAdapterField is a base class for adapter fields that provide a single value.
	TCustomAdapterFileField	TCustomAdapterFileField is a base class for adapter fields that can have associated files.
	TCustomAdapterGotoPageAction	TCustomAdapterGotoPageAction is an adapter action that supports commands to go to a page of a TDefaultFieldsPagedAdapter.
	TCustomAdapterImageField	TCustomAdapterImageField is a base class for adapter fields that have an associated image file.
	TCustomAdapterMemoField	TCustomAdapterMemoField is a base class for adapter fields that have a multi-line text value.
	TCustomAdapterMultiValueField	TCustomAdapterMultiValueField is a base class for adapter fields that have one or more values.
	TCustomAdapterPageAction	TCustomPagedAdapterAction is a base class for adapter actions that execute the next or previous page commands.
	TCustomApplicationAdapter	TCustomApplicationAdapter is a base class for components that implement the server-side script Application object.
	TCustomApplicationAdapterAction	TCustomApplicationAdapterAction is a base class for adapter actions that work with descendants of TCustomApplicationAdapter.
	TCustomEndUserAdapter	TCustomEndUserAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
	TCustomEndUserAdapterAction	TCustomEndUserAdapterAction is a base class for adapter actions that work with descendants of TCustomEndUserAdapter.
	TCustomEndUserSessionAdapter	TCustomEndUserSessionAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
	TCustomLoginFormAdapter	TCustomLoginFormAdapter is the base class for adapters that manage the fields and actions of a login form.
	TCustomLoginFormAdapterAction	TCustomEndUserAdapterAction is a base class for adapter actions that work with descendants of TCustomLoginFormAdapter.
	TCustomPagedAdapter	TCustomPagedAdapter is a base class for adapters that support paging.
	TCustomPagedAdapterAction	TCustomPagedAdapterAction is a base class for adapter actions that work with descendants of TDefaultFieldsPagedAdapter.
	TCustomStringsValuesList	TCustomStringsValuesList is a base class for a values list that defines it's name/value pairs using a string list.
	TDefaultFieldsAdapter	TDefaultFieldsAdapter is a base class for adapters that automatically adds default fields and/or actions.
	TDefaultFieldsPagedAdapter	TDefaultFieldsPagedAdapter is a base class for adapters that support paging.
	TEndUserAdapter	TEndUserAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
	TEndUserAdapterLoginFormAction	TEndUserAdapterLoginFormAction is an adapter action that displays a login form when executed.
	TEndUserAdapterLogoutAction	TEndUserAdapterLogoutAction is an adapter action that logs the end-user out.
	TEndUserSessionAdapter	TEndUserSessionAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
	TFieldValuesAdapter	TFieldValuesAdapter is an adapter that includes a single field value.
	TFieldValuesValueField	TFieldValuesValueField is a adapter field child of TFieldValuesAdapter.
	TImplementedAdapterAction	TImplementedAdapterAction is a base class for adapter actions.
	TLogicalPageList	This is class WebAdapt.TLogicalPageList.
	TLoginFormAdapter	TLoginFormAdapter contains the adapter fields and adapter actions used to generate a login form.
	TLoginFormAdapterLoginAction	TLoginFormAdapterLoginAction executes the login command of a login form generated with TLoginFormAdapter.
	TPagedAdapter	TPagedAdapter divides a large amount of data into several pages, each page displaying a portion of the data records.
	TStringsValuesList	TStringsValuesList is an adapter component that provides a list of name/value pairs defined by items in a TStrings property.
	TUpdateFileList	TUpdateFileList is a container for uploaded files.
	TValuesListNameField	TValuesListNameField is an adapter field used to access the Name of the current list item of a values list adapter.
	TValuesListValueField	TValuesListValueField is an adapter field used to access the Value of the current list item of a values list adapter.

Constants

Name	Description
sActionRequestLong	This is constant WebAdapt.sActionRequestLong.
sCurrentPage	This is constant WebAdapt.sCurrentPage.
sGotoPageAction	This is constant WebAdapt.sGotoPageAction.
sImageRequest	This is constant WebAdapt.sImageRequest.
sLoginPassword	This is constant WebAdapt.sLoginPassword.
sLoginUserName	This is constant WebAdapt.sLoginUserName.
sNextPageAction	This is constant WebAdapt.sNextPageAction.
sPrevPageAction	This is constant WebAdapt.sPrevPageAction.

Functions

	Name	Description
	AddDefaultActions	This is function WebAdapt.AddDefaultActions.
	AddDefaultFields	This is function WebAdapt.AddDefaultFields.
	FindAdapterAction	This is function WebAdapt.FindAdapterAction.
	FindAdapterField	This is function WebAdapt.FindAdapterField.
	FindAdapterInParent	This is function WebAdapt.FindAdapterInParent.
	MakeAdapterRequestIdentifier	This is function WebAdapt.MakeAdapterRequestIdentifier.
	MakeValidAdapterFieldName	This is function WebAdapt.MakeValidAdapterFieldName.
	RaiseFileUploadNotSupported	This is function WebAdapt.RaiseFileUploadNotSupported.
	RaiseMultipleFilesException	This is function WebAdapt.RaiseMultipleFilesException.
	RaiseMultipleValuesException	This is function WebAdapt.RaiseMultipleValuesException.

Interfaces

	Name	Description
	IAdapterEditor	This is class WebAdapt.IAdapterEditor.
	IAdapterNotifyAdapterChange	This is class WebAdapt.IAdapterNotifyAdapterChange.
	ICheckOrigValue	This is class WebAdapt.ICheckOrigValue.
	ICheckValueChange	This is class WebAdapt.ICheckValueChange.
	IClearAdapterValues	This is class WebAdapt.IClearAdapterValues.
	ICreateActionRequestContext	This is class WebAdapt.ICreateActionRequestContext.
	IEchoActionFieldValue	This is class WebAdapt.IEchoActionFieldValue.
	IEchoAdapterFieldValues	This is class WebAdapt.IEchoAdapterFieldValues.
	IExecuteValue	IExecuteValue is the interface for executing an adapter's fields with values passed in an HTTP request.
	IFullyQualifyInputNames	This is class WebAdapt.IFullyQualifyInputNames.
	IGetAdapterErrorsList	This is class WebAdapt.IGetAdapterErrorsList.
	IGetAdapterModeNames	This is class WebAdapt.IGetAdapterModeNames.
	IGetRecordKeys	This is class WebAdapt.IGetRecordKeys.
	IIdentifyAdapter	This is class WebAdapt.IIdentifyAdapter.
	ISetSubComponents	This is class WebAdapt.ISetSubComponents.
	ISetWebFieldValue	This is class WebAdapt.ISetWebFieldValue.
	IUpdateValue	This is class WebAdapt.IUpdateValue.
	IValidateValue	This is class WebAdapt.IValidateValue.
	IWebActionsSubcomponent	This is class WebAdapt.IWebActionsSubcomponent.
	IWebFieldsSubcomponent	This is class WebAdapt.IWebFieldsSubcomponent.
	IWebGetFieldPrevValue	This is class WebAdapt.IWebGetFieldPrevValue.

Structs, Records, Enums

	Name	Description
	TAdapterHiddenFieldOption	TAdapterHiddenFieldOptions identifies the types of hidden fields an adapter adds to generated HTML forms.
	TIteratorMethod	TIteratorMethod identifies a record of data to which an adapter should navigate.

Types

Name	Description
IActionFieldValue	This is type WebAdapt.IActionFieldValue.
IActionRequest	This is type WebAdapt.IActionRequest.
TAbstractWebRequestFile	This is type WebAdapt.TAbstractWebRequestFile.
TActionExecuteEvent	TActionExecuteEvent is the type for event handlers on adapter action objects that are called when the action executes.
TActionExecuteHandledEvent	TActionExecuteHandledEvent is the type for event handlers on adapter action objects that can handle the execution of the action.
TActionGetEnabledEvent	TActionGetEnabledEvent is the type for event handlers on adapter action objects that are called when the action executes.
TActionGetParamsEvent	TActionGetParamsEvent is the type for event handlers that supply the parameters for an adapter action.
TActionRequestFieldsEvent	TActionRequestFieldsEvent is the type for event handlers on adapter action objects that are called after the adapter performs some operation on its fields in response to an HTTP request.
TActionRequestFieldsHandledEvent	TActionRequestFieldsHandledEvent is the type for event handlers on adapter action objects that are called when the adapter performs some operation on its fields in response to an HTTP request.
TAdapterActionExecuteEvent	TAdapterActionExecuteEvent is the type for event handlers on adapter objects that are called after one of its actions executes.
TAdapterActionExecuteHandledEvent	TAdapterActionExecuteHandledEvent is the type for event handlers on adapter objects that are called when one of its actions executes.
TAdapterActionGetParamsEvent	TAdapterActionGetParamsEvent is the type for event handlers that supply the parameters needed to execute an adapter action.
TAdapterActionsClass	TAdapterActionsClass defines the metaclass for TAdapterActions.
TAdapterFieldBooleanValueEvent	TAdapterFieldBooleanValueEvent is the type for event handlers that respond when a boolean value is assigned to an adapter field.
TAdapterFieldFileEvent	TAdapterFieldFileEvent is the type for event handlers that perform some action on an uploaded file.
TAdapterFieldFileListEvent	TAdapterFieldFileListEvent is the type for event handlers that perform some action on a set of uploaded files.
TAdapterFieldGetBooleanEvent	TAdapterFieldGetBooleanEvent is the type for event handlers that provide a boolean value associated with an adapter field.
TAdapterFieldGetMultiValueEvent	TAdapterFieldGetMultiValueEvent is the type for event handlers that supply a set of values for an adapter field.
TAdapterFieldGetMultiValueStringEvent	TAdapterFieldGetMultiValueStringEvent is the type for event handlers that supply a set of string values for an adapter field.
TAdapterFieldGetStringEvent	TAdapterFieldGetStringEvent is the type for event handlers that provide a string associated with an adapter field.
TAdapterFieldGetValueCountEvent	TAdapterFieldGetValueCountEvent is the type for event handlers that indicate the number of values associated with an adapter field.
TAdapterFieldGetValueEvent	TAdapterFieldGetValueEvent is the type for event handlers that provide the value associated with an adapter field.
TAdapterFieldHasValueEvent	TAdapterFieldHasValueEvent is the type for event handlers that indicate whether a value is assigned to an adapter field.
TAdapterFieldsClass	This is type WebAdapt.TAdapterFieldsClass.
TAdapterFieldStringEvent	TAdapterFieldStringEvent is the type for event handlers that respond when a string value is assigned to an adapter field.
TAdapterFieldStringsEvent	TAdapterFieldStringsEvent is the type for event handlers that respond when a set of string values is assigned to an adapter field.
TAdapterFieldValidateValueEvent	TAdapterFieldValidateValueEvent is the type for event handlers that validate a value for an adapter field.
TAdapterFieldValueEvent	TAdapterFieldValueEvent is the type for event handlers that respond when an adapter field's value changes.
TAdapterHiddenFieldOptions	This is type WebAdapt.TAdapterHiddenFieldOptions.
TEndUserGetNameEvent	TEndUserGetNameEvent is the type for event handlers that supply the name of the current end user.
TEndUserGetUserIDEvent	TEndUserGetUserIDEvent is the type for event handlers that supply the user ID of the current end user.
TEndUserHandledEvent	TEndUserHandledEvent is the type for event handlers that can optionally handle a task for an end user adapter.
TEndUserIsLoggedInEvent	TEndUserIsLoggedInEvent is the type for event handlers that indicate whether the current end user has logged in.
TEndUserRightsEvent	TEndUserRightsEvent is the type for event handlers that check whether a user has rights to perform a specific operation.
TEndUserUserIDEvent	TEndUserUserIDEvent is the type for event handlers that log in a user given the user ID.
TGetEOFEvent	TGetEOFEvent is the type for event handlers on adapters that indicate when to stop iterating over values.
TGetRecordCountEvent	TGetRecordCountEvent is the type for event handlers that indicate how many values an adapter has.
TGetRecordEvent	TGetRecordEvent is the type for event handlers on adapters that position the adapter on one of multiple values.
TGetRecordIndexEvent	TGetRecordIndexEvent is the type for event handlers that indicate which of multiple values an adapter is positioned on.
THandledEvent	This is type WebAdapt.THandledEvent.
TImageFieldGetHREFEvent	TImageFieldGetHREFEvent is the type for event handlers that supply an URL that can be used to access an image field associated with an adapter field..
TImageFieldGetImageEvent	TImageFieldGetImageEvent is the type for event handlers that supply a stream from which to read an image.
TImageFieldGetParamsEvent	TImageFieldGetParamsEvent is the type for event handlers that supply a set of parameters to identify the value of an image field.
TIterateRecordsEvent	TIterateRecordsEvent is the type for event handlers that navigate the records of an adapter.
TLoginUserIDEvent	TLoginUserIDEvent is the type for event handlers that respond after a user logs in.
TObjectList	This is type WebAdapt.TObjectList.
TValidateAdapterFieldEvent	TValidateAdapterFieldEvent is the type for event handlers that validate the values supplied for adapter fields.
TWebFormGetPageNameEvent	TWebFormGetPageNameEvent is the type for event handlers that supply labels for the controls that navigate to Web pages.

Variables

Name	Description
NotifyPossibleHTMLChange	This is variable WebAdapt.NotifyPossibleHTMLChange.

What do you think about this topic? Send feedback!