SecurityTokenHandler.CanWriteToken Property

.NET Framework 4.5

Gets a value that indicates whether the handler can serialize security tokens.

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public virtual bool CanWriteToken { get; }

Property Value

Type: System.Boolean
true if the class is capable of serializing tokens; otherwise false. The default is false.

To implement serialization in a derived class, override this property to return true and override the WriteToken methods to implement the serialization logic.

The following code shows how to override the CanWriteToken property to indicate that a custom handler can serialize tokens. The code is taken from the Custom Token sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see WIF Code Sample Index.

/// <summary> 
/// Gets a value indicating whether the SecurityTokenHandler can Serialize Tokens. Return true by default. 
/// </summary> 
/// <value>True is the handler can serialize tokens of type <see cref="SimpleWebToken"/>.</value>
public override bool CanWriteToken
{
    get
    {
        return true;
    }
}

.NET Framework

Supported in: 4.6, 4.5

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft