KeyReference Class

.NET Framework (current version)

Other Versions

Represents the <KeyReference> element used in XML encryption. This class cannot be inherited.

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

Inheritance Hierarchy

System::Object
System.Security.Cryptography.Xml::EncryptedReference
System.Security.Cryptography.Xml::KeyReference

Syntax

C++

[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class KeyReference sealed : EncryptedReference

Constructors

	Name	Description
	KeyReference()	Initializes a new instance of the KeyReference class for XML encryption.
	KeyReference(String^)	Initializes a new instance of the KeyReference class for XML encryption using the supplied Uniform Resource Identifier (URI).
	KeyReference(String^, TransformChain^)	Initializes a new instance of the KeyReference class for XML encryption using the specified Uniform Resource Identifier (URI) and a TransformChain object.

Properties

	Name	Description
	CacheValid	Gets a value that indicates whether the cache is valid.(Inherited from EncryptedReference.)
	TransformChain	Gets or sets the transform chain of an EncryptedReference object.(Inherited from EncryptedReference.)
	Uri	Gets or sets the Uniform Resource Identifier (URI) of an EncryptedReference object.(Inherited from EncryptedReference.)

Methods

	Name	Description
	AddTransform(Transform^)	Adds a Transform object to the current transform chain of an EncryptedReference object.(Inherited from EncryptedReference.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetXml()	Returns the XML representation of an EncryptedReference object.(Inherited from EncryptedReference.)
	LoadXml(XmlElement^)	Loads an XML element into an EncryptedReference object.(Inherited from EncryptedReference.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

The KeyReference class represents the <KeyReference> element that contains information about the location of an encrypted key.

Use the <KeyReference> element to refer to <EncryptedKey> elements that were encrypted using the key defined in the enclosing <EncryptedKey> element. You can use multiple <KeyReference> elements when multiple <EncryptedKey> elements exist that are encrypted using the same key.

You can include additional information such as XPath transforms, decompression transforms, or information about how to retrieve the elements from a document storage facility to aid the decrypting application.

For more information about XML encryption standards, see the XML Encryption specification, which is available from the World Wide Web Consortium (W3C) at http://www.w3.org/TR/xmlenc-core/.

Examples

The following code example demonstrates how to use a KeyReference object while encrypting an XML document.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0

Thread Safety

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