Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

EnvelopedSignatureWriter Class

.NET Framework 4.5

Wraps a writer and generates a signature automatically when the envelope has been completely written. This class cannot be inherited.

Namespace:  System.IdentityModel
Assembly:  System.IdentityModel (in System.IdentityModel.dll)
public sealed class EnvelopedSignatureWriter : DelegatingXmlDictionaryWriter

The EnvelopedSignatureWriter type exposes the following members.

  NameDescription
Public methodEnvelopedSignatureWriterInitializes a new instance of the EnvelopedSignatureWriter class.
Top
  NameDescription
Public propertyCanCanonicalizeReturns a value indicating if the reader is capable of Canonicalization. (Inherited from DelegatingXmlDictionaryWriter.)
Public propertySettingsGets the XmlWriterSettings object used to create this XmlWriter instance. (Inherited from XmlWriter.)
Public propertyWriteStateWhen overridden in a derived class, gets the state of the writer. (Inherited from DelegatingXmlDictionaryWriter.)
Public propertyXmlLangWhen overridden in a derived class, gets the current xml:lang scope. (Inherited from XmlWriter.)
Public propertyXmlSpaceWhen overridden in a derived class, gets an XmlSpace representing the current xml:space scope. (Inherited from XmlWriter.)
Top
  NameDescription
