X509Certificate2UI.SelectFromCollection Method

Definition

Namespace:

System.Security.Cryptography.X509Certificates

Assembly:

System.Windows.Extensions.dll

Displays a dialog box for selecting an X.509 certificate from a certificate collection.

Overloads

SelectFromCollection(X509Certificate2Collection, String, String, X509SelectionFlag)	Displays a dialog box for selecting an X.509 certificate from a certificate collection.
SelectFromCollection(X509Certificate2Collection, String, String, X509SelectionFlag, IntPtr)	Displays a dialog box for selecting an X.509 certificate from a certificate collection using a handle to a parent window.

Remarks

Use this method if you require users to manually select X.509 certificates using a dialog box. If no user interaction is required, use the X509Certificate2Collection.Find method.

SelectFromCollection(X509Certificate2Collection, String, String, X509SelectionFlag)

Displays a dialog box for selecting an X.509 certificate from a certificate collection.

public:
 static System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ SelectFromCollection(System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ certificates, System::String ^ title, System::String ^ message, System::Security::Cryptography::X509Certificates::X509SelectionFlag selectionFlag);

public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection (System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string? title, string? message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag);

static member SelectFromCollection : System.Security.Cryptography.X509Certificates.X509Certificate2Collection * string * string * System.Security.Cryptography.X509Certificates.X509SelectionFlag -> System.Security.Cryptography.X509Certificates.X509Certificate2Collection

Public Shared Function SelectFromCollection (certificates As X509Certificate2Collection, title As String, message As String, selectionFlag As X509SelectionFlag) As X509Certificate2Collection

Parameters

certificates

X509Certificate2Collection

A collection of X.509 certificates to select from.

title

String

The title of the dialog box.

message

String

A descriptive message to guide the user. The message is displayed in the dialog box.

selectionFlag

X509SelectionFlag

One of the X509SelectionFlag values that specifies whether single or multiple selections are allowed.

Returns

X509Certificate2Collection

An X509Certificate2Collection object that contains the selected certificate or certificates.

Exceptions

ArgumentException

The selectionFlag parameter is not a valid flag.

ArgumentNullException

The certificates parameter is null.

CryptographicException

The certificates parameter is invalid.

Examples

The following code example demonstrates how to display user interface dialogs to select and view X.509 certificates.

#using <System.dll>
#using <System.Security.dll>

using namespace System;
using namespace System::Security::Cryptography;
using namespace System::Security::Permissions;
using namespace System::IO;
using namespace System::Security::Cryptography::X509Certificates;
int main()
{
   try
   {
      X509Store ^ store = gcnew X509Store( "MY",StoreLocation::CurrentUser );
      store->Open( static_cast<OpenFlags>(OpenFlags::ReadOnly | OpenFlags::OpenExistingOnly) );
      X509Certificate2Collection ^ collection = dynamic_cast<X509Certificate2Collection^>(store->Certificates);
      X509Certificate2Collection ^ fcollection = dynamic_cast<X509Certificate2Collection^>(collection->Find( X509FindType::FindByTimeValid, DateTime::Now, false ));
      X509Certificate2Collection ^ scollection = X509Certificate2UI::SelectFromCollection(fcollection, "Test Certificate Select","Select a certificate from the following list to get information on that certificate",X509SelectionFlag::MultiSelection);
      Console::WriteLine( "Number of certificates: {0}{1}", scollection->Count, Environment::NewLine );
      System::Collections::IEnumerator^ myEnum = scollection->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         X509Certificate2 ^ x509 = safe_cast<X509Certificate2 ^>(myEnum->Current);
         array<Byte>^rawdata = x509->RawData;
         Console::WriteLine( "Content Type: {0}{1}", X509Certificate2::GetCertContentType( rawdata ), Environment::NewLine );
         Console::WriteLine( "Friendly Name: {0}{1}", x509->FriendlyName, Environment::NewLine );
         Console::WriteLine( "Certificate Verified?: {0}{1}", x509->Verify(), Environment::NewLine );
         Console::WriteLine( "Simple Name: {0}{1}", x509->GetNameInfo( X509NameType::SimpleName, true ), Environment::NewLine );
         Console::WriteLine( "Signature Algorithm: {0}{1}", x509->SignatureAlgorithm->FriendlyName, Environment::NewLine );
         Console::WriteLine( "Private Key: {0}{1}", x509->PrivateKey->ToXmlString( false ), Environment::NewLine );
         Console::WriteLine( "Public Key: {0}{1}", x509->PublicKey->Key->ToXmlString( false ), Environment::NewLine );
         Console::WriteLine( "Certificate Archived?: {0}{1}", x509->Archived, Environment::NewLine );
         Console::WriteLine( "Length of Raw Data: {0}{1}", x509->RawData->Length, Environment::NewLine );
         x509->Reset();
      }
      store->Close();
   }
   catch ( CryptographicException^ ) 
   {
      Console::WriteLine( "Information could not be written out for this certificate." );
   }

}

