Click here to Skip to main content
15,885,366 members
Articles / Desktop Programming / Win32

.NET Shell Extensions - Shell Preview Handlers

Rate me:
Please Sign up or sign in to vote.
4.93/5 (23 votes)
20 May 2014MIT8 min read 140.4K   6.1K   71  
Quickly create Shell Preview Handlers for Windows or Outlook using .NET!
using System;
using System.Diagnostics;

namespace SharpShell.Diagnostics
{
    /// <summary>
    /// The logging class is used for SharpShell logging.
    /// </summary>
    public static class Logging
    {
        /// <summary>
        /// Initializes the <see cref="Logging"/> class.
        /// </summary>
        static Logging()
        {
            Log(string.Format("SharpShell Diagnostics Initialised. Process {0}.", Process.GetCurrentProcess().ProcessName));

#if DEBUG
            //  If we're in debug mode, we can also register a handler for unhandled exceptions in the domain.
            AppDomain.CurrentDomain.UnhandledException += CurrentDomain_UnhandledException;
#endif
        }

        /// <summary>
        /// Handles the UnhandledException event of the CurrentDomain.
        /// </summary>
        /// <param name="sender">The source of the event.</param>
        /// <param name="e">The <see cref="System.UnhandledExceptionEventArgs"/> instance containing the event data.</param>
        static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
        {
            //  Log the unhandled exception.
            Error("SharpShell - Unhandled Exception in the AppDomain", e.ExceptionObject as Exception);
        }

        /// <summary>
        /// Logs the specified message.
        /// </summary>
        /// <param name="message">The message.</param>
        [Conditional("DEBUG")]
        public static void Log(string message)
        {
            //  Log to the event log.
            EventLog.WriteEntry(EventLog_Source, message);
        }

        /// <summary>
        /// Logs the specified message as an error.
        /// </summary>
        /// <param name="message">The message.</param>
        /// <param name="exception">The exception.</param>
        [Conditional("DEBUG")]
        public static void Error(string message, Exception exception = null)
        {
            //  Write the message.
            EventLog.WriteEntry(EventLog_Source, message, EventLogEntryType.Error);
            
            //  Write the exception, if it exists.
            if(exception != null)
                EventLog.WriteEntry(EventLog_Source, exception.ToString(), EventLogEntryType.Error);
        }

        /// <summary>
        /// Determines whether logging is enabled.
        /// </summary>
        /// <returns>
        ///   <c>true</c> if logging is enabled; otherwise, <c>false</c>.
        /// </returns>
        public static bool IsLoggingEnabled()
        {
            //  Check whether the source exists.
            return EventLog.SourceExists(EventLog_Source);
        }

        /// <summary>
        /// Enables or disables logging.
        /// </summary>
        /// <param name="enable">if set to <c>true</c> enable logging, otherwise, disable logging.</param>
        /// <returns></returns>
        public static void EnableLogging(bool enable)
        {
            if(IsLoggingEnabled() && !enable)
                EventLog.DeleteEventSource(EventLog_Source);
            else if(!IsLoggingEnabled() && enable)
                EventLog.CreateEventSource(EventLog_Source, EventLog_Log);
        }

        /// <summary>
        /// The event log log.
        /// </summary>
        private const string EventLog_Log = @"Application";

        /// <summary>
        /// The EventLog Source for SharpShell.
        /// </summary>
        public const string EventLog_Source = @"SharpShell";
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The MIT License


Written By
Software Developer
United Kingdom United Kingdom
Follow my blog at www.dwmkerr.com and find out about my charity at www.childrenshomesnepal.org.

Comments and Discussions