C# Class SIL.FieldWorks.TE.TeMainWnd

Main window for Translation Editor

Inheritance: SIL.FieldWorks.Common.Framework.FwMainWnd, IControlCreator, IPageSetupCallbacks, IMessageFilter, ITeImportCallbacks

Exibir arquivo Open project: sillsdev/FieldWorks Class Usage Examples

Protected Properties

Property	Type	Description
m_bookFilter	FilteredScrBooks
m_commonSelection	IVwSelection
m_gotoRefCtrl	DbScrPassageControl
m_lp	ILangProject
m_scr	IScripture
m_viewThatLostFocus	IRootSite

Private Properties

Property	Type	Description
AddKtLeafNodes	void
AddUserViews	void
AdjustScriptureAnnotations	void
BTStatusIconSelected	bool
BookFilterChanged	void
BooksChanged	void
ChangeDefaultBTWritingSystem	void
CreateBookFilterIfMissing	void
DisplayScripturePropertiesDlg	DialogResult
DisplayUsfmBrowser	void
EnsureEnglishLdsExists	void
GetBackTranslationWsForView	int
GetBtWsRegistrySetting	SIL.FieldWorks.Common.FwUtils.RegistryStringSetting
GetReferenceToCurrentBook	ScrReference
InitializeComponent	void
InitializePageSetupDlg	void
InsertCrossRefFootnoteAllowed	bool
InsertFootnoteAllowed	bool
InsertGeneralFootnoteAllowed	bool
InsertThePicture	void
LookupTerm	void
OnFileExportUsfmParatext	bool
OnFinishedInit	bool
OnInsertNote	bool
OnUpdateBackTranslationNextMissingBtFootnoteMkr	bool
OnUpdateFileExports	bool
OnUpdateViewNotes	bool
OpenTrainingDoc	void
RefreshNotesWindow	void
RegisterFocusableView	void
RestoreSelection	void
ScrollToReference	void
SetupSideBarInfoBar	void
ShowStylesHelp	void
ShowUsfmResources	void
UpdateBookFilter	void
UpdateGoToFirstLast	bool
UpdateKeyTermsBookFilter	void
UpdateSpellingMenus	bool
ViewGotFocus	void
ViewLostFocus	void

Public Methods

Method	Description
CreateContextMenu ( string name ) : ContextMenuStrip	Create the desired context menu.
GotoVerse ( ScrReference targetRef ) : bool	Attempt to set the selection immediately following the last character of the closest verse number to the requested verse. If no section exists within one chapter of the requested verse, the selection will not be changed.
InitAndShowClient ( ) : void	Create the client windows and add corresponding stuff to the sidebar, View menu, etc.
InitializeInsertBookMenus ( ) : void	Populate the InsertBook menus with the book names from the database.
OnGoToFirstBook ( object args ) : bool	Navigate to the first Scripture book
OnGoToFirstChapter ( object args ) : bool	Navigate to the first chapter in the current book
OnGoToFirstSection ( object args ) : bool	Navigate to the first Scripture section in the current book
OnGoToLastBook ( object args ) : bool	Navigate to the last Scripture book
OnGoToLastChapter ( object args ) : bool	Navigate to the last chapter in the current book
OnGoToLastSection ( object args ) : bool	Navigate to the last Scripture section in the current book
OnGoToNextBook ( object args ) : bool	Navigate to the next Scripture book
OnGoToNextChapter ( object args ) : bool	Navigate to the next chapter
OnGoToNextFootnote ( object menuItem ) : bool	Navigate to the next footnote.
OnGoToNextSection ( object args ) : bool	Navigate to the next Scripture section
OnGoToPrevBook ( object args ) : bool	Navigate to the next footnote.
OnGoToPrevChapter ( object args ) : bool	Navigate to the previous chapter
OnGoToPrevFootnote ( object args ) : bool	Navigate to the previous Scripture book
OnGoToPrevSection ( object args ) : bool	Navigate to the previous Scripture section
OnGoToReference ( object args ) : bool	Displays the GotoReferenceDialog dialog box and lets the user input a reference to go to.
OnReceiveReferences ( object args ) : bool	Enables the receiving of sync messages.
OnSelectedPassageChanged ( object obj ) : bool	This is called through the message mediator from TeEditingHelper when the selection changes. Used to update the GoToReferenceControl on the information toolbar.
OnSendReferences ( object args ) : bool	Enables the sending of sync messages.
OnShowUsfmResources ( object args ) : bool	Turn on or off the control that shows USFM resources.
OnUpdateEditRemoveBook ( object args ) : bool	Handles updating the remove book menu.
OnUpdateFootnoteProperties ( object args ) : bool	Called to enable or disable the Footnote properties menu/toolbar item.
OnUpdateGoToReference ( object args ) : bool	Displays the GotoReferenceDialog dialog box and lets the user input a reference to go to.
OnUpdateImportStandardFormat ( object args ) : bool	Handles updating the Import Standard Format menu.
OnUpdateInsertBook ( object args ) : bool	Handle the popup of the Insert Book popup menu. When the submenu pops up, each of the books in the menu that already exist in the database needs to be disabled. You can not insert a book that already exists.
OnUpdateInsertChapterNumber ( object args ) : bool	Updates the insert chapter number toolbar button and menu option
OnUpdateInsertCrossRefFootnote ( object args ) : bool	Handles updating the insert cross reference menu.
OnUpdateInsertGeneralFootnote ( object args ) : bool	Handles updating the Insert Footnote menu. Disables the footnote menu command if (1) we are in a view that has no editing capabilities, (2) there are no books in the book filter, (3) if we are in key terms view, or (4) if the user has the insertion point in a footnote.
OnUpdateInsertIntroSection ( object args ) : bool	Updates the insert section toolbar button and menu option
OnUpdateInsertNoteParent ( object args ) : bool	Populate the Insert Note menu with subitems for each type of note the user is allowed to create.
OnUpdateInsertPictureDialog ( object args ) : bool	Handles updating the insert picture menu.
OnUpdateInsertSection ( object args ) : bool	Updates the insert section toolbar button and menu option
OnUpdateInsertVerseNumber ( object args ) : bool	Update the insert verse number toolbar button and menu option
OnUpdateInsertVerseNumbers ( object args ) : bool	Updates the insert verse numbers mode toolbar button and menu option
OnUpdatePictureProperties ( object args ) : bool	Handles updating the insert picture menu. Disables the picture properties menu command if a picture isn't selected.
OnUpdateReceiveReferences ( object args ) : bool	Called to enable or disable the Receive Scripture References menu/toolbar item.
OnUpdateScriptureProperties ( object args ) : bool	Called to enable or disable the Scripture properties menu/toolbar item.
OnUpdateSendReferences ( object args ) : bool	Called to enable or disable the Send Scripture References menu/toolbar item.
OnUpdateShowUsfmResources ( object args ) : bool	Called to enable or disable the Send Scripture References menu/toolbar item.
PreFilterMessage ( Message &message ) : bool	Prefilters the message for special handling of shortcuts.
PreSynchronize ( SyncMsg sync ) : void	Called just before a window synchronizes it's views with DB changes (e.g. when an undo or redo command is issued).
RespondToSyncScrollingMsgs ( bool enable ) : void	Enables or disables this editing helper's ability to respond to synchronizing to the notes window or external applications (e.g. Libronix, Paratext, etc.). Each view has its own TeEditingHelper and this is called whenever the active view changes. When a view becomes active, this method of its editing helper is called to enable responding and vice versa when the view becomes inactive... in case it isn't obvious.
SaveComprehensionCheckingSettings ( object sender, EventArgs e ) : void	Saves the Transcelerator settings.
ScrollToCitedText ( object sender, IScrScriptureNote annotation ) : void	Scrolls to cited text.
SetCurrentReference ( ScrReference sr ) : void	This method is called from FocusMessageHandling.SetUsfmFocus to set the current reference in the usfm browser if one is active.
SyncToScrLocation ( TeEditingHelper editingHelper, bool fSendInternalOnly ) : void	Syncs to the current Scripture reference location of the given editing helper.
Synchronize ( SyncMsg sync ) : bool	Called when a window synchronizes it's views with DB changes (e.g. when an undo or redo command is issued).
TeMainWnd ( ) : System	Default constructor for TeMainWnd.
TeMainWnd ( FwApp app, Form wndCopyFrom ) : System	Initializes a new instance of the TeMainWnd class
TeMainWnd ( FwApp app, Form wndCopyFrom, FwLinkArgs startupLink ) : System	Initializes a new instance of the TeMainWnd class
TurnOffAllFilters ( ) : void	Turns off all the active filters
UpdateGoToSubItems ( TMItemProperties itemProps, bool fSelectionRequired ) : bool	Updates the enabled status of sub items in the GoTo menus.
UpdateKeyTermsView ( ) : void	Updates the key terms view.
UpdateSpellingStatus ( bool status ) : void	Update the spelling status of all embedded simple views.

