This documentation is archived and is not being maintained.

EncryptedReference Class

Represents the abstract base class used in XML encryption from which the CipherReference, KeyReference, and DataReference classes derive.

Namespace:  System.Security.Cryptography.Xml
Assembly:  System.Security (in System.Security.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public abstract class EncryptedReference

The EncryptedReference type exposes the following members.

Protected methodEncryptedReference()Initializes a new instance of the EncryptedReference class.
Protected methodEncryptedReference(String)Initializes a new instance of the EncryptedReference class using the specified Uniform Resource Identifier (URI).
Protected methodEncryptedReference(String, TransformChain)Initializes a new instance of the EncryptedReference class using the specified Uniform Resource Identifier (URI) and transform chain.

Protected propertyCacheValidGets a value that indicates whether the cache is valid.
Protected propertyReferenceTypeGets or sets a reference type.
Public propertyTransformChainGets or sets the transform chain of an EncryptedReference object.
Public propertyUriGets or sets the Uniform Resource Identifier (URI) of an EncryptedReference object.

Public methodAddTransformAdds a Transform object to the current transform chain of an EncryptedReference object.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetXmlReturns the XML representation of an EncryptedReference object.
Public methodLoadXmlLoads an XML element into an EncryptedReference object.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

For more information about XML encryption standards, see


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following example uses the GetXml method in the CipherReference class to write the XML values to the console.

using System;
using System.Security.Cryptography.Xml;
using System.Xml;
using System.IO;

/// This sample used the GetXml method in the CipherReference class to 
/// write the XML values for the CipherReference to the console.
namespace CipherReference2
	class CipherReference2
		static void Main(string[] args)
			//Create a URI string.
			String uri = "";

			// Create a Base64 transform. The input content retrieved from the
			// URI should be Base64-decoded before other processing.
			Transform base64 = new XmlDsigBase64Transform();

			//Create a transform chain and add the transform to it.
			TransformChain tc = new TransformChain();


			//Create <CipherReference> information.
			CipherReference reference = new CipherReference(uri, tc);
			// Write the CipherReference value to the console.
			Console.WriteLine("Cipher Reference data: {0}", reference.GetXml().OuterXml);

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.