EscapeValueAttribute Class

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

Definition

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

C#View Source Request Example

public sealed class EscapeValueAttribute : Attribute

VBView Source Request Example

Public NotInheritable Class EscapeValueAttribute
	Inherits Attribute

C++View Source Request Example

public ref class EscapeValueAttribute sealed : public Attribute

F#View Source Request Example

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

Inheritance: Object Attribute EscapeValueAttribute

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.

Constructors

EscapeValueAttribute

Initializes a new instance of the EscapeValueAttribute class

Properties

TypeId

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

Methods

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