Flynet Viewer .NET Programmer's Reference

load Method

load Method

Previous topic Next topic  

load Method

Previous topic Next topic  

 

Load a definition file.

 

void load(String fileName);

void load(String fileName, bool monitorChanges);

 

Arguments

 

ScreenDefControl

 Required. ScreenDefControl object.

 

fileName

 Required. The name of a definition file.

 

MonitorChanges

 Optional. If set to FALSE then the definition will be removed from the list in the registry.

 

Remarks

 

The fileName must only be that of a file with an XML extension and must not contain any path information. The XML file must reside in the folder specified by the "Definition Files Folder" setting in the Admin Console.

 

If the MonitorChanges property is set to TRUE the following scenario occurs:

The definitions file is added to the auto start list in the registry (if it does not already exist there).

The file will be loaded if it isn't already loaded.

If the file is modified it will be automatically reloaded.

 

If the MonitorChanges property is set to FALSE the following scenario occurs:

The file is loaded into memory.

If the file is modified it is not reloaded.

If the file exists in the auto start list in the registry it is removed from the list.

 

The auto start list in the registry can be found in the "DefinitionsList" entry under the "HKLM\SOFTWARE\Flynet\Viewer\Settings" key.

 

Any definitions that exist in the auto start list are automatically loaded. This means that the ScreenDefControl.load method is not needed for these definitions.

 

Requirements

 

Flynet Viewer

 

See Also

 

MapField | ScreenDef | ScreenMap | getScreenDef | HostScreen.getScreenDef | getScreenName | mappedGet | mappedSet | mappedRowGet | mappedRowSet

 

Applies To: ScreenDefControl object

 


© 2016 Inventu Corporation, Flynet LTD