Document passwords Leave feedback
The PasswordDictionary class is designed to store passwords for documents to be indexed. Information on indexing password protected documents is presented on the Indexing password protected documents page.
To get the number of passwords in the dictionary, use the getCount method.
To get the password for a document from the dictionary, the getPassword method is used, passing the path to 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 key is the path to the document.
To remove a password from the dictionary, use the remove method.
The following example demonstrates the use of methods of the password dictionary.
const indexFolder = 'c:/MyIndex/';
const documentsFolder = 'c:/MyDocuments/';
// Creating an index from in specified folder
const index = new groupdocs.search.Index(indexFolder);
if (index.getDictionaries().getDocumentPasswords().getCount() > 0) {
// Removing all passwords from the dictionary
index.getDictionaries().getDocumentPasswords().clear();
}
const absolutePath = path.resolve(Utils.PasswordProtectedDocumentsPath + 'English.docx');
index.getDictionaries().getDocumentPasswords().add(absolutePath, '123456');
if (index.getDictionaries().getDocumentPasswords().contains(absolutePath)) {
// Getting a password for a document
const password = index.getDictionaries().getDocumentPasswords().getPassword(absolutePath);
console.log(absolutePath);
console.log('\tPassword: ' + password);
// Deleting the password from the dictionary
index.getDictionaries().getDocumentPasswords().remove(absolutePath);
}
// Adding document passwords to the dictionary
index
.getDictionaries()
.getDocumentPasswords()
.add(Utils.PasswordProtectedDocumentsPath + 'English.docx', '123456');
index
.getDictionaries()
.getDocumentPasswords()
.add(Utils.PasswordProtectedDocumentsPath + 'Lorem ipsum.docx', '123456');
// Indexing documents from the specified folder
// Passwords will be automatically retrieved from the dictionary when necessary
index.add(documentsFolder);
// Searching in the index
const query = 'ipsum OR increasing';
const result = index.search(query);
You may easily run the code from documentation articles and see the features in action in our GitHub 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.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
