SignedInfo.CanonicalizationMethod Property

Definition

Namespace:

System.Security.Cryptography.Xml

Assembly:

System.Security.Cryptography.Xml.dll

Gets or sets the canonicalization algorithm that is used before signing for the current SignedInfo object.

public:
 property System::String ^ CanonicalizationMethod { System::String ^ get(); void set(System::String ^ value); };

public string CanonicalizationMethod { get; set; }

member this.CanonicalizationMethod : string with get, set

Public Property CanonicalizationMethod As String

Property Value

String

The canonicalization algorithm used before signing for the current SignedInfo object.

Remarks

The CanonicalizationMethod property uses a string Uniform Resource Identifier (URI) to represent the <Canonicalization> element of an XML digital signature.

Use the CanonicalizationMethod property to specify the canonicalization algorithm applied to the XML output of the SignedInfo class before performing signature calculations.

Use one of the URIs listed in the following table with this property.

Canonicalization Method	Value
Canonical XML	https://www.w3.org/TR/2001/REC-xml-c14n-20010315 This is default method. Also defined in the following static field: XmlDsigCanonicalizationUrl
Canonical XML with comments	https://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments Also defined in the following static field: XmlDsigCanonicalizationWithCommentsUrl
Exclusive Canonical XML	https://www.w3.org/TR/2002/REC-xml-exc-c14n-20020718/#WithComments Also defined in the following static field: XmlDsigExcC14NTransformUrl
Exclusive Canonical XML with comments	https://www.w3.org/TR/2002/REC-xml-exc-c14n-20020718/#WithComments Also defined in the following static field: XmlDsigExcC14NWithCommentsTransformUrl

For more information about XML digital signatures, see the World Wide Web Consortium (W3C) specification.