src/Text/Def/TextUI/Editor/TextViewRoleAttribute.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//
//  Copyright (c) Microsoft Corporation. All rights reserved.
//  Licensed under the MIT License. See License.txt in the project root for license information.
//
namespace Microsoft.VisualStudio.Text.Editor
{
    using System;
    using Microsoft.VisualStudio.Utilities;

    /// <summary>
    /// Use this attribute to specify the kinds of TextViews to which an extension applies.
    /// </summary>
    public sealed class TextViewRoleAttribute : MultipleBaseMetadataAttribute
    {
        string roles;

        /// <summary>
        /// Construct a new instance of the attribute.
        /// </summary>
        /// <param name="role">The case-insensitive name of the role.</param>
        /// <exception cref="ArgumentNullException"><paramref name="role"/> is null or empty.</exception>
        public TextViewRoleAttribute(string role)
        {
            if (string.IsNullOrEmpty(role))
            {
                throw new ArgumentNullException(nameof(role));
            }
            this.roles = role;
        }

        /// <summary>
        /// The role name.
        /// </summary>
        public string TextViewRoles
        {
            get { return this.roles; }
        }
    }
}