Represents a user-defined custom event. A custom event is raised whenever an object to which it is subscribed calls its RaiseEvent method.

To create a CustomEvent object, and persist it to a Content Engine object store, call the CreateInstance method on the Factory.CustomEvent class.

You can instantiate a CustomEvent object in the following ways:

  • By calling the GetInstance or FetchInstance method on the Factory.CustomEvent class.
  • By retrieving the AuditedEvents property on the source object of the custom event, and iterating the EventSet collection for instances of CustomEvent objects.
  • By retrieving a CustomEvent object from a CustomEventSet collection.

The following tables list the members exposed by ICustomEvent.

Public Properties

 NameDescription
Public propertyActiveMarkingsThe 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.
Public propertyModifiedPropertiesA 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 FetchInstance method. This property is not available from the event object passed to the event action handler.
Public propertyOriginalObjectThe event's source object prior to the event. To get the source object at the time the event occurred, retrieve the SourceObject property. To compare the two states of the source object, fetch the properties of the object returned by the OriginalObject property and the SourceObject property.
Public propertyVersionSeriesIdFor 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 IDocument or its subclass.
Top

See Also