TagControls.TagCloud

TagControls.TagCloud Class Reference

The tag cloud control, which is used to show a weighted list of keywords to the user. More...

List of all members.

Public Types

enum  SortOrder { Alphabetical, Size }
 The sort order of the tags shown in the tag cloud. More...

Public Member Functions

 TagCloud ()
 The control's constructor - Designer-created method, used to set up the controls contained within.
void Updater ()
 This function update and draw the tag cloud.

Public Attributes

event TagCloudEventHandler TagSelected
 The event that is invoked when a tag is selected in the tag cloud.

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used.

Properties

[TypeConverter(typeof(TagCloud)),
Category("Appearance"), Description("The current user's username")]
string 		Username [get, set]
 Gets and sets the value of Username.
Single minTagSize [get, set]
 Gets and sets the value of min trext size of the tags in the tag cloud.
Single maxTagSize [get, set]
 Gets and sets the value of min trext size of the tags in the tag cloud.
[TypeConverter(typeof(TagCloud)),
Category("Appearance"), Description("The library tags to work
from")] List< TagInfo > 		Tags [get, set]
 Gets and sets the value of Tags.
[TypeConverter(typeof(TagCloud)),
Category("Appearance"), Description("The currently selected tag")]
string 		SelectedTag [get, set]
 Gets and sets the value of the currently selected tag.
[TypeConverter(typeof(TagCloud)),
Category("Appearance"), Description("Wether to show only the
current user's tags")] bool 		ShowMyTagsOnly [get, set]
 Gets and sets the value of the my tags only option, as well as updates the GUI exposing the option.
SortOrder SortBy [get, set]
 Gets and sets the value of the sort order option, as well as updates the GUI exposing the option.

Private Member Functions

void SortTags ()
 This function runs through the control's tags collection and checks which keywords to show, as well as assigning weight to each keyword.
void RenderCloud ()
 The function which takes care of actually rendering the tag cloud to the canvas.
void lilTagCloud_Click (object sender, EventArgs e)
 This is executed when one of the labels in the tag cloud are pressed.
void lnkWhatsThis_LinkClicked (object sender, LinkLabelLinkClickedEventArgs e)
 Called when the ? LinkButton is clicked.
void chkAlphabetical_CheckedChanged (object sender, EventArgs e)
 Called when the chkAlphatetical RadioButton is changed. This happens both when it is changed itself, and when chkBysize is changed.
void chkOnlyMine_CheckedChanged (object sender, EventArgs e)
 Called when the chkOnlyMine CheckBox is changed.
void InitializeComponent ()
 Required method for Designer support - do not modify the contents of this method with the code editor.

Private Attributes

List< TagInfo > tags = new List<TagInfo>()
 The keywords to use, with each keyword, with an associated count of how many times the keyword has been assigned to a piece of information.
string selectedTag
 The currently selected tag. The empty string by default.
string username
 The current user's username - for use with the Show only my tags option.
bool showMyTagsOnly
 Show only the current user's tags.
SortOrder sortBy
 The order of sorting.
Single mintagsize = 5.0F
 The min. size of tags in the tag cloud.
Single maxsize = 20.0F
 The max. size of tags in the tag cloud.
List< TagsInfo > tagslist = new List<TagsInfo>()
 A new and updated list of the tags.
System.ComponentModel.IContainer components = null
 Required designer variable.
System.Windows.Forms.Panel panTop
System.Windows.Forms.Label lblTitle
System.Windows.Forms.LinkLabel lnkWhatsThis
System.Windows.Forms.Panel panBottom
System.Windows.Forms.Label lblSortorder
System.Windows.Forms.RadioButton chkAlphabetical
System.Windows.Forms.RadioButton chkBySize
System.Windows.Forms.CheckBox chkOnlyMine
System.Windows.Forms.Panel panCanvas
System.Windows.Forms.FlowLayoutPanel flowLayoutPanel

Detailed Description

The tag cloud control, which is used to show a weighted list of keywords to the user.

Definition at line 20 of file TagCloud.cs.

Member Enumeration Documentation

enum TagControls::TagCloud::SortOrder

The sort order of the tags shown in the tag cloud.

Definition at line 129 of file TagCloud.cs.

Constructor & Destructor Documentation

TagControls.TagCloud.TagCloud (  ) 

The control's constructor - Designer-created method, used to set up the controls contained within.

Definition at line 45 of file TagCloud.cs.

References TagControls.TagCloud.InitializeComponent().

Here is the call graph for this function:

Member Function Documentation

void TagControls.TagCloud.SortTags (  )  [private]

This function runs through the control's tags collection and checks which keywords to show, as well as assigning weight to each keyword.

Definition at line 155 of file TagCloud.cs.

References TagControls.TagCloud.sortBy, TagControls.TagCloud.tags, TagControls.TagCloud.tagslist, and TagControls.TagCloud.username.

Referenced by TagControls.TagCloud.chkAlphabetical_CheckedChanged(), TagControls.TagCloud.chkOnlyMine_CheckedChanged(), and TagControls.TagCloud.Updater().

Here is the caller graph for this function:

void TagControls.TagCloud.RenderCloud (  )  [private]

The function which takes care of actually rendering the tag cloud to the canvas.

Definition at line 172 of file TagCloud.cs.

References TagControls.TagCloud.flowLayoutPanel, TagControls.TagCloud.lilTagCloud_Click(), TagControls.TagCloud.maxsize, TagControls.TagCloud.mintagsize, TagControls.TagCloud.showMyTagsOnly, and TagControls.TagCloud.tagslist.

Referenced by TagControls.TagCloud.chkAlphabetical_CheckedChanged(), TagControls.TagCloud.chkOnlyMine_CheckedChanged(), and TagControls.TagCloud.Updater().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagCloud.Updater (  ) 

This function update and draw the tag cloud.

Definition at line 241 of file TagCloud.cs.

References TagControls.TagCloud.RenderCloud(), and TagControls.TagCloud.SortTags().

Referenced by Client.MainWindow.tagUpdater().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagCloud.lilTagCloud_Click ( object  sender,
EventArgs  e 
) [private]

This is executed when one of the labels in the tag cloud are pressed.

Parameters:
sender The sende is used the find the sender of the click event.
e Not used.

Definition at line 252 of file TagCloud.cs.

References TagControls.TagCloud.selectedTag, and TagControls.TagCloud.TagSelected.

Referenced by TagControls.TagCloud.RenderCloud().

Here is the caller graph for this function:

void TagControls.TagCloud.lnkWhatsThis_LinkClicked ( object  sender,
LinkLabelLinkClickedEventArgs  e 
) [private]

Called when the ? LinkButton is clicked.

Parameters:
sender Who is sending this event?
e What type of event is this?

Definition at line 270 of file TagCloud.cs.

Referenced by TagControls.TagCloud.InitializeComponent().

Here is the caller graph for this function:

void TagControls.TagCloud.chkAlphabetical_CheckedChanged ( object  sender,
EventArgs  e 
) [private]

Called when the chkAlphatetical RadioButton is changed. This happens both when it is changed itself, and when chkBysize is changed.

Parameters:
sender Who is sending this event?
e What type of event is this?

Definition at line 281 of file TagCloud.cs.

References TagControls.TagCloud.chkAlphabetical, TagControls.TagCloud.RenderCloud(), TagControls.TagCloud.sortBy, and TagControls.TagCloud.SortTags().

Referenced by TagControls.TagCloud.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagCloud.chkOnlyMine_CheckedChanged ( object  sender,
EventArgs  e 
) [private]

Called when the chkOnlyMine CheckBox is changed.

Parameters:
sender Who is sending this event?
e What type of event is this?

Definition at line 300 of file TagCloud.cs.

References TagControls.TagCloud.chkOnlyMine, TagControls.TagCloud.RenderCloud(), TagControls.TagCloud.showMyTagsOnly, and TagControls.TagCloud.SortTags().

Referenced by TagControls.TagCloud.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

override void TagControls.TagCloud.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 TagCloud.Designer.cs.

References TagControls.TagCloud.components.

void TagControls.TagCloud.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 TagCloud.Designer.cs.

References TagControls.TagCloud.chkAlphabetical, TagControls.TagCloud.chkAlphabetical_CheckedChanged(), TagControls.TagCloud.chkBySize, TagControls.TagCloud.chkOnlyMine, TagControls.TagCloud.chkOnlyMine_CheckedChanged(), TagControls.TagCloud.flowLayoutPanel, TagControls.TagCloud.lblSortorder, TagControls.TagCloud.lblTitle, TagControls.TagCloud.lnkWhatsThis, TagControls.TagCloud.lnkWhatsThis_LinkClicked(), TagControls.TagCloud.panBottom, TagControls.TagCloud.panCanvas, and TagControls.TagCloud.panTop.

Referenced by TagControls.TagCloud.TagCloud().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

List<TagInfo> TagControls.TagCloud.tags = new List<TagInfo>() [private]

The keywords to use, with each keyword, with an associated count of how many times the keyword has been assigned to a piece of information.

Definition at line 23 of file TagCloud.cs.

Referenced by TagControls.TagCloud.SortTags().

string TagControls.TagCloud.selectedTag [private]

The currently selected tag. The empty string by default.

Definition at line 25 of file TagCloud.cs.

Referenced by TagControls.TagCloud.lilTagCloud_Click().

string TagControls.TagCloud.username [private]

The current user's username - for use with the Show only my tags option.

Definition at line 27 of file TagCloud.cs.

Referenced by TagControls.TagCloud.SortTags().

bool TagControls.TagCloud.showMyTagsOnly [private]

Show only the current user's tags.

Definition at line 29 of file TagCloud.cs.

Referenced by TagControls.TagCloud.chkOnlyMine_CheckedChanged(), and TagControls.TagCloud.RenderCloud().

SortOrder TagControls.TagCloud.sortBy [private]

The order of sorting.

Definition at line 31 of file TagCloud.cs.

Referenced by TagControls.TagCloud.chkAlphabetical_CheckedChanged(), and TagControls.TagCloud.SortTags().

Single TagControls.TagCloud.mintagsize = 5.0F [private]

The min. size of tags in the tag cloud.

Definition at line 33 of file TagCloud.cs.

Referenced by TagControls.TagCloud.RenderCloud().

Single TagControls.TagCloud.maxsize = 20.0F [private]

The max. size of tags in the tag cloud.

Definition at line 35 of file TagCloud.cs.

Referenced by TagControls.TagCloud.RenderCloud().

List<TagsInfo> TagControls.TagCloud.tagslist = new List<TagsInfo>() [private]

A new and updated list of the tags.

Definition at line 37 of file TagCloud.cs.

Referenced by TagControls.TagCloud.RenderCloud(), and TagControls.TagCloud.SortTags().

event TagCloudEventHandler TagControls.TagCloud.TagSelected

The event that is invoked when a tag is selected in the tag cloud.

Definition at line 40 of file TagCloud.cs.

Referenced by TagControls.TagCloud.lilTagCloud_Click().

System.ComponentModel.IContainer TagControls.TagCloud.components = null [private]

Required designer variable.

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

Referenced by TagControls.TagCloud.Dispose().

Property Documentation

[ TypeConverter(typeof(TagCloud)), Category("Appearance"), Description("The current user's username") ] string TagControls.TagCloud.Username [get, set]

Gets and sets the value of Username.

Definition at line 59 of file TagCloud.cs.

Referenced by Client.MainWindow.tagUpdater().

Single TagControls.TagCloud.minTagSize [get, set]

Gets and sets the value of min trext size of the tags in the tag cloud.

Definition at line 67 of file TagCloud.cs.

Single TagControls.TagCloud.maxTagSize [get, set]

Gets and sets the value of min trext size of the tags in the tag cloud.

Definition at line 76 of file TagCloud.cs.

[ TypeConverter(typeof(TagCloud)), Category("Appearance"), Description("The library tags to work from") ] List<TagInfo> TagControls.TagCloud.Tags [get, set]

Gets and sets the value of Tags.

Definition at line 89 of file TagCloud.cs.

Referenced by Client.MainWindow.tagUpdater().

[ TypeConverter(typeof(TagCloud)), Category("Appearance"), Description("The currently selected tag") ] string TagControls.TagCloud.SelectedTag [get, set]

Gets and sets the value of the currently selected tag.

Definition at line 103 of file TagCloud.cs.

Referenced by Client.MainWindow.tagCloud1_TagSelected().

[ TypeConverter(typeof(TagCloud)), Category("Appearance"), Description("Wether to show only the current user's tags") ] bool TagControls.TagCloud.ShowMyTagsOnly [get, set]

Gets and sets the value of the my tags only option, as well as updates the GUI exposing the option.

Definition at line 117 of file TagCloud.cs.

SortOrder TagControls.TagCloud.SortBy [get, set]

Gets and sets the value of the sort order option, as well as updates the GUI exposing the option.

Definition at line 139 of file TagCloud.cs.

The documentation for this class was generated from the following files:
Generated on Thu Dec 21 06:26:10 2006 for SCRAML by  doxygen 1.5.1-p1