C# Class SIL.FieldWorks.IText.InterlinearExporter

InterlinearExporter is an IVwEnv implementation which exports interlinear data to an XmlWriter. Make one of these by creating an XmlTextWriter.

Inheritance: SIL.FieldWorks.Common.RootSites.CollectorEnv

Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_cache	SIL.FieldWorks.FDO.FdoCache
m_repoObj	ICmObjectRepository
m_writer	System.Xml.XmlWriter
m_wsManager	IWritingSystemManager

Public Methods

Method	Description
AddObj ( int hvoItem, IVwViewConstructor vc, int frag ) : void
AddObjProp ( int tag, IVwViewConstructor vc, int frag ) : void
AddObjVecItems ( int tag, IVwViewConstructor vc, int frag ) : void	This method (as far as I know) will be first called on the StText object, and then recursively from the base implementation for vector items in component objects.
AddProp ( int tag, IVwViewConstructor vc, int frag ) : void
AddString ( ITsString tss ) : void
AddStringAltMember ( int tag, int ws, IVwViewConstructor _vwvc ) : void
AddStringProp ( int tag, IVwViewConstructor _vwvc ) : void
AddTsString ( ITsString tss ) : void
AddUnicodeProp ( int tag, int ws, IVwViewConstructor _vwvc ) : void
Create ( string mode, SIL.FieldWorks.FDO.FdoCache cache, XmlWriter writer, ICmObject objRoot, SIL.FieldWorks.IText.InterlinLineChoices lineChoices, InterlinVc vc ) : InterlinearExporter
ExportDisplay ( ) : void
NoteDependency ( int _rghvo, int rgtag, int chvo ) : void
WriteBeginDocument ( ) : void
WriteEndDocument ( ) : void

Protected Methods

Method	Description
CloseTheObject ( ) : void
InterlinearExporter ( SIL.FieldWorks.FDO.FdoCache cache, XmlWriter writer, ICmObject objRoot, SIL.FieldWorks.IText.InterlinLineChoices lineChoices, InterlinVc vc ) : System
OpenTheObject ( int hvo, int ihvo ) : void
UpdateWsList ( int ws ) : void
WriteGuidAttributeForCurrentObj ( ) : System.Guid
WriteGuidAttributeForObj ( int hvo ) : System.Guid
WriteStartMorpheme ( int hvo ) : void
WriteStartParagraph ( int hvo ) : void
WriteStartPhrase ( int hvo ) : void
WriteStartWord ( int hvo ) : void

Private Methods

Method	Description
CloseItem ( ) : void
GetMarkedGloss ( int hvo, int tag, int ws ) : ITsString	Glosses must be marked as proclitics or enclitics. See LT-8288.
GetText ( ITsString tss ) : string
GetWsFromTsString ( ITsString tss ) : int
OpenItem ( string itemType ) : void
SetRootObject ( ICmObject objRoot ) : void	This allows the exporter to be called multiple times with different roots.
SetTextTitleAndMetadata ( IStText txt ) : void	Sets title, abbreviation, source and comment(description) data for the text.
WriteItem ( int tag, string itemType, int alt ) : void
WriteItem ( string itemType, ITsString tss ) : void
WriteLangAndContent ( int ws, ITsString tss ) : void	Write a lang attribute identifying the string, then its content as the body of an element.
WritePendingItem ( string itemType, ITsString &tss ) : void	Write an item consisting of the specified string, and clear it.
WritePrefixLangAlt ( int ws, int tag ) : void

Method Details

AddObj() public method

public AddObj ( int hvoItem, IVwViewConstructor vc, int frag ) : void
hvoItem	int
vc	IVwViewConstructor
frag	int
return	void

AddObjProp() public method

public AddObjProp ( int tag, IVwViewConstructor vc, int frag ) : void
tag	int
vc	IVwViewConstructor
frag	int
return	void

AddObjVecItems() public method

This method (as far as I know) will be first called on the StText object, and then recursively from the base implementation for vector items in component objects.

