gitextensions-ICSharpCode.TextEditor/Project/Src/Document/DocumentEventArgs.cs

// <file>
//     <copyright see="prj:///doc/copyright.txt"/>
//     <license see="prj:///doc/license.txt"/>
//     <owner name="Mike Krüger" email="mike@icsharpcode.net"/>
//     <version>$Revision$</version>
// </file>

using System;

namespace ICSharpCode.TextEditor.Document
{
    /// <summary>
    ///     This delegate is used for document events.
    /// </summary>
    public delegate void DocumentEventHandler(object sender, DocumentEventArgs e);

    /// <summary>
    ///     This class contains more information on a document event
    /// </summary>
    public class DocumentEventArgs : EventArgs
    {
        /// <summary>
        ///     Creates a new instance off <see cref="DocumentEventArgs" />
        /// </summary>
        public DocumentEventArgs(IDocument document) : this(document, offset: -1, length: -1, text: null)
        {
        }

        /// <summary>
        ///     Creates a new instance off <see cref="DocumentEventArgs" />
        /// </summary>
        public DocumentEventArgs(IDocument document, int offset) : this(document, offset, length: -1, text: null)
        {
        }

        /// <summary>
        ///     Creates a new instance off <see cref="DocumentEventArgs" />
        /// </summary>
        public DocumentEventArgs(IDocument document, int offset, int length) : this(document, offset, length, text: null)
        {
        }

        /// <summary>
        ///     Creates a new instance off <see cref="DocumentEventArgs" />
        /// </summary>
        public DocumentEventArgs(IDocument document, int offset, int length, string text)
        {
            Document = document;
            Offset = offset;
            Length = length;
            Text = text;
        }

        /// <returns>
        ///     always a valid Document which is related to the Event.
        /// </returns>
        public IDocument Document { get; }

        /// <returns>
        ///     -1 if no offset was specified for this event
        /// </returns>
        public int Offset { get; }

        /// <returns>
        ///     null if no text was specified for this event
        /// </returns>
        public string Text { get; }

        /// <returns>
        ///     -1 if no length was specified for this event
        /// </returns>
        public int Length { get; }

        public override string ToString()
        {
            return string.Format(
                "[DocumentEventArgs: Document = {0}, Offset = {1}, Text = {2}, Length = {3}]",
                Document,
                Offset,
                Text,
                Length);
        }
    }
}