EventLogHelper Class

Class for event helper methods

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<EventLogHelper>
        CMS.EventLog.EventLogHelper

Namespace: CMS.EventLog
Assembly: CMS.EventLog (in CMS.EventLog.dll) Version: 13.0.131

Syntax

public class EventLogHelper : AbstractHelper<EventLogHelper>

The EventLogHelper type exposes the following members.

Constructors

	Name	Description
Public method	EventLogHelper

Properties

	Name	Description
Public property Static member	LogEventsToFile	Indicates if events are logged to the file.
Protected property	LogEventsToFileInternal	Indicates if events are logged to the file.
Public property Static member	LogFile	Physical path to the log file.
Protected property	LogFileInternal	Physical path to the log file.
Public property Static member	LogFolder	Physical path to folder where log file is saved.
Protected property	LogFolderInternal	Physical path to folder where log file is saved.

Methods

	Name	Description
Public method Static member	ClearEventLog	Clears entire event log and writes new event record with information about this action and the user who performed it.
Protected method	ClearEventLogInternal	Clears entire event log and writes new event record with information about this action and the user who performed it.
Public method Static member	GetChangedFields	Gets the list of changed fields in the given object.
Protected method	GetChangedFieldsInternal	Gets the list of changed fields in the given object.
Public method Static member	GetEventText	Gets log event text from DataRow
Protected method	GetEventTextInternal(EventLogData)	Gets log event text from event data object
Protected method	GetEventTextInternal(EventLogInfo)	Gets log event text from DataRow
Public method Static member	GetEventTypeText	Returns user-friendly string for the given event type.
Protected method	GetEventTypeTextInternal	Returns user-friendly string for the given event type.
Public method Static member	GetFields	Gets the list of fields in the given object.
Protected method	GetFieldsInternal	Gets the list of fields in the given object.
Public method Static member	LogDelete	Logs deletion of an object.
Protected method	LogDeleteInternal	Logs deletion of an object.
Public method Static member	LogEventToFile(EventLogInfo)	Logs the log object to file.
Public method Static member	LogEventToFile(String, String, String, String, String, Int32, String, Int32, String, String, Int32, String, String, String, DateTime)	Logs the query to file.
Protected method	LogEventToFileInternal(EventLogInfo)	Logs the log object to file.
Protected method	LogEventToFileInternal(String, String, String, String, String, Int32, String, Int32, String, String, Int32, String, String, String, DateTime)	Logs the query to file.
Public method Static member	LogInsert	Logs insertion of an object.
Protected method	LogInsertInternal	Logs insertion of an object.
Public method Static member	LogUpdate	Logs update of an object.
Protected method	LogUpdateInternal	Logs update of an object.
Public method Static member	SendEmailNotification(EventLogData, String)	Sends email notification regarding received eventLogData.
Public method Static member	SendEmailNotification(EventLogInfo, String)	Logs the query to file.
Protected method	SendEmailNotificationInternal(EventLogData, String)	Sends email notification regarding received eventLogData.
Protected method	SendEmailNotificationInternal(EventLogInfo, String)	Logs the query to file.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)