• Home
• SIL
• FieldWorks
• Common
• RootSites
• CollectorEnv

C# Class SIL.FieldWorks.Common.RootSites.CollectorEnv

ファイルを表示 Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_baseEnv	IVwEnv
m_cda	IVwCacheDa
m_cpropPrev	PrevPropCounter
m_fGotNonPropInfo	bool
m_fIsPropOpen	bool
m_hvoCurr	int
m_mdc	IFwMetaDataCache
m_sda	ISilDataAccess
m_stack	List
m_tagCurrent	int
m_vectorItemIndex	int>.IDictionary
m_ws	int

Public Methods

Method	Description
AddDerivedProp ( int _rgtag, int ctag, IVwViewConstructor _vwvc, int frag ) : void	Also not implemented at all by VwEnv.
AddGenDateProp ( int tag ) : void	No easy way to implement this, it depends on a StrUni format method.
AddIntProp ( int tag ) : void	Member AddIntProp
AddIntPropPic ( int tag, IVwViewConstructor _vc, int frag, int nMin, int nMax ) : void	Member AddIntPropPic
AddLazyItems ( int _rghvo, int chvo, IVwViewConstructor _vwvc, int frag ) : void	Rarely if ever used.
AddLazyVecItems ( int tag, IVwViewConstructor vc, int frag ) : void	For our purpose, laziness is not relevant. Equivalent to the non-lazy version.
AddObj ( int hvoItem, IVwViewConstructor vc, int frag ) : void	Adds the obj.
AddObjProp ( int tag, IVwViewConstructor vc, int frag ) : void	Adds the obj prop.
AddObjVec ( int tag, IVwViewConstructor vc, int frag ) : void	Adds the obj vec.
AddObjVecItems ( int tag, IVwViewConstructor vc, int frag ) : void
AddPicture ( IPicture _pict, int tag, int dxmpWidth, int dympHeight ) : void	Member AddAdjustedPicture
AddPictureWithCaption ( IPicture _pict, int tag, ITsTextProps _ttpCaption, int hvoCmFile, int ws, int dxmpWidth, int dympHeight, IVwViewConstructor _vc ) : void	Member AddPicture
AddProp ( int tag, IVwViewConstructor vc, int frag ) : void	Adds the prop.
AddReversedObjVecItems ( int tag, IVwViewConstructor vc, int frag ) : void	Adds the obj vec items in reverse order.
AddSeparatorBar ( ) : void	A rather arbitrary way of representing a bar as a string.
AddSimpleRect ( int rgb, int dmpWidth, int dmpHeight, int dmpBaselineOffset ) : void
AddString ( ITsString tss ) : void	Adds the string.
AddStringAlt ( int tag ) : void	Add all the alternatives, in a very primitive arrangement. Not used much if at all.
AddStringAltMember ( int tag, int ws, IVwViewConstructor _vwvc ) : void	Member AddStringAltMember
AddStringAltSeq ( int tag, int _rgenc, int cws ) : void	An implementation equivalent to the IVwEnv one is fairly trivial, but so unsatisfactory that I'm sure we're not using it.
AddStringProp ( int tag, IVwViewConstructor _vwvc ) : void	Member AddStringProp
AddTimeProp ( int tag, uint flags ) : void	May need to do this one soon. Needs a new interface to give access to the IVwEnv internal methods.
AddTsString ( ITsString tss ) : void	Accumulate a TsString into our result. The base implementation does nothing.
AddUnicodeProp ( int tag, int ws, IVwViewConstructor _vwvc ) : void	Member AddUnicodeProp
AddWindow ( IVwEmbeddedWindow _ew, int dmpAscent, bool fJustifyRight, bool fAutoShow ) : void	Probably unused, but we'll put something in because a window is probably 'something' and therefore interesting to the TestCollectorEnv.
CloseDiv ( ) : void	Nothing to do here.
CloseInnerPile ( ) : void	Call virtual CloseParagraph
CloseParagraph ( ) : void	Nothing to do here.
CloseSpan ( ) : void
CloseTable ( ) : void	Nothing to do here.
CloseTableBody ( ) : void	Nothing to do here.
CloseTableCell ( ) : void	Nothing to do here.
CloseTableFooter ( ) : void	Nothing to do here.
CloseTableHeader ( ) : void	Nothing to do here.
CloseTableHeaderCell ( ) : void	Nothing to do here.
CloseTableRow ( ) : void	Nothing to do here.
CollectorEnv ( IVwEnv baseEnv, ISilDataAccess sda, int hvoRoot ) : System	Create one. If the base environment is not null, it is used for various things, such as obtaining 'outer object' information.
CurrentObject ( ) : int	Member CurrentObject
EmptyParagraphBehavior ( int behavior ) : void	Do nothing. This doesn't affect the collection of data.
GetOuterObject ( int iLevel, int &hvo, int &tag, int &ihvo ) : void	Gets the outer object.
IsParagraphOpen ( ) : bool	Current flow object is a paragraph. (But being in a span it will still be true.)
MakeColumnGroup ( int nColSpan, VwLength vlWidth ) : void	Nothing to do here. None of our collectors cares about flow object organization.
MakeColumns ( int nColSpan, VwLength vlWidth ) : void	Nothing to do here. None of our collectors cares about flow object organization.
NoteDependency ( int rghvo, int rgtag, int chvo ) : void	If we're capturing a test on top of a real VwEnv, pass the information on so things will regenerate properly.
NoteStringValDependency ( int hvo, int tag, int ws, ITsString _tssVal ) : void	If we're capturing a test on top of a real VwEnv, pass the information on so things will regenerate properly.
OpenConcPara ( int ichMinItem, int ichLimItem, VwConcParaOpts cpoFlags, int dmpAlign ) : void	Call virtual OpenParagraph
OpenDiv ( ) : void
OpenInnerPile ( ) : void	Call virtual OpenParagraph
OpenMappedPara ( ) : void	Call virtual OpenParagraph
OpenMappedTaggedPara ( ) : void	Call virtual OpenParagraph
OpenOverridePara ( int cOverrideProperties, DispPropOverride _rgOverrideProperties ) : void	Call virtual OpenParagraph
OpenParagraph ( ) : void	Nothing to do here.
OpenSpan ( ) : void	Nothing to do here.
OpenTable ( int cCols, VwLength vlWidth, int mpBorder, VwAlignment vwalign, VwFramePosition frmpos, VwRule vwrule, int mpSpacing, int mpPadding, bool fSelectOneCol ) : void	Nothing to do here.
OpenTableBody ( ) : void	Nothing to do here.
OpenTableCell ( int nRowSpan, int nColSpan ) : void	Nothing to do here.
OpenTableFooter ( ) : void	Nothing to do here.
OpenTableHeader ( ) : void	Nothing to do here.
OpenTableHeaderCell ( int nRowSpan, int nColSpan ) : void
OpenTableRow ( ) : void	Nothing to do here.
OpenTaggedPara ( ) : void	Call virtual OpenParagraph
PostProcess ( string sXsltFile, string sOutputFile, int iPass ) : void	Optionally apply an XSLT to the output file.
ProcessXsltForPass ( string sXsltFile, string sOutputFile, int iPass ) : void	Apply the XSLT to the output file, first renaming it so that the user sees the expected final output file.
RenameOutputToPassN ( string sOutputFile, int iPass ) : string	Renames the output to pass N.
Reset ( ) : void	Resets this instance.
SetParagraphMark ( VwBoundaryMark boundaryMark ) : void	Member SetParagraphMark
get_StringWidth ( ITsString tss, ITsTextProps _ttp, int &dmpx, int &dmpy ) : void	Answer some arbitrary guess. The string length is not very good, but probably good enough for collector results. Non-zero (except for empty strings) in case something divides by it.
set_IntProperty ( int tpt, int tpv, int nValue ) : void	Nothing to do here. None of our collectors cares about integer properties (yet).
set_StringProperty ( int sp, string bstrValue ) : void	Nothing to do here. None of our collectors cares about string properties (yet).

