ImageGear .NET v25.1 - Updated
OnList Method




ImageGear.Web.Services Assembly > ImageGear.Web.DataProviders Namespace > MarkupArtMiddleware Class : OnList Method
A reference to the List containing the Markup Layer Record IDs and mnemonic display names of Markup Layers associated with the requested Document Identifier. This can be set to null or modified in an override of this method before being returned to the client.
The Document Identifier for which to list associated Markup Layers
Any additional parameters passed when opening an Art Data Connection
This method is provides the Developer with a simple means of controlling data flow between client and server without fully implementing their own MarkupImageDataProvider. This method can be overridden in a derivation of either of the 2 provided MarkupImageDataProvider implementations (File and Sql) to retain all of the functionality of that MarkupImageDataProvider while giving the Developer the opportunity to intercept, reject, process, and alter the Markup Layer List returned by any request.

If markupLayerList is set to null or this method thows an exception, an empty Markup Layer List will be returned to the client.

MarkupArtDataConnection.List
Syntax
'Declaration
 
Public Overridable Sub OnList( _
   ByRef markupLayerList As List(Of MarkupLayerInfo), _
   ByVal documentIdentifier As String, _
   ByVal connectionContextData As NameValueCollection _
) 
'Usage
 
Dim instance As MarkupArtMiddleware
Dim markupLayerList As List(Of MarkupLayerInfo)
Dim documentIdentifier As String
Dim connectionContextData As NameValueCollection
 
instance.OnList(markupLayerList, documentIdentifier, connectionContextData)

Parameters

markupLayerList
A reference to the List containing the Markup Layer Record IDs and mnemonic display names of Markup Layers associated with the requested Document Identifier. This can be set to null or modified in an override of this method before being returned to the client.
documentIdentifier
The Document Identifier for which to list associated Markup Layers
connectionContextData
Any additional parameters passed when opening an Art Data Connection
See Also

Reference

MarkupArtMiddleware Class
MarkupArtMiddleware Members