C# Класс SIL.FieldWorks.XWorks.MorphologyEditor.RuleFormulaControl

This class class represents a rule formula control. It is not intended to be used directly. Specific phonological/morphological rules should extend this class. It is not abstract so that it can be modified in Windows Form designer. It is a button launcher with a rule formula view and a rule insertion control. It handles selection, deletion, insertion, and cursor movement for a rule formula. Rules that extend this class override the methods that provide information about the various table cells in the rule and the data contained in each cell.
Наследование: SIL.FieldWorks.Common.Framework.DetailControls.ButtonLauncher
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
m_insertionControl SIL.FieldWorks.LexText.Controls.InsertionControl
m_view SIL.FieldWorks.LexText.Controls.PatternView

Открытые методы

Метод Описание
GetContext ( SelectionHelper sel ) : object
GetContext ( SelectionHelper sel, SelectionHelper limit ) : object
GetContextCount ( object ctxt ) : int
GetFlid ( object ctxt ) : int
GetItem ( SelectionHelper sel, SelectionHelper limit ) : object
GetItemContextIndex ( object ctxt, object obj ) : int
GetLevelInfo ( object ctxt, int index ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
GetNextContext ( object ctxt ) : object
GetPrevContext ( object ctxt ) : object
Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore.Mediator mediator, string displayNameProperty, string displayWs ) : void
RuleFormulaControl ( ) : System
RuleFormulaControl ( XmlNode configurationNode ) : System
SetContextFeatures ( ) : void

Sets the phonological features for the currently selected natural class simple context with a feature-based natural class.

Защищенные методы