Protected Methods

Method	Description
AddResultString ( string s ) : void	Accumulate a string into our result. The base implementation does nothing.
CPropPrev ( int tag ) : int	Gets the count of previous occurrences of the given property at our current stack level.
CheckForNonPropInfo ( ) : void	See whether anything has been added to the view while no property was open, and if so, bump the gap-in-attrs count.
CloseFlowObject ( ) : void	Closes a flow object. Default implementation doesn't care about flow object organization.
CloseProp ( ) : void	Closes the prop. Does nothing as yet, but keeps things analogous to real VwEnv.
CloseTheObject ( ) : void	Closes the object.
ConvertVwEnvStackToSelLevInfo ( IList locationStack, int cPropPrevRootLevel ) : SelLevInfo[]	Converts the VwEnv Collector Stack to a SelLevInfo array.
DisplayThisObject ( int hvoItem, int tag ) : bool	Sub-classes can override
OpenFlowObject ( ) : void	Opens a flow object. Default only cares for the purpose of keeping track of non-property things added, which affects our count of gaps in properties, which is important for figuring out which literal a selection is part of.
OpenProp ( int tag ) : void	Opens the prop.
OpenProp ( int tag, int ws ) : void	Opens the prop.
OpenTheObject ( int hvo, int ihvo ) : void	Opens the object.
OpenVecProp ( int tag ) : void	calls OpenProp and starts tracking the vector property.
PopStack ( ) : StackItem	context stack

Private Methods

Method	Description
AddResultString ( string s, int ws ) : void	Accumulate a string into our result, with known writing system. This base implementation ignores the writing system.
IncrementPropCount ( int tag ) : void	Increments the property count for the given tag.
NoteAddingSomething ( ) : void	Note that something (box, text, picture) is being added to the display.

Method Details

Property Details