C# Class SIL.FieldWorks.TE.TeEditorialChecks.EditorialChecksRenderingsControl

The data grid for the Editorial Checks

Inheritance: CheckRenderingControl, IxCoreColleague

Datei anzeigen Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property	Type	Description
AddAsValidCharacter	void
EditCheckingErrorComment	void
GetCheckingError	SIL.FieldWorks.TE.TeEditorialChecks.CheckingError
GetCheckingError	int
GetValidCharacters	List
OnUpdateScrChecksAddAsValidCharacter	bool
OnUpdateScrChecksEditAnnotation	bool
OnUpdateScrChecksIgnored	bool
OnUpdateScrChecksInconsistency	bool
SelectCheckingError	void
m_dataGridView_CellClick	void
m_dataGridView_ColumnHeaderMouseClick	void
m_dataGridView_RowEnter	void
m_dataGridView_RowsAdded	void
m_dataGridView_RowsRemoved	void

Public Methods

Method	Description
EditorialChecksRenderingsControl ( ) : System	Initializes a new instance of the T:EditorialChecksRenderingsControl class.
EditorialChecksRenderingsControl ( SIL.FieldWorks.FDO.FdoCache cache, SIL.FieldWorks.FDO.Scripture.FilteredScrBooks bookFilter, FwMainWnd mainWnd, IHelpTopicProvider helpTopicProvider ) : System	Initializes a new instance of the T:EditorialChecksRenderingsControl class.
GetMessageTargets ( ) : IxCoreColleague[]
Init ( XCore.Mediator mediator, System configurationParameters ) : void
LoadCheckingErrors ( ) : void	Loads all the checking errors into the grid.
LoadCheckingErrors ( List selectedCheckIds ) : void	Loads into the grid, the checking errors for the specified checks.
PropChanged ( int hvo, int tag, int ivMin, int cvIns, int cvDel ) : void

Protected Methods

Method	Description
ChangeZoomPercent ( float oldFactor, float newFactor ) : void
Dispose ( bool disposing ) : void	Clean up any resources being used.
GetPreSortRow ( ) : object	Return the guid of the current row.
OnHandleCreated ( EventArgs e ) : void	Add ourselves from the xCoreColleagues list.
OnHandleDestroyed ( EventArgs e ) : void	Remove ourselves from the xCoreColleagues list.
OnLoadSettings ( Microsoft key ) : void
OnSaveSettings ( RegistryKey key ) : void
OnScrChecksAddAsValidCharacter ( object args ) : bool	For a characters check result, add the "invalid" character as a valid character.
OnScrChecksEditAnnotation ( object args ) : bool
OnScrChecksIgnored ( object args ) : bool
OnScrChecksIgnoredWAnnotation ( object args ) : bool
OnScrChecksInconsistency ( object args ) : bool
OnUpdateScrChecksIgnoredWAnnotation ( object args ) : bool
RestorePreSortRow ( object restoreRow ) : void	Use the supplied information to set the current checking error row.

Private Methods

Method	Description
AddAsValidCharacter ( SIL.FieldWorks.TE.TeEditorialChecks.CheckingError addedCharError ) : void	Adds the "invalid" character as a valid character.
EditCheckingErrorComment ( SIL.FieldWorks.TE.TeEditorialChecks.CheckingError error, string undoRedoLabel, bool fResolve ) : void
GetCheckingError ( int rowIndex ) : SIL.FieldWorks.TE.TeEditorialChecks.CheckingError	Gets the checking error from the specified row.
GetCheckingError ( System.Guid guid ) : int	Gets the index of the checking error for the specified guid. If a checking error for the guid cannot be found, then -1 is returned.
GetValidCharacters ( ) : List	Gets a list of valid characters from the vernacular writing system in the database.
OnUpdateScrChecksAddAsValidCharacter ( object args ) : bool
OnUpdateScrChecksEditAnnotation ( object args ) : bool
OnUpdateScrChecksIgnored ( object args ) : bool
OnUpdateScrChecksInconsistency ( object args ) : bool
SelectCheckingError ( System.Guid guid ) : void	Selects the checking error in the grid to the one whose guid is the same as that specified. If the specified guid cannot be found, then the first checking error in the grid is selected.
m_dataGridView_CellClick ( object sender, System.Windows.Forms.DataGridViewCellEventArgs e ) : void	Handles the CellClick event of the m_dataGridView control.
m_dataGridView_ColumnHeaderMouseClick ( object sender, System.Windows.Forms.DataGridViewCellMouseEventArgs e ) : void
m_dataGridView_RowEnter ( object sender, System.Windows.Forms.DataGridViewCellEventArgs e ) : void	Handles the RowEnter event of the m_dataGridView control.
m_dataGridView_RowsAdded ( object sender, System.Windows.Forms.DataGridViewRowsAddedEventArgs e ) : void
m_dataGridView_RowsRemoved ( object sender, System.Windows.Forms.DataGridViewRowsRemovedEventArgs e ) : void

