C# Class Sfm2Xml.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.

Inheritance: ILexImportFields

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
AddCustomField ( int classID, ILexImportCustomField field ) : bool	add a field to the given class
AddCustomImportFields ( Sfm2Xml customFields ) : bool	read the passed in list of additional fields (should be custom ones) and add them to the list of fields.
AddField ( string className, string partOf, ILexImportField field ) : bool	add a field to the given class
ContainsCustomField ( string key ) : bool
FieldsForClass ( string className ) : ICollection	get the field names for a given class of fields
GetAutoField ( string className ) : ILexImportField
GetAutoFields ( ) : ILexImportField>.Dictionary
GetCustomField ( ClsCustomFieldDescription cfIn ) : ILexImportCustomField
GetCustomField ( LexImportCustomField cfIn ) : ILexImportCustomField
GetCustomFieldClassFromClassID ( int classID ) : string
GetDestinationForName ( string name, string &className, string &fieldName ) : bool
GetField ( string fwDest, string &className ) : ILexImportField
GetUIDestForName ( string fieldName ) : string
HierarchForClass ( string className ) : string
LexImportFields ( ) : System

Private Methods

Method	Description
Initialize ( ) : bool	Any additional initialization processing could be done here. This is after the file has been read and before it's used.
ReadAClassNode ( System node ) : bool
ReadLexImportFields ( string xmlFileName ) : bool
ReadSignatureNode ( System node ) : bool

Method Details

AddCustomField() public method

add a field to the given class

public AddCustomField ( int classID, ILexImportCustomField field ) : bool
classID	int
field	ILexImportCustomField
return	bool

AddCustomImportFields() public method

read the passed in list of additional fields (should be custom ones) and add them to the list of fields.

public AddCustomImportFields ( Sfm2Xml customFields ) : bool
customFields	Sfm2Xml
return	bool

AddField() public method

add a field to the given class

public AddField ( string className, string partOf, ILexImportField field ) : bool
className	string
partOf	string
field	ILexImportField
return	bool

ContainsCustomField() public method

public ContainsCustomField ( string key ) : bool
key	string
return	bool

FieldsForClass() public method

get the field names for a given class of fields

public FieldsForClass ( string className ) : ICollection
className	string
return	ICollection

GetAutoField() public method

public GetAutoField ( string className ) : ILexImportField
className	string
return	ILexImportField

GetAutoFields() public method

public GetAutoFields ( ) : ILexImportField>.Dictionary
return	ILexImportField>.Dictionary

GetCustomField() public method

public GetCustomField ( ClsCustomFieldDescription cfIn ) : ILexImportCustomField
cfIn	ClsCustomFieldDescription
return	ILexImportCustomField

GetCustomField() public method

public GetCustomField ( LexImportCustomField cfIn ) : ILexImportCustomField
cfIn	LexImportCustomField
return	ILexImportCustomField

GetCustomFieldClassFromClassID() public method

public GetCustomFieldClassFromClassID ( int classID ) : string
classID	int
return	string

GetDestinationForName() public method

public GetDestinationForName ( string name, string &className, string &fieldName ) : bool
name	string
className	string
fieldName	string
return	bool

GetField() public method

public GetField ( string fwDest, string &className ) : ILexImportField
fwDest	string
className	string
return	ILexImportField

GetUIDestForName() public method

public GetUIDestForName ( string fieldName ) : string
fieldName	string
return	string

HierarchForClass() public method

public HierarchForClass ( string className ) : string
className	string
return	string

LexImportFields() public method

public LexImportFields ( ) : System
return	System