Client.Reference Class Reference

Create a new reference to a piece of literature. More...

List of all members.

Public Member Functions
	Reference (ISearchable[] allItems, ReferenceInfo[] References, int projectID)
	The Reference form constructor.
	Reference (ISearchable[] allItems, ReviewInfo[] Reviews, int projectID)
	The Reference form constructor.
	Reference (ISearchable[] allItems)
	The Reference form constructor.
Public Attributes
int	ID = -1
	The ID of the selected literature.
Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.
Private Member Functions
void	FilterListbox (string filter)
	Fills out the listBox with items from the internal items Dictionary.
void	txtFilter_TextChanged (object sender, EventArgs e)
	When the filter textbox chances...
void	txtFilter_Enter (object sender, EventArgs e)
	Clear the filter text-box of the Filter... text when it is entered.
void	txtFilter_Leave (object sender, EventArgs e)
	Put the Filter... text back into the text box upon leaving.
void	btnCancel_Click (object sender, EventArgs e)
	Clear the ID to -1 before closing if we're cancled.
void	btnOK_Click (object sender, EventArgs e)
	Since the ID is set automatically, just close the form on OK.
void	listReferences_SelectedIndexChanged (object sender, EventArgs e)
	When the user selects an item, set the corresponding ID.
void	listReferences_DoubleClick (object sender, EventArgs e)
	If the user double-clicks an item, that means they want to select that item. Set the ID and close!
void	btoAddLit_Click (object sender, EventArgs e)
void	Reference_Shown (object sender, EventArgs e)
void	InitializeComponent ()
	Required method for Designer support - do not modify the contents of this method with the code editor.
Private Attributes
Dictionary< int, string >	items = new Dictionary<int, string>()
	All items, by title.
List< int >	IDList = new List<int>()
	The list of IDs to fetch the ID from when the form is closed.
System.ComponentModel.IContainer	components = null
	Required designer variable.
System.Windows.Forms.TextBox	txtFilter
System.Windows.Forms.ListBox	listReferences
System.Windows.Forms.Panel	panel1
System.Windows.Forms.Button	btnOK
System.Windows.Forms.Button	btnCancel
System.Windows.Forms.Button	btoAddLit

---

Detailed Description

Create a new reference to a piece of literature.

Definition at line 15 of file Reference.cs.

---

Constructor & Destructor Documentation

Client.Reference.Reference	(	ISearchable[]	allItems,
		ReferenceInfo[]	References,
		int	projectID
	)

The Reference form constructor.

Parameters:

	allItems	A list of all the items to show
	References	A list of existing references
	projectID	Project ID

Definition at line 30 of file Reference.cs.

References Client.Reference.IDList, Client.Reference.InitializeComponent(), Client.Reference.items, and Client.Reference.listReferences.

Here is the call graph for this function:

Client.Reference.Reference	(	ISearchable[]	allItems,
		ReviewInfo[]	Reviews,
		int	projectID
	)

The Reference form constructor.

Parameters:

	allItems	A list of all the items to show
	Reviews	A list of existing Reviews
	projectID	Project ID

Definition at line 64 of file Reference.cs.

References Client.Reference.IDList, Client.Reference.InitializeComponent(), Client.Reference.items, and Client.Reference.listReferences.

Here is the call graph for this function:

Client.Reference.Reference

(

ISearchable[]

allItems

)

The Reference form constructor.

Parameters:

allItems

A list of all the items to show

Definition at line 97 of file Reference.cs.

References Client.Reference.IDList, Client.Reference.InitializeComponent(), Client.Reference.items, and Client.Reference.listReferences.

Here is the call graph for this function:

---

Member Function Documentation

void Client.Reference.FilterListbox

(

string

filter

)

[private]

Fills out the listBox with items from the internal items Dictionary.

Parameters:

filter

The text to filter the items against

Definition at line 125 of file Reference.cs.

References Client.Reference.IDList, Client.Reference.items, and Client.Reference.listReferences.

Referenced by Client.Reference.txtFilter_TextChanged().

Here is the caller graph for this function:

void Client.Reference.txtFilter_TextChanged	(	object	sender,
		EventArgs	e
	)			[private]

When the filter textbox chances...

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 144 of file Reference.cs.

