This documentation is archived and is not being maintained.

KeyReference Class

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

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

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

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

The KeyReference type exposes the following members.

  NameDescription
Public methodKeyReference()Initializes a new instance of the KeyReference class for XML encryption.
Public methodKeyReference(String)Initializes a new instance of the KeyReference class for XML encryption using the supplied Uniform Resource Identifier (URI).
Public methodKeyReference(String, TransformChain)Initializes a new instance of the KeyReference class for XML encryption using the specified Uniform Resource Identifier (URI) and a TransformChain object.
Top

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

  NameDescription
Public methodAddTransformAdds a Transform object to the current transform chain of an EncryptedReference object. (Inherited from EncryptedReference.)
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. (Inherited from EncryptedReference.)
Public methodLoadXmlLoads an XML element into an EncryptedReference object. (Inherited from EncryptedReference.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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/.

NoteNote

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 code example demonstrates how to use a KeyReference object while encrypting an XML document.

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

.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.
Show: