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
Mostra file Open project: brlima94/acat-localization Class Usage Examples

Public Methods

Method 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.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Disposer. Release resources and cleanup.

Private Methods

Method 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 method

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
return bool

Clear() public method

Clears all the abbreviations in the list
public Clear ( ) : void
return void

Dispose() public method

Disposes resources
public Dispose ( ) : void
return void

Dispose() protected method

Disposer. Release resources and cleanup.
protected Dispose ( bool disposing ) : void
disposing bool true to dispose managed resources
return void

Exists() public method

Checks if an abbreviation already exists in the list
public Exists ( String abbreviation ) : bool
abbreviation String the mnemonic
return bool

Load() public method

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
return bool

Lookup() public method

Returns the abbreviation object that corresponds to the mnemonic
public Lookup ( String mnemonic ) : ACAT.Lib.Core.AbbreviationsManagement.Abbreviation
mnemonic String Mnemonic to look for
return ACAT.Lib.Core.AbbreviationsManagement.Abbreviation

Remove() public method

Removes an abbreviation from the list
public Remove ( String abbreviation ) : bool
abbreviation String mnemonic of abbr to remove
return bool

Save() public method

Saves all the abbreviations from the sorted list to the abbreviations file
public Save ( ) : bool
return bool

Update() public method

Updates an existing abbreviation object.
public Update ( ACAT.Lib.Core.AbbreviationsManagement.Abbreviation abbreviation ) : bool
abbreviation ACAT.Lib.Core.AbbreviationsManagement.Abbreviation Abbreviation to update
return bool