References Client.Reference.FilterListbox(), Client.Reference.IDList, Client.Reference.items, Client.Reference.listReferences, and Client.Reference.txtFilter.

Referenced by Client.Reference.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

void Client.Reference.txtFilter_Enter	(	object	sender,
		EventArgs	e
	)			[private]

Clear the filter text-box of the Filter... text when it is entered.

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 165 of file Reference.cs.

References Client.Reference.txtFilter.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

void Client.Reference.txtFilter_Leave	(	object	sender,
		EventArgs	e
	)			[private]

Put the Filter... text back into the text box upon leaving.

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 179 of file Reference.cs.

References Client.Reference.txtFilter.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

void Client.Reference.btnCancel_Click	(	object	sender,
		EventArgs	e
	)			[private]

Clear the ID to -1 before closing if we're cancled.

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 193 of file Reference.cs.

References Client.Reference.ID.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

void Client.Reference.btnOK_Click	(	object	sender,
		EventArgs	e
	)			[private]

Since the ID is set automatically, just close the form on OK.

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 204 of file Reference.cs.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

void Client.Reference.listReferences_SelectedIndexChanged	(	object	sender,
		EventArgs	e
	)			[private]

When the user selects an item, set the corresponding ID.

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 214 of file Reference.cs.

References Client.Reference.ID, Client.Reference.IDList, and Client.Reference.listReferences.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

void Client.Reference.listReferences_DoubleClick	(	object	sender,
		EventArgs	e
	)			[private]

If the user double-clicks an item, that means they want to select that item. Set the ID and close!

Parameters:

	sender	Who is calling?
	e	What arguments do they give us?

Definition at line 227 of file Reference.cs.

References Client.Reference.ID, Client.Reference.IDList, and Client.Reference.listReferences.

Referenced by Client.Reference.InitializeComponent().

Here is the caller graph for this function:

override void Client.Reference.Dispose

(

bool

disposing

)

[protected]

Clean up any resources being used.

Parameters:

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 14 of file Reference.Designer.cs.

References Client.Reference.components.

void Client.Reference.InitializeComponent

(

)

[private]

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

Definition at line 29 of file Reference.Designer.cs.

References Client.Reference.btnCancel, Client.Reference.btnCancel_Click(), Client.Reference.btnOK, Client.Reference.btnOK_Click(), Client.Reference.btoAddLit, Client.Reference.btoAddLit_Click(), Client.Reference.listReferences, Client.Reference.listReferences_DoubleClick(), Client.Reference.listReferences_SelectedIndexChanged(), Client.Reference.panel1, Client.Reference.Reference_Shown(), Client.Reference.txtFilter, Client.Reference.txtFilter_Enter(), Client.Reference.txtFilter_Leave(), and Client.Reference.txtFilter_TextChanged().

Referenced by Client.Reference.Reference().

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

Dictionary<int, string> Client.Reference.items = new Dictionary<int, string>() [private]

All items, by title.

Definition at line 18 of file Reference.cs.

Referenced by Client.Reference.FilterListbox(), Client.Reference.Reference(), and Client.Reference.txtFilter_TextChanged().

List<int> Client.Reference.IDList = new List<int>() [private]

The list of IDs to fetch the ID from when the form is closed.

Definition at line 20 of file Reference.cs.

Referenced by Client.Reference.FilterListbox(), Client.Reference.listReferences_DoubleClick(), Client.Reference.listReferences_SelectedIndexChanged(), Client.Reference.Reference(), and Client.Reference.txtFilter_TextChanged().

int Client.Reference.ID = -1

The ID of the selected literature.

Definition at line 22 of file Reference.cs.

Referenced by Client.ProjectView.btnAddReference_Click(), Client.Reference.btnCancel_Click(), Client.ProjectView.btnReview_Click(), Client.Reference.btoAddLit_Click(), Client.LiteratureEntryView.findProjectToolStripMenuItem_Click(), Client.Reference.listReferences_DoubleClick(), and Client.Reference.listReferences_SelectedIndexChanged().

System.ComponentModel.IContainer Client.Reference.components = null [private]

Required designer variable.

Definition at line 8 of file Reference.Designer.cs.

Referenced by Client.Reference.Dispose().

---

The documentation for this class was generated from the following files:

• Client/Reference.cs
• Client/Reference.Designer.cs

---