Show: Delphi C++
Display Preferences

WebAdapt

From XE2 API Documentation
Jump to: navigation, search


Contents

Classes

EAdapterExceptionEAdapterException is raised by WebSnap adapter objects.
EAdapterFieldExceptionEAdapterFieldException is an exception class for errors by adapters using fields.
IActionFieldValue
IActionRequest
IAdapterEditor
IAdapterNotifyAdapterChange
ICheckOrigValue
ICheckValueChange
IClearAdapterValues
ICreateActionRequestContext
IEchoActionFieldValue
IEchoAdapterFieldValues
IExecuteValueIExecuteValue is the interface for executing an adapter's fields with values passed in an HTTP request.
IFullyQualifyInputNames
IGetAdapterErrorsList
IGetAdapterModeNames
IGetRecordKeys
IIdentifyAdapter
ISetSubComponents
ISetWebFieldValue
IUpdateValue
IValidateValue
IWebActionsSubcomponent
IWebFieldsSubcomponent
IWebGetFieldPrevValue
TAbstractFieldValuesAdapterTAbstractFieldValuesAdapter is the base class for adapters that have a single default field.
TAbstractWebRequestFile
TAdapterTAdapter defines a scriptable interface to event handlers that return data items or execute commands in your application.
TAdapterActionTAdapterAction is a generic adapter action that relies on event handlers.
TAdapterActionsTAdapterActions manages the list of actions that belong to an adapter.
TAdapterActionsClassTAdapterActionsClass defines the metaclass for TAdapterActions.
TAdapterApplicationFieldTAdapterApplicationField is a base class for adapter field components that are children of a TApplicationAdapter component.
TAdapterApplicationTitleFieldTAdapterApplicationTitleField is an adapter field used to access the application title.
TAdapterBooleanFieldTAdapterBooleanField is an event handler based adapter field that works with a Boolean value.
TAdapterDefaultActionsTAdapterDefaultActions manages the list of actions that belong to an adapter that supports a default set of actions.
TAdapterDefaultFieldsTAdapterDefaultFields manages the list of fields that belong to an adapter that supports a default set of fields.
TAdapterEndUserDisplayNameFieldTAdapterEndUserDisplayNameField is an adapter field used to access the end-user's name.
TAdapterEndUserFieldTAdapterEndUserField is a base class for adapter field components that are children of an end-user adapter component.
TAdapterEndUserLoggedInFieldTAdapterEndUserLoggedInField is an adapter field used to access the end-user logged in flag.
TAdapterErrorTAdapterError is the implementation of IAdapterError.
TAdapterErrorsListTAdapterErrorsList keeps track of errors that an adapter encounters.
TAdapterFieldTAdapterField is an event handler based adapter field that provides a single value.
TAdapterFieldsTAdapterFields manages the list of fields that belong to an adapter.
TAdapterFieldsClass
TAdapterFileFieldTAdapterFileField is an event handler based adapter field that can accept uploaded files.
TAdapterGotoPageActionTAdapterGotoPageAction is an adapter action that supports commands to go to a page of a TDefaultFieldsPagedAdapter.
TAdapterHiddenField
TAdapterHiddenFieldsListTAdapterHiddenFieldsList maintains a collection of name/value pairs that an adapter includes as hidden fields in an HTML form.
TAdapterImageFieldTAdapterImageField is an event handler based adapter field that can provide the URL of an image file and also accept an uploaded image file.
TAdapterLoginFieldTAdaperLoginField is a base class for adapter field components that are children of a TLoginFormAdapter component.
TAdapterMemoFieldTAdapterMemoField is an event handler based adapter field that supports a multi-line text value.
TAdapterMultiValueFieldTAdapterMultiValueField is an event handler based adapter field that provides zero or more values.
TAdapterNamedDisplayFieldThe AdapterNamedDisplayField is a base class for adapter fields.
TAdapterNamedFieldTAdapterNamedField is a based class for adapter field components.
TAdapterNextPageActionTAdapterNextPageAction implements the next page command for TDefaultFieldsPagedAdapter.
TAdapterNextPageFieldThe TAdapterNextPageField navigates to the next page of data.
TAdapterObjectErrorsList
TAdapterPasswordFieldTAdapterPasswordField is an adapter field used to access the password entered by the end-user.
TAdapterPrevPageActionTAdapterPrevPageAction implements the previous page command for TDefaultFieldsPagedAdapter.
TAdapterSubComponentTAdapterSubComponent is the base class for objects that represent a collection of actions or fields that belong to an adapter.
TAdapterUpdateFieldTAdapterUpdateField is a base class for adapter field components that support data entry into an HTML form.
TAdapterUserNameFieldTAdapterUserNameField is an adapter field used to access the user name entered by the end-user.
TApplicationAdapterTApplicationAdapter is a container for field and action components that are available through the Application script variable.
TBaseAdapterActionTBaseAdapterAction is a based class for adapter action components.
TBaseAdapterErrorsListTBaseAdapterErrorsList is the base class for adapter error object managers.
TBaseAdapterMultiValueFieldTBaseAdapterMultiValueField is a base class for adapter fields that have zero or more values.
TBaseEndUserAdapterTBaseEndUserAdapter contains user information.
TBaseValuesListAdapterTBaseValuesListAdapter is a base class for adapters that provide a list of name/value pairs.
TBaseValuesListFieldTBaseValuesListField is a base class for adapter field components that are children of a values list adapter component.
TCustomAdapterTCustomAdapter is a base class for adapter components.
TCustomAdapterActionTCustomAdapterAction is a base class for adapter actions.
TCustomAdapterBooleanFieldTCustomAdapterBooleanField is a base class for adapter fields that provide a single Boolean value.
TCustomAdapterFieldTCustomAdapterField is a base class for adapter fields that provide a single value.
TCustomAdapterFileFieldTCustomAdapterFileField is a base class for adapter fields that can have associated files.
TCustomAdapterGotoPageActionTCustomAdapterGotoPageAction is an adapter action that supports commands to go to a page of a TDefaultFieldsPagedAdapter.
TCustomAdapterImageFieldTCustomAdapterImageField is a base class for adapter fields that have an associated image file.
TCustomAdapterMemoFieldTCustomAdapterMemoField is a base class for adapter fields that have a multi-line text value.
TCustomAdapterMultiValueFieldTCustomAdapterMultiValueField is a base class for adapter fields that have one or more values.
TCustomAdapterPageActionTCustomPagedAdapterAction is a base class for adapter actions that execute the next or previous page commands.
TCustomApplicationAdapterTCustomApplicationAdapter is a base class for components that implement the server-side script Application object.
TCustomApplicationAdapterActionTCustomApplicationAdapterAction is a base class for adapter actions that work with descendants of TCustomApplicationAdapter.
TCustomEndUserAdapterTCustomEndUserAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
TCustomEndUserAdapterActionTCustomEndUserAdapterAction is a base class for adapter actions that work with descendants of TCustomEndUserAdapter.
TCustomEndUserSessionAdapterTCustomEndUserSessionAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
TCustomLoginFormAdapterTCustomLoginFormAdapter is the base class for adapters that manage the fields and actions of a login form.
TCustomLoginFormAdapterActionTCustomEndUserAdapterAction is a base class for adapter actions that work with descendants of TCustomLoginFormAdapter.
TCustomPagedAdapterTCustomPagedAdapter is a base class for adapters that support paging.
TCustomPagedAdapterActionTCustomPagedAdapterAction is a base class for adapter actions that work with descendants of TDefaultFieldsPagedAdapter.
TCustomStringsValuesListTCustomStringsValuesList is a base class for a values list that defines its name/value pairs using a string list.
TDefaultFieldsAdapterTDefaultFieldsAdapter is a base class for adapters that automatically adds default fields and/or actions.
TDefaultFieldsPagedAdapterTDefaultFieldsPagedAdapter is a base class for adapters that support paging.
TEndUserAdapterTEndUserAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
TEndUserAdapterLoginFormActionTEndUserAdapterLoginFormAction is an adapter action that displays a login form when executed.
TEndUserAdapterLogoutActionTEndUserAdapterLogoutAction is an adapter action that logs the end-user out.
TEndUserSessionAdapterTEndUserSessionAdapter provides information about the current end user such as the user name, user ID, and whether the user is logged in.
TFieldValuesAdapterTFieldValuesAdapter is an adapter that includes a single field value.
TFieldValuesValueFieldTFieldValuesValueField is a adapter field child of TFieldValuesAdapter.
TImplementedAdapterActionTImplementedAdapterAction is a base class for adapter actions.
TLogicalPageList
TLoginFormAdapterTLoginFormAdapter contains the adapter fields and adapter actions used to generate a login form.
TLoginFormAdapterLoginActionTLoginFormAdapterLoginAction executes the login command of a login form generated with TLoginFormAdapter.
TObjectList
TPagedAdapterTPagedAdapter divides a large amount of data into several pages, each page displaying a portion of the data records.
TStringsValuesListTStringsValuesList is an adapter component that provides a list of name/value pairs defined by items in a TStrings property.
TUpdateFileListTUpdateFileList is a container for uploaded files.
TValuesListNameFieldTValuesListNameField is an adapter field used to access the Name of the current list item of a values list adapter.
TValuesListValueFieldTValuesListValueField is an adapter field used to access the Value of the current list item of a values list adapter.

Routines

AddDefaultActions
AddDefaultFields
FindAdapterAction
FindAdapterField
FindAdapterInParent
MakeAdapterRequestIdentifier
MakeValidAdapterFieldName
RaiseFileUploadNotSupported
RaiseMultipleFilesException
RaiseMultipleValuesException

Types

_di_IAdapterEditor
_di_IAdapterNotifyAdapterChange
_di_ICheckOrigValue
_di_ICheckValueChange
_di_IClearAdapterValues
_di_ICreateActionRequestContext
_di_IEchoActionFieldValue
_di_IEchoAdapterFieldValues
_di_IExecuteValue
_di_IFullyQualifyInputNames
_di_IGetAdapterErrorsList
_di_IGetAdapterModeNames
_di_IGetRecordKeys
_di_IIdentifyAdapter
_di_ISetSubComponents
_di_ISetWebFieldValue
_di_IUpdateValue
_di_IValidateValue
_di_IWebActionsSubcomponent
_di_IWebFieldsSubcomponent
_di_IWebGetFieldPrevValue
TActionExecuteEventTActionExecuteEvent is the type for event handlers on adapter action objects that are called when the action executes.
TActionExecuteHandledEventTActionExecuteHandledEvent is the type for event handlers on adapter action objects that can handle the execution of the action.
TActionGetEnabledEventTActionGetEnabledEvent is the type for event handlers on adapter action objects that are called when the action executes.
TActionGetParamsEventTActionGetParamsEvent is the type for event handlers that supply the parameters for an adapter action.
TActionRequestFieldsEventTActionRequestFieldsEvent 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.
TActionRequestFieldsHandledEventTActionRequestFieldsHandledEvent 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.
TAdapterActionExecuteEventTAdapterActionExecuteEvent is the type for event handlers on adapter objects that are called after one of its actions executes.
TAdapterActionExecuteHandledEventTAdapterActionExecuteHandledEvent is the type for event handlers on adapter objects that are called when one of its actions executes.
TAdapterActionGetParamsEventTAdapterActionGetParamsEvent is the type for event handlers that supply the parameters needed to execute an adapter action.
TAdapterActionsClassTAdapterActionsClass defines the metaclass for TAdapterActions.
TAdapterFieldBooleanValueEventTAdapterFieldBooleanValueEvent is the type for event handlers that respond when a boolean value is assigned to an adapter field.
TAdapterFieldFileEventTAdapterFieldFileEvent is the type for event handlers that perform some action on an uploaded file.
TAdapterFieldFileListEventTAdapterFieldFileListEvent is the type for event handlers that perform some action on a set of uploaded files.
TAdapterFieldGetBooleanEventTAdapterFieldGetBooleanEvent is the type for event handlers that provide a boolean value associated with an adapter field.
TAdapterFieldGetMultiValueEventTAdapterFieldGetMultiValueEvent is the type for event handlers that supply a set of values for an adapter field.
TAdapterFieldGetMultiValueStringEventTAdapterFieldGetMultiValueStringEvent is the type for event handlers that supply a set of string values for an adapter field.
TAdapterFieldGetStringEventTAdapterFieldGetStringEvent is the type for event handlers that provide a string associated with an adapter field.
TAdapterFieldGetValueCountEventTAdapterFieldGetValueCountEvent is the type for event handlers that indicate the number of values associated with an adapter field.
TAdapterFieldGetValueEventTAdapterFieldGetValueEvent is the type for event handlers that provide the value associated with an adapter field.
TAdapterFieldHasValueEventTAdapterFieldHasValueEvent is the type for event handlers that indicate whether a value is assigned to an adapter field.
TAdapterFieldsClass
TAdapterFieldStringEventTAdapterFieldStringEvent is the type for event handlers that respond when a string value is assigned to an adapter field.
TAdapterFieldStringsEventTAdapterFieldStringsEvent is the type for event handlers that respond when a set of string values is assigned to an adapter field.
TAdapterFieldValidateValueEventTAdapterFieldValidateValueEvent is the type for event handlers that validate a value for an adapter field.
TAdapterFieldValueEventTAdapterFieldValueEvent is the type for event handlers that respond when an adapter field's value changes.
TAdapterHiddenFieldOptionTAdapterHiddenFieldOptions identifies the types of hidden fields an adapter adds to generated HTML forms.
TAdapterHiddenFieldOptions
TEndUserGetNameEventTEndUserGetNameEvent is the type for event handlers that supply the name of the current end user.
TEndUserGetUserIDEventTEndUserGetUserIDEvent is the type for event handlers that supply the user ID of the current end user.
TEndUserHandledEventTEndUserHandledEvent is the type for event handlers that can optionally handle a task for an end user adapter.
TEndUserIsLoggedInEventTEndUserIsLoggedInEvent is the type for event handlers that indicate whether the current end user has logged in.
TEndUserRightsEventTEndUserRightsEvent is the type for event handlers that check whether a user has rights to perform a specific operation.
TEndUserUserIDEventTEndUserUserIDEvent is the type for event handlers that log in a user given the user ID.
TGetEOFEventTGetEOFEvent is the type for event handlers on adapters that indicate when to stop iterating over values.
TGetRecordCountEventTGetRecordCountEvent is the type for event handlers that indicate how many values an adapter has.
TGetRecordEventTGetRecordEvent is the type for event handlers on adapters that position the adapter on one of multiple values.
TGetRecordIndexEventTGetRecordIndexEvent is the type for event handlers that indicate which of multiple values an adapter is positioned on.
THandledEvent
TImageFieldGetHREFEventTImageFieldGetHREFEvent is the type for event handlers that supply an URL that can be used to access an image field associated with an adapter field..
TImageFieldGetImageEventTImageFieldGetImageEvent is the type for event handlers that supply a stream from which to read an image.
TImageFieldGetParamsEventTImageFieldGetParamsEvent is the type for event handlers that supply a set of parameters to identify the value of an image field.
TIterateRecordsEventTIterateRecordsEvent is the type for event handlers that navigate the records of an adapter.
TIteratorMethodTIteratorMethod identifies a record of data to which an adapter should navigate.
TLoginUserIDEventTLoginUserIDEvent is the type for event handlers that respond after a user logs in.
TValidateAdapterFieldEventTValidateAdapterFieldEvent is the type for event handlers that validate the values supplied for adapter fields.
TWebFormGetPageNameEventTWebFormGetPageNameEvent is the type for event handlers that supply labels for the controls that navigate to Web pages.

Variables

NotifyPossibleHTMLChange

Constants

hoModehoMode: TAdapterHiddenFieldOption = hoMode;
hoOrigValueshoOrigValues: TAdapterHiddenFieldOption = hoOrigValues;
hoRecordKeyshoRecordKeys: TAdapterHiddenFieldOption = hoRecordKeys;
itEnditEnd: TIteratorMethod = itEnd;
itNextitNext: TIteratorMethod = itNext;
itStartitStart: TIteratorMethod = itStart;
sActionRequestLongsActionRequestLong: string = __action;
sCurrentPagesCurrentPage: string = _cp;
sGotoPageActionsGotoPageAction: string = GotoPage;
sImageRequestsImageRequest: string = __img;
sLoginPasswordsLoginPassword: string = Password;
sLoginUserNamesLoginUserName: string = UserName;
sNextPageActionsNextPageAction: string = NextPage;
sPrevPageActionsPrevPageAction: string = PrevPage;


Personal tools
Previous Versions
Translations