C# Class SIL.FieldWorks.Common.Controls.LayoutCache

This class caches the layout and part inventories and optimizes looking up a particular item.

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Properties

Property	Type	Description
LayoutVersionNumber	int

Public Methods

Method	Description
GetNode ( int clsid, string layoutName, bool fIncludeLayouts ) : XmlNode	Gets the node.
InitializeLayoutsForWsTag ( string sWsTag, string sDatabase ) : void	Displaying Reversal Indexes requires expanding a variable number of writing system specific layouts. This method does that for a specific writing system and database.
InitializePartInventories ( string sDatabase, IApp app, String projectPath ) : void	Initializes the part inventories.
InitializePartInventories ( string sDatabase, IApp app, bool fLoadUserOverrides, String projectPath ) : void	Initialize the part inventories.
LayoutCache ( IFwMetaDataCache mdc, Inventory layouts, Inventory parts ) : System	Initializes a new instance of the LayoutCache class.
LayoutCache ( IFwMetaDataCache mdc, string sDatabase, IApp app, String projectPath ) : System	Initializes a new instance of the LayoutCache class.

Method Details

GetNode() public method

Gets the node.

public GetNode ( int clsid, string layoutName, bool fIncludeLayouts ) : XmlNode
clsid	int	The CLSID.
layoutName	string	Name of the layout.
fIncludeLayouts	bool	if set to true [f include layouts].
return	System.Xml.XmlNode

InitializeLayoutsForWsTag() public static method

Displaying Reversal Indexes requires expanding a variable number of writing system specific layouts. This method does that for a specific writing system and database.

public static InitializeLayoutsForWsTag ( string sWsTag, string sDatabase ) : void
sWsTag	string
sDatabase	string
return	void

InitializePartInventories() public static method

Initializes the part inventories.

public static InitializePartInventories ( string sDatabase, IApp app, String projectPath ) : void
sDatabase	string	The name of the database.
app	IApp	The application.
projectPath	String	The path to the project folder.
return	void

InitializePartInventories() public static method

Initialize the part inventories.

public static InitializePartInventories ( string sDatabase, IApp app, bool fLoadUserOverrides, String projectPath ) : void
sDatabase	string
app	IApp
fLoadUserOverrides	bool
projectPath	String
return	void

LayoutCache() public method

Initializes a new instance of the LayoutCache class.

public LayoutCache ( IFwMetaDataCache mdc, Inventory layouts, Inventory parts ) : System
mdc	IFwMetaDataCache	The MDC.
layouts	Inventory	The layouts.
parts	Inventory	The parts.
return	System

LayoutCache() public method

Initializes a new instance of the LayoutCache class.

public LayoutCache ( IFwMetaDataCache mdc, string sDatabase, IApp app, String projectPath ) : System
mdc	IFwMetaDataCache	The MDC.
sDatabase	string	The database name.
app	IApp	The application.
projectPath	String	The project folder.
return	System

Property Details

LayoutVersionNumber public static property

Layout Version Number (last updated by JohnT, 18 June 2013, as part of LT-14656).

Note: often we also want to update BrowseViewer.kBrowseViewVersion.

public static int LayoutVersionNumber
return	int