Represents a user-defined custom event. A custom event is raised whenever an object to which it is subscribed calls its
Top
RaiseEvent
method. To create a
object, and persist it to a Content Engine object store, call the
method on the
You can instantiate a
object in the following ways:
- By calling the
orGetInstance
method on the Factory.CustomEvent class.FetchInstance - By retrieving the
property on the source object of the custom event, and iterating theAuditedEvents EventSet collection for instances of
objects.CustomEvent - By retrieving a
object from aCustomEvent CustomEventSet collection.
The following tables list the members exposed by ICustomEvent.
Public Properties
Name | Description | |
---|---|---|
![]() | ActiveMarkings | The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object. |
![]() | ModifiedProperties | A list of the symbolic names of the properties modified during a given event. Note that this property is only available when you retrieve the event object, for example, by calling the Factory method. This property is not available from the event object passed to the event action handler. |
![]() | OriginalObject | The event's source object prior to the event. To get the source object at the time the event occurred, retrieve the property. To compare the two states of the source object, fetch the properties of the object returned by the property and the property. |
![]() | VersionSeriesId | For a IPublishCompleteEvent object, the ID of the version series of the publication document. For other versioning-related events, the ID of the version series for the source object. Note that this property will have a valid value only when the event's source object is an instance of or its subclass. |