C# Class Sfm2Xml.ClsFieldDescription

This class implements the data structure for the "fieldDescriptions" mapping element. This element contains all the "field" elements that can be in the input data file. Attributes of "field": - sfm : this is the text of the field / marker that is used in the input file.

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

Protected Properties

Свойство	Type	Description
m_Abbr	bool
m_AbbrOrName	bool
m_AutoImport	bool
m_AutoSfm	string
m_Excluded	bool
m_Language	string
m_Meaning	string
m_Name	string
m_OtherAttributes	string
m_RefFunc	string
m_RefFuncWS	string
m_Sfm	string
m_Type	string
m_autoFieldClass	string
m_autofieldInfo	Hashtable
m_meaningApp	string
m_meaningId	string
m_xmlLanguage	string

Méthodes publiques

Méthode	Description
AddAutoFieldInfo ( string className, string fwDest ) : void
ClearRef ( ) : void
ClsFieldDescription ( ) : System
ClsFieldDescription ( string sfm ) : System
NextNewSFM ( ) : string
Output ( Hashtable languages, System xmlOutput, Hashtable &langsToIgnore, Hashtable &fieldsToIgnore ) : bool
ReadAndOutputXmlNode ( System fieldNode, Hashtable languages, string topAnalysisWS, System xmlOutput, Hashtable &langsToIgnore, Hashtable &fieldsToIgnore ) : bool
ReadXmlNode ( System fieldNode, Hashtable languages, string topAnalysisWS ) : bool
ToString ( ) : string
ToXmlLangString ( System xmlOutput ) : string
ToXmlString ( ) : string
UpdateLanguageValues ( string longName, string shortName ) : void

Méthodes protégées

Méthode	Description
ClsFieldDescription ( string marker, string name, string datatype, string lang, bool abbr, string fwID ) : System
MakeValidFwId ( string value ) : string
SetAutoSfm ( ) : void
ToXmlBaseString ( bool useXMLLang, System xmlOutput ) : string

Private Methods

Méthode	Description
ContainsInvalidSFMCharacters ( ) : bool	Test the sfm marker characters for validness in the xml elements.
Init ( ) : void
IsValidSFMName ( ) : bool
RebuildMeaningEntry ( System xmlOutput, string topAnalysisWS ) : void

Method Details

AddAutoFieldInfo() public méthode

public AddAutoFieldInfo ( string className, string fwDest ) : void
className	string
fwDest	string
Résultat	void

ClearRef() public méthode

public ClearRef ( ) : void
Résultat	void

ClsFieldDescription() public méthode

public ClsFieldDescription ( ) : System
Résultat	System

ClsFieldDescription() public méthode

public ClsFieldDescription ( string sfm ) : System
sfm	string
Résultat	System

ClsFieldDescription() protected méthode

protected ClsFieldDescription ( string marker, string name, string datatype, string lang, bool abbr, string fwID ) : System
marker	string
name	string
datatype	string
lang	string
abbr	bool
fwID	string
Résultat	System

MakeValidFwId() protected méthode

protected MakeValidFwId ( string value ) : string
value	string
Résultat	string

NextNewSFM() static public méthode

static public NextNewSFM ( ) : string
Résultat	string

Output() public méthode

public Output ( Hashtable languages, System xmlOutput, Hashtable &langsToIgnore, Hashtable &fieldsToIgnore ) : bool
languages	Hashtable
xmlOutput	System
langsToIgnore	Hashtable
fieldsToIgnore	Hashtable
Résultat	bool

ReadAndOutputXmlNode() public méthode

public ReadAndOutputXmlNode ( System fieldNode, Hashtable languages, string topAnalysisWS, System xmlOutput, Hashtable &langsToIgnore, Hashtable &fieldsToIgnore ) : bool
fieldNode	System
languages	Hashtable
topAnalysisWS	string
xmlOutput	System
langsToIgnore	Hashtable
fieldsToIgnore	Hashtable
Résultat	bool

ReadXmlNode() public méthode

public ReadXmlNode ( System fieldNode, Hashtable languages, string topAnalysisWS ) : bool
fieldNode	System
languages	Hashtable
topAnalysisWS	string
Résultat	bool

SetAutoSfm() protected méthode

protected SetAutoSfm ( ) : void
Résultat	void

ToString() public méthode

public ToString ( ) : string
Résultat	string

ToXmlBaseString() protected méthode

protected ToXmlBaseString ( bool useXMLLang, System xmlOutput ) : string
useXMLLang	bool
xmlOutput	System
Résultat	string

ToXmlLangString() public méthode

public ToXmlLangString ( System xmlOutput ) : string
xmlOutput	System
Résultat	string

ToXmlString() public méthode

public ToXmlString ( ) : string
Résultat	string

UpdateLanguageValues() public méthode

public UpdateLanguageValues ( string longName, string shortName ) : void
longName	string
shortName	string
Résultat	void

Property Details

m_Abbr protected_oe property

protected bool m_Abbr
Résultat	bool

m_AbbrOrName protected_oe property

protected bool m_AbbrOrName
Résultat	bool

m_AutoImport protected_oe property

protected bool m_AutoImport
Résultat	bool

m_AutoSfm protected_oe property

protected string m_AutoSfm
Résultat	string

m_Excluded protected_oe property

protected bool m_Excluded
Résultat	bool

m_Language protected_oe property

protected string m_Language
Résultat	string

m_Meaning protected_oe property

protected string m_Meaning
Résultat	string

m_Name protected_oe property

protected string m_Name
Résultat	string

m_OtherAttributes protected_oe property

protected string m_OtherAttributes
Résultat	string

m_RefFunc protected_oe property

protected string m_RefFunc
Résultat	string

m_RefFuncWS protected_oe property

protected string m_RefFuncWS
Résultat	string

m_Sfm protected_oe property

protected string m_Sfm
Résultat	string

m_Type protected_oe property

protected string m_Type
Résultat	string

m_autoFieldClass protected_oe property

protected string m_autoFieldClass
Résultat	string

m_autofieldInfo protected_oe property

protected Hashtable m_autofieldInfo
Résultat	Hashtable

m_meaningApp protected_oe property

protected string m_meaningApp
Résultat	string

m_meaningId protected_oe property

protected string m_meaningId
Résultat	string

m_xmlLanguage protected_oe property

protected string m_xmlLanguage
Résultat	string