C# Class SIL.FieldWorks.IText.InterlinDocForAnalysis

Approve all the suggested analyses in this text. See LT-4312.

Make a free translation line out of the current glosses. Note that this is sometimes called by reflection; the parameter of type object is required to match the expected signature even though it is not used.

Enable the 'insert word glosses' command

Select the word indicated by the occurrence. Note that this does not save any changes made in the Sandbox. It is mainly used when the view is read-only.

Move the sandbox to the AnalysisOccurrence, (which may be a WfiWordform, WfiAnalysis, or WfiGloss).

Move the sandbox to the AnalysisOccurrence, (which may be a WfiWordform, WfiAnalysis, or WfiGloss).

Move the sandbox (see main method), making the default selection.

Handles a view selection produced by a click. Return true to suppress normal mouse down handling, indicating that an interlinear bundle has been clicked and the Sandbox moved.

Notifies the site that something about the selection has changed.

When overriding you should call the base class first.

factory

Overridden for subclasses needing a Sandbox.

If we try to scroll to show the focus box before we are Created, our attempt to set the scroll position is ignored. This is an attempt to recover and make sure that even the first time the view is being created, we are scrolled to show the focus box if we have set one up.

If we have an active focus box put the focus back there when this is focused.

If you lost focus while processing a key or click, it may be because you are making a new selection before calling a method like TryHideFocusBoxAndUninstall(). Hide focus and uninstall first!

As a last resort for making sure the focus box is where we think it should be, check every time we paint. A recursive call may well happen, since an Update() is called if MoveFocusBoxIntoPlace needs to scroll. However, it can't get infinitely recursive, since MoveFocusBoxIntoPlace is guarded against being called again while it is active.

Windows.Forms is way too enthusiastic about trying to make the focused child control visible. For example it does it any time we change AutoScrollMinSize, such as when scrolling up and expanding lazy boxes. This has bad effects (LT-LT-11692). Returning the control's current location prevents ScrollControlIntoView from making any changes. However, in some cases we may want to make it visible.

Answer whether the AddWordGlossesToFreeTranslation menu option should be enabled. Also get the Segment to which they can be added.

Answer true if the indicated selection is within a single note we can delete.

Converts InterlinLineChoices flids to corresponding SegmentTags. or NoteTags. This is useful when making translation or note selections.

Detect that downward movement out of this segment is needed. Considerations: Configured analysis lines preceed translation or note lines (currently). "Annotation" lines include translation lines (free and literal) and notes. Each translation or note in a diffeerent ws is a different line. Translations are stored in a segment as a multistring while notes are in a sequence of multistrings. Each note is repeated in each note line of a different ws. So, the IP may be in the last configured note, but not in the last note.

Detect that upward movement out of this segment or to an analysis in this same segment is needed. Considerations: Configured analysis lines preceed translation or note lines (currently). Analyses are stored as a sequence in the segement. Some analyses are punctuation that are skipped by the IP. Only analyses that have a word in them are considered "real". "Annotation" lines include translation lines (free and literal) and notes. Each translation or note in a diffeerent ws is a different line. Translations are stored in a segment as a multistring while notes are in a sequence of multistrings. Each note is repeated in each note line of a different ws. So, the IP may be in the first configured note, but not in the first note.

Determines if the selection is at the start, end or other position in the string. Accounts for writing system direction based on the line spec.

Finds a real analysis in the segment from the indicated direction. When used just to check if there is an analysis, the direction doesn't matter.

Gets the current selection and returns enough data to move the IP.

Retrieves the selected objects and data from the selection range.

Gets the first visible (non-null and configured) translation or note line in the current segment.

Assumes the selection data belongs to a translation or note! Gets the InterlinLineChoices flid (id) and a meaningful interpretation of where the IP is in the translation or note text. If an empty translation note was selected, its tag is kTagUserPrompt.

Get the next segment with either a non-null annotation that is configured or a non-punctuation analysis. Also skip segments that are Scripture labels (like Chapter/Verse/Footnote numbers. It tries the next one after the SelectedOccurrence.Segment then tries the next paragraph, etc.. Use this version if the calling code already has the actual para/seg objects.

Get the next segment with either a non-null annotation that is configured or a non-punctuation analysis. It tries the next one after the SelectedOccurrence.Segment then tries the next paragraph, etc..

Answer true if the indicated selection is within a single note we can delete. Also obtain the object and property.

Performs a change in IP when arrow keys should take the IP from a translation or note to an analysis. Also handles right and left arrow for empty translation lines via the output enum. two directions of concern for Left to Right(LTR) and Right To Left(RTL): 1: up from the first translation or note in a paragraph after a word line possibly in another paragraph via up arrow or a left (right if RTL) arrow from the first (last) character of the annotaton 2: down from the last translation or note in a paragraph before a word line possibly in another paragraph via down arrow or a right (left if RTL) arrow from the last (right) character of the annotaton The following logic accounts for the configured position of notes and whether the user added them. The idea here is to eliminate as many default cases as possible as early as possible to be handled by the old annotation OnKeyDown() method.

Determines if there are visible translation or note - non null and configured.

Determines if a visible translation or note is the next line in the indicated direction (up or down).

Sets up the tags for the 0 level of a selection of a free translation or note. This will be the level "inside" the ones that select the paragraph and segment. For a note, we need to select the first note. For a free translation, we need to insert the level for the 'self' property which the VC inserts to isolate the free translations and make it easier to update them.

Return the selection that corresponds to the SandBox position.

Moves from the current segment to the next that has a real word line or a real translation or note depending on the direction. If none, try the appropriate segment in the next paragraph. Continue until a suitable analysis or translation or note is found or there are no more to check.

Return the first non-null translation or note selection in the specified segment. The segment does not need to be the current occurance.

Select the first non-null translation or note in the current segment of the current analysis occurance.

This computes and saves the information needed to ensure the insertion point is placed on the correct line of a multilingual annotation when replacing a user prompt. See LT-9421.

Something about the display of the AnalysisOccurrence has changed...perhaps it has become or ceased to be the current annotation displayed using the Sandbox, or the Sandbox changed size. Produce a PropChanged that makes the system think it has been replaced (with itself) to refresh the relevant part of the display.

Hides the sandbox and removes it from the controls.

Adds the sandbox to the control and makes it visible.

Answers true if there is a "real" analysis in the segment.