C# Class SILUBS.SharedScrUtils.VersificationTable

Manipulate information for standard chatper/verse schemes

Afficher le fichier Open project: sillsdev/FieldWorks Class Usage Examples

Méthodes publiques

Méthode	Description
ChangeVersification ( IVerseReference vref ) : void	Change the passed VerseRef to be this versification.
Get ( ScrVers vers ) : VersificationTable	Get the versification table for this versification
GetFileNameForVersification ( ScrVers vers ) : string	Gets the name of this requested versification file.
Initialize ( string vrsFolder ) : void	This method should be called once before an application accesses anything that requires versification info. TODO: Paratext needs to call this with ScrTextCollection.SettingsDirectory.
LastBook ( ) : int
LastChapter ( int bookNum ) : int	Last chapter number in this book.
LastVerse ( int bookNum, int chapterNum ) : int	Last verse number in this book/chapter.

Private Methods

Méthode	Description
FileName ( ScrVers vers ) : string
ParseChapterVerseLine ( string fileName, VersificationTable versification, string line ) : void
ParseMappingLine ( string fileName, VersificationTable versification, string line ) : void
ReadVersificationFile ( string fileName, VersificationTable versification ) : void	Read versification file and "add" its entries. At the moment we only do this once. Eventually we will call this twice. Once for the standard versification, once for custom entries in versification.vrs file for this project.
VersificationTable ( ScrVers vers ) : System

Method Details

ChangeVersification() public méthode

Change the passed VerseRef to be this versification.

public ChangeVersification ( IVerseReference vref ) : void
vref	IVerseReference
Résultat	void

Get() public static méthode

Get the versification table for this versification

public static Get ( ScrVers vers ) : VersificationTable
vers	ScrVers
Résultat	VersificationTable

GetFileNameForVersification() public static méthode

Gets the name of this requested versification file.

public static GetFileNameForVersification ( ScrVers vers ) : string
vers	ScrVers	Versification scheme
Résultat	string

Initialize() public static méthode

This method should be called once before an application accesses anything that requires versification info. TODO: Paratext needs to call this with ScrTextCollection.SettingsDirectory.

public static Initialize ( string vrsFolder ) : void
vrsFolder	string	Path to the folder containing the .vrs files
Résultat	void

LastBook() public méthode

public LastBook ( ) : int
Résultat	int

LastChapter() public méthode

Last chapter number in this book.

public LastChapter ( int bookNum ) : int
bookNum	int
Résultat	int

LastVerse() public méthode

Last verse number in this book/chapter.

public LastVerse ( int bookNum, int chapterNum ) : int
bookNum	int
chapterNum	int
Résultat	int