C# Class SIL.FieldWorks.Common.Framework.FwApp

Activate the given window.

This method can be used to do the size and spacing calculations when tiling either side-by-side or stacked. It calculates two things: 1) The desired width or height of tiled windows. 2) how many pixels between the left or top edges of tiled windows. If the calculated width or height of a window is less than the allowable minimum, then tiled windows will be overlapped.

Calculate a size (width or height) which is 2/3 of the screen area or the minimum allowable size.

Cascade the windows from top left and resize them to fill 2/3 of the screen area (or the minimum allowable size).

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

Must not be virtual.

Use this for slow operations that should happen during the splash screen instead of during app construction

Enable or disable all top-level windows. This allows nesting. In other words, calling EnableMainWindows(false) twice requires 2 calls to EnableMainWindows(true) before the top level windows are actually enabled. An example of where not allowing nesting was a problem was the Tools/Options dialog, which could open a PossListChooser dialog. Before, when you closed the PossListChooser, you could select the main window.

Close all windows (which will shut down the application)

Returns the features available for the application

Gets a URL identifying a Help topic.

Return a string from a resource ID.

Applications should override this method to handle incoming links. This method is called from FieldWorks when a link is requested. It is guaranteed to be on the correct thread (the thread this application is on) so invoking should not be needed. Overridden in FwXApp. See the class comment on FwLinkArgs for details on how all the parts of hyperlinking work.

Handles an outgoing link request from this application.

Registers events for the main window and adds the main window to the list of windows. Then shows the window.

Provides a hook for initializing the cache in application-specific ways.

Called just after DoApplicationInitialization(). Allows a separate overide of loading settings. If you override this you probably also want to override SaveSettings.

Creates a new instance of the main window

Filters out a message before it is dispatched.

Refreshes all the views in all of the Main Windows of the app.

Close and remove the Find/Replace modeless dialog (result of LT-5702)

Removes the specified IFwMainWnd from the list of windows. If it is ok to close down the application and the count of main windows is zero, then this method will also shut down the application.

Restart the spell-checking process (e.g. when dictionary changed)

Resumes painting in every view and every main window.

Resume execution of synchronize messages. If there are any messages in the queue execute them now.

Triggered by shutting down the app, this is a possible override point for saving any settings to be loaded by LoadSettings. This is the real place to save settings, as opposed to SaveSettingsNow, which is a dummy implementation required because (for the sake of the SettingsKey method) we implement ISettings.

For now, app has no settings to save. This method is required as part of ISettings implementation. Note that the SaveSettings() method is the appropriate one to modify or override if you really want to save settings. This one is NEVER called!

Display the Find/Replace modeless dialog

Displays a message box asking the user whether or not he wants to open a sample DB.

Suppresses painting in every view and every main window.

Suppress execution of all synchronize messages and store them in a queue instead.

Cycle through the applications main windows and synchronize them with database changes.

Arrange the windows top to bottom or left to right.

Arrange the windows top to bottom or left to right.

Handle changes to the LinkedFiles root directory for a language project.

This may not be the best place for this method, but I'm not sure there is a "best place".

Adjust the new window position - offset right and down from the original. Also copy the window size, state, and set the StartPosition mode to manual.

This provides a hook for any kind of app that wants to configure the dialog in some special way. TE wants to disable regular expressions for replace.

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

Constructor for FwApp

The active main window is closing, so try to find some other main window that can "own" the find/replace dialog, so it can stay alive. If we can't find one, then all main windows are going away and we're going to have to close, too.

Handles the EnterThreadModal event of the Application control.

Handles the LeaveThreadModal event of the Application control.

Suppress all calls to T:RefreshAllViews() until T:EndUpdate is called.

Used by T:ResumeSynchronize to do only one refresh of the view.

This method can be used to do the size and spacing calculations when tiling either side-by-side or stacked. It calculates two things: 1) The desired width or height of tiled windows. 2) how many pixels between the left or top edges of tiled windows. If the calculated width or height of a window is less than the allowable minimum, then tiled windows will be overlapped.

Recursively look at all the controls belonging to the specified control and save the settings for each root box for controls of type ISettings. Then close the root box for controls of type IRootSite. Ideally IRootSite controls should close their root boxes in the OnHandleDestroyed event, but since sometimes IRootSite controls are created but never shown (which means their handle is never created), we have to close the rootboxes here instead.

Build a list of files that can be moved (or copied) to the new LinkedFiles root directory.

Do a T:RefreshAllViews() if it was called at least once after T:BeginUpdate

Expand the internal paths from relative to absolute as needed, since the user doesn't want to move (or copy) them.

Return a string from a resource ID. This should normally not be called directly. Use FwApp.GetResourceString() instead.

When a window is closed, we need to make sure we close any root boxes that may be on the window.

Note the most recent of our main windows to become active.

Make sure a window that's no longer valid isn't considered active.