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.
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property 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

Public Methods

Method 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

Protected Methods

Method 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

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

public AddAutoFieldInfo ( string className, string fwDest ) : void
className string
fwDest string
return void

ClearRef() public method

public ClearRef ( ) : void
return void

ClsFieldDescription() public method

public ClsFieldDescription ( ) : System
return System

ClsFieldDescription() public method

public ClsFieldDescription ( string sfm ) : System
sfm string
return System

ClsFieldDescription() protected method

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

MakeValidFwId() protected method

protected MakeValidFwId ( string value ) : string
value string
return string

NextNewSFM() static public method

static public NextNewSFM ( ) : string
return string

Output() public method

public Output ( Hashtable languages, System xmlOutput, Hashtable &langsToIgnore, Hashtable &fieldsToIgnore ) : bool
languages Hashtable
xmlOutput System
langsToIgnore Hashtable
fieldsToIgnore Hashtable
return bool

ReadAndOutputXmlNode() public method

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

ReadXmlNode() public method

public ReadXmlNode ( System fieldNode, Hashtable languages, string topAnalysisWS ) : bool
fieldNode System
languages Hashtable
topAnalysisWS string
return bool

SetAutoSfm() protected method

protected SetAutoSfm ( ) : void
return void

ToString() public method

public ToString ( ) : string
return string

ToXmlBaseString() protected method

protected ToXmlBaseString ( bool useXMLLang, System xmlOutput ) : string
useXMLLang bool
xmlOutput System
return string

ToXmlLangString() public method

public ToXmlLangString ( System xmlOutput ) : string
xmlOutput System
return string

ToXmlString() public method

public ToXmlString ( ) : string
return string

UpdateLanguageValues() public method

public UpdateLanguageValues ( string longName, string shortName ) : void
longName string
shortName string
return void

Property Details

m_Abbr protected property

protected bool m_Abbr
return bool

m_AbbrOrName protected property

protected bool m_AbbrOrName
return bool

m_AutoImport protected property

protected bool m_AutoImport
return bool

m_AutoSfm protected property

protected string m_AutoSfm
return string

m_Excluded protected property

protected bool m_Excluded
return bool

m_Language protected property

protected string m_Language
return string

m_Meaning protected property

protected string m_Meaning
return string

m_Name protected property

protected string m_Name
return string

m_OtherAttributes protected property

protected string m_OtherAttributes
return string

m_RefFunc protected property

protected string m_RefFunc
return string

m_RefFuncWS protected property

protected string m_RefFuncWS
return string

m_Sfm protected property

protected string m_Sfm
return string

m_Type protected property

protected string m_Type
return string

m_autoFieldClass protected property

protected string m_autoFieldClass
return string

m_autofieldInfo protected property

protected Hashtable m_autofieldInfo
return Hashtable

m_meaningApp protected property

protected string m_meaningApp
return string

m_meaningId protected property

protected string m_meaningId
return string

m_xmlLanguage protected property

protected string m_xmlLanguage
return string