Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version
Go to top

RTF Document Constructor Library

, 16 Aug 2010
Create Rich Text Format documents programatically.
using System;
using System.Text;
using System.Collections;
using System.Collections.Generic;

namespace ESCommon.Rtf
{
    /// <summary>
    /// Represents a collection of ESCommon.Rtf.RtfColor in the header of a RTF document.
    /// </summary>
    public class RtfColorCollection: ICollection<RtfColor>, IEnumerable<RtfColor>
    {
        private List<RtfColor> list;

        /// <summary>
        /// Gets or sets ESCommon.Rtf.RtfColor at specified location.
        /// </summary>
        /// <param name="index">A zero-based index of ESCommon.Rtf.RtfColor to get or set.</param>
        public RtfColor this[int index]
        {
            get { return list[index]; }
            set { list[index] = value; }
        }

        /// <summary>
        /// Gets the number of items in the collection.
        /// </summary>
        public int Count
        {
            get { return list.Count; }
        }

        /// <summary>
        /// Initializes a new instance of ESCommon.Rtf.RtfColorCollection class.
        /// </summary>
        internal RtfColorCollection()
        {
            list = new List<RtfColor>();

            list.Add(RtfColor.Auto);
        }


        /// <summary>
        /// Adds the specified ESCommon.Rtf.RtfColor to the collection.
        /// </summary>
        public void Add(RtfColor rtfColor)
        {
            list.Add(rtfColor);
        }

        /// <summary>
        /// Adds the specified ESCommon.Rtf.RtfColor objects to the collection.
        /// </summary>
        public void AddRange(RtfColor[] rtfColors)
        {
            foreach (RtfColor color in rtfColors)
            {
                Add(color);
            }
        }
        
        /// <summary>
        /// Clears all the contents of the collection.
        /// </summary>
        public void Clear()
        {
            list.Clear();

            list.Add(RtfColor.Auto);
        }
        
        /// <summary>
        /// Determines if an element is in the collection.
        /// </summary>
        /// <param name="rtfColor">An instance of ESCommon.Rtf.RtfColor to locate in the collection.</param>
        public bool Contains(RtfColor rtfColor)
        {
            return list.Contains(rtfColor);
        }

        /// <summary>
        /// Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
        /// </summary>
        /// <param name="array">The one-dimensional System.Array that is the destination of the elements.</param>
        /// <param name="arrayIndex">The zero-based index in array at which copying begins.</param>
        public void CopyTo(RtfColor[] array, int arrayIndex)
        {
            list.CopyTo(array, arrayIndex);
        }

        /// <summary>
        /// Removes specified color from the collection.
        /// </summary>
        /// <param name="rtfColor">Color to remove.</param>
        public bool Remove(RtfColor rtfColor)
        {
            bool result = list.Remove(rtfColor);

            if (list.Count == 0)
            {
                list.Add(RtfColor.Auto);
            }

            return result;
        }


        bool ICollection<RtfColor>.IsReadOnly
        {
            get { return false; }
        }

        IEnumerator<RtfColor> IEnumerable<RtfColor>.GetEnumerator()
        {
            return list.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return list.GetEnumerator();
        }
    }
}

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 Code Project Open License (CPOL)

Share

About the Author

Dima Popov
Software Developer Energoservice
Russian Federation Russian Federation
Dmitry lives in Arkhangelsk, Russia. He has developed C# applications since 2007.

| Advertise | Privacy | Mobile
Web02 | 2.8.140916.1 | Last Updated 16 Aug 2010
Article Copyright 2010 by Dima Popov
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid