Snippet Downloads

All Snippets (.zip)

Dave Sexton — Mon, 19 Mar 2007 08:30:34 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

This download is a compressed ZIP file that contains all of my C# Code Snippets. Each snippet is available for download separately as well here.

Alternative Download Method

If you'd prefer a Visual Studio Content Installer package (.vsi) instead it's available for download here.

When you run the .vsi file it will show you all of the components that it contains and allow you to choose where the snippets may be copied so that Visual Studio will find them. You may choose which snippets you'd like as well and each snippet provides a tooltip with its summary.

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets.

All Snippets (Installer)

Dave Sexton — Mon, 19 Mar 2007 08:26:51 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

This download is a Visual Studio Content Installer package (.vsi) that contains all of my C# Code Snippets. Each snippet is available for download separately as well here.

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets.

How to use the installer file

Download the CSharp_Snippets.vsi file to your computer, browse to it using Windows Explorer, and double-click it. The installer will show you all of the components that my .vsi file contains and ask you where you want to copy each snippet after clicking Next.

Note: Because the file isn't signed with a software publisher's certificate it will prompt you to continue; you must click Yes.

Installation with the Visual Studio Content Installer

Start the installation by double-clicking the .vsi file that you downloaded.
Click Next to begin installation.
Click Yes when you are warned that the package isn't signed.
Select all of the snippets in the left-hand pane at once using Shift or Ctrl, or drag the mouse over all of them with the left-mouse button pressed.
Check the item in the right-hand pane labeled My Code Snippets. The tooltip will show you the full path of that directory, usually found at My Documents\Visual Studio 2005\Code Snippets\Visual C#\My Code Snippets. (You can choose the Visual C# directory instead if you'd like; however, the snippets will then be installed in Visual Studio's installation directory instead of the Visual Studio 2005 folder under My Documents. If you need to locate them for some reason in the future, you'll probably have an easier time finding them under My Code Snippets.)
Click Next and then Finish to install the snippets.

If you'd prefer a plain ZIP version instead I've provided that here.

Component Event Member Snippet

Dave Sexton — Mon, 19 Mar 2007 08:12:03 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical event member declaration and corresponding method for invocation for a class that derives from System.ComponentModel.Component. EventHandler is used as the delegate. The code produced by this snippet is thread-safe.

Shortcut: eventc

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion or surrounds with from within the body of a class definition. The class must derive, directly or indirectly, from a class with a System.ComponentModel.EventHandlerList Events { get; } property defined with accessible scope. Otherwise, the property must be defined in the class itself.

It's useful for classes that derive from System.ComponentModel.Component or derived types such as the WinForms Control class. The ASP.NET Control class does not derive from System.ComponentModel.Component, however, it provides an EventHandlerList instance via a protected, read-only Events property. Therefore, this snippet is suitable for classes that derive from any FCL component or control.

Example Output

The following code illustrates this snippet's output using the default token values:

private readonly object TextChangedEvent = new object();

/// <summary>
/// Event raised after the <see cref="Text" />  property value has changed.
/// </summary>
[Category("Property Changed")]
[Description("Event raised after the Text property value has changed.")]
public event EventHandler TextChanged
{
  add
  {
    lock (TextChangedEvent)
    {
      Events.AddHandler(TextChangedEvent, value);
    }
  }
  remove
  {
    lock (TextChangedEvent)
    {
      Events.RemoveHandler(TextChangedEvent, value);
    }
  }
}

/// <summary>
/// Raises the <see cref="TextChanged" /> event.
/// </summary>
/// <param name="e"><see cref="EventArgs" /> object that provides the arguments for the event.</param>
protected virtual void OnTextChanged(EventArgs e)
{
  EventHandler handler = null;

  lock (TextChangedEvent)
  {
    handler = (EventHandler) Events[TextChangedEvent];
  }

  if (handler != null)
    handler(this, e);
}

Custom EventArgs Snippet

Dave Sexton — Mon, 19 Mar 2007 08:11:22 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the definition for a class that inherits from EventArgs.

Shortcut: eventargs

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion only.

Example Output

The following code illustrates this snippet's output:

/// <summary>
/// Provides arguments for an event.
/// </summary>
[Serializable]
public class CustomEventArgs : EventArgs
{
  public new static readonly CustomEventArgs Empty = new CustomEventArgs();

  #region Public Properties
  #endregion

  #region Private / Protected
  #endregion

  #region Constructors
  /// <summary>
  /// Constructs a new instance of the <see cref="CustomEventArgs" /> class.
  /// </summary>
  public CustomEventArgs(|)  < {text cursor goes here}
  {
  }
  #endregion
}

