Saml2NameIdentifier.Format Property

Article
10/05/2012

[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.]

Gets or sets a URI reference that represents the classification of string-based identifier information. [Saml2Core, 2.2.2]

Namespace: Microsoft.IdentityModel.Tokens.Saml2
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As Saml2NameIdentifier
Dim value As Uri

value = instance.Format

instance.Format = value

Syntax

'Declaration
Public Property Format As Uri

public Uri Format { get; set; }

public:
property Uri^ Format {
    Uri^ get ();
    void set (Uri^ value);
}

/** @property */
public Uri get_Format ()

/** @property */
public void set_Format (Uri value)

public function get Format () : Uri

public function set Format (value : Uri)

Property Value

A Uri.

Exceptions

Exception type	Condition
ArgumentException	An attempt to set a value that is not null and is not an absolute URI occurs.

Remarks

The Format attribute. This can be one of the URIs defined in NameIdentifierFormats class.

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.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)