diff options
| author | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-01-14 15:24:49 +0200 |
|---|---|---|
| committer | Roy Ben-Shabat <Roy@Twine-s.com> | 2018-01-14 15:24:49 +0200 |
| commit | a20fd4bd769aeccd1fd1f20273f895c92a5b5bb8 (patch) | |
| tree | 15f2dc0d4629dfd17b2e44ca3732d549fed27751 /Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs | |
| parent | 04db84896f75bb761e8b3d482b4cb0f82c08d96e (diff) | |
| download | Tango-a20fd4bd769aeccd1fd1f20273f895c92a5b5bb8.tar.gz Tango-a20fd4bd769aeccd1fd1f20273f895c92a5b5bb8.zip | |
Added code comments for:
MachineStudio.Common.
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs')
| -rw-r--r-- | Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs index 0cf5e2c8e..110fbfa74 100644 --- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs +++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/Notifications/TaskItem.cs @@ -7,32 +7,53 @@ using Tango.Core; namespace Tango.MachineStudio.Common.Notifications { + /// <summary> + /// Represents a Machine Studio "work-bar" item. + /// </summary> + /// <seealso cref="Tango.Core.ExtendedObject" /> + /// <seealso cref="System.IDisposable" /> public class TaskItem : ExtendedObject, IDisposable { private INotificationProvider _notificationProvider; + /// <summary> + /// Initializes a new instance of the <see cref="TaskItem"/> class. + /// </summary> + /// <param name="notificationProvider">The notification provider.</param> public TaskItem(INotificationProvider notificationProvider) { _notificationProvider = notificationProvider; } private String _message; + /// <summary> + /// Gets or sets the message. + /// </summary> public String Message { get { return _message; } set { _message = value; RaisePropertyChangedAuto(); } } + /// <summary> + /// Removed this item from the queue. + /// </summary> public void Pop() { _notificationProvider.PopTaskItem(this); } + /// <summary> + /// Pushes this item to the queue. + /// </summary> public void Push() { _notificationProvider.PushTaskItem(this); } + /// <summary> + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + /// </summary> public void Dispose() { Pop(); |
