Class TagCollection

Namespace

Dynamicweb.Rendering

Assembly

Dynamicweb.Core.dll

Represents a collection of Tag.

[Serializable]
public class TagCollection : KeyedCollection<string, Tag>, IList<Tag>, ICollection<Tag>, IReadOnlyList<Tag>, IReadOnlyCollection<Tag>, IEnumerable<Tag>, IList, ICollection, IEnumerable

Inheritance

object

Collection<Tag>

KeyedCollection<string, Tag>

TagCollection

Implements

IList<Tag>

ICollection<Tag>

IReadOnlyList<Tag>

IReadOnlyCollection<Tag>

IEnumerable<Tag>

IList

ICollection

IEnumerable

Inherited Members

KeyedCollection<string, Tag>.ChangeItemKey(Tag, string)

KeyedCollection<string, Tag>.ClearItems()

KeyedCollection<string, Tag>.Contains(string)

KeyedCollection<string, Tag>.GetKeyForItem(Tag)

KeyedCollection<string, Tag>.InsertItem(int, Tag)

KeyedCollection<string, Tag>.Remove(string)

KeyedCollection<string, Tag>.RemoveItem(int)

KeyedCollection<string, Tag>.SetItem(int, Tag)

KeyedCollection<string, Tag>.TryGetValue(string, out Tag)

KeyedCollection<string, Tag>.Comparer

KeyedCollection<string, Tag>.Dictionary

KeyedCollection<string, Tag>.this[string]

Collection<Tag>.Clear()

Collection<Tag>.ClearItems()

Collection<Tag>.Contains(Tag)

Collection<Tag>.CopyTo(Tag[], int)

Collection<Tag>.GetEnumerator()

Collection<Tag>.IndexOf(Tag)

Collection<Tag>.Insert(int, Tag)

Collection<Tag>.InsertItem(int, Tag)

Collection<Tag>.Remove(Tag)

Collection<Tag>.RemoveAt(int)

Collection<Tag>.RemoveItem(int)

Collection<Tag>.SetItem(int, Tag)

Collection<Tag>.Count

Collection<Tag>.this[int]

Collection<Tag>.Items

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PageableExtensions.TakeByPageable<T>(IEnumerable<T>, IPageable, int?, int?)

SortableExtensions.SortBy<TModel>(IEnumerable<TModel>, ISortable)

EnumerationExtensions.Split<T>(IEnumerable<T>, int)

ListExtensions.Split<T>(IList<T>, int)

Examples

using System;
using System.Globalization;
using Dynamicweb.Rendering;

namespace Dynamicweb.Examples.Rendering;

public static class TagSample
{
    public static void AddTags(Template template)
    {
        ArgumentNullException.ThrowIfNull(template, nameof(template));

        //Create a tag instance and add it to a template instance
        var myTag = new Tag("greeting", "Hello");
        template.Tags.Add(myTag);

        //Create a second tag instance using its Name and Value properties and add it to a template instance
        var myTag2 = new Tag { Name = "greeting2" };
        myTag2.Value = " World!";
        template.Tags.Add(myTag2);

        //Create a collection of tags and add it to a template instance
        var myTags = new TagCollection();
        for (int i = 1; i <= 5; i++)
            myTags.Add(new Tag($"Counter{i}", i.ToString(CultureInfo.InvariantCulture)));
        template.Tags.Add(myTags);

        //Examine all the tags in the template instance.
        foreach (Tag tag in template.Tags)
        {
            if (tag.Name.Equals("greeting", StringComparison.OrdinalIgnoreCase))
            {
                //Found the tag in the collection named "greeting"
            }
        }

        //Or look it up
        if (template.Tags.ContainsTagName("greeting"))
        {
            //Found the tag in the collection named "greeting"
        }

        //And clear all tags from the template instances tags collection
        template.Tags.Clear();
    }
}

Constructors

TagCollection()

Initializes a new instance of the TagCollection class.

public TagCollection()

Examples

See usage example in TagCollection

Methods

Add(Tag)

Adds the specified tag.

public void Add(Tag tag)

Parameters

tag Tag

The tag of the tag.

Examples

See usage example in TagCollection

Remarks

If a tag with the same name already exists, the tag is not inserted.

Add(TagCollection)

Adds the specified collection of tags to this instance of the collection.

public void Add(TagCollection tags)

Parameters

tags TagCollection

The collection of tags to add to this instance.

Examples

See usage example in TagCollection

Remarks

If a tag with the same name already exists, the tag is not inserted.

ContainsTagName(string)

Determines whether the collection contains a tag with the specified name.

public bool ContainsTagName(string name)

Parameters

name string

The name of the tag.

Returns

bool

true if the specified name is found; otherwise, false.

Examples

See usage example in TagCollection

GetKeyForItem(Tag)

Gets the key for item. The key is the tag name.

protected override string GetKeyForItem(Tag item)

Parameters

item Tag

The item - a Tag instance.

Returns

string

The name of the passed Tag

GetTagByName(string)

Gets the tag object by tag name.

public Tag? GetTagByName(string name)

Parameters

name string

The name of the tag.

Returns

Tag

A Tag instance if the collection contains a tag with the specified name, otherwise null (Nothing in Visual Basic)

Examples

See usage example in TagCollection