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
Afficher le fichier Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Свойство Type Description
m_cache SIL.FieldWorks.FDO.FdoCache
m_repoObj ICmObjectRepository
m_writer System.Xml.XmlWriter
m_wsManager IWritingSystemManager

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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

Méthode 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 méthode

public AddObj ( int hvoItem, IVwViewConstructor vc, int frag ) : void
hvoItem int
vc IVwViewConstructor
frag int
Résultat void

AddObjProp() public méthode

public AddObjProp ( int tag, IVwViewConstructor vc, int frag ) : void
tag int
vc IVwViewConstructor
frag int
Résultat void

AddObjVecItems() public méthode

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
Résultat void

AddProp() public méthode

public AddProp ( int tag, IVwViewConstructor vc, int frag ) : void
tag int
vc IVwViewConstructor
frag int
Résultat void

AddString() public méthode

public AddString ( ITsString tss ) : void
tss ITsString
Résultat void

AddStringAltMember() public méthode

public AddStringAltMember ( int tag, int ws, IVwViewConstructor _vwvc ) : void
tag int
ws int
_vwvc IVwViewConstructor
Résultat void

AddStringProp() public méthode

public AddStringProp ( int tag, IVwViewConstructor _vwvc ) : void
tag int
_vwvc IVwViewConstructor
Résultat void

AddTsString() public méthode

public AddTsString ( ITsString tss ) : void
tss ITsString
Résultat void

AddUnicodeProp() public méthode

public AddUnicodeProp ( int tag, int ws, IVwViewConstructor _vwvc ) : void
tag int
ws int
_vwvc IVwViewConstructor
Résultat void

CloseTheObject() protected méthode

protected CloseTheObject ( ) : void
Résultat void

Create() public static méthode

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
Résultat InterlinearExporter

ExportDisplay() public méthode

public ExportDisplay ( ) : void
Résultat void

InterlinearExporter() protected méthode

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
Résultat System

NoteDependency() public méthode

public NoteDependency ( int _rghvo, int rgtag, int chvo ) : void
_rghvo int
rgtag int
chvo int
Résultat void

OpenTheObject() protected méthode

protected OpenTheObject ( int hvo, int ihvo ) : void
hvo int
ihvo int
Résultat void

UpdateWsList() protected méthode

protected UpdateWsList ( int ws ) : void
ws int
Résultat void

WriteBeginDocument() public méthode

public WriteBeginDocument ( ) : void
Résultat void

WriteEndDocument() public méthode

public WriteEndDocument ( ) : void
Résultat void

WriteGuidAttributeForCurrentObj() protected méthode

protected WriteGuidAttributeForCurrentObj ( ) : System.Guid
Résultat System.Guid

WriteGuidAttributeForObj() protected méthode

protected WriteGuidAttributeForObj ( int hvo ) : System.Guid
hvo int
Résultat System.Guid

WriteStartMorpheme() protected méthode

protected WriteStartMorpheme ( int hvo ) : void
hvo int
Résultat void

WriteStartParagraph() protected méthode

protected WriteStartParagraph ( int hvo ) : void
hvo int
Résultat void

WriteStartPhrase() protected méthode

protected WriteStartPhrase ( int hvo ) : void
hvo int
Résultat void

WriteStartWord() protected méthode

protected WriteStartWord ( int hvo ) : void
hvo int
Résultat void

Property Details

m_cache protected_oe property

protected FdoCache,SIL.FieldWorks.FDO m_cache
Résultat SIL.FieldWorks.FDO.FdoCache

m_repoObj protected_oe property

protected ICmObjectRepository m_repoObj
Résultat ICmObjectRepository

m_writer protected_oe property

protected XmlWriter,System.Xml m_writer
Résultat System.Xml.XmlWriter

m_wsManager protected_oe property

protected IWritingSystemManager m_wsManager
Résultat IWritingSystemManager