Back to Devexpress

WorkbookImportOptions.Password Property

officefileapi-devexpress-dot-xtraspreadsheet-dot-import-dot-workbookimportoptions.md

latest4.0 KB
Original Source

WorkbookImportOptions.Password Property

Gets or sets a password used to unprotect a password-protected document during import.

Namespace : DevExpress.XtraSpreadsheet.Import

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
public string Password { get; set; }
vb
Public Property Password As String

Property Value

TypeDescription
String

A string value that specifies the password.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to Password
DocumentOptions

.Import .Password

|

Remarks

The Password property specifies a password for opening a password-encrypted document.

Example

The code snippet below demonstrates how to use the WorkbookImportOptions.Password property.

View Example

csharp
spreadsheetControl1.Options.Import.Password = "123";
spreadsheetControl1.LoadDocument(documentName);
vb
spreadsheetControl1.Options.Import.Password = "123"
spreadsheetControl1.LoadDocument(documentName)

The following code snippets (auto-collected from DevExpress Examples) contain references to the Password property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-spreadsheet-load-and-save-a-password-encrypted-files/CS/EncryptionExample/Form1.cs#L38

csharp
#region #OptionsImportPassword
spreadsheetControl1.Options.Import.Password = "123";
spreadsheetControl1.LoadDocument(documentName);

winforms-spreadsheet-load-and-save-a-password-encrypted-files/VB/EncryptionExample/Form1.vb#L39

vb
#Region "#OptionsImportPassword"
            spreadsheetControl1.Options.Import.Password = "123"
            spreadsheetControl1.LoadDocument(documentName)

spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L14

vb
Dim workbook As Workbook = New Workbook()
workbook.Options.Import.Password = "123"
workbook.LoadDocument("..\..\..\Documents\encrypted.xlsx")

See Also

Protection in Spreadsheet Documents

WorkbookImportOptions Class

WorkbookImportOptions Members

DevExpress.XtraSpreadsheet.Import Namespace