Protected Methods

Method	Description
AddBackTransConsultantCheckView ( string viewName ) : void	Adds the Back Translation Review view
AddBackTransDraftView ( string viewName ) : void	Adds the Back Translation/Draft View
AddBackTransPrintLayoutView ( string viewName, TeViewType viewType ) : void	Adds the Back Translation/Print Layout View
AddDraftView ( string viewName ) : void	Adds the Scripture/Draft View
AddEditorialChecksView ( string viewName ) : void	Adds the Editorial Checks View
AddFilters ( ) : void	Add filters to the side bar
AddKeyTermsView ( string viewName ) : void	Adds the Checking/Key Terms View
AddPrintLayoutView ( string viewName, TeViewType viewType, string pubName, TeResourceHelper sideBarIndex, string sideBarItemName ) : void	Adds the Scripture/Print layout View
AddVerticalView ( string viewName ) : void	Adds the Scripture/Vertical View.
CreateBackTransConsultantCheckView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the Back Translation Review view
CreateBackTransDraftView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the Back Translation/Draft View
CreateBackTransPrintLayoutView ( string viewName, TeViewType viewType, string pubName, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the Back Translation/Print Layout View
CreateDraftView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the Scripture/Draft View
CreateEditorialChecksView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the editorial checks view when the user switches to it.
CreateKeyTermsView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the key terms view when the user switches to it.
CreatePageSetupDialog ( IPubPageLayout pgl, IPublication pub, IPubDivision div ) : IPageSetupDialog	Creates the page setup dialog.
CreatePrintLayoutView ( string viewName, TeViewType viewType, string pubName, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Adds the Scripture/Print layout View
CreatePublicationView ( IPublication pub, TeViewType viewType, int btWs ) : ScripturePublication	Creates a publication view of the desired type
CreateVerticalView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView	Creates the Scripture/Vertical View.
DisplayFootnoteDialog ( ) : DialogResult	Displays footnote properties dialog. Created so that dialog could be skipped in testing
Dispose ( bool disposing ) : void	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.
GetAppSpecificMenuToolBarDefinition ( ) : string	Add TE specific toolbars to the ones added by the framework's main window.
GetDefaultItemForTab ( string tabName ) : string	Get the name of the default sidebar item for the given tab
Init ( ) : void	Do required initializations
InitializeContextMenus ( string generalFile, string specificFile ) : void	Store the information needed to create context menus.
InsertFootnoteInternal ( string styleName ) : bool	Gets the ball rolling to insert a footnote.
LoadAppSpecificCustomToolBarControls ( string name, string tooltip ) : Control	Applications containing derivations of this class implement this if they have their own custom control they want on a toolbar.
OnAddToDictionary ( object args ) : bool	Called to add a word to spelling dictionary.
OnApplyUnTransWord ( object arg ) : bool
OnBackTranslationNextMissingBtFootnoteMkr ( object args ) : bool	Handles the BackTranslationNextMissingBtFootnoteMkr command by attempting to navigate to a position in the back translation that closely corresponds to a place in the verncaular that has a footnote whose marker has not been inserted into the back translation.
OnBookFilter ( object args ) : bool	Handle a click on the book filter menu
OnBookFilterToggle ( object args ) : bool	Handle a click on the "book filter" button
OnBookProperties ( object args ) : bool	Display the book properties dialog
OnChangeMultipleOccurrences ( object args ) : bool	Change Spelling of Multiple Occurences.
OnClosing ( CancelEventArgs e ) : void	Do stuff when the window is closing.
OnCorrectMisspelledWords ( object args ) : bool	This method implements the CorrectMisspelledWords menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdCorrectMisspelledWords. It launches Flex (if necessary) and configues it to show the Analyses view filtered for words where spelling status is Incorrect and occurrences in corpus is not zero.
OnDemos ( object args ) : bool	Handle the Help Demos menu item.
OnEditRemoveBook ( object args ) : bool	Handler for "Remove Book" option of Edit menu.
OnEditUndo ( object args ) : bool	Undo handler. Main undo is done in FwMainWnd, but we need this method to be able to deal with staying in verse insert mode.
OnFileExportPs ( object args ) : bool	Handle the File/Export/Open Office menu command
OnFileExportRtf ( object args ) : bool	Handle the File/Export/Rtf menu command
OnFileExportUsfmToolbox ( object args ) : bool	Handle the File/Export/Usfm Toolbox menu command
OnFileExportXhtml ( object args ) : bool	Handle the File/Export/Xhtml menu command
OnFileExportXml ( object args ) : bool	Handle the File/Export/Xml menu command
OnFilePrint ( object args ) : bool	Prints the current view
OnFindInDictionary ( object args ) : bool	This method implements the FindInDictionary menu item (both menu bar and context menu). It is called using reflection by xCore, not directly.
OnFindRelatedWords ( object args ) : bool	This method implements the FindRelatedWords menu item (both menu bar and context menu). It is called using reflection by xCore, not directly.
OnFootnoteClick ( object arg ) : bool	Clicking on a footnote in a draft view does the same as the menu item View Footnotes, except that the provided StFootnote forces the footnote window to show (instead of toggling).
OnFootnoteProperties ( object args ) : bool	handle the footnote properties context menu
OnHeaderFooterSetup ( object arg ) : bool	Brings up the header footer setup dialog from the View menu
OnHelpApplication ( object args ) : bool	Shows the help file for the application
OnImportOXES ( object args ) : bool	This method is called when the user selects File, Import, Open XML for Editing Scripture.
OnImportStandardFormat ( object args ) : bool	This method is called when the user selects File, Import, Standard Format. Despite of the name it handles both SF and PT imports.
OnInsertBackTransCV ( object args ) : bool	Generate chapter and verse numbers for the translations of the paragraphs in the current section content.
OnInsertBook ( object args ) : bool	For the Insert-Book menu, handle the click on the book in the book list. Create the requested book and title.
OnInsertChapterNumber ( object args ) : bool	Insert a new chapter number
OnInsertCrossRefFootnote ( object args ) : bool	Inserts a cross-reference footnote. Called when the user clicks Insert Cross Reference on the main menu.
OnInsertGeneralFootnote ( object args ) : bool	Inserts a general footnote. Called when the user clicks InsertFootnote on the main menu, as well as from DraftView when the user clicks InsertFootnote on the context menu.
OnInsertIntroSection ( object args ) : bool	For the Insert Section menu, if IP at the end of a section, inserts a new section. Sets the IP in the new para of the new section.
OnInsertPictureDialog ( object args ) : bool	Displays the insert picture dialog.
OnInsertSection ( object args ) : bool	For the Insert Section menu, if IP at the end of a section, inserts a new section. Sets the IP in the new para of the new section.
OnInsertVerseNumber ( object args ) : bool	Insert a verse number at the current location in the text.
OnInsertVerseNumbers ( object args ) : bool	Toggle the InsertVerseNumber mode
OnInterlinearize ( object args ) : bool	This method implements the Interlinearize menu item (in the Back Translation section). It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdInterlinearize. It launches Flex (if necessary) and configues it to show the the Interlinear Text view with the current StText selected.
OnLoad ( EventArgs e ) : void
OnNoFilters ( object args ) : bool	Handle a click on the "no filter" menu
OnPassageChanged ( ScrReference newReference ) : void	Called when the scripture passage changed.
OnPictureProperties ( object args ) : bool	Handles the clicking on the "Picture Properties" context menu.
OnRemoveCharacterStyle ( object args ) : bool	Handles the Remove Character Style menu/toolbar command.
OnResetParagraphStyle ( object args ) : bool	Handles the Reset Paragraph Style menu/toolbar command.
OnReviewMisspelledWords ( object args ) : bool	This method implements the ReviewMisspelledWords menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdReviewMisspelledWords. It launches Flex (if necessary) and configues it to show the Bulk Edit Wordforms view filtered for words where spelling status is Undecided and occurrences in corpus is not zero.
OnSavedVersions ( object args ) : bool	Handle the File/Saved Versions command
OnScriptureProperties ( object args ) : bool	Display the scripture properties dialog from the File menu
OnScripturePropertiesForCVCheck ( object args ) : bool	Display the scripture properties dialog from the chapter verse check dialog.
OnShowSpellingErrors ( object args ) : bool	Turn on or off vernacular spelling.
OnSideBarConfigure ( object arg ) : bool	Handle the configure event for any menu associated with the sidebar.
OnSpellingSuggestionChosen ( object args ) : bool	This method handles the case when the user has chosen one of the suggested spellings for a misspelled word on which they right-clicked.
OnSwitchActiveView ( object args ) : bool	Hide the previously active view and activate the new one (corresponding to the button clicked in the sidebar (or the menu item chosen).
OnToolsOptions ( object args ) : bool	Respond to the Tools/Options menu option to bring up the options dialog.
OnTrainingCopyPasteData ( object args ) : bool	Handle the Copy-and-paste Data menu item.
OnTrainingExercises ( object args ) : bool	Handle the Training Exercises menu item.
OnTrainingInstructorGuide ( object args ) : bool	Handle the Instructor Guide menu item.
OnTrainingStudentManual ( object args ) : bool	Handle the Student Training Manual menu item.
OnUnsQuestions ( object args ) : bool	This method implements the Translate UNS Questions menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdUnsQuestions.
OnUpdateAddToDictionary ( object args ) : bool	Called to enable or disable the Add to Spelling Dictionary command in the context menu.
OnUpdateApplyUnTransWord ( object args ) : bool	Update the Apply Untranslated Word menu/toolbar item
OnUpdateBookFilter ( object args ) : bool	Handle updating the book filter menu
OnUpdateBookFilterToggle ( object args ) : bool	Handle updating the book filter toolbar button
OnUpdateBookProperties ( object args ) : bool	Determine if the book properties menu item should be enabled
OnUpdateChangeMultipleOccurrences ( object args ) : bool	Called to enable or disable the Change Multiple Occurrences command in the context menu.
OnUpdateCorrectMisspelledWords ( object args ) : bool	This menu item is available if Flex is.
OnUpdateEditSelectAll ( object args ) : bool	Edit/Select All is not a valid command for TE. This will keep it disabled.
OnUpdateFileExportPs ( object args ) : bool	Update the File/Export/Pathway menu command
OnUpdateFileExportRtf ( object args ) : bool	Update the File/Export/Rtf menu command
OnUpdateFileExportUsfmParatext ( object args ) : bool	Update the File/Export/Usfm Paratext menu command
OnUpdateFileExportUsfmToolbox ( object args ) : bool	Update the File/Export/Usfm Toolbox menu command
OnUpdateFileExportXhtml ( object args ) : bool	Update the File/Export/Xhtml menu command
OnUpdateFileExportXml ( object args ) : bool	Update the File/Export/Xml menu command
OnUpdateFindInDictionary ( object args ) : bool	Handle updating the "Find in dictionary" menu item. If there is no selection we want to disable this menu item (TE-4805).
OnUpdateFindRelatedWords ( object args ) : bool	Handle updating the "Find in related words" menu item. If there is no selection we want to disable this menu item (TE-4805).
OnUpdateGoTo ( object args ) : bool	Handles enabling or disabling the Goto Menu.
OnUpdateGoToFirstBook ( object args ) : bool	Called when updating the enabled status of Go To First: Book submenu item.
OnUpdateGoToFirstChapter ( object args ) : bool	Display current book name in "First" menu
OnUpdateGoToFirstSection ( object args ) : bool	Display current book name in "First" menu
OnUpdateGoToLastBook ( object args ) : bool	Called when updating the enabled status of Go To Last: Book submenu item..
OnUpdateGoToLastChapter ( object args ) : bool	Display current book name in "Last" menu
OnUpdateGoToLastSection ( object args ) : bool	Display current book name in "Last" menu
OnUpdateGoToNextBook ( object args ) : bool	Called when updating the enabled status of Go To Next: Book submenu item..
OnUpdateGoToNextChapter ( object args ) : bool	Called when updating the enabled status of Go To Next: Chapter submenu item..
OnUpdateGoToNextFootnote ( object args ) : bool	Called when updating the enabled status of Go To Next: Footnote submenu item..
OnUpdateGoToNextSection ( object args ) : bool	Called when updating the enabled status of Go To Next: Section submenu item..
OnUpdateGoToPrevBook ( object args ) : bool	Called when updating the enabled status of Go To Prev: Book submenu item..
OnUpdateGoToPrevChapter ( object args ) : bool	Called when updating the enabled status of Go To Prev: Chapter submenu item..
OnUpdateGoToPrevFootnote ( object args ) : bool	Called when updating the enabled status of Go To Prev: Footnote submenu item..
OnUpdateGoToPrevSection ( object args ) : bool	Called when updating the enabled status of Go To Prev: Section submenu item..
OnUpdateGoToRelativeItem ( object args ) : bool	Handles enabling or disabling the Goto First, Next, Prev, and Last menus.
OnUpdateGotoReferenceCtrl ( object args ) : bool	Update the scripture reference control status. If there are no books then disable it.
OnUpdateHeaderFooterSetup ( object arg ) : bool	Updates the Edit/Header Footer Setup menu item.
OnUpdateInsertBackTransCV ( object args ) : bool	Determine if the back translation chapter and verse template menu item should be enabled.
OnUpdateInterlinearize ( object args ) : bool	Determine if the back translation Use Interlinear Text Tool menu item should be enabled.
OnUpdateNoFilters ( object args ) : bool	Handle updating the "no filter" menu
OnUpdateRemoveCharacterStyle ( object args ) : bool	Called to update the Remove Character Style menu or toolbar item.
OnUpdateResetParagraphStyle ( object args ) : bool
OnUpdateReviewMisspelledWords ( object args ) : bool	This menu item is available if Flex is.
OnUpdateShowSpellingErrors ( object args ) : bool	Make the item checked if we have a dictionary.
OnUpdateSideBarConfigure ( object args ) : bool	This updates the given configure menu item. This configure menu item is on the sidebar tab's context menu or on one of the view menu item's sub-menus or one of the context menus that pops-up when the user clicks on an info. bar button.
OnUpdateStyleComboBox ( object args ) : bool	Enables/disables the styles combobox
OnUpdateUnsQuestions ( object args ) : bool	Handler to update the menu item for translating UNS questions.
OnUpdateViewFootnotes ( object arg ) : bool	Updates the menu's checkmark status given the state of the footnote view.
OnUpdateViewStylePane ( object arg ) : bool	Updates the menu's checkmark status given the state of the style pane view.
OnUpdateViewUpdatePageBreak ( object args ) : bool	Handle updating the "Update Page Break" menu/toolbar item.
OnUpdateWritingSystem ( object args ) : bool	Makes the Writing System Selector combobox enabled or disabled
OnViewFootnotes ( object arg ) : bool	Toggles the visibility of the footnote view.
OnViewNotes ( object arg ) : bool	Toggles the visibility of the notes view.
RemoveBook ( int iBook ) : void	Removes requested book. If not running in test, message box will be displayed to confirm deletion.
SaveSettings ( RegistryKey key ) : void	Save UI settings specific to this window.
SetPropsToFactorySettings ( SIL.FieldWorks.FwCoreDlgControls.StyleInfo styleInfo ) : void	Set the properties of a StyleInfo to the factory default settings
ShowApplyStyleDialog ( string paraStyleName, string charStyleName ) : void	Shows the Format Apply Style dialog
TeMainWnd ( FdoCache cache ) : System	Initializes a new instance of the TeMainWnd class.
WndProc ( Message &msg ) : void	Processes Windows messages.
ZoomEnabledForView ( SimpleRootSite view ) : bool	Make sure zooming isn't allowed for style bars.

Private Methods

Method	Description
AddKtLeafNodes ( List keyTerms, ICmPossibility keyTerm ) : void	Adds the kt leaf nodes.
AddUserViews ( ) : void	Create the individual views (panes) and wrappers for each user view. Add the views to the side bar tabs.
AdjustScriptureAnnotations ( ) : void	Check scripture annotations for titles and introductions to make sure they point to paragraphs in the current version of books. This will ensure that they are included at the proper location in the export.
BTStatusIconSelected ( ) : bool	Determine if a status icon is selected in the BT view
BookFilterChanged ( object sender, EventArgs e ) : void	Update the filter panel in the status bar.
BooksChanged ( ICmObject sender ) : void	Updates the "Filtered" indicator on the status bar in response to a book being added or removed
ChangeDefaultBTWritingSystem ( int newWs ) : void	Change the default BT writing system for this main window and update any back translation views that have already been instantiated.
CreateBookFilterIfMissing ( ) : void	Create the "book" filter if it doesn't already exist.
DisplayScripturePropertiesDlg ( bool fOnFootnoteTab, bool showFootnoteTab ) : DialogResult
DisplayUsfmBrowser ( bool fDisplay ) : void	Displays or hides the USFM resource browser.
EnsureEnglishLdsExists ( ) : void
GetBackTranslationWsForView ( string viewName ) : int	Gets the back translation writing system to use for the given named view.
GetBtWsRegistrySetting ( string btViewName ) : SIL.FieldWorks.Common.FwUtils.RegistryStringSetting
GetReferenceToCurrentBook ( ) : ScrReference	Get a reference to the beginning of the current book.
InitializeComponent ( ) : void
InitializePageSetupDlg ( SIL.FieldWorks.TE.TePageSetupDlg dlg ) : void	Initializes the Page Setup dialog with TE-specific settings.
InsertCrossRefFootnoteAllowed ( ) : bool	Checks if a cross-reference footnote can be inserted
InsertFootnoteAllowed ( int &tagSelectedScrElement ) : bool	Checks if a footnote can be inserted
InsertGeneralFootnoteAllowed ( ) : bool	Checks if a general footnote can be inserted
InsertThePicture ( ICmPicture initialPicture, PicturePropertiesDialog dlg ) : void	Inserts the picture at the current selection (or updates the picture we are editing)
LookupTerm ( IEnumerable terms, int startRef, int endRef ) : void	Attempts to look up and select one of the given terms, if possible, selecting one that has an occurrence in the given reference range.
OnFileExportUsfmParatext ( object args ) : bool
OnFinishedInit ( ) : bool
OnInsertNote ( object args ) : bool
OnUpdateBackTranslationNextMissingBtFootnoteMkr ( object args ) : bool
OnUpdateFileExports ( object args ) : bool	Common code for updating the file/export menu items
OnUpdateViewNotes ( object arg ) : bool
OpenTrainingDoc ( string folder, string document ) : void	Open a training document in the associated application.
RefreshNotesWindow ( ) : void
RegisterFocusableView ( UserControl view ) : void	Registers a view.
RestoreSelection ( RestoreSelInfo restoreSelInfo ) : void	Restores the selection after applying a book filter.
ScrollToReference ( object sender, ScrReference scrRef, ITsString tssSelectedText ) : void
SetupSideBarInfoBar ( ) : void	Setup the sidebar/info. bar adapter.
ShowStylesHelp ( StyleListItem item ) : void	Show help topic for currently selected style. (This method is also in NotesMainWnd. I tried to move it out but the reference chain would have made it ugly).
ShowUsfmResources ( ) : void	Shows the usfm resources.
UpdateBookFilter ( IScrBook rghvoBooks ) : void	Update the book filter with new set of filtered books. Preserve any existing selections for all views.
UpdateGoToFirstLast ( TMItemProperties itemProps, SelectionHelper selLimitType ) : bool	Display current book name in "First" and "Last" menus
UpdateKeyTermsBookFilter ( ) : void	Updates the key terms book filter.
UpdateSpellingMenus ( TMItemProperties itemProps ) : bool	Helper method to determine if the spelling menu items should be visible.
ViewGotFocus ( object sender, EventArgs e ) : void
ViewLostFocus ( object sender, EventArgs e ) : void	Saves the selection of the view that loses focus

Method Details

AddBackTransConsultantCheckView() protected method

Adds the Back Translation Review view

protected AddBackTransConsultantCheckView ( string viewName ) : void
viewName	string
return	void

AddBackTransDraftView() protected method

Adds the Back Translation/Draft View

protected AddBackTransDraftView ( string viewName ) : void
viewName	string
return	void

AddBackTransPrintLayoutView() protected method

Adds the Back Translation/Print Layout View

protected AddBackTransPrintLayoutView ( string viewName, TeViewType viewType ) : void
viewName	string
viewType	TeViewType
return	void

AddDraftView() protected method

Adds the Scripture/Draft View

protected AddDraftView ( string viewName ) : void
viewName	string
return	void

AddEditorialChecksView() protected method

Adds the Editorial Checks View

protected AddEditorialChecksView ( string viewName ) : void
viewName	string
return	void

AddFilters() protected method

Add filters to the side bar

protected AddFilters ( ) : void
return	void

AddKeyTermsView() protected method

Adds the Checking/Key Terms View

protected AddKeyTermsView ( string viewName ) : void
viewName	string
return	void

AddPrintLayoutView() protected method

Adds the Scripture/Print layout View

protected AddPrintLayoutView ( string viewName, TeViewType viewType, string pubName, TeResourceHelper sideBarIndex, string sideBarItemName ) : void
viewName	string	Name of the resource string for the view.
viewType	TeViewType	Type of the view.
pubName	string	Name of the publication.
sideBarIndex	TeResourceHelper	Index of the icon for the view in the side bar.
sideBarItemName	string	Name of the side bar item.
return	void

AddVerticalView() protected method

Adds the Scripture/Vertical View.

protected AddVerticalView ( string viewName ) : void
viewName	string
return	void

CreateBackTransConsultantCheckView() protected method

Creates the Back Translation Review view

protected CreateBackTransConsultantCheckView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreateBackTransDraftView() protected method

Creates the Back Translation/Draft View

protected CreateBackTransDraftView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreateBackTransPrintLayoutView() protected method

Creates the Back Translation/Print Layout View

protected CreateBackTransPrintLayoutView ( string viewName, TeViewType viewType, string pubName, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
pubName	string	Name of the publication.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreateContextMenu() public method

Create the desired context menu.

public CreateContextMenu ( string name ) : ContextMenuStrip
name	string
return	System.Windows.Forms.ContextMenuStrip

CreateDraftView() protected method

Creates the Scripture/Draft View

protected CreateDraftView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreateEditorialChecksView() protected method

Creates the editorial checks view when the user switches to it.

protected CreateEditorialChecksView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreateKeyTermsView() protected method

Creates the key terms view when the user switches to it.

protected CreateKeyTermsView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreatePageSetupDialog() protected method

Creates the page setup dialog.

protected CreatePageSetupDialog ( IPubPageLayout pgl, IPublication pub, IPubDivision div ) : IPageSetupDialog
pgl	IPubPageLayout	The PubPageLayout object
pub	IPublication	The Publication object
div	IPubDivision	The PubDivision object
return	IPageSetupDialog

CreatePrintLayoutView() protected method

Adds the Scripture/Print layout View

protected CreatePrintLayoutView ( string viewName, TeViewType viewType, string pubName, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string	Name of the view.
viewType	TeViewType	Type of the view.
pubName	string	Name of the publication.
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties	The tab item.
return	ISelectableView

CreatePublicationView() protected method

Creates a publication view of the desired type

protected CreatePublicationView ( IPublication pub, TeViewType viewType, int btWs ) : ScripturePublication
pub	IPublication	The DB representation of the publication
viewType	TeViewType	The type of view to create.
btWs	int	BacktTranslation WS
return	ScripturePublication

CreateVerticalView() protected method

Creates the Scripture/Vertical View.

protected CreateVerticalView ( string viewName, TeViewType viewType, SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties tabItem ) : ISelectableView
viewName	string
viewType	TeViewType
tabItem	SIL.FieldWorks.Common.UIAdapters.SBTabItemProperties
return	ISelectableView

DisplayFootnoteDialog() protected method

Displays footnote properties dialog.

Created so that dialog could be skipped in testing

protected DisplayFootnoteDialog ( ) : DialogResult
return	DialogResult

Dispose() protected method

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.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GetAppSpecificMenuToolBarDefinition() protected method

Add TE specific toolbars to the ones added by the framework's main window.

protected GetAppSpecificMenuToolBarDefinition ( ) : string
return	string

GetDefaultItemForTab() protected method

Get the name of the default sidebar item for the given tab

protected GetDefaultItemForTab ( string tabName ) : string
tabName	string	Name of the sidebar tab
return	string

GotoVerse() public method

Attempt to set the selection immediately following the last character of the closest verse number to the requested verse. If no section exists within one chapter of the requested verse, the selection will not be changed.

public GotoVerse ( ScrReference targetRef ) : bool
targetRef	ScrReference	Reference to seek
return	bool

Init() protected method

Do required initializations

protected Init ( ) : void
return	void

InitAndShowClient() public method

Create the client windows and add corresponding stuff to the sidebar, View menu, etc.

Invalid user view type in database

public InitAndShowClient ( ) : void
return	void

InitializeContextMenus() protected method

Store the information needed to create context menus.

protected InitializeContextMenus ( string generalFile, string specificFile ) : void
generalFile	string
specificFile	string
return	void

InitializeInsertBookMenus() public method

Populate the InsertBook menus with the book names from the database.

public InitializeInsertBookMenus ( ) : void
return	void

InsertFootnoteInternal() protected method

Gets the ball rolling to insert a footnote.

protected InsertFootnoteInternal ( string styleName ) : bool
styleName	string	style name for the footnote paragraph
return	bool

LoadAppSpecificCustomToolBarControls() protected method

Applications containing derivations of this class implement this if they have their own custom control they want on a toolbar.

protected LoadAppSpecificCustomToolBarControls ( string name, string tooltip ) : Control
name	string	Name of the toolbar container item for which a control is /// requested.
tooltip	string	The tooltip to assign to the custom control.
return	Control

OnAddToDictionary() protected method

Called to add a word to spelling dictionary.

protected OnAddToDictionary ( object args ) : bool
args	object
return	bool

OnApplyUnTransWord() protected method

protected OnApplyUnTransWord ( object arg ) : bool
arg	object
return	bool

OnBackTranslationNextMissingBtFootnoteMkr() protected method

Handles the BackTranslationNextMissingBtFootnoteMkr command by attempting to navigate to a position in the back translation that closely corresponds to a place in the verncaular that has a footnote whose marker has not been inserted into the back translation.

protected OnBackTranslationNextMissingBtFootnoteMkr ( object args ) : bool
args	object
return	bool

OnBookFilter() protected method

Handle a click on the book filter menu

protected OnBookFilter ( object args ) : bool
args	object
return	bool

OnBookFilterToggle() protected method

Handle a click on the "book filter" button

protected OnBookFilterToggle ( object args ) : bool
args	object
return	bool

OnBookProperties() protected method

Display the book properties dialog

protected OnBookProperties ( object args ) : bool
args	object
return	bool

OnChangeMultipleOccurrences() protected method

Change Spelling of Multiple Occurences.

protected OnChangeMultipleOccurrences ( object args ) : bool
args	object
return	bool

OnClosing() protected method

Do stuff when the window is closing.

protected OnClosing ( CancelEventArgs e ) : void
e	CancelEventArgs
return	void

OnCorrectMisspelledWords() protected method

This method implements the CorrectMisspelledWords menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdCorrectMisspelledWords. It launches Flex (if necessary) and configues it to show the Analyses view filtered for words where spelling status is Incorrect and occurrences in corpus is not zero.

protected OnCorrectMisspelledWords ( object args ) : bool
args	object
return	bool

OnDemos() protected method

Handle the Help Demos menu item.

protected OnDemos ( object args ) : bool
args	object	The args.
return	bool

OnEditRemoveBook() protected method

Handler for "Remove Book" option of Edit menu.

protected OnEditRemoveBook ( object args ) : bool
args	object
return	bool

OnEditUndo() protected method

Undo handler. Main undo is done in FwMainWnd, but we need this method to be able to deal with staying in verse insert mode.

protected OnEditUndo ( object args ) : bool
args	object
return	bool

OnFileExportPs() protected method

Handle the File/Export/Open Office menu command

protected OnFileExportPs ( object args ) : bool
args	object
return	bool

OnFileExportRtf() protected method

Handle the File/Export/Rtf menu command

protected OnFileExportRtf ( object args ) : bool
args	object
return	bool

OnFileExportUsfmToolbox() protected method

Handle the File/Export/Usfm Toolbox menu command

protected OnFileExportUsfmToolbox ( object args ) : bool
args	object
return	bool

OnFileExportXhtml() protected method

Handle the File/Export/Xhtml menu command

protected OnFileExportXhtml ( object args ) : bool
args	object
return	bool

OnFileExportXml() protected method

Handle the File/Export/Xml menu command

protected OnFileExportXml ( object args ) : bool
args	object
return	bool

OnFilePrint() protected method

Prints the current view

protected OnFilePrint ( object args ) : bool
args	object
return	bool

OnFindInDictionary() protected method

This method implements the FindInDictionary menu item (both menu bar and context menu). It is called using reflection by xCore, not directly.

protected OnFindInDictionary ( object args ) : bool
args	object
return	bool

OnFindRelatedWords() protected method

This method implements the FindRelatedWords menu item (both menu bar and context menu). It is called using reflection by xCore, not directly.

protected OnFindRelatedWords ( object args ) : bool
args	object
return	bool

OnFootnoteClick() protected method

Clicking on a footnote in a draft view does the same as the menu item View Footnotes, except that the provided StFootnote forces the footnote window to show (instead of toggling).

protected OnFootnoteClick ( object arg ) : bool
arg	object	The footnote that was clicked on.
return	bool

OnFootnoteProperties() protected method

handle the footnote properties context menu

protected OnFootnoteProperties ( object args ) : bool
args	object
return	bool

OnGoToFirstBook() public method

Navigate to the first Scripture book

public OnGoToFirstBook ( object args ) : bool
args	object
return	bool

OnGoToFirstChapter() public method

Navigate to the first chapter in the current book

public OnGoToFirstChapter ( object args ) : bool
args	object
return	bool

OnGoToFirstSection() public method

Navigate to the first Scripture section in the current book

public OnGoToFirstSection ( object args ) : bool
args	object
return	bool

OnGoToLastBook() public method

Navigate to the last Scripture book

public OnGoToLastBook ( object args ) : bool
args	object
return	bool

OnGoToLastChapter() public method

Navigate to the last chapter in the current book

public OnGoToLastChapter ( object args ) : bool
args	object
return	bool

OnGoToLastSection() public method

Navigate to the last Scripture section in the current book

public OnGoToLastSection ( object args ) : bool
args	object
return	bool

OnGoToNextBook() public method

Navigate to the next Scripture book

public OnGoToNextBook ( object args ) : bool
args	object
return	bool

OnGoToNextChapter() public method

Navigate to the next chapter

public OnGoToNextChapter ( object args ) : bool
args	object
return	bool

OnGoToNextFootnote() public method

Navigate to the next footnote.

public OnGoToNextFootnote ( object menuItem ) : bool
menuItem	object
return	bool

OnGoToNextSection() public method

Navigate to the next Scripture section

public OnGoToNextSection ( object args ) : bool
args	object
return	bool

OnGoToPrevBook() public method

Navigate to the next footnote.

public OnGoToPrevBook ( object args ) : bool
args	object
return	bool

OnGoToPrevChapter() public method

Navigate to the previous chapter

public OnGoToPrevChapter ( object args ) : bool
args	object
return	bool

OnGoToPrevFootnote() public method

Navigate to the previous Scripture book

public OnGoToPrevFootnote ( object args ) : bool
args	object
return	bool

OnGoToPrevSection() public method

Navigate to the previous Scripture section

public OnGoToPrevSection ( object args ) : bool
args	object
return	bool

OnGoToReference() public method

Displays the GotoReferenceDialog dialog box and lets the user input a reference to go to.

public OnGoToReference ( object args ) : bool
args	object
return	bool

OnHeaderFooterSetup() protected method

Brings up the header footer setup dialog from the View menu

protected OnHeaderFooterSetup ( object arg ) : bool
arg	object
return	bool

OnHelpApplication() protected method

Shows the help file for the application

protected OnHelpApplication ( object args ) : bool
args	object
return	bool

OnImportOXES() protected method

This method is called when the user selects File, Import, Open XML for Editing Scripture.

protected OnImportOXES ( object args ) : bool
args	object	The args.
return	bool

OnImportStandardFormat() protected method

This method is called when the user selects File, Import, Standard Format. Despite of the name it handles both SF and PT imports.

protected OnImportStandardFormat ( object args ) : bool
args	object
return	bool

OnInsertBackTransCV() protected method

Generate chapter and verse numbers for the translations of the paragraphs in the current section content.

protected OnInsertBackTransCV ( object args ) : bool
args	object
return	bool

OnInsertBook() protected method

For the Insert-Book menu, handle the click on the book in the book list. Create the requested book and title.

protected OnInsertBook ( object args ) : bool
args	object
return	bool

OnInsertChapterNumber() protected method

Insert a new chapter number

protected OnInsertChapterNumber ( object args ) : bool
args	object
return	bool

OnInsertCrossRefFootnote() protected method

Inserts a cross-reference footnote.

Called when the user clicks Insert Cross Reference on the main menu.

protected OnInsertCrossRefFootnote ( object args ) : bool
args	object
return	bool

OnInsertGeneralFootnote() protected method

Inserts a general footnote.

Called when the user clicks InsertFootnote on the main menu, as well as from DraftView when the user clicks InsertFootnote on the context menu.

protected OnInsertGeneralFootnote ( object args ) : bool
args	object
return	bool

OnInsertIntroSection() protected method

For the Insert Section menu, if IP at the end of a section, inserts a new section. Sets the IP in the new para of the new section.

protected OnInsertIntroSection ( object args ) : bool
args	object
return	bool

OnInsertPictureDialog() protected method

Displays the insert picture dialog.

protected OnInsertPictureDialog ( object args ) : bool
args	object
return	bool

OnInsertSection() protected method

For the Insert Section menu, if IP at the end of a section, inserts a new section. Sets the IP in the new para of the new section.

protected OnInsertSection ( object args ) : bool
args	object
return	bool

OnInsertVerseNumber() protected method

Insert a verse number at the current location in the text.

protected OnInsertVerseNumber ( object args ) : bool
args	object
return	bool

OnInsertVerseNumbers() protected method

Toggle the InsertVerseNumber mode

protected OnInsertVerseNumbers ( object args ) : bool
args	object
return	bool

OnInterlinearize() protected method

This method implements the Interlinearize menu item (in the Back Translation section). It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdInterlinearize. It launches Flex (if necessary) and configues it to show the the Interlinear Text view with the current StText selected.

protected OnInterlinearize ( object args ) : bool
args	object	The args.
return	bool

OnLoad() protected method

protected OnLoad ( EventArgs e ) : void
e	EventArgs
return	void

OnNoFilters() protected method

Handle a click on the "no filter" menu

protected OnNoFilters ( object args ) : bool
args	object
return	bool

OnPassageChanged() protected method

Called when the scripture passage changed.

protected OnPassageChanged ( ScrReference newReference ) : void
newReference	ScrReference	The new reference.
return	void

OnPictureProperties() protected method

Handles the clicking on the "Picture Properties" context menu.

protected OnPictureProperties ( object args ) : bool
args	object
return	bool

OnReceiveReferences() public method

Enables the receiving of sync messages.

public OnReceiveReferences ( object args ) : bool
args	object
return	bool

OnRemoveCharacterStyle() protected method

Handles the Remove Character Style menu/toolbar command.

protected OnRemoveCharacterStyle ( object args ) : bool
args	object	The arguments
return	bool

OnResetParagraphStyle() protected method

Handles the Reset Paragraph Style menu/toolbar command.

protected OnResetParagraphStyle ( object args ) : bool
args	object	The arguments
return	bool

OnReviewMisspelledWords() protected method

This method implements the ReviewMisspelledWords menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdReviewMisspelledWords. It launches Flex (if necessary) and configues it to show the Bulk Edit Wordforms view filtered for words where spelling status is Undecided and occurrences in corpus is not zero.

protected OnReviewMisspelledWords ( object args ) : bool
args	object
return	bool

OnSavedVersions() protected method

Handle the File/Saved Versions command

protected OnSavedVersions ( object args ) : bool
args	object
return	bool

OnScriptureProperties() protected method

Display the scripture properties dialog from the File menu

protected OnScriptureProperties ( object args ) : bool
args	object
return	bool

OnScripturePropertiesForCVCheck() protected method

Display the scripture properties dialog from the chapter verse check dialog.

protected OnScripturePropertiesForCVCheck ( object args ) : bool
args	object
return	bool

OnSelectedPassageChanged() public method

This is called through the message mediator from TeEditingHelper when the selection changes. Used to update the GoToReferenceControl on the information toolbar.

public OnSelectedPassageChanged ( object obj ) : bool
obj	object
return	bool

OnSendReferences() public method

Enables the sending of sync messages.

public OnSendReferences ( object args ) : bool
args	object
return	bool

OnShowSpellingErrors() protected method

Turn on or off vernacular spelling.

protected OnShowSpellingErrors ( object args ) : bool
args	object
return	bool

OnShowUsfmResources() public method

Turn on or off the control that shows USFM resources.

public OnShowUsfmResources ( object args ) : bool
args	object
return	bool

OnSideBarConfigure() protected method

Handle the configure event for any menu associated with the sidebar.

protected OnSideBarConfigure ( object arg ) : bool
arg	object
return	bool

OnSpellingSuggestionChosen() protected method

This method handles the case when the user has chosen one of the suggested spellings for a misspelled word on which they right-clicked.

protected OnSpellingSuggestionChosen ( object args ) : bool
args	object
return	bool

OnSwitchActiveView() protected method

Hide the previously active view and activate the new one (corresponding to the button clicked in the sidebar (or the menu item chosen).

protected OnSwitchActiveView ( object args ) : bool
args	object
return	bool

OnToolsOptions() protected method

Respond to the Tools/Options menu option to bring up the options dialog.

protected OnToolsOptions ( object args ) : bool
args	object
return	bool

OnTrainingCopyPasteData() protected method

Handle the Copy-and-paste Data menu item.

protected OnTrainingCopyPasteData ( object args ) : bool
args	object	The args.
return	bool

OnTrainingExercises() protected method

Handle the Training Exercises menu item.

protected OnTrainingExercises ( object args ) : bool
args	object
return	bool

OnTrainingInstructorGuide() protected method

Handle the Instructor Guide menu item.

protected OnTrainingInstructorGuide ( object args ) : bool
args	object
return	bool

OnTrainingStudentManual() protected method

Handle the Student Training Manual menu item.

protected OnTrainingStudentManual ( object args ) : bool
args	object
return	bool

OnUnsQuestions() protected method

This method implements the Translate UNS Questions menu item. It is called using reflection by xCore, not directly. See TeTMDefinition.xml, look for CmdUnsQuestions.

protected OnUnsQuestions ( object args ) : bool
args	object
return	bool

OnUpdateAddToDictionary() protected method

Called to enable or disable the Add to Spelling Dictionary command in the context menu.

protected OnUpdateAddToDictionary ( object args ) : bool
args	object
return	bool

OnUpdateApplyUnTransWord() protected method

Update the Apply Untranslated Word menu/toolbar item

protected OnUpdateApplyUnTransWord ( object args ) : bool
args	object
return	bool

OnUpdateBookFilter() protected method

Handle updating the book filter menu

protected OnUpdateBookFilter ( object args ) : bool
args	object
return	bool

OnUpdateBookFilterToggle() protected method

Handle updating the book filter toolbar button

protected OnUpdateBookFilterToggle ( object args ) : bool
args	object
return	bool

OnUpdateBookProperties() protected method

Determine if the book properties menu item should be enabled

protected OnUpdateBookProperties ( object args ) : bool
args	object
return	bool

OnUpdateChangeMultipleOccurrences() protected method

Called to enable or disable the Change Multiple Occurrences command in the context menu.

protected OnUpdateChangeMultipleOccurrences ( object args ) : bool
args	object
return	bool

OnUpdateCorrectMisspelledWords() protected method

This menu item is available if Flex is.

protected OnUpdateCorrectMisspelledWords ( object args ) : bool
args	object
return	bool

OnUpdateEditRemoveBook() public method

Handles updating the remove book menu.

public OnUpdateEditRemoveBook ( object args ) : bool
args	object
return	bool

OnUpdateEditSelectAll() protected method

Edit/Select All is not a valid command for TE. This will keep it disabled.

protected OnUpdateEditSelectAll ( object args ) : bool
args	object
return	bool

OnUpdateFileExportPs() protected method

Update the File/Export/Pathway menu command

protected OnUpdateFileExportPs ( object args ) : bool
args	object
return	bool

OnUpdateFileExportRtf() protected method

Update the File/Export/Rtf menu command

protected OnUpdateFileExportRtf ( object args ) : bool
args	object
return	bool

OnUpdateFileExportUsfmParatext() protected method

Update the File/Export/Usfm Paratext menu command

protected OnUpdateFileExportUsfmParatext ( object args ) : bool
args	object
return	bool

OnUpdateFileExportUsfmToolbox() protected method

Update the File/Export/Usfm Toolbox menu command

protected OnUpdateFileExportUsfmToolbox ( object args ) : bool
args	object
return	bool

OnUpdateFileExportXhtml() protected method

Update the File/Export/Xhtml menu command

protected OnUpdateFileExportXhtml ( object args ) : bool
args	object
return	bool

OnUpdateFileExportXml() protected method

Update the File/Export/Xml menu command

protected OnUpdateFileExportXml ( object args ) : bool
args	object
return	bool

OnUpdateFindInDictionary() protected method

Handle updating the "Find in dictionary" menu item. If there is no selection we want to disable this menu item (TE-4805).

protected OnUpdateFindInDictionary ( object args ) : bool
args	object	true if we handled this message.
return	bool

OnUpdateFindRelatedWords() protected method

Handle updating the "Find in related words" menu item. If there is no selection we want to disable this menu item (TE-4805).

protected OnUpdateFindRelatedWords ( object args ) : bool
args	object	true if we handled this message.
return	bool

OnUpdateFootnoteProperties() public method

Called to enable or disable the Footnote properties menu/toolbar item.

public OnUpdateFootnoteProperties ( object args ) : bool
args	object	The args.
return	bool

OnUpdateGoTo() protected method

Handles enabling or disabling the Goto Menu.

protected OnUpdateGoTo ( object args ) : bool
args	object
return	bool

OnUpdateGoToFirstBook() protected method

Called when updating the enabled status of Go To First: Book submenu item.

protected OnUpdateGoToFirstBook ( object args ) : bool
args	object
return	bool

OnUpdateGoToFirstChapter() protected method

Display current book name in "First" menu

protected OnUpdateGoToFirstChapter ( object args ) : bool
args	object	The menu item about to display
return	bool

OnUpdateGoToFirstSection() protected method

Display current book name in "First" menu

protected OnUpdateGoToFirstSection ( object args ) : bool
args	object	The menu item about to display
return	bool

OnUpdateGoToLastBook() protected method

Called when updating the enabled status of Go To Last: Book submenu item..

protected OnUpdateGoToLastBook ( object args ) : bool
args	object	The args.
return	bool

OnUpdateGoToLastChapter() protected method

Display current book name in "Last" menu

protected OnUpdateGoToLastChapter ( object args ) : bool
args	object	The menu item about to display
return	bool

OnUpdateGoToLastSection() protected method

Display current book name in "Last" menu

protected OnUpdateGoToLastSection ( object args ) : bool
args	object	The menu item about to display
return	bool

OnUpdateGoToNextBook() protected method

Called when updating the enabled status of Go To Next: Book submenu item..

protected OnUpdateGoToNextBook ( object args ) : bool
args	object
return	bool

OnUpdateGoToNextChapter() protected method

Called when updating the enabled status of Go To Next: Chapter submenu item..

protected OnUpdateGoToNextChapter ( object args ) : bool
args	object
return	bool

OnUpdateGoToNextFootnote() protected method

Called when updating the enabled status of Go To Next: Footnote submenu item..

protected OnUpdateGoToNextFootnote ( object args ) : bool
args	object
return	bool

OnUpdateGoToNextSection() protected method

Called when updating the enabled status of Go To Next: Section submenu item..

protected OnUpdateGoToNextSection ( object args ) : bool
args	object
return	bool

OnUpdateGoToPrevBook() protected method

Called when updating the enabled status of Go To Prev: Book submenu item..

protected OnUpdateGoToPrevBook ( object args ) : bool
args	object
return	bool

OnUpdateGoToPrevChapter() protected method

Called when updating the enabled status of Go To Prev: Chapter submenu item..

protected OnUpdateGoToPrevChapter ( object args ) : bool
args	object
return	bool

OnUpdateGoToPrevFootnote() protected method

Called when updating the enabled status of Go To Prev: Footnote submenu item..

protected OnUpdateGoToPrevFootnote ( object args ) : bool
args	object
return	bool

OnUpdateGoToPrevSection() protected method

Called when updating the enabled status of Go To Prev: Section submenu item..

protected OnUpdateGoToPrevSection ( object args ) : bool
args	object
return	bool

OnUpdateGoToReference() public method

Displays the GotoReferenceDialog dialog box and lets the user input a reference to go to.

public OnUpdateGoToReference ( object args ) : bool
args	object
return	bool

OnUpdateGoToRelativeItem() protected method

Handles enabling or disabling the Goto First, Next, Prev, and Last menus.

protected OnUpdateGoToRelativeItem ( object args ) : bool
args	object
return	bool

OnUpdateGotoReferenceCtrl() protected method

Update the scripture reference control status. If there are no books then disable it.

protected OnUpdateGotoReferenceCtrl ( object args ) : bool
args	object
return	bool

OnUpdateHeaderFooterSetup() protected method

Updates the Edit/Header Footer Setup menu item.

protected OnUpdateHeaderFooterSetup ( object arg ) : bool
arg	object
return	bool

OnUpdateImportStandardFormat() public method

Handles updating the Import Standard Format menu.

public OnUpdateImportStandardFormat ( object args ) : bool
args	object
return	bool

OnUpdateInsertBackTransCV() protected method

Determine if the back translation chapter and verse template menu item should be enabled.

protected OnUpdateInsertBackTransCV ( object args ) : bool
args	object
return	bool

OnUpdateInsertBook() public method

Handle the popup of the Insert Book popup menu. When the submenu pops up, each of the books in the menu that already exist in the database needs to be disabled. You can not insert a book that already exists.

public OnUpdateInsertBook ( object args ) : bool
args	object	The Insert Book menu being popped up
return	bool

OnUpdateInsertChapterNumber() public method

Updates the insert chapter number toolbar button and menu option

public OnUpdateInsertChapterNumber ( object args ) : bool
args	object
return	bool

OnUpdateInsertCrossRefFootnote() public method

Handles updating the insert cross reference menu.

public OnUpdateInsertCrossRefFootnote ( object args ) : bool
args	object
return	bool

OnUpdateInsertGeneralFootnote() public method

Handles updating the Insert Footnote menu. Disables the footnote menu command if (1) we are in a view that has no editing capabilities, (2) there are no books in the book filter, (3) if we are in key terms view, or (4) if the user has the insertion point in a footnote.

public OnUpdateInsertGeneralFootnote ( object args ) : bool
args	object
return	bool

OnUpdateInsertIntroSection() public method

Updates the insert section toolbar button and menu option

public OnUpdateInsertIntroSection ( object args ) : bool
args	object
return	bool

OnUpdateInsertNoteParent() public method

Populate the Insert Note menu with subitems for each type of note the user is allowed to create.

public OnUpdateInsertNoteParent ( object args ) : bool
args	object
return	bool

OnUpdateInsertPictureDialog() public method

Handles updating the insert picture menu.

public OnUpdateInsertPictureDialog ( object args ) : bool
args	object
return	bool

OnUpdateInsertSection() public method

Updates the insert section toolbar button and menu option

public OnUpdateInsertSection ( object args ) : bool
args	object
return	bool

OnUpdateInsertVerseNumber() public method

Update the insert verse number toolbar button and menu option

public OnUpdateInsertVerseNumber ( object args ) : bool
args	object
return	bool

OnUpdateInsertVerseNumbers() public method

Updates the insert verse numbers mode toolbar button and menu option

public OnUpdateInsertVerseNumbers ( object args ) : bool
args	object
return	bool

OnUpdateInterlinearize() protected method

Determine if the back translation Use Interlinear Text Tool menu item should be enabled.

protected OnUpdateInterlinearize ( object args ) : bool
args	object
return	bool

OnUpdateNoFilters() protected method

Handle updating the "no filter" menu

protected OnUpdateNoFilters ( object args ) : bool
args	object
return	bool

OnUpdatePictureProperties() public method

Handles updating the insert picture menu. Disables the picture properties menu command if a picture isn't selected.

public OnUpdatePictureProperties ( object args ) : bool
args	object
return	bool

OnUpdateReceiveReferences() public method

Called to enable or disable the Receive Scripture References menu/toolbar item.

public OnUpdateReceiveReferences ( object args ) : bool
args	object	The args.
return	bool

OnUpdateRemoveCharacterStyle() protected method

Called to update the Remove Character Style menu or toolbar item.

protected OnUpdateRemoveCharacterStyle ( object args ) : bool
args	object	The menu item
return	bool

OnUpdateResetParagraphStyle() protected method

protected OnUpdateResetParagraphStyle ( object args ) : bool
args	object	The menu item
return	bool

OnUpdateReviewMisspelledWords() protected method

This menu item is available if Flex is.

protected OnUpdateReviewMisspelledWords ( object args ) : bool
args	object
return	bool

OnUpdateScriptureProperties() public method

Called to enable or disable the Scripture properties menu/toolbar item.

public OnUpdateScriptureProperties ( object args ) : bool
args	object	The args.
return	bool

OnUpdateSendReferences() public method

Called to enable or disable the Send Scripture References menu/toolbar item.

public OnUpdateSendReferences ( object args ) : bool
args	object	The args.
return	bool

OnUpdateShowSpellingErrors() protected method

Make the item checked if we have a dictionary.

protected OnUpdateShowSpellingErrors ( object args ) : bool
args	object
return	bool

OnUpdateShowUsfmResources() public method

Called to enable or disable the Send Scripture References menu/toolbar item.

public OnUpdateShowUsfmResources ( object args ) : bool
args	object	The args.
return	bool

OnUpdateSideBarConfigure() protected method

This updates the given configure menu item. This configure menu item is on the sidebar tab's context menu or on one of the view menu item's sub-menus or one of the context menus that pops-up when the user clicks on an info. bar button.

protected OnUpdateSideBarConfigure ( object args ) : bool
args	object
return	bool

OnUpdateStyleComboBox() protected method

Enables/disables the styles combobox

protected OnUpdateStyleComboBox ( object args ) : bool
args	object
return	bool

OnUpdateUnsQuestions() protected method

Handler to update the menu item for translating UNS questions.

protected OnUpdateUnsQuestions ( object args ) : bool
args	object
return	bool

OnUpdateViewFootnotes() protected method

Updates the menu's checkmark status given the state of the footnote view.

protected OnUpdateViewFootnotes ( object arg ) : bool
arg	object	The menu or toolbar item
return	bool

OnUpdateViewStylePane() protected method

Updates the menu's checkmark status given the state of the style pane view.

protected OnUpdateViewStylePane ( object arg ) : bool
arg	object	The menu or toolbar item
return	bool

OnUpdateViewUpdatePageBreak() protected method

Handle updating the "Update Page Break" menu/toolbar item.

protected OnUpdateViewUpdatePageBreak ( object args ) : bool
args	object	menu/toolbar item
return	bool

OnUpdateWritingSystem() protected method

Makes the Writing System Selector combobox enabled or disabled

protected OnUpdateWritingSystem ( object args ) : bool
args	object
return	bool

OnViewFootnotes() protected method

Toggles the visibility of the footnote view.

protected OnViewFootnotes ( object arg ) : bool
arg	object	The menu or toolbar item
return	bool

OnViewNotes() protected method

Toggles the visibility of the notes view.

protected OnViewNotes ( object arg ) : bool
arg	object	The menu or toolbar item
return	bool

PreFilterMessage() public method

Prefilters the message for special handling of shortcuts.

public PreFilterMessage ( Message &message ) : bool
message	Message
return	bool

PreSynchronize() public method

Called just before a window synchronizes it's views with DB changes (e.g. when an undo or redo command is issued).

public PreSynchronize ( SyncMsg sync ) : void
sync	SyncMsg	syncronization message
return	void

RemoveBook() protected method

Removes requested book. If not running in test, message box will be displayed to confirm deletion.

protected RemoveBook ( int iBook ) : void
iBook	int	index of book to be deleted
return	void

RespondToSyncScrollingMsgs() public method

Enables or disables this editing helper's ability to respond to synchronizing to the notes window or external applications (e.g. Libronix, Paratext, etc.). Each view has its own TeEditingHelper and this is called whenever the active view changes. When a view becomes active, this method of its editing helper is called to enable responding and vice versa when the view becomes inactive... in case it isn't obvious.

public RespondToSyncScrollingMsgs ( bool enable ) : void
enable	bool
return	void

SaveComprehensionCheckingSettings() public method

Saves the Transcelerator settings.

public SaveComprehensionCheckingSettings ( object sender, EventArgs e ) : void
sender	object
e	EventArgs
return	void

SaveSettings() protected method

Save UI settings specific to this window.

protected SaveSettings ( RegistryKey key ) : void
key	RegistryKey	The Registry Key.
return	void

ScrollToCitedText() public method

Scrolls to cited text.

public ScrollToCitedText ( object sender, IScrScriptureNote annotation ) : void
sender	object	The sender.
annotation	IScrScriptureNote	The annotation whose reference and cited text we should /// sync. to.
return	void

SetCurrentReference() public method

This method is called from FocusMessageHandling.SetUsfmFocus to set the current reference in the usfm browser if one is active.

public SetCurrentReference ( ScrReference sr ) : void
sr	ScrReference	The target reference in the current project's versification
return	void

SetPropsToFactorySettings() protected method

Set the properties of a StyleInfo to the factory default settings

protected SetPropsToFactorySettings ( SIL.FieldWorks.FwCoreDlgControls.StyleInfo styleInfo ) : void
styleInfo	SIL.FieldWorks.FwCoreDlgControls.StyleInfo
return	void

ShowApplyStyleDialog() protected method

Shows the Format Apply Style dialog

protected ShowApplyStyleDialog ( string paraStyleName, string charStyleName ) : void
paraStyleName	string	The currently-selected Paragraph style name
charStyleName	string	The currently-selected Character style name
return	void

SyncToScrLocation() public method

Syncs to the current Scripture reference location of the given editing helper.

public SyncToScrLocation ( TeEditingHelper editingHelper, bool fSendInternalOnly ) : void
editingHelper	TeEditingHelper	The editing helper.
fSendInternalOnly	bool	if set to true does not send reference to /// third-party listeners.
return	void

Synchronize() public method

Called when a window synchronizes it's views with DB changes (e.g. when an undo or redo command is issued).

public Synchronize ( SyncMsg sync ) : bool
sync	SyncMsg	synchronization information record
return	bool

TeMainWnd() public method

Default constructor for TeMainWnd.

public TeMainWnd ( ) : System
return	System

TeMainWnd() protected method

Initializes a new instance of the TeMainWnd class.

protected TeMainWnd ( FdoCache cache ) : System
cache	FdoCache	The cache.
return	System

TeMainWnd() public method

Initializes a new instance of the TeMainWnd class

public TeMainWnd ( FwApp app, Form wndCopyFrom ) : System
app	FwApp
wndCopyFrom	Form
return	System

TeMainWnd() public method

Initializes a new instance of the TeMainWnd class

public TeMainWnd ( FwApp app, Form wndCopyFrom, FwLinkArgs startupLink ) : System
app	FwApp
wndCopyFrom	Form
startupLink	FwLinkArgs	Optional link to jump to in OnFinishedInit
return	System

TurnOffAllFilters() public method

Turns off all the active filters

public TurnOffAllFilters ( ) : void
return	void

UpdateGoToSubItems() public method

Updates the enabled status of sub items in the GoTo menus.

public UpdateGoToSubItems ( TMItemProperties itemProps, bool fSelectionRequired ) : bool
itemProps	TMItemProperties	The item props.
fSelectionRequired	bool	if set to true selection is required in /// order for this command to be enabled.
return	bool

UpdateKeyTermsView() public method

Updates the key terms view.

public UpdateKeyTermsView ( ) : void
return	void

UpdateSpellingStatus() public method

Update the spelling status of all embedded simple views.

public UpdateSpellingStatus ( bool status ) : void
status	bool
return	void

WndProc() protected method

Processes Windows messages.

protected WndProc ( Message &msg ) : void
msg	Message	The Windows Message to process.
return	void

ZoomEnabledForView() protected method

Make sure zooming isn't allowed for style bars.

protected ZoomEnabledForView ( SimpleRootSite view ) : bool
view	SimpleRootSite
return	bool

Property Details

m_bookFilter protected_oe property

Virtual sequence of books

protected FilteredScrBooks m_bookFilter
return	FilteredScrBooks

m_commonSelection protected_oe property

protected IVwSelection m_commonSelection
return	IVwSelection

m_gotoRefCtrl protected_oe property

protected DbScrPassageControl m_gotoRefCtrl
return	DbScrPassageControl

m_lp protected_oe property

protected ILangProject m_lp
return	ILangProject

m_scr protected_oe property

protected IScripture m_scr
return	IScripture

m_viewThatLostFocus protected_oe property

protected IRootSite m_viewThatLostFocus
return	IRootSite