// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using System.ComponentModel;

namespace Core.Common.Utils.Attributes
{
    /// <summary>
    /// Variation on <see cref="DisplayNameAttribute"/>, enables the display name to be fetched from resources.
    /// </summary>
    /// <remarks>Do not combine this with <see cref="DisplayNameAttribute"/> on the same item</remarks>
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event | AttributeTargets.Enum | AttributeTargets.Field)]
    public sealed class ResourcesDisplayNameAttribute : DisplayNameAttribute
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ResourcesDisplayNameAttribute"/> class.
        /// </summary>
        /// <param name="resourceType">Type of the resource file.</param>
        /// <param name="resourceName">Name of the string resource property to be used as display name.</param>
        /// <exception cref="InvalidOperationException">Thrown when the resource cannot be found 
        /// or does not have the given resource name.</exception>
        public ResourcesDisplayNameAttribute(Type resourceType, string resourceName) :
            base(ResourceHelper.GetResourceLookup(resourceType, resourceName)) {}
    }
}