EscapeValueAttribute Class

This is used to mark a property that needs its value escaped when stored in an MSBuild project file.

Inheritance Hierarchy

SystemObject
SystemAttribute
SandcastleBuilder.Utils.DesignEscapeValueAttribute

Namespace: SandcastleBuilder.Utils.Design
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public sealed class EscapeValueAttribute : Attribute

Public NotInheritable Class EscapeValueAttribute
	Inherits Attribute

public ref class EscapeValueAttribute sealed : public Attribute

[<SealedAttribute>]
type EscapeValueAttribute =  
    class
        inherit Attribute
    end

The EscapeValueAttribute type exposes the following members.

Constructors

	Name	Description
	EscapeValueAttribute	Initializes a new instance of the EscapeValueAttribute class

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Escape	This is used to HTML encode and escape an MSBuild property value.
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unescape	This is used to return an unescaped and HTML decoded MSBuild value

Top

Properties

	Name	Description
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Remarks

MSBuild requires that the following characters be escaped in property values unless they are intended to be interpreted by the build engine: % * ? @ $ ( ) ; '. In addition, this attribute will cause the values to be HTML encoded so that any HTML characters, especially tag delimiters are not interpreted. MSBuild tends to add XML namespaces to things it thinks are XML elements.

Reference

SandcastleBuilder.Utils.Design Namespace