C# Class ACAT.Lib.Core.AbbreviationsManagement.Abbreviations

Represents a sorted list of abbreviation objects. The list of abbreviations is created by parsing the xml file that has a list of all the abbreviations.

Inheritance: IDisposable

Afficher le fichier Open project: brlima94/acat-localization Class Usage Examples

Méthodes publiques

Méthode	Description
Add ( ACAT.Lib.Core.AbbreviationsManagement.Abbreviation abbreviation ) : bool	Adds the abbreviation object to the list. If it already exists, it is replaced.
Clear ( ) : void	Clears all the abbreviations in the list
Dispose ( ) : void	Disposes resources
Exists ( String abbreviation ) : bool	Checks if an abbreviation already exists in the list
Load ( String abbreviationsFile = null ) : bool	Loads abbreviations from the specified file. If filename is null, loads from the default file. Parses the XML file and populates the sorted list
Lookup ( String mnemonic ) : ACAT.Lib.Core.AbbreviationsManagement.Abbreviation	Returns the abbreviation object that corresponds to the mnemonic
Remove ( String abbreviation ) : bool	Removes an abbreviation from the list
Save ( ) : bool	Saves all the abbreviations from the sorted list to the abbreviations file
Update ( ACAT.Lib.Core.AbbreviationsManagement.Abbreviation abbreviation ) : bool	Updates an existing abbreviation object.

Méthodes protégées

Méthode	Description
Dispose ( bool disposing ) : void	Disposer. Release resources and cleanup.

Private Methods

Méthode	Description
closeAbbreviationFile ( XmlWriter xmlTextWriter ) : void	Writes the closing xml element and closes the xmltextwriter object
createAbbreviationsFile ( String fileName ) : XmlTextWriter	Creates an empty abbreviations file
createAndAddAbbreviation ( XmlNode node ) : void	Parses the xml node attributes from the xml nodeand creates an abbreviation object adds it to the sorted list

Method Details

Add() public méthode

Adds the abbreviation object to the list. If it already exists, it is replaced.

public Add ( ACAT.Lib.Core.AbbreviationsManagement.Abbreviation abbreviation ) : bool
abbreviation	ACAT.Lib.Core.AbbreviationsManagement.Abbreviation	Abbreviation to add
Résultat	bool

Clear() public méthode

Clears all the abbreviations in the list

public Clear ( ) : void
Résultat	void

Dispose() public méthode

Disposes resources

public Dispose ( ) : void
Résultat	void

Dispose() protected méthode

Disposer. Release resources and cleanup.

protected Dispose ( bool disposing ) : void
disposing	bool	true to dispose managed resources
Résultat	void

Exists() public méthode

Checks if an abbreviation already exists in the list

public Exists ( String abbreviation ) : bool
abbreviation	String	the mnemonic
Résultat	bool

Load() public méthode

Loads abbreviations from the specified file. If filename is null, loads from the default file. Parses the XML file and populates the sorted list

public Load ( String abbreviationsFile = null ) : bool
abbreviationsFile	String	name of the abbreviations file
Résultat	bool

Lookup() public méthode

Returns the abbreviation object that corresponds to the mnemonic

public Lookup ( String mnemonic ) : ACAT.Lib.Core.AbbreviationsManagement.Abbreviation
mnemonic	String	Mnemonic to look for
Résultat	ACAT.Lib.Core.AbbreviationsManagement.Abbreviation

Remove() public méthode

Removes an abbreviation from the list

public Remove ( String abbreviation ) : bool
abbreviation	String	mnemonic of abbr to remove
Résultat	bool

Save() public méthode

Saves all the abbreviations from the sorted list to the abbreviations file

public Save ( ) : bool
Résultat	bool

Update() public méthode

Updates an existing abbreviation object.

public Update ( ACAT.Lib.Core.AbbreviationsManagement.Abbreviation abbreviation ) : bool
abbreviation	ACAT.Lib.Core.AbbreviationsManagement.Abbreviation	Abbreviation to update
Résultat	bool