C# (CSharp) Sfm2Xml Namespace

Classes

Name Description
ByteReader Replacement reader class for byte reading.
ClsCustomFieldDescription
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.
ClsFieldDescriptionWrapper This class serves as a wrapper for the ClsFieldDescription class so that properties can be set at construction time.
ClsHierarchyEntry This class implements the data structure for the "hierarchy" mapping element. This element contains any number of "level" elements which define a hierarchy level. Attributes of "level" are: - name : (R) the name of this type - partOf : (R) this is a list of "levels" that this one can belong to. - beginFields : (R) this is a list of "field"-"sfm" values that defines which fields can be used to start a new "level". - additionalFields : (O) this is a list of "field"-"sfm" values that are allowed for this type. - multiFields : (O) this is a list of "field"-"sfm" values that can have multiple entries at this current level. - uniqueFields: (O) this is a list of "field"-"sfm" values that can only be used one time in each entry. It is used to override allowing multiple begin fields that are different to be combined in a given field/object.
ClsInFieldMarker
ClsLanguage Summary description for ClsLanguage.
ClsLog This 'log' class servers as a common location for capturing error and warning messages that are captured during the conversion process. They are accumulated and then added to the output xml file at the end.
FollowedByInfo
IsSfmFile This class if for checking to see if the passed in file name is a valid sfm file.
LanguageInfoUI This class contains the Language info that is used and displayed in the UI. It's primarly used for mapping the FW writing system and encoding converter to the key that is used in the map file.
LexImportCustomField
LexImportField This class is used to contain the field element in the FW import fields xml file
LexImportFields This container holds the import fields that were read in from the controled xml file that is used for mapping the markers in the import data to the fields used in FieldWorks. Properties show up in the Content Mappings page as well as the Modify mapping dlg.
STATICS This class exists as a common place for putting static methods for the Sfm2Xml namespace.
SfmData
SfmField This class represents one field (which may be one line or multiple lines) from a standard format file.
SfmFile This is like SfmReader except that it stores the data for all the lines. It also stores the Shoebox private marker lines like SfmReaderEx.
SfmFileReader
SfmFileReaderEx
WrnErrInfo