TagControls.TagContainer

TagControls.TagContainer Class Reference

The TagContainer control, which is used to edit the tags for an item with a UniquelyIdentifiable ID Make sure to actually add ID, Username and Tags to the control! Otherwise it has nothing to handle. More...

Collaboration diagram for TagControls.TagContainer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TagContainer ()
 Constructor, which sets up the Designer-imposed stuffs.
void FireRemoveTag ()
 This function is only user to fire the TagRemoved event on the tagcontainer.
void FireAddTag ()
 This function is only user to fire the TagAdded event on the tagcontainer.

Public Attributes

event TagContainerEventHandler TagAdded
 The event that is invoked when a tag is added.
event TagContainerEventHandler TagRemoved
 The event that is invoked when a tag is removed.

Protected Member Functions

override void OnPaint (PaintEventArgs e)
 Override the OnPain so the tags are redrawn when the form is updated.
override void Dispose (bool disposing)
 Clean up any resources being used.

Properties

[TypeConverter(typeof(TagContainer)),
Category("Appearance"), Description("The library tags to work
from")] List< TagInfo > 		Tags [get, set]
 Read-write property containing the collection of handled tags.
int ID [get, set]
 Read-write property, containing the handled information's UniquelyIdentifiable ID.
string Username [get, set]
 Read-write property, containing the current user's username.
[TypeConverter(typeof(TagContainer)),
Category("Appearance"), Description("The tag which was added")]
TagInfo 		AddedTag [get, set]
 Read-only property, containing the tag when a tag is added.
[TypeConverter(typeof(TagContainer)),
Category("Appearance"), Description("The tag which was removed")]
TagInfo 		RemovedTag [get, set]
 Read-only property, containing the tag when a tag is removed.

Private Member Functions

void sortTags ()
 This funtcion sorts the tage in to to groups, the tage the user has made and all other tags.
void AddTagsToControl (int numberOfTagsToAdd)
 This function adds a number of tags to the tagcontainer.
void scrollbarupdater ()
 This function updates the maximun(size value) for scroll bar in the tag container.
void txtNewTag_Enter (object sender, EventArgs e)
 Function called when the user enters the new tag TextBox.
void txtNewTag_Leave (object sender, EventArgs e)
 Function called when the user leaves the new tag TextBox. Doing so will, if the text is not empty, add a new tag to the tag collection, as well as fire the TagAdded event.
void txtNewTag_KeyDown (object sender, KeyEventArgs e)
 This is executed if the used presses any key.
void AddTagViaTextbox ()
 This add a new tag.
void tagsToPaint ()
 This calculate how many tag there can be painted in the tagcontainer so it dont overflow.
void linShowAllTags_LinkClicked (object sender, LinkLabelLinkClickedEventArgs e)
 This is executed when the show all tags are pressed.
void vScrollBar_Scroll (object sender, ScrollEventArgs e)
 This move all the tag according the the scroll bar.
void vScrollBar_MouseCaptureChanged (object sender, EventArgs e)
 Updates the tag container.
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 collection of tags handled by this instance of the control.
List< TagsInfo > updatedTagList = new List<TagsInfo>()
 A new and updated list of the tags.
TagInfo addedTag = new TagInfo()
 Set when a tag is added.
TagInfo removedTag = new TagInfo()
 Set when a tag is removed.
int id
 The currently handled item's UniquelyIdentifiable ID.
string username
 The username of the current user.
int NumberOfTagsToPaint
 The number of tags to paint under my tag and under other tags.
int tagSpace = 20
 The size of the tag controle component.
TagControle MyTags
 Used to paint the tags.
System.ComponentModel.IContainer components = null
 Required designer variable.
System.Windows.Forms.Panel panContainer
System.Windows.Forms.Panel panTitleOne
System.Windows.Forms.Label lblTitleOne
System.Windows.Forms.Panel panTitleTwo
System.Windows.Forms.Label lblTitleTwo
System.Windows.Forms.Panel panNewTag
System.Windows.Forms.Button button1
System.Windows.Forms.TextBox txtNewTag
System.Windows.Forms.TextBox txtFirstHelp
System.Windows.Forms.LinkLabel linShowAllTags
System.Windows.Forms.VScrollBar vScrollBar

Detailed Description

The TagContainer control, which is used to edit the tags for an item with a UniquelyIdentifiable ID Make sure to actually add ID, Username and Tags to the control! Otherwise it has nothing to handle.

Definition at line 16 of file TagContainer.cs.

Constructor & Destructor Documentation

TagControls.TagContainer.TagContainer (  ) 

Constructor, which sets up the Designer-imposed stuffs.

Definition at line 43 of file TagContainer.cs.

References TagControls.TagContainer.InitializeComponent(), TagControls.TagContainer.MyTags, TagControls.TagContainer.panContainer, and TagControls.TagContainer.tagsToPaint().

Here is the call graph for this function:

Member Function Documentation

override void TagControls.TagContainer.OnPaint ( PaintEventArgs  e  )  [protected]

Override the OnPain so the tags are redrawn when the form is updated.

Parameters:
e The graphics boundaries

Definition at line 54 of file TagContainer.cs.

References TagControls.TagContainer.AddTagsToControl(), and TagControls.TagContainer.NumberOfTagsToPaint.

Here is the call graph for this function:

void TagControls.TagContainer.sortTags (  )  [private]

This funtcion sorts the tage in to to groups, the tage the user has made and all other tags.

Definition at line 111 of file TagContainer.cs.

References TagControls.TagContainer.tags, TagControls.TagContainer.updatedTagList, and TagControls.TagContainer.username.

Referenced by TagControls.TagContainer.AddTagViaTextbox(), TagControls.TagContainer.FireAddTag(), and TagControls.TagContainer.FireRemoveTag().

Here is the caller graph for this function:

void TagControls.TagContainer.AddTagsToControl ( int  numberOfTagsToAdd  )  [private]

This function adds a number of tags to the tagcontainer.

Parameters:
numberOfTagsToAdd The max number of controls there will bee made under my tag and other tags.

Definition at line 124 of file TagContainer.cs.

References TagControls.TagControle.draw(), TagControls.TagContainer.linShowAllTags, TagControls.TagContainer.MyTags, TagControls.TagContainer.panContainer, TagControls.TagContainer.panNewTag, TagControls.TagControle.TagCleaner(), TagControls.TagContainer.tagSpace, TagControls.TagContainer.txtFirstHelp, and TagControls.TagContainer.updatedTagList.

Referenced by TagControls.TagContainer.AddTagViaTextbox(), TagControls.TagContainer.FireAddTag(), TagControls.TagContainer.FireRemoveTag(), TagControls.TagContainer.linShowAllTags_LinkClicked(), TagControls.TagContainer.OnPaint(), and TagControls.TagContainer.vScrollBar_MouseCaptureChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.scrollbarupdater (  )  [private]

This function updates the maximun(size value) for scroll bar in the tag container.

Definition at line 216 of file TagContainer.cs.

References TagControls.TagContainer.panContainer, and TagControls.TagContainer.vScrollBar.

Referenced by TagControls.TagContainer.AddTagViaTextbox(), TagControls.TagContainer.FireAddTag(), TagControls.TagContainer.FireRemoveTag(), and TagControls.TagContainer.linShowAllTags_LinkClicked().

Here is the caller graph for this function:

void TagControls.TagContainer.FireRemoveTag (  ) 

This function is only user to fire the TagRemoved event on the tagcontainer.

Definition at line 234 of file TagContainer.cs.

References TagControls.TagContainer.AddTagsToControl(), TagControls.TagContainer.NumberOfTagsToPaint, TagControls.TagContainer.scrollbarupdater(), TagControls.TagContainer.sortTags(), and TagControls.TagContainer.TagRemoved.

Referenced by TagControls.TagControle.m_Click().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.FireAddTag (  ) 

This function is only user to fire the TagAdded event on the tagcontainer.

Definition at line 249 of file TagContainer.cs.

References TagControls.TagContainer.AddTagsToControl(), TagControls.TagContainer.NumberOfTagsToPaint, TagControls.TagContainer.scrollbarupdater(), TagControls.TagContainer.sortTags(), and TagControls.TagContainer.TagAdded.

Referenced by TagControls.TagControle.m_Click().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.txtNewTag_Enter ( object  sender,
EventArgs  e 
) [private]

Function called when the user enters the new tag TextBox.

Parameters:
sender Who called the method
e What arguments do we have

Definition at line 266 of file TagContainer.cs.

References TagControls.TagContainer.txtNewTag.

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the caller graph for this function:

void TagControls.TagContainer.txtNewTag_Leave ( object  sender,
EventArgs  e 
) [private]

Function called when the user leaves the new tag TextBox. Doing so will, if the text is not empty, add a new tag to the tag collection, as well as fire the TagAdded event.

Parameters:
sender Who called the method
e What arguments do we have

Definition at line 281 of file TagContainer.cs.

References TagControls.TagContainer.AddTagViaTextbox().

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.txtNewTag_KeyDown ( object  sender,
KeyEventArgs  e 
) [private]

This is executed if the used presses any key.

Parameters:
sender Not used.
e The key event args

Definition at line 291 of file TagContainer.cs.

References TagControls.TagContainer.AddTagViaTextbox(), and TagControls.TagContainer.button1.

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.AddTagViaTextbox (  )  [private]

This add a new tag.

Definition at line 303 of file TagContainer.cs.

References TagControls.TagContainer.addedTag, TagControls.TagContainer.AddTagsToControl(), TagControls.TagContainer.NumberOfTagsToPaint, TagControls.TagContainer.scrollbarupdater(), TagControls.TagContainer.sortTags(), TagControls.TagContainer.TagAdded, TagControls.TagContainer.txtNewTag, and TagControls.TagContainer.updatedTagList.

Referenced by TagControls.TagContainer.txtNewTag_KeyDown(), and TagControls.TagContainer.txtNewTag_Leave().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.tagsToPaint (  )  [private]

This calculate how many tag there can be painted in the tagcontainer so it dont overflow.

Definition at line 339 of file TagContainer.cs.

References TagControls.TagContainer.NumberOfTagsToPaint, TagControls.TagContainer.panTitleOne, TagControls.TagContainer.panTitleTwo, and TagControls.TagContainer.tagSpace.

Referenced by TagControls.TagContainer.TagContainer().

Here is the caller graph for this function:

void TagControls.TagContainer.linShowAllTags_LinkClicked ( object  sender,
LinkLabelLinkClickedEventArgs  e 
) [private]

This is executed when the show all tags are pressed.

Parameters:
sender Not used
e Not Used

Definition at line 354 of file TagContainer.cs.

References TagControls.TagContainer.AddTagsToControl(), TagControls.TagContainer.linShowAllTags, TagControls.TagContainer.NumberOfTagsToPaint, and TagControls.TagContainer.scrollbarupdater().

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

void TagControls.TagContainer.vScrollBar_Scroll ( object  sender,
ScrollEventArgs  e 
) [private]

This move all the tag according the the scroll bar.

Parameters:
sender Not used.
e Scroll Event Args

Definition at line 372 of file TagContainer.cs.

References TagControls.TagContainer.panContainer.

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the caller graph for this function:

void TagControls.TagContainer.vScrollBar_MouseCaptureChanged ( object  sender,
EventArgs  e 
) [private]

Updates the tag container.

Parameters:
sender Not used.
e Not used.

Definition at line 383 of file TagContainer.cs.

References TagControls.TagContainer.AddTagsToControl(), and TagControls.TagContainer.NumberOfTagsToPaint.

Referenced by TagControls.TagContainer.InitializeComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References TagControls.TagContainer.components.

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

References TagControls.TagContainer.button1, TagControls.TagContainer.lblTitleOne, TagControls.TagContainer.lblTitleTwo, TagControls.TagContainer.linShowAllTags, TagControls.TagContainer.linShowAllTags_LinkClicked(), TagControls.TagContainer.panContainer, TagControls.TagContainer.panNewTag, TagControls.TagContainer.panTitleOne, TagControls.TagContainer.panTitleTwo, TagControls.TagContainer.txtFirstHelp, TagControls.TagContainer.txtNewTag, TagControls.TagContainer.txtNewTag_Enter(), TagControls.TagContainer.txtNewTag_KeyDown(), TagControls.TagContainer.txtNewTag_Leave(), TagControls.TagContainer.vScrollBar, TagControls.TagContainer.vScrollBar_MouseCaptureChanged(), and TagControls.TagContainer.vScrollBar_Scroll().

Referenced by TagControls.TagContainer.TagContainer().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

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

The collection of tags handled by this instance of the control.

Definition at line 19 of file TagContainer.cs.

Referenced by TagControls.TagContainer.sortTags().

List<TagsInfo> TagControls.TagContainer.updatedTagList = new List<TagsInfo>() [private]

A new and updated list of the tags.

Definition at line 21 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagsToControl(), TagControls.TagContainer.AddTagViaTextbox(), and TagControls.TagContainer.sortTags().

TagInfo TagControls.TagContainer.addedTag = new TagInfo() [private]

Set when a tag is added.

Definition at line 23 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagViaTextbox().

TagInfo TagControls.TagContainer.removedTag = new TagInfo() [private]

Set when a tag is removed.

Definition at line 25 of file TagContainer.cs.

int TagControls.TagContainer.id [private]

The currently handled item's UniquelyIdentifiable ID.

Definition at line 27 of file TagContainer.cs.

string TagControls.TagContainer.username [private]

The username of the current user.

Definition at line 29 of file TagContainer.cs.

Referenced by TagControls.TagContainer.sortTags().

int TagControls.TagContainer.NumberOfTagsToPaint [private]

The number of tags to paint under my tag and under other tags.

Definition at line 31 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagViaTextbox(), TagControls.TagContainer.FireAddTag(), TagControls.TagContainer.FireRemoveTag(), TagControls.TagContainer.linShowAllTags_LinkClicked(), TagControls.TagContainer.OnPaint(), TagControls.TagContainer.tagsToPaint(), and TagControls.TagContainer.vScrollBar_MouseCaptureChanged().

int TagControls.TagContainer.tagSpace = 20 [private]

The size of the tag controle component.

Definition at line 33 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagsToControl(), and TagControls.TagContainer.tagsToPaint().

TagControle TagControls.TagContainer.MyTags [private]

Used to paint the tags.

Definition at line 35 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagsToControl(), and TagControls.TagContainer.TagContainer().

event TagContainerEventHandler TagControls.TagContainer.TagAdded

The event that is invoked when a tag is added.

Definition at line 38 of file TagContainer.cs.

Referenced by TagControls.TagContainer.AddTagViaTextbox(), and TagControls.TagContainer.FireAddTag().

event TagContainerEventHandler TagControls.TagContainer.TagRemoved

The event that is invoked when a tag is removed.

Definition at line 40 of file TagContainer.cs.

Referenced by TagControls.TagContainer.FireRemoveTag().

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

Required designer variable.

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

Referenced by TagControls.TagContainer.Dispose().

Property Documentation

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

Read-write property containing the collection of handled tags.

Definition at line 67 of file TagContainer.cs.

Referenced by TagControls.TagControle.m_Click().

int TagControls.TagContainer.ID [get, set]

Read-write property, containing the handled information's UniquelyIdentifiable ID.

Definition at line 74 of file TagContainer.cs.

Referenced by TagControls.TagControle.m_Click().

string TagControls.TagContainer.Username [get, set]

Read-write property, containing the current user's username.

Definition at line 81 of file TagContainer.cs.

Referenced by TagControls.TagControle.m_Click().

[ TypeConverter(typeof(TagContainer)), Category("Appearance"), Description("The tag which was added") ] TagInfo TagControls.TagContainer.AddedTag [get, set]

Read-only property, containing the tag when a tag is added.

Definition at line 93 of file TagContainer.cs.

Referenced by TagControls.TagControle.m_Click().

[ TypeConverter(typeof(TagContainer)), Category("Appearance"), Description("The tag which was removed") ] TagInfo TagControls.TagContainer.RemovedTag [get, set]

Read-only property, containing the tag when a tag is removed.

Definition at line 105 of file TagContainer.cs.

Referenced by TagControls.TagControle.m_Click().

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