C# Class SIL.FieldWorks.Common.Framework.DetailControls.Slice.Slice

This is called when clearing the slice collection, or otherwise about to remove a slice from its parent and discard it. It allows us to put views into a state where they won't waste time if they get an OnLoad message somewhere in the course of clearing them from the collection. (LT-3118 is one problem this helped with.)

In some contexts we insert into the slice array

Some 'unreal' slices can become 'real' (ready to actually display) without actually replacing themselves with a different object. Such slices override this method to do whatever is needed and then answer true. If a slice answers false to IsRealSlice, this is tried, and if it returns false, then BecomeReal is called.

Check whether a "Delete Reference" command can be executed. Currently implemented only for the VariantEntryBackRefs / LexEntry/EntryRefs/ComponentLexemes references.

Draws the label in the containing SilTreeControl's Graphics object at the specified position. Override if you have a more complex type of label, e.g., if the field contains interlinear data and you want to label each line.

Expand this node, which is at position iSlice in its parent.

I (JH) don't know why this was written to take the index of the slice. It's just as easy for this class to find its own index. JohnT: for performance; finding its own index is a linear search, and the caller often has the info already, especially in loops expanding many children.

Find a slice nested below this one whose object is hvo and expand it if it is collapsed.

This method should be called once the various properties of the slice have been set, particularly the Cache, Object, Key, and Spec. The slice may create its Control in this method, so don't assume it exists before this is called. It should be called before installing the slice.

Returns the height, from the top of the item, at which to draw the line across towards it. Typically this is the center of where DrawLabel will draw the label, but it might not be (e.g., if DrawLabel actually draws two labels and a bit of tree diagram).

is it possible to do a deletion menu command on this slice right now?

Is it possible to do a merge menu command on this slice right now?

Is it possible to do a split menu command on this slice right now?

Main work of deleting an object; answer true if it was actually deleted.

Handle a "Delete Reference" command. Currently implemented only for the VariantEntryBackRefs / LexEntry/EntryRefs/ComponentLexemes references.

do an insertion

called by the containing environment in response to a user command.

do an insertion

called by the containing environment in response to a user command.

This was added for Lexical Relation slices which now have the Add/Replace Reference menu item in the dropdown menu.

This is passed the color that the XDE specified, if any, otherwise null. The default is to use the normal window color for editable text. Subclasses which know they should have a different default should override this method, but normally should use the specified color if not null.

We tend to get a visual stuttering effect if sub-controls are made visible before the main slice is correctly positioned. This method is called after the slice is positioned to give it a chance to make embedded controls visible. This default implementation does nothing.

The slice should become the focus slice (and return true). If the fOkToFocusTreeNode argument is false, this should happen iff it has a control which is appropriate to focus. Note: JohnT: recently I noticed that trying to focus the tree node doesn't seem to do anything; I'm not sure passing true is useful.

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.

Get the flid for the specified field name of this slice's object. May return zero if the object does not have that field.

Focus the main child control, if possible.

If we don't have a splitter (because no label), set the width of the tree node directly; the other node's size is set by being docked 'fill'.

extract the "part ref" node from the slice.Key

This is used to control the width of the slice when the data tree is being laid out. Any earlier width set is meaningless. Some slices can avoid doing a lot of work by ignoring earlier OnSizeChanged messages.

Updates the display of a slice, if an hvo and tag it cares about has changed in some way.

This method determines how much we should indent nodes produced from "part ref" elements embedded inside an "indent" element in another "part ref" element. Currently, by default we in fact do NOT add any indent, unless there is also an attribute indent="true".

Insert a new object of the specified class into the specified property of your object.

Answer whether clidTest is, or is a subclass of, clidSig. That is, either clidTest is the same as clidSig, or one of the base classes of clidTest is clidSig. As a special case, if clidSig is 0, all classes are considered to match

Attempt to set the split position, but do NOT modify the global setting for the data tree if unsuccessful. This occurs during window initialization, since (I think) slices are created before the proper width is set for the containing data pane, and the constraints on the width of the splitter may not allow it to take on the persisted position.

Return true if the target array starts with the objects in the match array.

Generates a possible help topic id from the field name, but does NOT check it for validity!

Is m_helpTopic a valid help topic?

Note: There are two SplitterDistance event handlers on a Slice. This one handles the side effects of redrawing the tree node, when needed. Another one on DataTree takes care of updating the SplitterDisance on all the other slices.