GetImage Method (ImageDataProvider)

Retrieves the image specified in the parameter DocumentIdentifier. This call is being deprecated. Please use OpenImageData() instead.This method does not support multiple provider model!!

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
<ObsoleteAttribute("Please switch to the OpenImageData API")>
Public Overridable Function GetImage( _
   ByVal documentIdentifier As String _
) As Stream

'Usage
 
Dim instance As ImageDataProvider
Dim documentIdentifier As String
Dim value As Stream
 
value = instance.GetImage(documentIdentifier)

[Obsolete("Please switch to the OpenImageData API")]
public virtual Stream GetImage( 
   string documentIdentifier
)

[Obsolete("Please switch to the OpenImageData API")]
public: virtual Stream* GetImage( 
   string* documentIdentifier
)

[Obsolete("Please switch to the OpenImageData API")]
public:
virtual Stream^ GetImage( 
   String^ documentIdentifier
)

Parameters

documentIdentifier: A string that uniquely identifies a single image file.

Return Value

A stream of binary image data

Remarks

The documentIdentifier specifies the identifier for the image to be retrieved. This can represent an image file, a valid file URL or database table data field. Whatever is specified, the viewer will retrieve and display the image specified by this parameter.

The DocumentIdentifier value can depend on the image data provider that you are using. For details, refer to DocumentIdentifier property in "ImageGear.Web.UI.PageView.DocumentIdentifier" in this help document.

An Image Data Provider must be specified in the web.config file. For details refer to the "web.config settings for PageView and ThumbnailView" section."

Note: If you are writing a custom provider derived from this class, then make sure this method returns a binary image data stream.

Reference

ImageDataProvider Class
ImageDataProvider Members