Property | Type | Description | |
---|---|---|---|
btnClose | |||
chkMatchCase | |||
chkMatchDiacritics | |||
chkMatchWS | |||
chkMatchWholeWord | |||
chkUseRegularExpressions | |||
fweditFindText | |||
fweditReplaceText | |||
lblFindFormat | Label | ||
lblFindFormatText | |||
lblReplaceFormat | Label | ||
lblReplaceFormatText | |||
m_cache | FdoCache | ||
m_findEnvironment | FindCollectorEnv | ||
m_prevSearchText | ITsString | ||
m_searchKiller | SearchKiller | ||
m_vwFindPattern | IVwPattern | ||
m_vwRootsite | IVwRootSite | ||
m_vwSelectionForPattern | IVwSelection | ||
mnuFormat | ContextMenu | ||
mnuStyle | MenuItem | ||
mnuWritingSystem | MenuItem | ||
panelSearchOptions |
Property | Type | Description | |
---|---|---|---|
AdjustControlState | void | ||
AttemptWrap | void | ||
CanFindNext | bool | ||
EnableControls | void | ||
EnableRegexMenuReplaceButton | void | ||
EnsureValidWs | ITsString | ||
Find | void | ||
FindFrom | void | ||
FindFromAndWrap | void | ||
FwTextBox_Enter | void | ||
FwTextBox_Leave | void | ||
HandleTextChanged | void | ||
InitializeComponent | void | ||
InitializeFindEnvironment | void | ||
InternalMatchNotFound | void | ||
IsReplacePossible | bool | ||
OnStop | void | ||
PatternIsValid | bool | ||
PostpareToFind | void | ||
PrepareToFind | void | ||
RemoveEndOfPara | void | ||
RemoveWaitCursor | void | ||
SaveDialogValues | void | ||
SelectAtBeginning | IVwSelection | ||
SetCheckboxStates | void | ||
SetFormatLabels | void | ||
SetFormatLabels | void | ||
SetHelpTopicId | void | ||
StyleMenu_Click | void | ||
SuppressAllMatchNotFoundMessages | bool | ||
WritingSystemMenu_Click | void | ||
btnClose_Click | void | ||
btnFormat_Click | void | ||
btnHelp_Click | void | ||
btnRegexMenuFind_Click | void | ||
btnRegexMenuReplace_Click | void | ||
chkMatchWS_CheckedChanged | void | ||
chkUseRegularExpressions_CheckedChanged | void | ||
m_okButton_Click | void | ||
panel2_Paint | void |
Method | Description | |
---|---|---|
ApplyStyle ( |
Applies the specified style to the current selection of the Tss string in the specified Tss edit control
|
|
ApplyWS ( |
Applies the specified writing system to the current selection of the Tss string in the specified Tss edit control
|
|
CheckDisposed ( ) : void |
Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
|
|
FindNext ( ) : void |
Find the next match.
|
|
FindPrevious ( ) : void |
Find the previous match.
|
|
FwFindReplaceDlg ( ) : System |
Initializes a new instance of the FwFindReplaceDlg class.
|
|
PreFilterMessage ( |
Provide tabbing with the view controls and handle the ESC key to close the find dialog
|
|
Replace ( ) : void |
Executes a replace.
|
|
RestoreAndPersistSettingsIn ( XCore.Mediator mediator ) : void |
Call this after SetDialogValues on startup to restore settings and have them saved on close.
|
|
SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwRootSite rootSite, bool fReplace, bool fOverlays, |
Set the initial values for the dialog controls, assuming that the find and replace edit boxes use the default vernacular writing system.
|
|
SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwRootSite rootSite, bool fReplace, bool fOverlays, |
Sets the initial values for the dialog controls, prior to displaying the dialog. This method should be called after creating, but prior to calling DoModeless. This overload is meant to be called from managed code. ENHANCE JohnT: it may need more arguments, for example, the name of the kind of object we can restrict the search to, a list of fields. |
|
SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwStylesheet stylesheet, |
Set initial values, assuming default vernacular writing system for the find and replace edit boxes.
|
|
SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwStylesheet stylesheet, |
Sets the initial values for the dialog controls, prior to displaying the dialog. This method should be called after creating, but prior to calling DoModal. This overload is meant to be called from the Setup button of the Find/Replace tab of the Bulk Edit bar. Instead of having a root site and controls that allow the find/replace to be actually done, it just serves to edit the pattern. ENHANCE JohnT: it may need more arguments, for example, the name of the kind of object we can restrict the search to, a list of fields. |
|
SetOwner ( IVwRootSite rootSite, |
Change the main window which owns this dialog. Since this dialog attempts to stay alive as long as the app is alive (or, as long as there is a main window open), the app should call this to re-assign an owner any time the existing owner is closing. This assumes that the find and replace edit boxes use the default vernacular writing system.
|
|
SetOwner ( IVwRootSite rootSite, |
Change the main window which owns this dialog. Since this dialog attempts to stay alive as long as the app is alive (or, as long as there is a main window open), the app should call this to re-assign an owner any time the existing owner is closing.
|
Method | Description | |
---|---|---|
DisplayInvalidRegExMessage ( string errorMessage ) : void |
Displays a message box that the regular expression is invalid.
|
|
Dispose ( bool disposing ) : void |
Clean up any resources being used.
|
|
DoReplace ( IVwSelection sel ) : void |
Replace the existing selection with the string in the replace box, then find the next occurrance, if any.
|
|
DoReplaceAll ( ) : void |
Does the replace all.
|
|
DoReplacement ( IVwSelection sel, ITsString tssReplace, bool fUseWS, bool fEmptySearch ) : void |
Perform a single instance of a text replace TODO TE-973: searching for writing systems. |
|
GetCurrentWS ( |
Given an FwTextBox, we get the name of the WS of the current selection. If the selection spans multiple writing systems, we return an empty string.
|
|
OnActivated ( |
Activate dialog.
|
|
OnClosing ( CancelEventArgs e ) : void |
Instead of closing, just try to hide.
|
|
OnDeactivate ( |
Remove the message filter when the dialog loses focus (Don't mistake this for onLoseFocus...this dialog never loses focus, it never has it, only it's sub-controls do.)
|
|
OnFindNext ( object sender, |
Handle the Find Next button click event
|
|
OnKeyDown ( |
Handle special keystrokes in the dialog.
|
|
OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void |
|
|
OnReplace ( object sender, |
Handle the Replace button click event. The first time the user presses the "Replace" button, we just find the next match; the second time we actually do the replace and then go on to find the next match.
|
|
OnReplaceAll ( object sender, |
Handle the Replace All button click event.
|
|
OnVisibleChanged ( |
Change Close button back to Cancel whenever we re-open the dialog
|
|
PopulateStyleMenu ( ) : void |
Fill the Style menu the "No style" item, plus a an alphabetized list of all character styles in stylesheet of the last Fw Edit Box to have focus. The style of the current selection (if there is exactly one) will be checked. If the selection contains no style, then "No style" will be checked. If the selection covers multiple styles, nothing will be checked.
|
|
PopulateWritingSystemMenu ( ) : void |
Fill the Writing Systems menu with an alphebetized list of all writing systems defined in this language project. The writing system of the current selection (if there is exactly one) will be checked; otherwise, nothing will be checked.
|
|
SetupFindPattern ( ) : void |
Setup and save the find pattern, clear the selection for the pattern. This is done at the start of a NEW search only.
|
|
btnLess_Click ( object sender, System e ) : void |
Show fewer options.
|
|
btnMore_Click ( object sender, System e ) : void |
Show more options.
|
|
tabControls_SelectedIndexChanged ( object sender, System e ) : void |
When the user switches between Find and Replace tabs, we need to transfer ownership of the panels that hold the controls and hide/show/change controls as appropriate.
|
Method | Description | |
---|---|---|
AdjustControlState ( |
If enable is false, save the current enable state of the control and disable it. If it is true, restore the previous enable state of each control.
|
|
AttemptWrap ( bool fFirstTry ) : void |
Attempts to wrap and continue searching if we hit the bottom of the view.
|
|
CanFindNext ( ) : bool | ||
EnableControls ( bool enable ) : void |
Enables or disables all the controls except the close/stop/cancel button on the find/replace dialog.
|
|
EnableRegexMenuReplaceButton ( ) : void | ||
EnsureValidWs ( int wsEdit, ITsString tss ) : ITsString |
Check that the ws in the ITsString is still valid. If it isn't, set it to the given default value.
|
|
Find ( bool fSearchForward ) : void |
Find the next match based on the current pattern settings
|
|
FindFrom ( IVwSelection sel ) : void |
Attempts to find a pattern match in the view starting from the specified selection.
|
|
FindFromAndWrap ( IVwSelection sel, bool fFirstTry ) : void |
Attempts to find a pattern match in the view starting from the specified selection, wrapping around if we reach the end of the view.
|
|
FwTextBox_Enter ( object sender, |
When the focus arrives on a TSS edit control, the other edit control needs to have the selection removed from it. Also, the entered box needs to have all of the text selected.
|
|
FwTextBox_Leave ( object sender, |
Needed to keep track of the last Tss edit control to have focus, for the purpose of setting styles, etc.
|
|
HandleTextChanged ( object sender, |
Handle a text changed event in an FW edit box. The style labels need to be updated when the text changes.
|
|
InitializeComponent ( ) : void |
Required method for Designer support - do not modify the contents of this method with the code editor.
|
|
InitializeFindEnvironment ( IVwRootSite rootSite, bool fSearchForward = true ) : void | ||
InternalMatchNotFound ( bool fFirstTry ) : void |
Checks for a subscriber to the MatchNotFound event and displays the appropriate not found message if the subscriber says it's ok, or if there is no subscriber.
|
|
IsReplacePossible ( IVwSelection vwsel ) : bool |
Determine if the current selection can be replaced with the replace text.
|
|
OnStop ( object sender, System e ) : void |
Stops a find/replace
|
|
PatternIsValid ( ) : bool |
Verifies the pattern is valid. If user wants to use a regex, this validates the regular expression.
|
|
PostpareToFind ( bool fMakeCloseBtnSayClose ) : void |
Postpares to find: reset controls to how they were before the find; remove NoMatchFound from the MatchNotFound handler
|
|
PrepareToFind ( ) : void |
Prepares to find: change the Close button to a Stop button; disable all other controls.
|
|
RemoveEndOfPara ( ITsStrBldr bldr ) : void |
Removes any end of paragraph marker from the string builder.
|
|
RemoveWaitCursor ( |
Remove the wait cursor, which is left behind on several controls when the DataUpdateMonitor object is disposed. This is a patch over a bug in Mono as far as I can tell. It fixes FWNX-659. The strange thing is that the cursor on all these controls seems to already be set to Cursors.Default, but this fix works. |
|
SaveDialogValues ( ) : void |
Save the values set in the dialog in the pattern.
|
|
SelectAtBeginning ( ) : IVwSelection |
Moves the selection to the beginning of the root site and returns the selection information.
|
|
SetCheckboxStates ( IVwPattern vwPattern ) : void |
Sets the checkbox states.
|
|
SetFormatLabels ( ) : void |
Updates visibility and values of format labels used to show selected styles in find and replace text boxes.
|
|
SetFormatLabels ( |
Updates visibility and content of labels depending on char styles in passed TsString.
|
|
SetHelpTopicId ( ) : void | ||
StyleMenu_Click ( object sender, |
This gets called whenever the user selects a style from the style menu
|
|
SuppressAllMatchNotFoundMessages ( object sender, string defaultMsg, MatchType type ) : bool |
Suppress any messages about matches not found.
|
|
WritingSystemMenu_Click ( object sender, |
This gets called whenever the user selects a writing system
|
|
btnClose_Click ( object sender, System e ) : void |
Close the Find/Replace dialog
|
|
btnFormat_Click ( object sender, |
Method to handle the Click event of the Format button. Displays the format menu.
|
|
btnHelp_Click ( object sender, System e ) : void |
Open the help window when the help button is pressed.
|
|
btnRegexMenuFind_Click ( object sender, EventArgs e ) : void |
Show the Regex Helper context menu for Find
|
|
btnRegexMenuReplace_Click ( object sender, EventArgs e ) : void |
Show the Regex Helper context menu for Replace
|
|
chkMatchWS_CheckedChanged ( object sender, EventArgs e ) : void |
Handles the CheckedChanged event of the chkMatchWS control.
|
|
chkUseRegularExpressions_CheckedChanged ( object sender, System e ) : void |
Handle the event when the check on "Use Regular Expressions" changes.
|
|
m_okButton_Click ( object sender, System e ) : void |
Handle a click on the OK button.
|
|
panel2_Paint ( object sender, System e ) : void |
Draws an etched line on the dialog to separate the Search Options from the basic controls.
|
public ApplyStyle ( |
||
fwTextBox | The Tss edit control whose selection should have the /// specified style applied to it. | |
sStyle | string | The name of the style to apply |
return | void |
public ApplyWS ( |
||
fwTextBox | The Tss edit control whose selection should have the /// specified style applied to it. | |
hvoWs | int | The ID of the writing system to apply |
return | void |
protected DisplayInvalidRegExMessage ( string errorMessage ) : void | ||
errorMessage | string | The error message. |
return | void |
protected Dispose ( bool disposing ) : void | ||
disposing | bool | |
return | void |
protected DoReplace ( IVwSelection sel ) : void | ||
sel | IVwSelection | |
return | void |
protected DoReplacement ( IVwSelection sel, ITsString tssReplace, bool fUseWS, bool fEmptySearch ) : void | ||
sel | IVwSelection | The current (new) selection in the view where we just did a find. /// Presumably, this matches the Find Text string. |
tssReplace | ITsString | The tss string that the user entered in the Replace box /// |
fUseWS | bool | |
fEmptySearch | bool | |
return | void |
protected GetCurrentWS ( |
||
fwtextbox | An FwTextBox (either the Find or Replace box) | |
return | IWritingSystem |
protected OnActivated ( |
||
e | ||
return | void |
protected OnClosing ( CancelEventArgs e ) : void | ||
e | CancelEventArgs | |
return | void |
protected OnDeactivate ( |
||
e | ||
return | void |
protected OnFindNext ( object sender, |
||
sender | object | |
e | ||
return | void |
protected OnKeyDown ( |
||
e | ||
return | void |
protected OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void | ||
levent | System.Windows.Forms.LayoutEventArgs | |
return | void |
protected OnReplace ( object sender, |
||
sender | object | |
e | ||
return | void |
protected OnReplaceAll ( object sender, |
||
sender | object | |
e | ||
return | void |
protected OnVisibleChanged ( |
||
e | ||
return | void |
protected PopulateWritingSystemMenu ( ) : void | ||
return | void |
public PreFilterMessage ( |
||
m | ||
return | bool |
public RestoreAndPersistSettingsIn ( XCore.Mediator mediator ) : void | ||
mediator | XCore.Mediator | |
return | void |
public SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwRootSite rootSite, bool fReplace, bool fOverlays, |
||
cache | SIL.FieldWorks.FDO.FdoCache | The cache. |
vwPattern | IVwPattern | Find/replace values |
rootSite | IVwRootSite | view |
fReplace | bool | |
fOverlays | bool | ignored for now |
owner | The main window that owns the rootsite | |
helpTopicProvider | IHelpTopicProvider | help topic provider allows the dialog box class /// to specify the appropriate help topic path for this dialog |
app | IApp | The application |
return | bool |
public SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwRootSite rootSite, bool fReplace, bool fOverlays, |
||
cache | SIL.FieldWorks.FDO.FdoCache | The cache. |
vwPattern | IVwPattern | Find/replace values |
rootSite | IVwRootSite | view |
fReplace | bool | |
fOverlays | bool | ignored for now |
owner | The main window that owns the rootsite | |
helpTopicProvider | IHelpTopicProvider | help topic provider allows the dialog box class /// to specify the appropriate help topic path for this dialog |
app | IApp | The application |
wsEdit | int | writing system for the find and replace edit boxes |
return | bool |
public SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwStylesheet stylesheet, |
||
cache | SIL.FieldWorks.FDO.FdoCache | The cache. |
vwPattern | IVwPattern | Find/replace values |
stylesheet | IVwStylesheet | to use in text boxes |
owner | The main window that owns the rootsite | |
helpTopicProvider | IHelpTopicProvider | help topic provider allows the dialog box class /// to specify the appropriate help topic path for this dialog |
app | IApp | The application |
return | bool |
public SetDialogValues ( SIL.FieldWorks.FDO.FdoCache cache, IVwPattern vwPattern, IVwStylesheet stylesheet, |
||
cache | SIL.FieldWorks.FDO.FdoCache | The cache. |
vwPattern | IVwPattern | Find/replace values |
stylesheet | IVwStylesheet | to use in text boxes |
owner | The main window that owns the rootsite | |
helpTopicProvider | IHelpTopicProvider | help topic provider allows the dialog box class /// to specify the appropriate help topic path for this dialog |
app | IApp | The application |
wsEdit | int | writing system used in the find/replace text boxes |
return | bool |
public SetOwner ( IVwRootSite rootSite, |
||
rootSite | IVwRootSite | |
newOwner | ||
findPattern | IVwPattern | |
return | void |
public SetOwner ( IVwRootSite rootSite, |
||
rootSite | IVwRootSite | view |
newOwner | The main window that owns the rootsite | |
findPattern | IVwPattern | The find/replace pattern of the new owner. TODO Review (Hasso) 2015.08: unused |
wsEdit | int | writing system for the find and replace edit boxes TODO Review (Hasso) 2015.08: unused |
return | void |
protected btnLess_Click ( object sender, System e ) : void | ||
sender | object | |
e | System | |
return | void |
protected btnMore_Click ( object sender, System e ) : void | ||
sender | object | |
e | System | |
return | void |
protected tabControls_SelectedIndexChanged ( object sender, System e ) : void | ||
sender | object | |
e | System | |
return | void |
protected Button,System.Windows.Forms btnClose | ||
return |
protected CheckBox,System.Windows.Forms chkMatchCase | ||
return |
protected CheckBox,System.Windows.Forms chkMatchDiacritics | ||
return |
protected CheckBox,System.Windows.Forms chkMatchWS | ||
return |
protected CheckBox,System.Windows.Forms chkMatchWholeWord | ||
return |
protected CheckBox,System.Windows.Forms chkUseRegularExpressions | ||
return |
protected FwTextBox,SIL.FieldWorks.Common.Widgets fweditFindText | ||
return |
protected FwTextBox,SIL.FieldWorks.Common.Widgets fweditReplaceText | ||
return |
protected Label,System.Windows.Forms lblFindFormatText | ||
return |
protected Label,System.Windows.Forms lblReplaceFormatText | ||
return |
protected FindCollectorEnv m_findEnvironment | ||
return | FindCollectorEnv |
protected IVwSelection m_vwSelectionForPattern | ||
return | IVwSelection |