NanoXLSX.Core 3.0.0-rc.3
Loading...
Searching...
No Matches
NanoXLSX.Interfaces.IPassword Interface Reference

Interface to represent a protection password, either for workbooks or worksheets. The implementations will define the password algorithms. More...

Inheritance diagram for NanoXLSX.Interfaces.IPassword:

Public Member Functions

void SetPassword (string plainText)
 Sets the plain text password.
void UnsetPassword ()
 Unsets a previously defined password.
string GetPassword ()
 Gets the password as plain text.
bool PasswordIsSet ()
 Gets whether a password was set or not.
void CopyFrom (IPassword passwordInstance)
 Method to copy a password instance from another one.

Properties

string PasswordHash [get, set]
 Gets or sets the password hash.

Detailed Description

Interface to represent a protection password, either for workbooks or worksheets. The implementations will define the password algorithms.

Definition at line 13 of file IPassword.cs.

Member Function Documentation

◆ CopyFrom()

void NanoXLSX.Interfaces.IPassword.CopyFrom ( IPassword passwordInstance)

Method to copy a password instance from another one.

Parameters
passwordInstanceSource instance

Implemented in NanoXLSX.LegacyPassword.

◆ GetPassword()

string NanoXLSX.Interfaces.IPassword.GetPassword ( )

Gets the password as plain text.

Returns
Password as plain text

Implemented in NanoXLSX.LegacyPassword.

◆ PasswordIsSet()

bool NanoXLSX.Interfaces.IPassword.PasswordIsSet ( )

Gets whether a password was set or not.

Returns

Implemented in NanoXLSX.LegacyPassword.

◆ SetPassword()

void NanoXLSX.Interfaces.IPassword.SetPassword ( string plainText)

Sets the plain text password.

Parameters
plainTextPassword in plain text

Implemented in NanoXLSX.LegacyPassword.

◆ UnsetPassword()

void NanoXLSX.Interfaces.IPassword.UnsetPassword ( )

Unsets a previously defined password.

Implemented in NanoXLSX.LegacyPassword.

Property Documentation

◆ PasswordHash

string NanoXLSX.Interfaces.IPassword.PasswordHash
getset

Gets or sets the password hash.

Implemented in NanoXLSX.LegacyPassword.

Definition at line 18 of file IPassword.cs.


The documentation for this interface was generated from the following file: