GeneratePreviewEventArgs Class

Event arguments for GeneratePreviewHandler handler type.

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.Newsletters.GeneratePreviewEventArgs

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 11.0.0

Syntax

public class GeneratePreviewEventArgs : CMSEventArgs

The GeneratePreviewEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	GeneratePreviewEventArgs

Properties

	Name	Description
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	Issue	Issue for which the e-mail preview is being generated.
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	PreviewHtml	Final HTML, that will get shown in preview. Will not modify content if left empty.
Public property	Subscriber	Subscriber for which the e-mail preview is being generated. Can be null if the issue is being generated for generic subscriber.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false. (Inherited from CMSEventArgs.)
Public method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)

Extension Methods

	Name	Description
Public Extension Method	UseTransaction	Ensures that the event uses transaction (Defined by DataExtensions.)