Designer Layout Regions Snippet

Dave Sexton — Mon, 19 Mar 2007 08:10:46 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates several #region blocks for the placement of specific code elements from within the body of a class definition created by a designer.

Shortcut: layoutd

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion or surrounds with from within the body of a class, struct or interface definition. Using this snippet for a struct or interface requires manual deletion of some of the regions that do not apply. The same goes for regions that do not apply to a particular class definition.

Example Output

The following code illustrates this snippet's output when it's executed for expansion from within the body of the Person class:

class Person
{
  #region Public Properties
  #endregion

  #region Private / Protected
  | {text cursor goes here}
  #endregion

  #region Constructors
  /// <summary>
  /// Constructs a new instance of the <see cref="Person" /> class.
  /// </summary>
  public Person()
  {
    InitializeComponent();
  }
  #endregion

  #region Methods
  {surrounds selection here}
  #endregion

  #region Events
  #endregion

  #region Event Handlers
  #endregion

  #region Nested
  #endregion
}

Dispose Method Override Snippet

Dave Sexton — Mon, 19 Mar 2007 08:10:00 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical Dispose method override code for types that ultimately derive from the System.ComponentModel.Component class.

Shortcut: disposec

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion only from within the body of a class definition. The class must derive, directly or indirectly, from a class with a protected virtual void Dispose(bool disposing) method that is not sealed.

This snippet is useful for classes that derive from System.ComponentModel.Component or derived types such as WinForms Controls. This snippet is not suitable for classes that derive from the ASP.NET Control class.

Example Output

The following code illustrates this snippet's output when it's executed for expansion from within the body of the Person class:

class Person : Component
{
  /// <summary>
  /// Releases the unmanaged resources used by an instance of the <see cref="Person" /> class 
  /// and optionally releases the managed resources.
  /// </summary>
  /// <param name="disposing"><strong>true</strong> to release both managed and 
  /// unmanaged resources; <strong>false</strong> to release only unmanaged resources.</param>
  protected override void Dispose(bool disposing)
  {
    try
    {
      if (disposing)
      {
        | {text cursor goes here}
      }
    }
    finally
    {
      base.Dispose(disposing);
    }
  }
}

Event Member Snippet

Dave Sexton — Mon, 19 Mar 2007 08:09:12 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical event member declaration and corresponding method for invocation. EventHandler is used as the delegate. The code produced by this snippet is thread-safe.

Shortcut: event

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion or surrounds with from within the body of a class definition.

Example Output

The following code illustrates this snippet's output using the default token values:

private readonly object TextChangedEventLock = new object();
private EventHandler TextChangedEvent;

/// <summary>
/// Event raised after the <see cref="Text" />  property value has changed.
/// </summary>
public event EventHandler TextChanged
{
  add
  {
    lock (TextChangedEventLock)
    {
      TextChangedEvent += value;
    }
  }
  remove
  {
    lock (TextChangedEventLock)
    {
      TextChangedEvent -= value;
    }
  }
}

/// <summary>
/// Raises the <see cref="TextChanged" /> event.
/// </summary>
/// <param name="e"><see cref="EventArgs" /> object that provides the arguments for the event.</param>
protected virtual void OnTextChanged(EventArgs e)
{
  EventHandler handler = null;

  lock (TextChangedEventLock)
  {
    handler = TextChangedEvent;

    if (handler == null)
      return;
  }

  handler(this, e);
}

Generic Component Event Member Snippet

Dave Sexton — Mon, 19 Mar 2007 08:08:24 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical event member declaration and corresponding method for invocation for a class that derives from System.ComponentModel.Component. EventHandler<TEventArgs> is used as the delegate and TEventArgs has been tokenized. The code produced by this snippet is thread-safe.

Shortcut: eventcg

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

Example Output

The following code illustrates this snippet's output using the default token values:

private readonly object TextChangedEvent = new object();

/// <summary>
/// Event raised after the <see cref="Text" />  property value has changed.
/// </summary>
[Category("Property Changed")]
[Description("Event raised after the Text property value has changed.")]
public event EventHandler<EventArgs> TextChanged
{
  add
  {
    lock (TextChangedEvent)
    {
      Events.AddHandler(TextChangedEvent, value);
    }
  }
  remove
  {
    lock (TextChangedEvent)
    {
      Events.RemoveHandler(TextChangedEvent, value);
    }
  }
}