using System;
using System.Security.Cryptography;
using System.Security.Permissions;
using System.IO;
using System.Security.Cryptography.X509Certificates;

class CertSelect
{
    static void Main()
    {
        X509Store store = new X509Store("MY",StoreLocation.CurrentUser);
        store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly);

        X509Certificate2Collection collection = (X509Certificate2Collection)store.Certificates;
        X509Certificate2Collection fcollection = (X509Certificate2Collection)collection.Find(X509FindType.FindByTimeValid,DateTime.Now,false);
        X509Certificate2Collection scollection = X509Certificate2UI.SelectFromCollection(fcollection, "Test Certificate Select","Select a certificate from the following list to get information on that certificate",X509SelectionFlag.MultiSelection);
        Console.WriteLine("Number of certificates: {0}{1}",scollection.Count,Environment.NewLine);

        foreach (X509Certificate2 x509 in scollection)
        {
            try
            {
                byte[] rawdata = x509.RawData;
                Console.WriteLine("Content Type: {0}{1}",X509Certificate2.GetCertContentType(rawdata),Environment.NewLine);
                Console.WriteLine("Friendly Name: {0}{1}",x509.FriendlyName,Environment.NewLine);
                Console.WriteLine("Certificate Verified?: {0}{1}",x509.Verify(),Environment.NewLine);
                Console.WriteLine("Simple Name: {0}{1}",x509.GetNameInfo(X509NameType.SimpleName,true),Environment.NewLine);
                Console.WriteLine("Signature Algorithm: {0}{1}",x509.SignatureAlgorithm.FriendlyName,Environment.NewLine);
                Console.WriteLine("Public Key: {0}{1}",x509.PublicKey.Key.ToXmlString(false),Environment.NewLine);
                Console.WriteLine("Certificate Archived?: {0}{1}",x509.Archived,Environment.NewLine);
                Console.WriteLine("Length of Raw Data: {0}{1}",x509.RawData.Length,Environment.NewLine);
                X509Certificate2UI.DisplayCertificate(x509);
                x509.Reset();
            }
            catch (CryptographicException)
            {
                Console.WriteLine("Information could not be written out for this certificate.");
            }
        }
        store.Close();
    }
}

Imports System.Security.Cryptography
Imports System.Security.Permissions
Imports System.IO
Imports System.Security.Cryptography.X509Certificates

