Document passwords Leave feedback

The PasswordDictionary class is designed to store passwords for documents to be indexed. The password dictionary of an index is available through the DocumentPasswords property of the Index.Dictionaries object. Information on indexing password protected documents is presented on the Indexing password protected documents page.

The password dictionary can be changed at any time. A password is stored with a key, which is the full path of a document file or, for a document added from a stream or a structure, the document key.

To get the number of passwords in the dictionary, use the Count property.

To get the password for a document from the dictionary, the GetPassword method is used, passing the full path or the key of the document as an argument.

The Clear method is used to remove all passwords from the dictionary.

To check for the presence of a password in the dictionary for the specified document, the Contains method is used.

To add a password to the dictionary, use the Add method. The first parameter is the full path or the key of the document. If the dictionary already contains a password for the document, the method throws ArgumentException; remove the existing password first.

To remove a password from the dictionary, use the Remove method.

To export passwords to a file, use the ExportDictionary method.

To import passwords from a file, use the ImportDictionary method. The imported passwords are added to the dictionary, so the dictionary must not already contain passwords for the same documents; otherwise, the import fails. Errors of exporting and importing are reported by the ErrorOccurred event of the index instead of exceptions.

The following example demonstrates the use of methods of the password dictionary.

C#

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating or opening an index in the specified folder
Index index = new Index(indexFolder);

string path = Path.GetFullPath(@"c:\MyDocuments\Protected.pdf");
if (index.Dictionaries.DocumentPasswords.Contains(path))
{
    // Getting a password for a document
    string password = index.Dictionaries.DocumentPasswords.GetPassword(path);
    Console.WriteLine(path);
    Console.WriteLine("\tPassword: " + password);

    // Deleting the password from the dictionary
    index.Dictionaries.DocumentPasswords.Remove(path);
}

if (index.Dictionaries.DocumentPasswords.Count > 0)
{
    // Removing all passwords from the dictionary
    index.Dictionaries.DocumentPasswords.Clear();
}

// Adding a password for a document
index.Dictionaries.DocumentPasswords.Add(path, "123456");

// Exporting passwords to a file
index.Dictionaries.DocumentPasswords.ExportDictionary(@"c:\Passwords.dat");

// Removing all passwords and importing them from the file
index.Dictionaries.DocumentPasswords.Clear();
index.Dictionaries.DocumentPasswords.ImportDictionary(@"c:\Passwords.dat");

// Indexing documents; the passwords from the dictionary are used to open protected documents
index.Add(documentsFolder);

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

• GroupDocs.Search for .NET examples

• GroupDocs.Search for Java examples

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.