Метод Описание
DisplayChooser ( string fieldName, string linkText, string toolName, string guiControl, IEnumerable candidates ) : ICmObject
GetCell ( SelectionHelper sel ) : int
GetCell ( SelectionHelper sel, SelectionHelper limit ) : int
GetCellCount ( int cellId ) : int
GetCmObject ( SelectionHelper sel, SelectionHelper limit ) : ICmObject
GetFlid ( int cellId ) : int
GetIndexToRemove ( ICmObject objs, SelectionHelper sel, bool forward ) : int
GetIndicesToRemove ( ICmObject objs, SelectionHelper sel ) : int[]
GetInsertionIndex ( ICmObject objs, SelectionHelper sel ) : int
GetItemCellIndex ( int cellId, ICmObject obj ) : int
GetLevelInfo ( int cellId, int index ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
GetNextCell ( int cellId ) : int
GetPrevCell ( int cellId ) : int
HandleChooser ( ) : void

Handle launching of the environment chooser.

Subclasses should override this method, if the SimpleListChooser is not suitable.

InsertBdry ( IPhBdryMarker bdry, SelectionHelper sel, int &cellIndex ) : int

Inserts an item from a boundary.

InsertColumn ( SelectionHelper sel ) : int

Inserts a new column.

InsertContextInto ( IPhSimpleContext ctxt, SelectionHelper sel, IFdoOwningSequence seq ) : int
InsertContextInto ( IPhSimpleContext ctxt, SelectionHelper sel, IPhSequenceContext seqCtxt ) : int
InsertIndex ( int index, SelectionHelper sel, int &cellIndex ) : int

Inserts an item from the specified rule mapping index.

InsertNC ( IPhNaturalClass nc, SelectionHelper sel, int &cellIndex, IPhSimpleContextNC &ctxt ) : int

Inserts an item from a natural class.

InsertPhoneme ( IPhPhoneme phoneme, SelectionHelper sel, int &cellIndex ) : int

Inserts an item from a phoneme.

InsertVariable ( SelectionHelper sel, int &cellIndex ) : int

Inserts the variable (PhVariable).

ReconstructView ( int cellId, int cellIndex, bool initial ) : void

Reconstructs the view and moves the cursor the specified position.

RemoveContextsFrom ( bool forward, SelectionHelper sel, IFdoOwningSequence seq, bool preRemovalSideEffects, int &index ) : bool
RemoveContextsFrom ( bool forward, SelectionHelper sel, IPhSequenceContext seqCtxt, bool preRemovalSideEffects, int &index ) : bool
RemoveItems ( SelectionHelper sel, bool forward, int &cellIndex ) : int

Removes items based on the specified selection and direction.

SetupPhonologicalFeatureChoooserDlg ( PhonologicalFeatureChooserDlg featChooser ) : void
UpdateEnvironment ( IPhEnvironment env ) : int

Updates the environment.

Приватные методы

Метод Описание
ContextMenuRequested ( object sender, ContextMenuRequestedEventArgs e ) : void
GetOptionString ( RuleInsertType type ) : string
InitializeComponent ( ) : void
InsertNC ( IPhNaturalClass nc, SelectionHelper sel, int &cellIndex ) : int
IsMorphBoundary ( IPhContextOrVar ctxt ) : bool
IsWordBoundary ( IPhContextOrVar ctxt ) : bool
ProcessIndicesSeqContext ( ICmObject ctxts, bool preRemovalSideEffects, int idx ) : void
ProcessIndicesSimpleContext ( IFdoOwningSequence seq, ICmObject ctxts, bool preRemovalSideEffects, int idx ) : void
RemoveItemsRequested ( object sender, RemoveItemsRequestedEventArgs e ) : void
SelectionChanged ( object sender, EventArgs eventArgs ) : void
ToCellId ( object ctxt ) : int
ToContextObject ( int cellId ) : object
m_insertionControl_Insert ( object sender, InsertEventArgs e ) : void

Handles the Insert event of the m_insertionControl control.

Описание методов

DisplayChooser() защищенный Метод

protected DisplayChooser ( string fieldName, string linkText, string toolName, string guiControl, IEnumerable candidates ) : ICmObject
fieldName string
linkText string
toolName string
guiControl string
candidates IEnumerable
Результат ICmObject

GetCell() защищенный Метод

protected GetCell ( SelectionHelper sel ) : int
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат int

GetCell() защищенный Метод

protected GetCell ( SelectionHelper sel, SelectionHelper limit ) : int
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
limit SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат int

GetCellCount() защищенный Метод

protected GetCellCount ( int cellId ) : int
cellId int
Результат int

GetCmObject() защищенный Метод

protected GetCmObject ( SelectionHelper sel, SelectionHelper limit ) : ICmObject
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
limit SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат ICmObject

GetContext() публичный Метод

public GetContext ( SelectionHelper sel ) : object
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат object

GetContext() публичный Метод

public GetContext ( SelectionHelper sel, SelectionHelper limit ) : object
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
limit SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат object

GetContextCount() публичный Метод

public GetContextCount ( object ctxt ) : int
ctxt object
Результат int

GetFlid() защищенный Метод

protected GetFlid ( int cellId ) : int
cellId int
Результат int

GetFlid() публичный Метод

public GetFlid ( object ctxt ) : int
ctxt object
Результат int

GetIndexToRemove() защищенный Метод

protected GetIndexToRemove ( ICmObject objs, SelectionHelper sel, bool forward ) : int
objs ICmObject
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
forward bool
Результат int

GetIndicesToRemove() защищенный Метод

protected GetIndicesToRemove ( ICmObject objs, SelectionHelper sel ) : int[]
objs ICmObject
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат int[]

GetInsertionIndex() защищенный Метод

protected GetInsertionIndex ( ICmObject objs, SelectionHelper sel ) : int
objs ICmObject
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат int

GetItem() публичный Метод

public GetItem ( SelectionHelper sel, SelectionHelper limit ) : object
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
limit SIL.FieldWorks.Common.RootSites.SelectionHelper
Результат object

GetItemCellIndex() защищенный Метод

protected GetItemCellIndex ( int cellId, ICmObject obj ) : int
cellId int
obj ICmObject
Результат int

GetItemContextIndex() публичный Метод

public GetItemContextIndex ( object ctxt, object obj ) : int
ctxt object
obj object
Результат int

GetLevelInfo() защищенный Метод

protected GetLevelInfo ( int cellId, int index ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
cellId int
index int
Результат SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]

GetLevelInfo() публичный Метод

public GetLevelInfo ( object ctxt, int index ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
ctxt object
index int
Результат SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]

GetNextCell() защищенный Метод

protected GetNextCell ( int cellId ) : int
cellId int
Результат int

GetNextContext() публичный Метод

public GetNextContext ( object ctxt ) : object
ctxt object
Результат object

GetPrevCell() защищенный Метод

protected GetPrevCell ( int cellId ) : int
cellId int
Результат int

GetPrevContext() публичный Метод

public GetPrevContext ( object ctxt ) : object
ctxt object
Результат object

HandleChooser() защищенный Метод

Handle launching of the environment chooser.
Subclasses should override this method, if the SimpleListChooser is not suitable.
protected HandleChooser ( ) : void
Результат void

Initialize() публичный Метод

public Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore.Mediator mediator, string displayNameProperty, string displayWs ) : void
cache SIL.FieldWorks.FDO.FdoCache
obj ICmObject
flid int
fieldName string
persistProvider IPersistenceProvider
mediator XCore.Mediator
displayNameProperty string
displayWs string
Результат void

InsertBdry() защищенный Метод

