Class Tag

Namespace

Dynamicweb.Rendering

Assembly

Dynamicweb.Core.dll

Represents a template tag definition and its value.

[Serializable]
public class Tag

Inheritance

object

Tag

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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();
    }
}

Remarks

A Tag is represented asd <!--@TagName--&gt; in HTML templates. In XSLT templates the tag is a node in the form <TagName>Value</TagName>

Creating new tags to a template object should use SetTag(string, string?)

Constructors

Tag()

Initializes a new instance of the Tag class.

public Tag()

Examples

See usage example in Tag

Tag(string, string?)

Initializes a new instance of the Tag class and sets the value of a tag with the specified name.

public Tag(string tagName, string? tagValue)

Parameters

tagName string

Name of the tag.

tagValue string

The tag value.

Examples

See usage example in Tag

Tag(string, string?, string?, string?)

Initializes a new instance of the Tag class and sets the value of a tag with the specified name and also renderes an attribute on the xml (if template is using a xslt template).

public Tag(string tagName, string? tagValue, string? xmlAttributeName, string? xmlAttributeValue)

Parameters

tagName string

Name of the tag.

tagValue string

The tag value.

xmlAttributeName string

Name of the XML attribute.

xmlAttributeValue string

The XML attribute value.

Examples

See usage example in Tag

Properties

Name

Gets or sets the name.

public required string Name { get; set; }

Property Value

string

The name.

Examples

See usage example in Tag

Value

Gets or sets the value.

public string Value { get; set; }

Property Value

string

The value.

Examples

See usage example in Tag

XmlAttributeName

Gets or sets the name of the XML attribute. A tag is rendered as <DWPageID>54</DWPageID> in the XML. Using XmlAttributeName and XmlAttributeValue adds an attribute and the specified value to the tagname node.

public string? XmlAttributeName { get; set; }

Property Value

string

The name of the XML attribute.

XmlAttributeValue

Gets or sets the XML attribute value. A tag is rendered as <DWPageID>54</DWPageID> in the XML. Using XmlAttributeName and XmlAttributeValue adds an attribute and the specified value to the tagname node.

public string? XmlAttributeValue { get; set; }

Property Value

string

The XML attribute value.