C# Class XCore.MultiPane

A MultiPane (actually currently more a DualPane) displays two child controls, either side by side or one above the other, with a splitter between them. It is normally created using XML like this: The vertical parameter causes the two controls to be one above the other, if true, or side by side, if false. (Default, if omitted, is true.) The id parameter gives the MultiPane a name (which should be unique across the whole containing application) to use in storing state, such as the position of the splitter, persistently. It is mandatory to specify the area that the control is part of, but I (JT) don't know why. If the mediator has a property called id_ShowFirstPane (e.g., LexEntryAndEditor_ShowFirstPane), it will control the visibility of the first pane (visible if the property is true).
IxCoreContentControl includes IxCoreColleague now, so only IxCoreContentControl needs to be declared here.
Inheritance: XCore.CollapsingSplitContainer, IxCoreContentControl, IXCoreUserControl
Afficher le fichier Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Свойство Type Description
GetPropertyControllingVisibilityOfFirstPane string
Init void
InitializeComponent void
MakeSubControl void
PopulateCtrlTabTargetCandidateList System.Windows.Forms.Control
SetFocusInDefaultControl void
SetSplitterDistance void

Méthodes publiques

Méthode Description
GetMessageTargets ( ) : IxCoreColleague[]

return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast

MultiPane ( ) : System
OnPropertyChanged ( string name ) : void
PrepareToGoAway ( ) : bool

Méthodes protégées

Méthode Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

OnSizeChanged ( EventArgs e ) : void
OnSplitterMoved ( object sender, System.Windows.Forms.SplitterEventArgs e ) : void

Private Methods

Méthode Description
GetPropertyControllingVisibilityOfFirstPane ( XmlNode configurationNodeOfFirstPane ) : string
Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

MakeSubControl ( XmlNode configuration, Size parentSizeHint, bool isFirst ) : void
PopulateCtrlTabTargetCandidateList ( List targetCandidates ) : Control
SetFocusInDefaultControl ( ) : void

The focus will only be set in the default control if it implements IFocusablePanePortion. Note that it may BE our First or SecondPane, or it may be a child of one of those.

SetSplitterDistance ( ) : void

Method Details

Dispose() protected méthode

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool
Résultat void

GetMessageTargets() public méthode

return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast
public GetMessageTargets ( ) : IxCoreColleague[]
Résultat IxCoreColleague[]

MultiPane() public méthode

public MultiPane ( ) : System
Résultat System

OnPropertyChanged() public méthode

public OnPropertyChanged ( string name ) : void
name string
Résultat void

OnSizeChanged() protected méthode

protected OnSizeChanged ( EventArgs e ) : void
e System.EventArgs
Résultat void

OnSplitterMoved() protected méthode

protected OnSplitterMoved ( object sender, System.Windows.Forms.SplitterEventArgs e ) : void
sender object
e System.Windows.Forms.SplitterEventArgs
Résultat void

PrepareToGoAway() public méthode

public PrepareToGoAway ( ) : bool
Résultat bool