Inserts an item from a boundary.
protected InsertBdry ( IPhBdryMarker bdry, SelectionHelper sel, int &cellIndex ) : int
bdry IPhBdryMarker The boundary.
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The sel.
cellIndex int Index of the new item.
Результат int

InsertColumn() защищенный Метод

Inserts a new column.
protected InsertColumn ( SelectionHelper sel ) : int
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
Результат int

InsertContextInto() защищенный Метод

protected InsertContextInto ( IPhSimpleContext ctxt, SelectionHelper sel, IFdoOwningSequence seq ) : int
ctxt IPhSimpleContext
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
seq IFdoOwningSequence
Результат int

InsertContextInto() защищенный Метод

protected InsertContextInto ( IPhSimpleContext ctxt, SelectionHelper sel, IPhSequenceContext seqCtxt ) : int
ctxt IPhSimpleContext
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
seqCtxt IPhSequenceContext
Результат int

InsertIndex() защищенный Метод

Inserts an item from the specified rule mapping index.
protected InsertIndex ( int index, SelectionHelper sel, int &cellIndex ) : int
index int The rule mapping index.
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
cellIndex int Index of the new item.
Результат int

InsertNC() защищенный Метод

Inserts an item from a natural class.
protected InsertNC ( IPhNaturalClass nc, SelectionHelper sel, int &cellIndex, IPhSimpleContextNC &ctxt ) : int
nc IPhNaturalClass The natural class.
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
cellIndex int Index of the new item.
ctxt IPhSimpleContextNC The new context.
Результат int

InsertPhoneme() защищенный Метод

Inserts an item from a phoneme.
protected InsertPhoneme ( IPhPhoneme phoneme, SelectionHelper sel, int &cellIndex ) : int
phoneme IPhPhoneme The phoneme.
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
cellIndex int Index of the new item.
Результат int

InsertVariable() защищенный Метод

Inserts the variable (PhVariable).
protected InsertVariable ( SelectionHelper sel, int &cellIndex ) : int
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
cellIndex int Index of the new item.
Результат int

ReconstructView() защищенный Метод

Reconstructs the view and moves the cursor the specified position.
protected ReconstructView ( int cellId, int cellIndex, bool initial ) : void
cellId int The cell id.
cellIndex int Index of the item in the cell.
initial bool if true move the cursor to the beginning of the specified item, otherwise it is moved to the end
Результат void

RemoveContextsFrom() защищенный Метод

protected RemoveContextsFrom ( bool forward, SelectionHelper sel, IFdoOwningSequence seq, bool preRemovalSideEffects, int &index ) : bool
forward bool
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
seq IFdoOwningSequence
preRemovalSideEffects bool
index int
Результат bool

RemoveContextsFrom() защищенный Метод

protected RemoveContextsFrom ( bool forward, SelectionHelper sel, IPhSequenceContext seqCtxt, bool preRemovalSideEffects, int &index ) : bool
forward bool
sel SIL.FieldWorks.Common.RootSites.SelectionHelper
seqCtxt IPhSequenceContext
preRemovalSideEffects bool
index int
Результат bool

RemoveItems() защищенный Метод

Removes items based on the specified selection and direction.
protected RemoveItems ( SelectionHelper sel, bool forward, int &cellIndex ) : int
sel SIL.FieldWorks.Common.RootSites.SelectionHelper The selection.
forward bool if true delete button was used, otherwise backspace was used
cellIndex int Index of the item before the removed items.
Результат int

RuleFormulaControl() публичный Метод

public RuleFormulaControl ( ) : System
Результат System

RuleFormulaControl() публичный Метод

public RuleFormulaControl ( XmlNode configurationNode ) : System
configurationNode System.Xml.XmlNode
Результат System

SetContextFeatures() публичный Метод

Sets the phonological features for the currently selected natural class simple context with a feature-based natural class.
public SetContextFeatures ( ) : void
Результат void

SetupPhonologicalFeatureChoooserDlg() защищенный Метод

protected SetupPhonologicalFeatureChoooserDlg ( PhonologicalFeatureChooserDlg featChooser ) : void
featChooser PhonologicalFeatureChooserDlg
Результат void

UpdateEnvironment() защищенный Метод

Updates the environment.
protected UpdateEnvironment ( IPhEnvironment env ) : int
env IPhEnvironment The environment.
Результат int

Описание свойств

m_insertionControl защищенное свойство

protected InsertionControl,SIL.FieldWorks.LexText.Controls m_insertionControl
Результат SIL.FieldWorks.LexText.Controls.InsertionControl

m_view защищенное свойство

protected PatternView,SIL.FieldWorks.LexText.Controls m_view
Результат SIL.FieldWorks.LexText.Controls.PatternView