public AddObjVecItems ( int tag, IVwViewConstructor vc, int frag ) : void
tag	int
vc	IVwViewConstructor
frag	int
return	void

AddProp() public method

public AddProp ( int tag, IVwViewConstructor vc, int frag ) : void
tag	int
vc	IVwViewConstructor
frag	int
return	void

AddString() public method

public AddString ( ITsString tss ) : void
tss	ITsString
return	void

AddStringAltMember() public method

public AddStringAltMember ( int tag, int ws, IVwViewConstructor _vwvc ) : void
tag	int
ws	int
_vwvc	IVwViewConstructor
return	void

AddStringProp() public method

public AddStringProp ( int tag, IVwViewConstructor _vwvc ) : void
tag	int
_vwvc	IVwViewConstructor
return	void

AddTsString() public method

public AddTsString ( ITsString tss ) : void
tss	ITsString
return	void

AddUnicodeProp() public method

public AddUnicodeProp ( int tag, int ws, IVwViewConstructor _vwvc ) : void
tag	int
ws	int
_vwvc	IVwViewConstructor
return	void

CloseTheObject() protected method

protected CloseTheObject ( ) : void
return	void

Create() public static method

public static Create ( string mode, SIL.FieldWorks.FDO.FdoCache cache, XmlWriter writer, ICmObject objRoot, SIL.FieldWorks.IText.InterlinLineChoices lineChoices, InterlinVc vc ) : InterlinearExporter
mode	string
cache	SIL.FieldWorks.FDO.FdoCache
writer	System.Xml.XmlWriter
objRoot	ICmObject
lineChoices	SIL.FieldWorks.IText.InterlinLineChoices
vc	InterlinVc
return	InterlinearExporter

ExportDisplay() public method

public ExportDisplay ( ) : void
return	void

InterlinearExporter() protected method

protected InterlinearExporter ( SIL.FieldWorks.FDO.FdoCache cache, XmlWriter writer, ICmObject objRoot, SIL.FieldWorks.IText.InterlinLineChoices lineChoices, InterlinVc vc ) : System
cache	SIL.FieldWorks.FDO.FdoCache
writer	System.Xml.XmlWriter
objRoot	ICmObject
lineChoices	SIL.FieldWorks.IText.InterlinLineChoices
vc	InterlinVc
return	System

NoteDependency() public method

public NoteDependency ( int _rghvo, int rgtag, int chvo ) : void
_rghvo	int
rgtag	int
chvo	int
return	void

OpenTheObject() protected method

protected OpenTheObject ( int hvo, int ihvo ) : void
hvo	int
ihvo	int
return	void

UpdateWsList() protected method

protected UpdateWsList ( int ws ) : void
ws	int
return	void

WriteBeginDocument() public method

public WriteBeginDocument ( ) : void
return	void

WriteEndDocument() public method

public WriteEndDocument ( ) : void
return	void

WriteGuidAttributeForCurrentObj() protected method

protected WriteGuidAttributeForCurrentObj ( ) : System.Guid
return	System.Guid

WriteGuidAttributeForObj() protected method

protected WriteGuidAttributeForObj ( int hvo ) : System.Guid
hvo	int
return	System.Guid

WriteStartMorpheme() protected method

protected WriteStartMorpheme ( int hvo ) : void
hvo	int
return	void

WriteStartParagraph() protected method

protected WriteStartParagraph ( int hvo ) : void
hvo	int
return	void

WriteStartPhrase() protected method

protected WriteStartPhrase ( int hvo ) : void
hvo	int
return	void

WriteStartWord() protected method

protected WriteStartWord ( int hvo ) : void
hvo	int
return	void

Property Details

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
return	SIL.FieldWorks.FDO.FdoCache

m_repoObj protected_oe property

protected ICmObjectRepository m_repoObj
return	ICmObjectRepository

m_writer protected_oe property

protected XmlWriter,System.Xml m_writer
return	System.Xml.XmlWriter

m_wsManager protected_oe property

protected IWritingSystemManager m_wsManager
return	IWritingSystemManager