C# Class SIL.FieldWorks.Discourse.ConstChartBody

The main body of the chart, containing the actual view of the charted words.

Inheritance: SIL.FieldWorks.Common.RootSites.RootSite

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property	Type	Description
CalculateHoverButtonHorizPosition	int
GetCellInfo	bool
GetIndexOfTopLevelObject	int
InitializeComponent	void
LogicalFromDisplay	int
MakeRowSelection	IVwSelection
SelectAndScrollToAnalysisOccurrence	void
SelectAndScrollToBookmark	void
SelectAndScrollToLoc	void
SetHoverButtonLocation	void
m_cellContextMenu_Closed	void
m_logic_RowModifiedEvent	void

Public Methods

Method	Description
AdjustPrintDialog ( System.Windows.Forms.PrintDialog dlg ) : void	The constituent chart typically wants to take up all the page it can, in landscape mode! Enhance JohnT: eventually we should have a page layout diagram that allows at least this to be controlled.
ConstChartBody ( ConstituentChartLogic logic, ConstituentChart chart ) : System	Make one.
GetColumnContentsWidth ( int icolChanged ) : int	measures the width of the strings built by the display of a column and returns the maximumn width found. NOTE: you may need to add a small (e.g. under 10-pixel) margin to prevent wrapping in most cases.
MakeRoot ( ) : void
SetColWidths ( int widths ) : void
SetRoot ( IDsConstChart chart, ICmPossibility allColumns ) : void	Change the root chart. This version takes the actual chart object.
SetRoot ( int hvoChart, ICmPossibility allColumns ) : void	Change the root chart.
SetRoot ( int hvoChart, ICmPossibility allColumns, bool fRightToLeft ) : void	Change the root chart.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void
GetPrintInfo ( int &hvo, IVwViewConstructor &vc, int &frag, IVwStylesheet &ss ) : void
OnHandleCreated ( EventArgs e ) : void
OnMouseDown ( MouseEventArgs e ) : void
OnMouseLeave ( EventArgs e ) : void
OnMouseMove ( MouseEventArgs e ) : void
OnPaint ( PaintEventArgs e ) : void

Private Methods

Method	Description
CalculateHoverButtonHorizPosition ( int columnIndex, bool fRtl ) : int
GetCellInfo ( MouseEventArgs e, SIL.FieldWorks.Discourse.ChartLocation &clickedCell, int &irow ) : bool	Get info about which cell the user clicked in.
GetIndexOfTopLevelObject ( TextSelInfo info, bool fEndPoint ) : int
InitializeComponent ( ) : void
LogicalFromDisplay ( int icol ) : int	Gets the logical column index from the display column index. (If the chart is for a RTL script, the 2 column orders are swapped.)
MakeRowSelection ( IConstChartRow row, bool fInstall ) : IVwSelection
SelectAndScrollToAnalysisOccurrence ( AnalysisOccurrence occurrence ) : void	Select and scroll to Chart location closest to an AnalysisOccurrence. Takes into account ChOrphs by finding nearest charted location.
SelectAndScrollToBookmark ( InterAreaBookmark bookmark ) : void	Selects and scrolls to the bookmarked location in the constituent chart.
SelectAndScrollToLoc ( SIL.FieldWorks.Discourse.ChartLocation chartLoc, bool fbookmark ) : void	Selects and scrolls to the bookmarked location in the constituent chart. This version assumes the bookmarked location has been charted, since the location is passed as a parameter.
SetHoverButtonLocation ( Rect cellRect, int columnIndex ) : void
m_cellContextMenu_Closed ( object sender, System.Windows.Forms.ToolStripDropDownClosedEventArgs e ) : void
m_logic_RowModifiedEvent ( object sender, RowModifiedEventArgs e ) : void

Method Details

AdjustPrintDialog() public method

The constituent chart typically wants to take up all the page it can, in landscape mode! Enhance JohnT: eventually we should have a page layout diagram that allows at least this to be controlled.

public AdjustPrintDialog ( System.Windows.Forms.PrintDialog dlg ) : void
dlg	System.Windows.Forms.PrintDialog
return	void

ConstChartBody() public method

Make one.

public ConstChartBody ( ConstituentChartLogic logic, ConstituentChart chart ) : System
logic	ConstituentChartLogic
chart	ConstituentChart
return	System

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GetColumnContentsWidth() public method

measures the width of the strings built by the display of a column and returns the maximumn width found. NOTE: you may need to add a small (e.g. under 10-pixel) margin to prevent wrapping in most cases.

public GetColumnContentsWidth ( int icolChanged ) : int
icolChanged	int
return	int

GetPrintInfo() protected method

protected GetPrintInfo ( int &hvo, IVwViewConstructor &vc, int &frag, IVwStylesheet &ss ) : void
hvo	int
vc	IVwViewConstructor
frag	int
ss	IVwStylesheet
return	void

MakeRoot() public method

public MakeRoot ( ) : void
return	void

OnHandleCreated() protected method

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

OnMouseDown() protected method

protected OnMouseDown ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnMouseLeave() protected method

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

OnMouseMove() protected method

protected OnMouseMove ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnPaint() protected method

protected OnPaint ( PaintEventArgs e ) : void
e	PaintEventArgs
return	void

SetColWidths() public method

public SetColWidths ( int widths ) : void
widths	int
return	void

SetRoot() public method

Change the root chart. This version takes the actual chart object.

public SetRoot ( IDsConstChart chart, ICmPossibility allColumns ) : void
chart	IDsConstChart
allColumns	ICmPossibility
return	void

SetRoot() public method

Change the root chart.

public SetRoot ( int hvoChart, ICmPossibility allColumns ) : void
hvoChart	int
allColumns	ICmPossibility
return	void

SetRoot() public method

Change the root chart.

public SetRoot ( int hvoChart, ICmPossibility allColumns, bool fRightToLeft ) : void
hvoChart	int
allColumns	ICmPossibility
fRightToLeft	bool
return	void