Click or drag to resize

EAPAuditMessageEventArgs Class

Event arguments for use with the AuditMessage event.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class EAPAuditMessageEventArgs : EAPEventArgs

The EAPAuditMessageEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodEAPAuditMessageEventArgs(String)
Constructs the EAPAuditMessageEventArgs object with the most data, just the message.
Public methodEAPAuditMessageEventArgs(String, Char)
Constructs the EAPAuditMessageEventArgs object with just message and custom audit type.
Top
Properties
  NameDescription
Public propertyAuditType
Gets/sets the audit type indicator.
Public propertyBulkAudit
When set, this specifies that this is auditing a bulk operation rather than an event affecting a single record.
Public propertyBulkContext
Gets/sets the context of the current bulk operation, if any. If this event is part of a bulk operation, this is the context of that bulk operation. If this event is not part of a bulk operation, this context will be null.
(Inherited from EAPEventArgs.)
Public propertyErrorDeveloperMessage
An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but only displayed in user error messages when the user is identified as IsDeveloper.
(Inherited from EAPEventArgs.)
Public propertyCode exampleErrorMessage
Sets the extention's error message for this event.
(Inherited from EAPEventArgs.)
Public propertyErrorOptions
Options used to specify additional characteristics about an exception.
(Inherited from EAPEventArgs.)
Public propertyEvent
Gets/Sets the event that is currently executing.
(Inherited from EAPEventArgs.)
Public propertyFieldCaptions
Gets/sets the localized-separator separated set of localized mapper field captions for fields that are logged in this audit entry, using the user's natural language, numeric, date/time, etc. locales. Typically this item is omitted on audit message entries.
Public propertyFieldKeys
Gets/sets the semi-colon separated set of mapper field keys for fields that are logged in this audit entry. Typically this item is omitted on audit message entries.
Public propertyMessageHtml
Gets/sets the audit message HTML.
Public propertyPKOverrideFieldName
When set, this specifies the Field to use as the rel_id value when creating the Audit record.
Public propertyResult
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.)
Top
Methods
  NameDescription
Public methodCode exampleCancel
Sets the extention's result code and error message for this event. The result code is set to ExtResultsExtResults.Cancel.
(Inherited from EAPEventArgs.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodCode exampleError(String)
Sets the extention's result code and error message for this event. The result code is set to Error. Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.
(Inherited from EAPEventArgs.)
Public methodCode exampleError(String, String, ExceptionOptions)
Sets the extention's result code and error message for this event with an optional developer-specific error message and options. The result code is set to Error.
(Inherited from EAPEventArgs.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also