Click or drag to resize
ResolveMacrosEventArgs Class
Event arguments for the ResolveMacrosHandler.
Inheritance Hierarchy

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 9.0.0
Syntax
C#
public class ResolveMacrosEventArgs : CMSEventArgs

The ResolveMacrosEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodResolveMacrosEventArgs
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyIssueInfo
Text which is being resolved belongs to this issue. Can be null if there is no corresponding issue available.
Public propertyMacroResolver
Macro resolver which will be used to resolve macros.
Public propertyNewsletter
Text which is being resolved belongs to the issue in this newsletter. Can be null if there is no corresponding newsletter available.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyTextToResolve
Text before resolving on the Before event or already resolved text on the After event.
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.)
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.)
Public methodCancel
Cancels the current handler execution
(Inherited from CMSEventArgs.)
Public methodDetectRecursion
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 methodDispose
Make sure the objects get disposed
(Inherited from CMSEventArgs.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Top
Extension Methods
  NameDescription
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
See Also