Public methodCloseCloses the underlying stream. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodDispose()Releases all resources used by the current instance of the XmlWriter class. (Inherited from XmlWriter.)
Public methodEndCanonicalizationWhen implemented by a derived class, it stops the canonicalization started by the matching StartCanonicalization call. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodFlushFlushes the underlying stream. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodFlushAsyncAsynchronously flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. (Inherited from XmlWriter.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLookupPrefixReturns the closest prefix defined in the current namespace scope for the namespace URI. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodStartCanonicalizationWhen implemented by a derived class, it starts the canonicalization. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteArray(String, String, String, Boolean[], Int32, Int32)Writes nodes from a Boolean array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, DateTime[], Int32, Int32)Writes nodes from a DateTime array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Decimal[], Int32, Int32)Writes nodes from a Decimal array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Double[], Int32, Int32)Writes nodes from a Double array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Guid[], Int32, Int32)Writes nodes from a Guid array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Int16[], Int32, Int32)Writes nodes from a Int16 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Int32[], Int32, Int32)Writes nodes from a Int32 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Int64[], Int32, Int32)Writes nodes from a Int64 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, Single[], Int32, Int32)Writes nodes from a Single array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, String, String, TimeSpan[], Int32, Int32)Writes nodes from a TimeSpan array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Boolean[], Int32, Int32)Writes nodes from a Boolean array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, DateTime[], Int32, Int32)Writes nodes from a DateTime array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Decimal[], Int32, Int32)Writes nodes from a Decimal array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Double[], Int32, Int32)Writes nodes from a Double array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Guid[], Int32, Int32)Writes nodes from a Guid array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Int16[], Int32, Int32)Writes nodes from a Int16 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Int32[], Int32, Int32)Writes nodes from a Int32 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Int64[], Int32, Int32)Writes nodes from a Int64 array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, Single[], Int32, Int32)Writes nodes from a Single array. (Inherited from XmlDictionaryWriter.)
Public methodWriteArray(String, XmlDictionaryString, XmlDictionaryString, TimeSpan[], Int32, Int32)Writes nodes from a TimeSpan array. (Inherited from XmlDictionaryWriter.)
Public methodWriteAttributesWhen overridden in a derived class, writes out all the attributes found at the current position in the XmlReader. (Inherited from XmlWriter.)
Public methodWriteAttributesAsyncAsynchronously writes out all the attributes found at the current position in the XmlReader. (Inherited from XmlWriter.)
Public methodWriteAttributeString(String, String)When overridden in a derived class, writes out the attribute with the specified local name and value. (Inherited from XmlWriter.)
Public methodWriteAttributeString(String, String, String)When overridden in a derived class, writes an attribute with the specified local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteAttributeString(XmlDictionaryString, XmlDictionaryString, String)Writes an attribute qualified name and value. (Inherited from XmlDictionaryWriter.)
Public methodWriteAttributeString(String, XmlDictionaryString, XmlDictionaryString, String)Writes an attribute qualified name and value. (Inherited from XmlDictionaryWriter.)
Public methodWriteAttributeString(String, String, String, String)When overridden in a derived class, writes out the attribute with the specified prefix, local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteAttributeStringAsyncAsynchronously writes out the attribute with the specified prefix, local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteBase64Encodes the specified binary bytes as Base64 and writes out the resulting text. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteBase64AsyncAsynchronously encodes the specified binary bytes as Base64 and writes out the resulting text. (Inherited from XmlDictionaryWriter.)
Public methodWriteBinHexWhen overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text. (Inherited from XmlWriter.)
Public methodWriteBinHexAsyncAsynchronously encodes the specified binary bytes as BinHex and writes out the resulting text. (Inherited from XmlWriter.)
Public methodWriteCDatawrites out a CDATA block containing the specified text. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteCDataAsyncAsynchronously writes out a <![CDATA[...]]> block containing the specified text. (Inherited from XmlWriter.)
Public methodWriteCharEntityForces the generation of a character entity for the specified Unicode character value. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteCharEntityAsyncAsynchronously forces the generation of a character entity for the specified Unicode character value. (Inherited from XmlWriter.)
Public methodWriteCharsWhen overridden in a derived class, writes text one buffer at a time. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteCharsAsyncAsynchronously writes text one buffer at a time. (Inherited from XmlWriter.)
Public methodWriteCommentWrites out a comment containing the specified text. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteCommentAsyncAsynchronously writes out a comment <!--...--> containing the specified text. (Inherited from XmlWriter.)
Public methodWriteDocTypeWrites the DOCTYPE declaration with the specified name and optional attributes. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteDocTypeAsyncAsynchronously writes the DOCTYPE declaration with the specified name and optional attributes. (Inherited from XmlWriter.)
Public methodWriteElementString(String, String)Writes an element with the specified local name and value. (Inherited from XmlWriter.)
Public methodWriteElementString(String, String, String)Writes an element with the specified local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteElementString(XmlDictionaryString, XmlDictionaryString, String)Writes an element with a text content. (Inherited from XmlDictionaryWriter.)
Public methodWriteElementString(String, XmlDictionaryString, XmlDictionaryString, String)Writes an element with a text content. (Inherited from XmlDictionaryWriter.)
Public methodWriteElementString(String, String, String, String)Writes an element with the specified prefix, local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteElementStringAsyncAsynchronously writes an element with the specified prefix, local name, namespace URI, and value. (Inherited from XmlWriter.)
Public methodWriteEndAttributeCloses the previous System.Xml.XmlWriter.WriteStartAttribute(System.String,System.String) call. (Inherited from DelegatingXmlDictionaryWriter.)
Protected methodWriteEndAttributeAsyncAsynchronously closes the previous WriteStartAttribute call. (Inherited from XmlWriter.)
Public methodWriteEndDocumentCloses any open elements or attributes and puts the writer back in the Start state. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteEndDocumentAsyncAsynchronously closes any open elements or attributes and puts the writer back in the Start state. (Inherited from XmlWriter.)
Public methodWriteEndElementCloses one element and pops the corresponding namespace scope. (Overrides DelegatingXmlDictionaryWriter.WriteEndElement().)
Public methodWriteEndElementAsyncAsynchronously closes one element and pops the corresponding namespace scope. (Inherited from XmlWriter.)
Public methodWriteEntityRefWrites out an entity reference as name. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteEntityRefAsyncAsynchronously writes out an entity reference as &name;. (Inherited from XmlWriter.)
Public methodWriteFullEndElementCloses one element and pops the corresponding namespace scope. (Overrides DelegatingXmlDictionaryWriter.WriteFullEndElement().)
Public methodWriteFullEndElementAsyncAsynchronously closes one element and pops the corresponding namespace scope. (Inherited from XmlWriter.)
Public methodWriteNameWhen overridden in a derived class, writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public methodWriteNameAsyncAsynchronously writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public methodWriteNmTokenWhen overridden in a derived class, writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public methodWriteNmTokenAsyncAsynchronously writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name). (Inherited from XmlWriter.)
Public methodWriteNode(XmlDictionaryReader, Boolean)Writes the current XML node from an XmlDictionaryReader. (Inherited from XmlDictionaryWriter.)
Public methodWriteNode(XmlReader, Boolean)Writes the current XML node from an XmlReader. (Inherited from XmlDictionaryWriter.)
Public methodWriteNode(XPathNavigator, Boolean)Copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged. (Inherited from XmlWriter.)
Public methodWriteNodeAsync(XmlReader, Boolean)Asynchronously copies everything from the reader to the writer and moves the reader to the start of the next sibling. (Inherited from XmlWriter.)
Public methodWriteNodeAsync(XPathNavigator, Boolean)Asynchronously copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged. (Inherited from XmlWriter.)
Public methodWriteProcessingInstructionWrites out a processing instruction with a space between the name and text as follows: &lt;?name text?&gt;. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteProcessingInstructionAsyncAsynchronously writes out a processing instruction with a space between the name and text as follows: <?name text?>. (Inherited from XmlWriter.)
Public methodWriteQualifiedName(String, String)When overridden in a derived class, writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace. (Inherited from XmlWriter.)
Public methodWriteQualifiedName(XmlDictionaryString, XmlDictionaryString)Writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace. (Inherited from XmlDictionaryWriter.)
Public methodWriteQualifiedNameAsyncAsynchronously writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace. (Inherited from XmlWriter.)
Public methodWriteRaw(String)Writes raw markup manually from a string. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteRaw(Char[], Int32, Int32)When overridden in a derived class, writes raw markup manually from a character buffer. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteRawAsync(String)Asynchronously writes raw markup manually from a string. (Inherited from XmlWriter.)
Public methodWriteRawAsync(Char[], Int32, Int32)Asynchronously writes raw markup manually from a character buffer. (Inherited from XmlWriter.)
Public methodWriteSignatureSets the position of the signature within the envelope. Call this method while writing the envelope to indicate at which point the signature should be inserted.
Public methodWriteStartAttribute(String)Writes the start of an attribute with the specified local name. (Inherited from XmlWriter.)
Public methodWriteStartAttribute(String, String)Writes the start of an attribute with the specified local name and namespace URI. (Inherited from XmlWriter.)
Public methodWriteStartAttribute(XmlDictionaryString, XmlDictionaryString)Writes the start of an attribute with the specified local name, and namespace URI. (Inherited from XmlDictionaryWriter.)
Public methodWriteStartAttribute(String, String, String)Writes the start of an attribute with the specified local name and namespace URI. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteStartAttribute(String, XmlDictionaryString, XmlDictionaryString)Writes the start of an attribute with the specified prefix, local name, and namespace URI. (Inherited from XmlDictionaryWriter.)
Protected methodWriteStartAttributeAsyncAsynchronously writes the start of an attribute with the specified prefix, local name, and namespace URI. (Inherited from XmlWriter.)
Public methodWriteStartDocument()When overridden in a derived class, writes the XML declaration with the version "1.0". (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteStartDocument(Boolean)When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteStartDocumentAsync()Asynchronously writes the XML declaration with the version "1.0". (Inherited from XmlWriter.)
Public methodWriteStartDocumentAsync(Boolean)Asynchronously writes the XML declaration with the version "1.0" and the standalone attribute. (Inherited from XmlWriter.)
Public methodWriteStartElement(String)When overridden in a derived class, writes out a start tag with the specified local name. (Inherited from XmlWriter.)
Public methodWriteStartElement(String, String)When overridden in a derived class, writes the specified start tag and associates it with the given namespace. (Inherited from XmlWriter.)
Public methodWriteStartElement(XmlDictionaryString, XmlDictionaryString)Writes the specified start tag and associates it with the given namespace. (Inherited from XmlDictionaryWriter.)
Public methodWriteStartElement(String, String, String)Writes the specified start tag and associates it with the specified namespace. (Overrides DelegatingXmlDictionaryWriter.WriteStartElement(String, String, String).)
Public methodWriteStartElement(String, XmlDictionaryString, XmlDictionaryString)Writes the specified start tag and associates it with the given namespace and prefix. (Inherited from XmlDictionaryWriter.)
Public methodWriteStartElementAsyncAsynchronously writes the specified start tag and associates it with the given namespace and prefix. (Inherited from XmlWriter.)
Public methodWriteString(String)Writes the given text content. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteString(XmlDictionaryString)Writes the given text content. (Inherited from XmlDictionaryWriter.)
Public methodWriteStringAsyncAsynchronously writes the given text content. (Inherited from XmlWriter.)
Public methodWriteSurrogateCharEntityGenerates and writes the surrogate character entity for the surrogate character pair. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteSurrogateCharEntityAsyncAsynchronously generates and writes the surrogate character entity for the surrogate character pair. (Inherited from XmlWriter.)
Public methodWriteValue(Boolean)Writes a Boolean value. (Inherited from XmlWriter.)
Public methodWriteValue(DateTime)Writes a DateTime value. (Inherited from XmlWriter.)
Public methodWriteValue(DateTimeOffset)Writes a DateTimeOffset value. (Inherited from XmlWriter.)
Public methodWriteValue(Decimal)Writes a Decimal value. (Inherited from XmlWriter.)
Public methodWriteValue(Double)Writes a Double value. (Inherited from XmlWriter.)
Public methodWriteValue(Guid)Writes a Guid value. (Inherited from XmlDictionaryWriter.)
Public methodWriteValue(Int32)Writes a Int32 value. (Inherited from XmlWriter.)
Public methodWriteValue(Int64)Writes a Int64 value. (Inherited from XmlWriter.)
Public methodWriteValue(IStreamProvider)Writes a value from an IStreamProvider. (Inherited from XmlDictionaryWriter.)
Public methodWriteValue(Object)Writes the object value. (Inherited from XmlWriter.)
Public methodWriteValue(Single)Writes a single-precision floating-point number. (Inherited from XmlWriter.)
Public methodWriteValue(String)Writes a String value. (Inherited from XmlWriter.)
Public methodWriteValue(TimeSpan)Writes a TimeSpan value. (Inherited from XmlDictionaryWriter.)
Public methodWriteValue(UniqueId)Writes a Unique Id value. (Inherited from XmlDictionaryWriter.)
Public methodWriteValue(XmlDictionaryString)Writes a XmlDictionaryString value. (Inherited from XmlDictionaryWriter.)
Public methodWriteValueAsyncAsynchronously writes a value from an IStreamProvider. (Inherited from XmlDictionaryWriter.)
Public methodWriteWhitespaceWrites out the given white space. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteWhitespaceAsyncAsynchronously writes out the given white space. (Inherited from XmlWriter.)
Public methodWriteXmlAttribute(String, String)Writes an attribute as a xml attribute with the prefix 'xml:'. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteXmlAttribute(XmlDictionaryString, XmlDictionaryString)Writes an XML attribute in the current node. (Inherited from XmlDictionaryWriter.)
Public methodWriteXmlnsAttribute(String, String)Writes an xmlns namespace declaration. (Inherited from DelegatingXmlDictionaryWriter.)
Public methodWriteXmlnsAttribute(String, XmlDictionaryString)Writes a namespace declaration attribute. (Inherited from XmlDictionaryWriter.)
Top

By default the generated signature is inserted as the last element in the envelope. This can be modified by explicitly calling the WriteSignature method to indicate the location inside the envelope where the signature should be inserted.

.NET Framework

Supported in: 4.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.