NanoXLSX.Writer 3.0.0-rc.5
Loading...
Searching...
No Matches
NanoXLSX.Internal.Writers.LegacyPasswordWriter Class Reference

Class to write a legacy password. More...

Inheritance diagram for NanoXLSX.Internal.Writers.LegacyPasswordWriter:

Public Member Functions

 LegacyPasswordWriter (PasswordType type, string hash)
 Default constructor with parameter.
 LegacyPasswordWriter ()
 Default constructor.
void Init (PasswordType type, string passwordHash)
 Initializer method with all mandatory parameters.
void CopyFrom (IPassword passwordInstance)
 Not relevant for the writer (inherited from IPassword).
bool PasswordIsSet ()
 Gets whether a password to write is defined.
string GetPassword ()
 Not relevant for the writer (inherited from IPassword).
void SetPassword (string plainText)
 Not relevant for the writer (inherited from IPassword).
void UnsetPassword ()
 Not relevant for the writer (inherited from IPassword).
IEnumerable< XmlAttribute > GetAttributes ()
 Gets the XML attributes of the current password instance, that are used when writing XLSX files.

Properties

PasswordType Type [get]
 Current target type of the password instance.
string PasswordHash [get, set]
 Gets or sets the password hash.

Detailed Description

Class to write a legacy password.

Definition at line 24 of file LegacyPasswordWriter.cs.

Constructor & Destructor Documentation

◆ LegacyPasswordWriter() [1/2]

NanoXLSX.Internal.Writers.LegacyPasswordWriter.LegacyPasswordWriter ( PasswordType type,
string hash )

Default constructor with parameter.

Parameters
typeTarget type of the password instance
hashHash representation of the password (do not use null)

Definition at line 43 of file LegacyPasswordWriter.cs.

◆ LegacyPasswordWriter() [2/2]

NanoXLSX.Internal.Writers.LegacyPasswordWriter.LegacyPasswordWriter ( )

Default constructor.

Definition at line 54 of file LegacyPasswordWriter.cs.

Member Function Documentation

◆ CopyFrom()

void NanoXLSX.Internal.Writers.LegacyPasswordWriter.CopyFrom ( IPassword passwordInstance)

Not relevant for the writer (inherited from IPassword).

Parameters
passwordInstanceSource instance
Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 76 of file LegacyPasswordWriter.cs.

◆ GetAttributes()

IEnumerable< XmlAttribute > NanoXLSX.Internal.Writers.LegacyPasswordWriter.GetAttributes ( )

Gets the XML attributes of the current password instance, that are used when writing XLSX files.

Returns
IENumerable of attributes

Definition at line 122 of file LegacyPasswordWriter.cs.

◆ GetPassword()

string NanoXLSX.Internal.Writers.LegacyPasswordWriter.GetPassword ( )

Not relevant for the writer (inherited from IPassword).

Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 94 of file LegacyPasswordWriter.cs.

◆ Init()

void NanoXLSX.Internal.Writers.LegacyPasswordWriter.Init ( PasswordType type,
string passwordHash )

Initializer method with all mandatory parameters.

Parameters
typeTarget type of the password instance
passwordHashHash representation of the password (do not use null)

Definition at line 65 of file LegacyPasswordWriter.cs.

◆ PasswordIsSet()

bool NanoXLSX.Internal.Writers.LegacyPasswordWriter.PasswordIsSet ( )

Gets whether a password to write is defined.

Returns
True if a password is set to be written

Definition at line 85 of file LegacyPasswordWriter.cs.

◆ SetPassword()

void NanoXLSX.Internal.Writers.LegacyPasswordWriter.SetPassword ( string plainText)

Not relevant for the writer (inherited from IPassword).

Parameters
plainText
Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 104 of file LegacyPasswordWriter.cs.

◆ UnsetPassword()

void NanoXLSX.Internal.Writers.LegacyPasswordWriter.UnsetPassword ( )

Not relevant for the writer (inherited from IPassword).

Exceptions
NotImplementedExceptionThrows a NotImplementedException if called in any case

Definition at line 113 of file LegacyPasswordWriter.cs.

Property Documentation

◆ PasswordHash

string NanoXLSX.Internal.Writers.LegacyPasswordWriter.PasswordHash
getset

Gets or sets the password hash.

Definition at line 36 of file LegacyPasswordWriter.cs.

◆ Type

PasswordType NanoXLSX.Internal.Writers.LegacyPasswordWriter.Type
get

Current target type of the password instance.

Definition at line 31 of file LegacyPasswordWriter.cs.


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