RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
IActionImageProducer.GetAdapterEventImage Method

Returns the object that is responsible for providing a specified image from a set of related images.

Pascal
function GetAdapterEventImage(const AComponentName: WideString; const AEvent: WideString; const ACaption: WideString): TObject;
C++
__fastcall TObject * GetAdapterEventImage(const BSTR AComponentName, const BSTR AEvent, const BSTR ACaption);

GetAdapterEventImage returns the object that supplies an HREF for the specified image. That object can supply the HREF in one of two ways: 

It can implement the IWebImageHREF interface. 

It can be the object that produces the image in response to request messages. In this case, the adapter dispatcher's EncodeAdapterItemRequestAsHREF method generates the HREF to address this object. 

AComponentName is the name of the component that is requesting the image. GetAdapterEventImage can use this parameter to determine which of several objects is appropriate for supplying the image. 

AEvent identifies the user event that the image should reflect. This parameter is used when the GetDisplayStyle method returns 'EventImages'. If AEvent is an empty string, GetAdapterEventImage returns the object that supplies the base image. If AEvent is not empty, GetAdapterEventImage returns the object that supplies the version of the image to use in response to the associated user action. Possible values are 'onmouseover', 'onmouseout', and 'onmousedown'. 

ACaption is a text label that describes the desired image. GetAdapterEventImage can use this parameter to determine which of several objects is appropriate for supplying the image. 

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!