File: TagHelpers\TagHelperContext.cs
Web Access
Project: src\src\Razor\Razor\src\Microsoft.AspNetCore.Razor.csproj (Microsoft.AspNetCore.Razor)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
namespace Microsoft.AspNetCore.Razor.TagHelpers;
 
/// <summary>
/// Contains information related to the execution of <see cref="ITagHelper"/>s.
/// </summary>
public class TagHelperContext
{
    private readonly TagHelperAttributeList _allAttributes;
 
    /// <summary>
    /// Instantiates a new <see cref="TagHelperContext"/>.
    /// </summary>
    /// <param name="tagName">The parsed HTML tag name of the element.</param>
    /// <param name="allAttributes">Every attribute associated with the current HTML element.</param>
    /// <param name="items">Collection of items used to communicate with other <see cref="ITagHelper"/>s.</param>
    /// <param name="uniqueId">The unique identifier for the source element this <see cref="TagHelperContext" />
    /// applies to.</param>
    public TagHelperContext(
        string tagName,
        TagHelperAttributeList allAttributes,
        IDictionary<object, object> items,
        string uniqueId) : this(allAttributes, items, uniqueId)
    {
        ArgumentNullException.ThrowIfNull(tagName);
 
        TagName = tagName;
    }
 
    /// <summary>
    /// Instantiates a new <see cref="TagHelperContext"/>.
    /// </summary>
    /// <param name="allAttributes">Every attribute associated with the current HTML element.</param>
    /// <param name="items">Collection of items used to communicate with other <see cref="ITagHelper"/>s.</param>
    /// <param name="uniqueId">The unique identifier for the source element this <see cref="TagHelperContext" />
    /// applies to.</param>
    public TagHelperContext(
        TagHelperAttributeList allAttributes,
        IDictionary<object, object> items,
        string uniqueId)
    {
        ArgumentNullException.ThrowIfNull(items);
        ArgumentNullException.ThrowIfNull(uniqueId);
        ArgumentNullException.ThrowIfNull(allAttributes);
 
        _allAttributes = allAttributes;
        Items = items;
        UniqueId = uniqueId;
    }
 
    /// <summary>
    /// The parsed HTML tag name of the element.
    /// </summary>
    public string TagName { get; private set; }
 
    /// <summary>
    /// Every attribute associated with the current HTML element.
    /// </summary>
    public ReadOnlyTagHelperAttributeList AllAttributes => _allAttributes;
 
    /// <summary>
    /// Gets the collection of items used to communicate with other <see cref="ITagHelper"/>s.
    /// </summary>
    /// <remarks>
    /// This <see cref="IDictionary{Object, Object}" /> is copy-on-write in order to ensure items added to this
    /// collection are visible only to other <see cref="ITagHelper"/>s targeting child elements.
    /// </remarks>
    public IDictionary<object, object> Items { get; private set; }
 
    /// <summary>
    /// An identifier unique to the HTML element this context is for.
    /// </summary>
    public string UniqueId { get; private set; }
 
    /// <summary>
    /// Clears the <see cref="TagHelperContext"/> and updates its state with the provided values.
    /// </summary>
    /// <param name="tagName">The HTML tag name to use.</param>
    /// <param name="items">The <see cref="IDictionary{Object, Object}"/> to use.</param>
    /// <param name="uniqueId">The unique id to use.</param>
    public void Reinitialize(string tagName, IDictionary<object, object> items, string uniqueId)
    {
        TagName = tagName;
        Reinitialize(items, uniqueId);
    }
 
    /// <summary>
    /// Clears the <see cref="TagHelperContext"/> and updates its state with the provided values.
    /// </summary>
    /// <param name="items">The <see cref="IDictionary{Object, Object}"/> to use.</param>
    /// <param name="uniqueId">The unique id to use.</param>
    public void Reinitialize(IDictionary<object, object> items, string uniqueId)
    {
        _allAttributes.Clear();
        Items = items;
        UniqueId = uniqueId;
    }
}