source: branches/2901_StaticSelectionMethods/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Highlighting/HighlightedSection.cs

// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System;
#if NREFACTORY
using ICSharpCode.NRefactory.Editor;
#else
using ICSharpCode.AvalonEdit.Document;
#endif

namespace ICSharpCode.AvalonEdit.Highlighting
{
  /// <summary>
  /// A text section with syntax highlighting information.
  /// </summary>
  public class HighlightedSection : ISegment
  {
    /// <summary>
    /// Gets/sets the document offset of the section.
    /// </summary>
    public int Offset { get; set; }
    
    /// <summary>
    /// Gets/sets the length of the section.
    /// </summary>
    public int Length { get; set; }
    
    int ISegment.EndOffset {
      get { return this.Offset + this.Length; }
    }
    
    /// <summary>
    /// Gets the highlighting color associated with the highlighted section.
    /// </summary>
    public HighlightingColor Color { get; set; }
    
    /// <inheritdoc/>
    public override string ToString()
    {
      return string.Format("[HighlightedSection ({0}-{1})={2}]", Offset, Offset + Length, Color);
    }
  }
}