OnCreate Method

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 content or Markup Layer Record ID for any request for the creation of a new Markup Layer.

If markupLayer or markupLayerRecordId are set to null or if this method throws an exception, the Markup Layer will not be created.

Syntax

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

'Declaration
 
Public Overridable Sub OnCreate( _
   ByRef markupLayer As ImGearARTDocumentXML, _
   ByVal documentId As String, _
   ByRef markupLayerRecordId As String, _
   ByVal documentContextData As NameValueCollection _
)

'Usage
 
Dim instance As MarkupArtMiddleware
Dim markupLayer As ImGearARTDocumentXML
Dim documentId As String
Dim markupLayerRecordId As String
Dim documentContextData As NameValueCollection
 
instance.OnCreate(markupLayer, documentId, markupLayerRecordId, documentContextData)

public virtual void OnCreate( 
   ref ImGearARTDocumentXML markupLayer,
   string documentId,
   ref string markupLayerRecordId,
   NameValueCollection documentContextData
)

public: virtual void OnCreate( 
   ref ImGearARTDocumentXML* markupLayer,
   string* documentId,
   ref string* markupLayerRecordId,
   NameValueCollection* documentContextData
)

public:
virtual void OnCreate( 
   ImGearARTDocumentXML^% markupLayer,
   String^ documentId,
   String^% markupLayerRecordId,
   NameValueCollection^ documentContextData
)

Parameters

markupLayer: A reference to the Markup Layer to be created. This object may be modified or the reference may be set to null. If the reference is set to null, the Markup Layer will not be created.
documentId: The Document Identifier for the document with which this Markup Layer is associated
markupLayerRecordId: A reference to the Markup Layer Record ID for the newly created Markup Layer. The ID for a new Markup Layer is generated on the server and assigned to the client. This identifier may be altered or set to null. If the reference is set to null, the Markup Layer will not be created.
documentContextData: The context data with which the MarkupArtDocumentDataConnection was created

Reference

MarkupArtMiddleware Class
MarkupArtMiddleware Members