C# Class SIL.FieldWorks.FwCoreDlgs.FwUpdateReportDlg

Base class for displaying somewhat "techie" information to report on changes that were applied automatically to a project but which the user might need to review.

This is intended to be an abstract base class, but making it abstract messes up the Designer in the derived classes. You should override HelpTopicKey

Inheritance: System.Windows.Forms.Form, IFWDisposable

Show file Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
columnHeader1	System.Windows.Forms.ColumnHeader
lblWarning	System.Windows.Forms.Label
printDocument	System.Drawing.Printing.PrintDocument
saveFileDialog	SaveFileDialogAdapter

Public Methods

Method	Description
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
FwUpdateReportDlg ( ) : System	Constructor for FwUpdateReportDlg
FwUpdateReportDlg ( List itemsToReport, string projectName, IHelpTopicProvider helpTopicProvider ) : System	Constructor for FwUpdateReportDlg

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnLoad ( EventArgs e ) : void	Raises the E:System.Windows.Forms.Form.Load event.

Private Methods

Method	Description
InitializeComponent ( ) : void
StringToByteArray ( string stringToConvert ) : byte[]	Convert string to byte array.
btnHelp_Click ( object sender, EventArgs e ) : void	Handle click on the "Help" button.
btnPrintRpt_Click ( object sender, EventArgs e ) : void	Handle click on the "Print Report..." button.
btnSaveRpt_Click ( object sender, EventArgs e ) : void	Handle click on the "Save Report..." button.
lvItems_SizeChanged ( object sender, EventArgs e ) : void	Handles the SizeChanged event of the lvItems control.
printDocument_BeginPrint ( object sender, PrintEventArgs e ) : void
printDocument_PrintPage ( object sender, PrintPageEventArgs e ) : void	Handle PrintPage event.

Method Details

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
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

FwUpdateReportDlg() public method

Constructor for FwUpdateReportDlg

public FwUpdateReportDlg ( ) : System
return	System

FwUpdateReportDlg() public method

Constructor for FwUpdateReportDlg

public FwUpdateReportDlg ( List itemsToReport, string projectName, IHelpTopicProvider helpTopicProvider ) : System
itemsToReport	List	List of items to report in the list.
projectName	string	Name of the project.
helpTopicProvider	IHelpTopicProvider	context sensitive help
return	System

OnLoad() protected method

Raises the E:System.Windows.Forms.Form.Load event.

protected OnLoad ( EventArgs e ) : void
e	System.EventArgs	An that contains the event data.
return	void

Property Details

columnHeader1 protected property

protected System.Windows.Forms.ColumnHeader columnHeader1
return	System.Windows.Forms.ColumnHeader

lblWarning protected property

protected System.Windows.Forms.Label lblWarning
return	System.Windows.Forms.Label

printDocument protected property

protected System.Drawing.Printing.PrintDocument printDocument
return	System.Drawing.Printing.PrintDocument

saveFileDialog protected property

protected SaveFileDialogAdapter saveFileDialog
return	SaveFileDialogAdapter