AnnotationAuthorChangedEventArgs.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / wpf / src / Framework / System / Windows / Annotations / AnnotationAuthorChangedEventArgs.cs / 1305600 / AnnotationAuthorChangedEventArgs.cs
                        

                        
                            //------------------------------------------------------------------------------ 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// Description: 
//     AnnotationAuthorChangedEvents are fired by an Annotation when an author 
//     it contains has been added, removed or modified in some way.  The
//     event includes the annotation, the author, and what action was 
//     taken on the author
//
//     Spec: http://team/sites/ag/Specifications/Simplifying%20Store%20Cache%20Model.doc
// 
// History:
//  06/30/2004: rruiz:      Added new event (args and handler) for the new 
//                          Object Model design. 
//-----------------------------------------------------------------------------
 
using System;
using System.ComponentModel;

namespace System.Windows.Annotations 
{
    ///  
    ///     Delegate for handlers of the AuthorChanged event on Annotation. 
    /// 
    /// the annotation firing the event 
    /// args describing the Author and the action taken
    public delegate void AnnotationAuthorChangedEventHandler(Object sender, AnnotationAuthorChangedEventArgs e);

    ///  
    ///     Event args for changes to an Annotation's Authors.  This class includes
    ///     the annotation that fired the event, the Author that was changed, and 
    ///     what action was taken on the Author - added, removed or modified. 
    /// 
    public sealed class AnnotationAuthorChangedEventArgs : EventArgs 
    {
        //-----------------------------------------------------
        //
        //  Constructors 
        //
        //----------------------------------------------------- 
 
        #region Constructors
 
        /// 
        ///     Creates an instance of AuthorChangedEventArgs.
        /// 
        /// the Annotation firing the event 
        /// the action taken on the Author
        /// the Author that was changed 
        /// annotation is null 
        /// action is not a valid value from AnnotationAction
        public AnnotationAuthorChangedEventArgs(Annotation annotation, AnnotationAction action, Object author) 
        {

            // The author parameter can be null here - it is possible to add a null to
            // the list of authors and we must fire an event signalling a change in the collection. 

            if (annotation == null) 
            { 
                throw new ArgumentNullException("annotation");
            } 
            if (action < AnnotationAction.Added || action > AnnotationAction.Modified)
            {
                throw new InvalidEnumArgumentException("action", (int)action, typeof(AnnotationAction));
            } 

            _annotation = annotation; 
            _author = author; 
            _action = action;
        } 

        #endregion Constructors

        //------------------------------------------------------ 
        //
        //  Public Properties 
        // 
        //-----------------------------------------------------
 
        #region Public Properties

        /// 
        ///     The Annotation that fired the event. 
        /// 
        public Annotation Annotation 
        { 
            get
            { 
                return _annotation;
            }
        }
 
        /// 
        ///     The Author that was changed. 
        ///  
        public Object Author
        { 
            get
            {
                return _author;
            } 
        }
 
        ///  
        ///     The action that was taken on the Author.
        ///  
        public AnnotationAction Action
        {
            get
            { 
                return _action;
            } 
        } 

        #endregion Public Properties 

        //------------------------------------------------------
        //
        //  Private Fields 
        //
        //------------------------------------------------------ 
 
        #region Private Fields
 
        /// 
        /// The annotation that fired the event.
        /// 
        private Annotation _annotation; 

        ///  
        /// The Author that was changed. 
        /// 
        private Object _author; 

        /// 
        /// The action taken on the Author
        ///  
        private AnnotationAction _action;
 
        #endregion Private Fields 
    }
} 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------------------------ 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// Description: 
//     AnnotationAuthorChangedEvents are fired by an Annotation when an author 
//     it contains has been added, removed or modified in some way.  The
//     event includes the annotation, the author, and what action was 
//     taken on the author
//
//     Spec: http://team/sites/ag/Specifications/Simplifying%20Store%20Cache%20Model.doc
// 
// History:
//  06/30/2004: rruiz:      Added new event (args and handler) for the new 
//                          Object Model design. 
//-----------------------------------------------------------------------------
 
using System;
using System.ComponentModel;

namespace System.Windows.Annotations 
{
    ///  
    ///     Delegate for handlers of the AuthorChanged event on Annotation. 
    /// 
    /// the annotation firing the event 
    /// args describing the Author and the action taken
    public delegate void AnnotationAuthorChangedEventHandler(Object sender, AnnotationAuthorChangedEventArgs e);

    ///  
    ///     Event args for changes to an Annotation's Authors.  This class includes
    ///     the annotation that fired the event, the Author that was changed, and 
    ///     what action was taken on the Author - added, removed or modified. 
    /// 
    public sealed class AnnotationAuthorChangedEventArgs : EventArgs 
    {
        //-----------------------------------------------------
        //
        //  Constructors 
        //
        //----------------------------------------------------- 
 
        #region Constructors
 
        /// 
        ///     Creates an instance of AuthorChangedEventArgs.
        /// 
        /// the Annotation firing the event 
        /// the action taken on the Author
        /// the Author that was changed 
        /// annotation is null 
        /// action is not a valid value from AnnotationAction
        public AnnotationAuthorChangedEventArgs(Annotation annotation, AnnotationAction action, Object author) 
        {

            // The author parameter can be null here - it is possible to add a null to
            // the list of authors and we must fire an event signalling a change in the collection. 

            if (annotation == null) 
            { 
                throw new ArgumentNullException("annotation");
            } 
            if (action < AnnotationAction.Added || action > AnnotationAction.Modified)
            {
                throw new InvalidEnumArgumentException("action", (int)action, typeof(AnnotationAction));
            } 

            _annotation = annotation; 
            _author = author; 
            _action = action;
        } 

        #endregion Constructors

        //------------------------------------------------------ 
        //
        //  Public Properties 
        // 
        //-----------------------------------------------------
 
        #region Public Properties

        /// 
        ///     The Annotation that fired the event. 
        /// 
        public Annotation Annotation 
        { 
            get
            { 
                return _annotation;
            }
        }
 
        /// 
        ///     The Author that was changed. 
        ///  
        public Object Author
        { 
            get
            {
                return _author;
            } 
        }
 
        ///  
        ///     The action that was taken on the Author.
        ///  
        public AnnotationAction Action
        {
            get
            { 
                return _action;
            } 
        } 

        #endregion Public Properties 

        //------------------------------------------------------
        //
        //  Private Fields 
        //
        //------------------------------------------------------ 
 
        #region Private Fields
 
        /// 
        /// The annotation that fired the event.
        /// 
        private Annotation _annotation; 

        ///  
        /// The Author that was changed. 
        /// 
        private Object _author; 

        /// 
        /// The action taken on the Author
        ///  
        private AnnotationAction _action;
 
        #endregion Private Fields 
    }
} 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK