C# Class SIL.FieldWorks.XWorks.FwXApp

Summary description for XApp.
Inheritance: SIL.FieldWorks.Common.Framework.FwApp
ファイルを表示 Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property Type Description
m_appArgs SIL.FieldWorks.Common.FwUtils.FwAppArgs

Private Properties

Property Type Description

Public Methods

Method Description
DoApplicationInitialization ( IProgress progressDlg ) : void

Use this for slow operations that should happen during the splash screen instead of during app construction
FwXApp ( IFieldWorksManager fwManager, IHelpTopicProvider helpTopicProvider, SIL.FieldWorks.Common.FwUtils.FwAppArgs appArgs ) : System.Diagnostics.CodeAnalysis

Constructor.
HandleIncomingLink ( SIL.FieldWorks.Common.FwUtils.FwLinkArgs link ) : void

Handles the incoming link, after the right window of the right application on the right project has been activated. See the class comment on FwLinkArgs for details on how all the parts of hyperlinking work.
NewMainAppWnd ( IProgress progressDlg, bool isNewCache, Form wndCopyFrom, bool fOpeningNewProject ) : Form

Creates a new instance of the main X window
OnMasterRefresh ( object sender ) : void

This is the one (and should be only) handler for the user Refresh command. Refresh wants to first clean up the cache, then give things like Clerks a chance to reload stuff (calling the old OnRefresh methods), then give windows a chance to redisplay themselves.
Synchronize ( SyncMsg sync ) : bool

Method Details

DoApplicationInitialization() public method

Use this for slow operations that should happen during the splash screen instead of during app construction
public DoApplicationInitialization ( IProgress progressDlg ) : void
progressDlg IProgress The progress dialog to use.
return void

FwXApp() public method

Constructor.
public FwXApp ( IFieldWorksManager fwManager, IHelpTopicProvider helpTopicProvider, SIL.FieldWorks.Common.FwUtils.FwAppArgs appArgs ) : System.Diagnostics.CodeAnalysis
fwManager IFieldWorksManager The FieldWorks manager for dealing with FieldWorks-level /// stuff.
helpTopicProvider IHelpTopicProvider An application-specific help topic provider.
appArgs SIL.FieldWorks.Common.FwUtils.FwAppArgs The application arguments.
return System.Diagnostics.CodeAnalysis

HandleIncomingLink() public method

Handles the incoming link, after the right window of the right application on the right project has been activated. See the class comment on FwLinkArgs for details on how all the parts of hyperlinking work.
public HandleIncomingLink ( SIL.FieldWorks.Common.FwUtils.FwLinkArgs link ) : void
link SIL.FieldWorks.Common.FwUtils.FwLinkArgs The link.
return void

NewMainAppWnd() public method

Creates a new instance of the main X window
public NewMainAppWnd ( IProgress progressDlg, bool isNewCache, Form wndCopyFrom, bool fOpeningNewProject ) : Form
progressDlg IProgress The progress dialog to use, if needed (can be null).
isNewCache bool Flag indicating whether one-time, application-specific /// initialization should be done for this cache.
wndCopyFrom System.Windows.Forms.Form Must be null for creating the original app window. /// Otherwise, a reference to the main window whose settings we are copying.
fOpeningNewProject bool true if opening a brand spankin' new /// project
return System.Windows.Forms.Form

OnMasterRefresh() public method

This is the one (and should be only) handler for the user Refresh command. Refresh wants to first clean up the cache, then give things like Clerks a chance to reload stuff (calling the old OnRefresh methods), then give windows a chance to redisplay themselves.
public OnMasterRefresh ( object sender ) : void
sender object
return void

Synchronize() public method

public Synchronize ( SyncMsg sync ) : bool
sync SyncMsg
return bool

Property Details

m_appArgs protected_oe property

protected FwAppArgs,SIL.FieldWorks.Common.FwUtils m_appArgs
return SIL.FieldWorks.Common.FwUtils.FwAppArgs