/// <summary>
/// Raises the <see cref="TextChanged" /> event.
/// </summary>
/// <param name="e"><see cref="EventArgs" /> object that provides the arguments for the event.</param>
protected virtual void OnTextChanged(EventArgs e)
{
  EventHandler<EventArgs> handler = null;

  lock (TextChangedEvent)
  {
    handler = (EventHandler<EventArgs>) Events[TextChangedEvent];
  }

  if (handler != null)
    handler(this, e);
}

Generic Event Member Snippet

Dave Sexton — Mon, 19 Mar 2007 08:06:06 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical event member declaration and corresponding method for invocation. EventHandler<TEventArgs> is used as the delegate and TEventArgs has been tokenized. The code produced by this snippet is thread-safe.

Shortcut: eventg

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion or surrounds with from within the body of a class definition.

Example Output

The following code illustrates this snippet's output using the default token values:

private readonly object TextChangedEventLock = new object();
private EventHandler<EventArgs> TextChangedEvent;

/// <summary>
/// Event raised after the <see cref="Text" />  property value has changed.
/// </summary>
public event EventHandler<EventArgs> TextChanged
{
  add
  {
    lock (TextChangedEventLock)
    {
      TextChangedEvent += value;
    }
  }
  remove
  {
    lock (TextChangedEventLock)
    {
      TextChangedEvent -= value;
    }
  }
}

/// <summary>
/// Raises the <see cref="TextChanged" /> event.
/// </summary>
/// <param name="e"><see cref="EventArgs" /> object that provides the arguments for the event.</param>
protected virtual void OnTextChanged(EventArgs e)
{
  EventHandler<EventArgs> handler = null;

  lock (TextChangedEventLock)
  {
    handler = TextChangedEvent;

    if (handler == null)
      return;
  }

  handler(this, e);
}

IDisposable Implementation Snippet

Dave Sexton — Mon, 19 Mar 2007 08:05:16 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates the canonical IDisposable implementation.

Shortcut: disposable

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

This snippet is intended to be used as expansion only from within the body of a class definition. The class shouldn't derive, directly or indirectly, from a class with a protected virtual void Dispose(bool disposing) method. This snippet should be used on a class that implements IDisposable.

Example Output

The following code illustrates this snippet's output when it's executed for expansion from within the body of the Person class:

class Person : IDisposable
{
  /// <summary>
  /// Releases all resources used by an instance of the <see cref="Person" /> class.
  /// </summary>
  /// <remarks>
  /// This method calls the virtual <see cref="Dispose(bool)" /> method, 
  /// passing in <strong>true</strong>, and then suppresses 
  /// finalization of the instance.
  /// </remarks>
  public void Dispose()
  {
    Dispose(true);
    GC.SuppressFinalize(this);
  }

  /// <summary>
  /// Releases unmanaged resources before an instance of the <see cref="Person" /> 
  /// class is reclaimed by garbage collection.
  /// </summary>
  /// <remarks>
  /// This method releases unmanaged resources by calling the virtual <see cref="Dispose(bool)" /> 
  /// method, passing in <strong>false</strong>.
  /// </remarks>
  ~Person()
  {
    Dispose(false);
  }

  /// <summary>
  /// Releases the unmanaged resources used by an instance of the <see cref="Person" /> 
  /// class and optionally releases the managed resources.
  /// </summary>
  /// <param name="disposing"><strong>true</strong> to release both managed 
  /// and unmanaged resources; <strong>false</strong> to release only unmanaged resources.</param>
  protected virtual void Dispose(bool disposing)
  {
    | {text cursor goes here}
  }
}

Layout Regions Snippet

Dave Sexton — Mon, 19 Mar 2007 08:03:48 GMT

My snippets are provided "as is", with no warranty of any kind, either express or implied. Use at your own risk.

Creates several #region blocks for the placement of specific code elements from within the body of a class definition.

Shortcut: layout

For more information on my C# Code Snippets see my blog entry: Custom C# Code Snippets. All of my snippets may be downloaded at once here.

Usage

Example Output

The following code illustrates this snippet's output when it's executed for expansion from within the body of the Person class:

public class Person
{
  #region Public Properties
  #endregion

  #region Private / Protected
  #endregion

  #region Constructors
  /// <summary>
  /// Constructs a new instance of the <see cref="Person" /> class.
  /// </summary>
  public Person(|)   < {text cursor goes here}
  {
  }
  #endregion

  #region Methods
  {surrounds selection here}
  #endregion

  #region Events
  #endregion

  #region Event Handlers
  #endregion

  #region Nested
  #endregion
}