Method Details

ChangeZoomPercent() protected method

protected ChangeZoomPercent ( float oldFactor, float newFactor ) : void
oldFactor	float
newFactor	float
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

EditorialChecksRenderingsControl() public method

Initializes a new instance of the T:EditorialChecksRenderingsControl class.

public EditorialChecksRenderingsControl ( ) : System
return	System

EditorialChecksRenderingsControl() public method

Initializes a new instance of the T:EditorialChecksRenderingsControl class.

public EditorialChecksRenderingsControl ( SIL.FieldWorks.FDO.FdoCache cache, SIL.FieldWorks.FDO.Scripture.FilteredScrBooks bookFilter, FwMainWnd mainWnd, IHelpTopicProvider helpTopicProvider ) : System
cache	SIL.FieldWorks.FDO.FdoCache	The cache.
bookFilter	SIL.FieldWorks.FDO.Scripture.FilteredScrBooks	The book filter.
mainWnd	SIL.FieldWorks.Common.Framework.FwMainWnd	The FwMainWnd that owns this control.
helpTopicProvider	IHelpTopicProvider	The help topic provider.
return	System

GetMessageTargets() public method

public GetMessageTargets ( ) : IxCoreColleague[]
return	IxCoreColleague[]

GetPreSortRow() protected method

Return the guid of the current row.

protected GetPreSortRow ( ) : object
return	object

Init() public method

public Init ( XCore.Mediator mediator, System configurationParameters ) : void
mediator	XCore.Mediator
configurationParameters	System
return	void

LoadCheckingErrors() public method

Loads all the checking errors into the grid.

public LoadCheckingErrors ( ) : void
return	void

LoadCheckingErrors() public method

Loads into the grid, the checking errors for the specified checks.

public LoadCheckingErrors ( List selectedCheckIds ) : void
selectedCheckIds	List	The list of checkIds for which to show results. /// When this is null, results for all the checks are shown.
return	void

OnHandleCreated() protected method

Add ourselves from the xCoreColleagues list.

protected OnHandleCreated ( EventArgs e ) : void
e	System.EventArgs
return	void

OnHandleDestroyed() protected method

Remove ourselves from the xCoreColleagues list.

protected OnHandleDestroyed ( EventArgs e ) : void
e	System.EventArgs
return	void

OnLoadSettings() protected method

protected OnLoadSettings ( Microsoft key ) : void
key	Microsoft
return	void

OnSaveSettings() protected method

protected OnSaveSettings ( RegistryKey key ) : void
key	Microsoft.Win32.RegistryKey
return	void

OnScrChecksAddAsValidCharacter() protected method

For a characters check result, add the "invalid" character as a valid character.

protected OnScrChecksAddAsValidCharacter ( object args ) : bool
args	object
return	bool

OnScrChecksEditAnnotation() protected method

protected OnScrChecksEditAnnotation ( object args ) : bool
args	object
return	bool

OnScrChecksIgnored() protected method

protected OnScrChecksIgnored ( object args ) : bool
args	object
return	bool

OnScrChecksIgnoredWAnnotation() protected method

protected OnScrChecksIgnoredWAnnotation ( object args ) : bool
args	object
return	bool

OnScrChecksInconsistency() protected method

protected OnScrChecksInconsistency ( object args ) : bool
args	object
return	bool

OnUpdateScrChecksIgnoredWAnnotation() protected method

protected OnUpdateScrChecksIgnoredWAnnotation ( object args ) : bool
args	object
return	bool

PropChanged() public method

public PropChanged ( int hvo, int tag, int ivMin, int cvIns, int cvDel ) : void
hvo	int
tag	int
ivMin	int
cvIns	int
cvDel	int
return	void

RestorePreSortRow() protected method

Use the supplied information to set the current checking error row.

protected RestorePreSortRow ( object restoreRow ) : void
restoreRow	object
return	void