Class CertSelect

    Shared Sub Main()

        Dim store As New X509Store("MY", StoreLocation.CurrentUser)
        store.Open(OpenFlags.ReadOnly Or OpenFlags.OpenExistingOnly)

        Dim collection As X509Certificate2Collection = CType(store.Certificates, X509Certificate2Collection)
        Dim fcollection As X509Certificate2Collection = CType(collection.Find(X509FindType.FindByTimeValid, DateTime.Now, False), X509Certificate2Collection)
        Dim scollection As X509Certificate2Collection = X509Certificate2UI.SelectFromCollection(fcollection, "Test Certificate Select", "Select a certificate from the following list to get information on that certificate", X509SelectionFlag.MultiSelection)
        Console.WriteLine("Number of certificates: {0}{1}", scollection.Count, Environment.NewLine)
         
        For Each x509 As X509Certificate2 In scollection
            Try
                Dim rawdata As Byte() = x509.RawData
                Console.WriteLine("Content Type: {0}{1}", X509Certificate2.GetCertContentType(rawdata), Environment.NewLine)
                Console.WriteLine("Friendly Name: {0}{1}", x509.FriendlyName, Environment.NewLine)
                Console.WriteLine("Certificate Verified?: {0}{1}", x509.Verify(), Environment.NewLine)
                Console.WriteLine("Simple Name: {0}{1}", x509.GetNameInfo(X509NameType.SimpleName, True), Environment.NewLine)
                Console.WriteLine("Signature Algorithm: {0}{1}", x509.SignatureAlgorithm.FriendlyName, Environment.NewLine)
                Console.WriteLine("Public Key: {0}{1}", x509.PublicKey.Key.ToXmlString(False), Environment.NewLine)
                Console.WriteLine("Certificate Archived?: {0}{1}", x509.Archived, Environment.NewLine)
                Console.WriteLine("Length of Raw Data: {0}{1}", x509.RawData.Length, Environment.NewLine)
                X509Certificate2UI.DisplayCertificate(x509)
                x509.Reset()         
             Catch cExcept As CryptographicException
                 Console.WriteLine("Information could not be written out for this certificate.")
             End Try
        Next x509

        store.Close()
    End Sub
End Class

Remarks

Use the SelectFromCollection method if you require users to manually select X.509 certificates using a dialog box. If no user interaction is required, use the X509Certificate2Collection.Find method.

SelectFromCollection(X509Certificate2Collection, String, String, X509SelectionFlag, IntPtr)

Displays a dialog box for selecting an X.509 certificate from a certificate collection using a handle to a parent window.

public:
 static System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ SelectFromCollection(System::Security::Cryptography::X509Certificates::X509Certificate2Collection ^ certificates, System::String ^ title, System::String ^ message, System::Security::Cryptography::X509Certificates::X509SelectionFlag selectionFlag, IntPtr hwndParent);

public static System.Security.Cryptography.X509Certificates.X509Certificate2Collection SelectFromCollection (System.Security.Cryptography.X509Certificates.X509Certificate2Collection certificates, string? title, string? message, System.Security.Cryptography.X509Certificates.X509SelectionFlag selectionFlag, IntPtr hwndParent);

static member SelectFromCollection : System.Security.Cryptography.X509Certificates.X509Certificate2Collection * string * string * System.Security.Cryptography.X509Certificates.X509SelectionFlag * nativeint -> System.Security.Cryptography.X509Certificates.X509Certificate2Collection

Public Shared Function SelectFromCollection (certificates As X509Certificate2Collection, title As String, message As String, selectionFlag As X509SelectionFlag, hwndParent As IntPtr) As X509Certificate2Collection

Parameters

certificates

X509Certificate2Collection

A collection of X.509 certificates to select from.

title

String

The title of the dialog box.

message

String

A descriptive message to guide the user. The message is displayed in the dialog box.

selectionFlag

X509SelectionFlag

One of the X509SelectionFlag values that specifies whether single or multiple selections are allowed.

hwndParent

IntPtr

nativeint

A handle to the parent window to use for the display dialog box.

Returns

X509Certificate2Collection

An X509Certificate2Collection object that contains the selected certificate or certificates.

Exceptions

ArgumentException

The selectionFlag parameter is not a valid flag.

ArgumentNullException

The certificates parameter is null.

CryptographicException

The certificates parameter is invalid.

Remarks

Use the SelectFromCollection method if you require users to manually select X.509 certificates using a dialog box. If no user interaction is required, use the X509Certificate2Collection.Find method.