Compartilhar via


EnvelopedSignatureWriter Members

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Wraps a writer and generates a signature automatically when the envelope is written completely. By default the generated signature is inserted as the last element in the enveloped. This can be modified by explicitily calling WriteSignature to indicate the location inside the envelope where the signature should be inserted.

The following tables list the members exposed by the EnvelopedSignatureWriter type.

Public Constructors

  Name Description
  EnvelopedSignatureWriter Initializes an instance of EnvelopedSignatureWriter. The returned writer can be directly used to write the envelope. The signature will be automatically generated when the envelope is completed.

Top

Public Properties

(see also Protected Properties)

  Name Description
public property CanCanonicalize  Overridden. Returns a value indicating if the reader is capable of Canonicalization. (Inherited from XmlDictionaryWriter)
public property Settings  (Inherited from XmlWriter)
public property WriteState  Overridden. When overridden in a derived class, gets the state of the writer. (Inherited from XmlWriter)
public property XmlLang  (Inherited from XmlWriter)
public property XmlSpace  (Inherited from XmlWriter)

Top

Protected Properties

  Name Description
protected property InnerWriter  Get the wrapped writer. (Inherited from DelegatingXmlDictionaryWriter)

Top

Public Methods

(see also Protected Methods)

  Name Description
public method Close  Overridden. Closes the underlying stream. (Inherited from XmlWriter)
public method EndCanonicalization  Overridden. Closes a previous Start canonicalization operation. The stream given to the StartCanonicalization is flushed and any data written after this call will not be written to the canonical stream. (Inherited from XmlDictionaryWriter)
public method Equals  (Inherited from Object)
public method Flush  Overridden. Flushes the underlying stream. (Inherited from XmlWriter)
public method GetHashCode  (Inherited from Object)
public method GetType  (Inherited from Object)
public method LookupPrefix  Overridden. Returns the closest prefix defined in the current namespace scope for the namespace URI. (Inherited from XmlWriter)
public method StartCanonicalization  Overridden. Indicates the start of Canonicalization. Any write opertation following this will canonicalize the data and will wirte it to the given stream. (Inherited from XmlDictionaryWriter)
public method ToString  (Inherited from Object)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteArray  (Inherited from XmlDictionaryWriter)
public method WriteAttributes  (Inherited from XmlWriter)
public method WriteAttributeString  (Inherited from XmlDictionaryWriter)
public method WriteAttributeString  (Inherited from XmlDictionaryWriter)
public method WriteAttributeString  (Inherited from XmlWriter)
public method WriteAttributeString  (Inherited from XmlWriter)
public method WriteAttributeString  (Inherited from XmlWriter)
public method WriteBase64  Overridden. Encodes the specified binary bytes as Base64 and writes out the resulting text. (Inherited from XmlWriter)
public method WriteBinHex  (Inherited from XmlWriter)
public method WriteCData  Overridden. writes out a CDATA block containing the specified text. (Inherited from XmlWriter)
public method WriteCharEntity  Overridden. Forces the generation of a character entity for the specified Unicode character value. (Inherited from XmlWriter)
public method WriteChars  Overridden. When overridden in a derived class, writes text one buffer at a time. (Inherited from XmlWriter)
public method WriteComment  Overridden. Writes out a comment containing the specified text. (Inherited from XmlWriter)
public method WriteDocType  Overridden. Writes the DOCTYPE declaration with the specified name and optional attributes. (Inherited from XmlWriter)
public method WriteElementString  (Inherited from XmlDictionaryWriter)
public method WriteElementString  (Inherited from XmlDictionaryWriter)
public method WriteElementString  (Inherited from XmlWriter)
public method WriteElementString  (Inherited from XmlWriter)
public method WriteElementString  (Inherited from XmlWriter)
public method WriteEndAttribute  Overridden. Closes the previous System.Xml.XmlWriter.WriteStartAttribute(System.String,System.String) call. (Inherited from XmlWriter)
public method WriteEndDocument  Overridden. Closes any open elements or attributes and puts the writer back in the Start state. (Inherited from XmlWriter)
public method WriteEndElement Overridden. Overrides the base class implementation. When the last element of the envelope is written the signature is automatically computed over the envelope and the signature is inserted at the appropriate position, if WriteSignature was explicitly called or is inserted at the end of the envelope.
public method WriteEntityRef  Overridden. Writes out an entity reference as name. (Inherited from XmlWriter)
public method WriteFullEndElement Overridden. Overrides the base class implementation. When the last element of the envelope is written the signature is automatically computed over the envelope and the signature is inserted at the appropriate position, if WriteSignature was explicitly called or is inserted at the end of the envelope.
public method WriteName  (Inherited from XmlWriter)
public method WriteNmToken  (Inherited from XmlWriter)
public method WriteNode  (Inherited from XmlDictionaryWriter)
public method WriteNode  Overridden. (Inherited from XmlWriter)
public method WriteNode  (Inherited from XmlWriter)
public method WriteProcessingInstruction  Overridden. Writes out a processing instruction with a space between the name and text as follows: <?name text?>. (Inherited from XmlWriter)
public method WriteQualifiedName  (Inherited from XmlDictionaryWriter)
public method WriteQualifiedName  (Inherited from XmlWriter)
public method WriteRaw  Overridden. When overridden in a derived class, writes raw markup manually from a character buffer. (Inherited from XmlWriter)
public method WriteSignature Sets 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 method WriteStartAttribute  Overridden. Writes the start of an attribute with the specified local name and namespace URI. (Inherited from XmlWriter)
public method WriteStartAttribute  (Inherited from XmlDictionaryWriter)
public method WriteStartAttribute  (Inherited from XmlDictionaryWriter)
public method WriteStartAttribute  (Inherited from XmlWriter)
public method WriteStartAttribute  (Inherited from XmlWriter)
public method WriteStartDocument  Overridden. When overridden in a derived class, writes the XML declaration with the version "1.0". (Inherited from XmlWriter)
public method WriteStartElement Overridden. Overrides the base class. Writes the specified start tag and associates it with the given namespace.
public method WriteStartElement  (Inherited from XmlDictionaryWriter)
public method WriteStartElement  (Inherited from XmlDictionaryWriter)
public method WriteStartElement  (Inherited from XmlWriter)
public method WriteStartElement  (Inherited from XmlWriter)
public method WriteString  Overridden. Writes the given text content. (Inherited from XmlWriter)
public method WriteString  (Inherited from XmlDictionaryWriter)
public method WriteSurrogateCharEntity  Overridden. Generates and writes the surrogate character entity for the surrogate character pair. (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlDictionaryWriter)
public method WriteValue  (Inherited from XmlDictionaryWriter)
public method WriteValue  (Inherited from XmlDictionaryWriter)
public method WriteValue  (Inherited from XmlDictionaryWriter)
public method WriteValue  (Inherited from XmlDictionaryWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteValue  (Inherited from XmlWriter)
public method WriteWhitespace  Overridden. Writes out the given white space. (Inherited from XmlWriter)
public method WriteXmlAttribute  Overridden. Writes an attribute as a xml attribute with the prefix 'xml:'. (Inherited from XmlDictionaryWriter)
public method WriteXmlAttribute  (Inherited from XmlDictionaryWriter)
public method WriteXmlnsAttribute  Overridden. Writes an xmlns namespace declaration. (Inherited from XmlDictionaryWriter)
public method WriteXmlnsAttribute  (Inherited from XmlDictionaryWriter)

Top

Protected Methods

  Name Description
protected method Dispose  (Inherited from XmlWriter)
protected method Finalize  (Inherited from Object)
protected method InitializeInnerWriter  Initializes the inner writer that this instance wraps. (Inherited from DelegatingXmlDictionaryWriter)
protected method InitializeTracingWriter  Initializes a writer that will write the un-canonicalize xml. If this agrument is not null, all calls will be echoed to this writer. (Inherited from DelegatingXmlDictionaryWriter)
protected method MemberwiseClone  (Inherited from Object)
protected method WriteTextNode  (Inherited from XmlDictionaryWriter)

Top

See Also

Reference

EnvelopedSignatureWriter Class
Microsoft.IdentityModel.Protocols.XmlSignature Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.