RepeatBehavior.cs source code in C# .NET

                        
Code:
                         / 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / wpf / src / Core / CSharp / System / Windows / Media / Animation / RepeatBehavior.cs / 1305600 / RepeatBehavior.cs
                        

                        
                            //------------------------------------------------------------------------------ 
//  Microsoft Windows Client Platform
//  Copyright (c) Microsoft Corporation, 2004
//
//  File: RepeatBehavior.cs 
//-----------------------------------------------------------------------------
 
// Allow suppression of certain presharp messages 
#pragma warning disable 1634, 1691
 
using MS.Internal;

using System.ComponentModel;
using System.Diagnostics; 
using System.Text;
 
using SR=MS.Internal.PresentationCore.SR; 
using SRID=MS.Internal.PresentationCore.SRID;
 
namespace System.Windows.Media.Animation
{
    /// 

    /// A RepeatBehavior describes how a Timeline object may repeat its simple duration. 
    /// There are three types of RepeatBehavior behaviors: IterationCount, RepeatDuration, and Forever.
    /// An IterationCount RepeatBehavior specifies the number of times the simple duration of a Timeline will 
    /// be repeated. An iteration count of 0.5 means the Timeline will only be active for half 
    /// of its simple duration and will only reach 50% progress. An iteration count of 1.0 is the
    /// default and means a Timeline will be active for exactly one of its simple durations. An 
    /// iteration count of 2.0 means a Timeline will run twice, or repeat its simple duration
    /// once after its initial simple duration.
    /// A RepeatDuration RepeatBehavior specifies the amount of time that a Timeline will repeat.
    /// For instance if a Timeline has a simple Duration value of 1 second and a RepeatBehavior with a 
    /// RepeatDuration value of 2.5 seconds, then it will run for 2.5 iterations.
    /// A Forever RepeatBehavior specifies that a Timeline will repeat forever. 
    /// 
 
    [TypeConverter(typeof(RepeatBehaviorConverter))]
    public struct RepeatBehavior : IFormattable 
    {
        private double _iterationCount;
        private TimeSpan _repeatDuration;
        private RepeatBehaviorType _type; 

        #region Constructors 
 
        /// 

        /// Creates a new RepeatBehavior that represents and iteration count. 
        /// 
        /// The number of iterations specified by this RepeatBehavior.
        public RepeatBehavior(double count)
        { 
            if (   Double.IsInfinity(count)
                || DoubleUtil.IsNaN(count) 
                || count < 0.0) 
            {
                throw new ArgumentOutOfRangeException("count", SR.Get(SRID.Timing_RepeatBehaviorInvalidIterationCount, count)); 
            }

            _repeatDuration = new TimeSpan(0);
            _iterationCount = count; 
            _type = RepeatBehaviorType.IterationCount;
        } 
 
        /// 

        /// Creates a new RepeatBehavior that represents a repeat duration for which a Timeline will repeat 
        /// its simple duration.
        /// 
        /// A TimeSpan representing the repeat duration specified by this RepeatBehavior.
        public RepeatBehavior(TimeSpan duration) 
        {
            if (duration < new TimeSpan(0)) 
            { 
                throw new ArgumentOutOfRangeException("duration", SR.Get(SRID.Timing_RepeatBehaviorInvalidRepeatDuration, duration));
            } 

            _iterationCount = 0.0;
            _repeatDuration = duration;
            _type = RepeatBehaviorType.RepeatDuration; 
        }
 
        /// 
 
        /// Creates and returns a RepeatBehavior that indicates that a Timeline should repeat its
        /// simple duration forever. 
        /// 
        /// A RepeatBehavior that indicates that a Timeline should repeat its simple duration
        /// forever.
        public static RepeatBehavior Forever 
        {
            get 
            { 
                RepeatBehavior forever = new RepeatBehavior();
                forever._type = RepeatBehaviorType.Forever; 

                return forever;
            }
        } 

        #endregion // Constructors 
 
        #region Properties
 
        /// 

        /// Indicates whether this RepeatBehavior represents an iteration count.
        /// 
        /// True if this RepeatBehavior represents an iteration count; otherwise false. 
        public bool HasCount
        { 
            get 
            {
                return _type == RepeatBehaviorType.IterationCount; 
            }
        }

        /// 
 
        /// Indicates whether this RepeatBehavior represents a repeat duration.
        /// 
 
        /// True if this RepeatBehavior represents a repeat duration; otherwise false. 
        public bool HasDuration
        { 
            get
            {
                return _type == RepeatBehaviorType.RepeatDuration;
            } 
        }
 
        /// 
 
        /// Returns the iteration count specified by this RepeatBehavior.
        /// 
 
        /// The iteration count specified by this RepeatBehavior.
        /// Thrown if this RepeatBehavior does not represent an iteration count.
        public double Count
        { 
            get
            { 
                if (_type != RepeatBehaviorType.IterationCount) 
                {
#pragma warning suppress 56503 // Suppress presharp warning: Follows a pattern similar to Nullable. 
                    throw new InvalidOperationException(SR.Get(SRID.Timing_RepeatBehaviorNotIterationCount, this));
                }

                return _iterationCount; 
            }
        } 
 
        /// 

        /// Returns the repeat duration specified by this RepeatBehavior. 
        /// 
        /// A TimeSpan representing the repeat duration specified by this RepeatBehavior.
        /// Thrown if this RepeatBehavior does not represent a repeat duration.
        public TimeSpan Duration 
        {
            get 
            { 
                if (_type != RepeatBehaviorType.RepeatDuration)
                { 
#pragma warning suppress 56503 // Suppress presharp warning: Follows a pattern similar to Nullable.
                    throw new InvalidOperationException(SR.Get(SRID.Timing_RepeatBehaviorNotRepeatDuration, this));
                }
 
                return _repeatDuration;
            } 
        } 

        #endregion // Properties 

        #region Methods

        /// 
 
        /// Indicates whether the specified Object is equal to this RepeatBehavior.
        /// 
 
        ///  
        /// true if value is a RepeatBehavior and is equal to this instance; otherwise false.
        public override bool Equals(Object value) 
        {
            if (value is RepeatBehavior)
            {
                return this.Equals((RepeatBehavior)value); 
            }
            else 
            { 
                return false;
            } 
        }

        /// 

        /// Indicates whether the specified RepeatBehavior is equal to this RepeatBehavior. 
        /// 
        /// A RepeatBehavior to compare with this RepeatBehavior. 
        /// true if repeatBehavior is equal to this instance; otherwise false. 
        public bool Equals(RepeatBehavior repeatBehavior)
        { 
            if (_type == repeatBehavior._type)
            {
                switch (_type)
                { 
                    case RepeatBehaviorType.Forever:
 
                        return true; 

                    case RepeatBehaviorType.IterationCount: 

                        return _iterationCount == repeatBehavior._iterationCount;

                    case RepeatBehaviorType.RepeatDuration: 

                        return _repeatDuration == repeatBehavior._repeatDuration; 
 
                    default:
 
                        Debug.Fail("Unhandled RepeatBehaviorType");
                        return false;
                }
            } 
            else
            { 
                return false; 
            }
        } 

        /// 

        /// Indicates whether the specified RepeatBehaviors are equal to each other.
        /// 
 
        /// 
        ///  
        /// true if repeatBehavior1 and repeatBehavior2 are equal; otherwise false. 
        public static bool Equals(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        { 
            return repeatBehavior1.Equals(repeatBehavior2);
        }

        /// 
 
        /// Generates a hash code for this RepeatBehavior.
        /// 
 
        /// A hash code for this RepeatBehavior. 
        public override int GetHashCode()
        { 
            switch (_type)
            {
                case RepeatBehaviorType.IterationCount:
 
                    return _iterationCount.GetHashCode();
 
                case RepeatBehaviorType.RepeatDuration: 

                    return _repeatDuration.GetHashCode(); 

                case RepeatBehaviorType.Forever:

                    // We try to choose an unlikely hash code value for Forever. 
                    // All Forevers need to return the same hash code value.
                    return int.MaxValue - 42; 
 
                default:
 
                    Debug.Fail("Unhandled RepeatBehaviorType");
                    return base.GetHashCode();
            }
        } 

        /// 
 
        /// Creates a string representation of this RepeatBehavior based on the current culture. 
        /// 
        /// A string representation of this RepeatBehavior based on the current culture. 
        public override string ToString()
        {
            return InternalToString(null, null);
        } 

        /// 
 
        /// 
        /// 
        ///  
        /// 
        public string ToString(IFormatProvider formatProvider)
        {
            return InternalToString(null, formatProvider); 
        }
 
        /// 
 
        ///
        /// 
 
        /// 
        /// 
        /// 
        string IFormattable.ToString(string format, IFormatProvider formatProvider) 
        {
            return InternalToString(format, formatProvider); 
        } 

        /// 
 
        ///
        /// 
        /// 
        ///  
        /// 
        internal string InternalToString(string format, IFormatProvider formatProvider) 
        { 
            switch (_type)
            { 
                case RepeatBehaviorType.Forever:

                    return "Forever";
 
                case RepeatBehaviorType.IterationCount:
 
                    StringBuilder sb = new StringBuilder(); 

                    sb.AppendFormat( 
                        formatProvider,
                        "{0:" + format + "}x",
                        _iterationCount);
 
                    return sb.ToString();
 
                case RepeatBehaviorType.RepeatDuration: 

                    return _repeatDuration.ToString(); 

                default:

                    Debug.Fail("Unhandled RepeatBehaviorType."); 
                    return null;
            } 
        } 

        #endregion // Methods 

        #region Operators

        /// 
 
        /// Indicates whether the specified RepeatBehaviors are equal to each other.
        /// 
 
        ///  
        /// 
        /// true if repeatBehavior1 and repeatBehavior2 are equal; otherwise false. 
        public static bool operator ==(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        {
            return repeatBehavior1.Equals(repeatBehavior2);
        } 

        /// 
 
        /// Indicates whether the specified RepeatBehaviors are not equal to each other. 
        /// 
        ///  
        /// 
        /// true if repeatBehavior1 and repeatBehavior2 are not equal; otherwise false.
        public static bool operator !=(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        { 
            return !repeatBehavior1.Equals(repeatBehavior2);
        } 
 
        #endregion // Operators
 
        /// 

        /// An enumeration of the different types of RepeatBehavior behaviors.
        /// 
        private enum RepeatBehaviorType 
        {
            IterationCount, 
            RepeatDuration, 
            Forever
        } 
    }
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------------------------ 
//  Microsoft Windows Client Platform
//  Copyright (c) Microsoft Corporation, 2004
//
//  File: RepeatBehavior.cs 
//-----------------------------------------------------------------------------
 
// Allow suppression of certain presharp messages 
#pragma warning disable 1634, 1691
 
using MS.Internal;

using System.ComponentModel;
using System.Diagnostics; 
using System.Text;
 
using SR=MS.Internal.PresentationCore.SR; 
using SRID=MS.Internal.PresentationCore.SRID;
 
namespace System.Windows.Media.Animation
{
    /// 

    /// A RepeatBehavior describes how a Timeline object may repeat its simple duration. 
    /// There are three types of RepeatBehavior behaviors: IterationCount, RepeatDuration, and Forever.
    /// An IterationCount RepeatBehavior specifies the number of times the simple duration of a Timeline will 
    /// be repeated. An iteration count of 0.5 means the Timeline will only be active for half 
    /// of its simple duration and will only reach 50% progress. An iteration count of 1.0 is the
    /// default and means a Timeline will be active for exactly one of its simple durations. An 
    /// iteration count of 2.0 means a Timeline will run twice, or repeat its simple duration
    /// once after its initial simple duration.
    /// A RepeatDuration RepeatBehavior specifies the amount of time that a Timeline will repeat.
    /// For instance if a Timeline has a simple Duration value of 1 second and a RepeatBehavior with a 
    /// RepeatDuration value of 2.5 seconds, then it will run for 2.5 iterations.
    /// A Forever RepeatBehavior specifies that a Timeline will repeat forever. 
    /// 
 
    [TypeConverter(typeof(RepeatBehaviorConverter))]
    public struct RepeatBehavior : IFormattable 
    {
        private double _iterationCount;
        private TimeSpan _repeatDuration;
        private RepeatBehaviorType _type; 

        #region Constructors 
 
        /// 

        /// Creates a new RepeatBehavior that represents and iteration count. 
        /// 
        /// The number of iterations specified by this RepeatBehavior.
        public RepeatBehavior(double count)
        { 
            if (   Double.IsInfinity(count)
                || DoubleUtil.IsNaN(count) 
                || count < 0.0) 
            {
                throw new ArgumentOutOfRangeException("count", SR.Get(SRID.Timing_RepeatBehaviorInvalidIterationCount, count)); 
            }

            _repeatDuration = new TimeSpan(0);
            _iterationCount = count; 
            _type = RepeatBehaviorType.IterationCount;
        } 
 
        /// 

        /// Creates a new RepeatBehavior that represents a repeat duration for which a Timeline will repeat 
        /// its simple duration.
        /// 
        /// A TimeSpan representing the repeat duration specified by this RepeatBehavior.
        public RepeatBehavior(TimeSpan duration) 
        {
            if (duration < new TimeSpan(0)) 
            { 
                throw new ArgumentOutOfRangeException("duration", SR.Get(SRID.Timing_RepeatBehaviorInvalidRepeatDuration, duration));
            } 

            _iterationCount = 0.0;
            _repeatDuration = duration;
            _type = RepeatBehaviorType.RepeatDuration; 
        }
 
        /// 
 
        /// Creates and returns a RepeatBehavior that indicates that a Timeline should repeat its
        /// simple duration forever. 
        /// 
        /// A RepeatBehavior that indicates that a Timeline should repeat its simple duration
        /// forever.
        public static RepeatBehavior Forever 
        {
            get 
            { 
                RepeatBehavior forever = new RepeatBehavior();
                forever._type = RepeatBehaviorType.Forever; 

                return forever;
            }
        } 

        #endregion // Constructors 
 
        #region Properties
 
        /// 

        /// Indicates whether this RepeatBehavior represents an iteration count.
        /// 
        /// True if this RepeatBehavior represents an iteration count; otherwise false. 
        public bool HasCount
        { 
            get 
            {
                return _type == RepeatBehaviorType.IterationCount; 
            }
        }

        /// 
 
        /// Indicates whether this RepeatBehavior represents a repeat duration.
        /// 
 
        /// True if this RepeatBehavior represents a repeat duration; otherwise false. 
        public bool HasDuration
        { 
            get
            {
                return _type == RepeatBehaviorType.RepeatDuration;
            } 
        }
 
        /// 
 
        /// Returns the iteration count specified by this RepeatBehavior.
        /// 
 
        /// The iteration count specified by this RepeatBehavior.
        /// Thrown if this RepeatBehavior does not represent an iteration count.
        public double Count
        { 
            get
            { 
                if (_type != RepeatBehaviorType.IterationCount) 
                {
#pragma warning suppress 56503 // Suppress presharp warning: Follows a pattern similar to Nullable. 
                    throw new InvalidOperationException(SR.Get(SRID.Timing_RepeatBehaviorNotIterationCount, this));
                }

                return _iterationCount; 
            }
        } 
 
        /// 

        /// Returns the repeat duration specified by this RepeatBehavior. 
        /// 
        /// A TimeSpan representing the repeat duration specified by this RepeatBehavior.
        /// Thrown if this RepeatBehavior does not represent a repeat duration.
        public TimeSpan Duration 
        {
            get 
            { 
                if (_type != RepeatBehaviorType.RepeatDuration)
                { 
#pragma warning suppress 56503 // Suppress presharp warning: Follows a pattern similar to Nullable.
                    throw new InvalidOperationException(SR.Get(SRID.Timing_RepeatBehaviorNotRepeatDuration, this));
                }
 
                return _repeatDuration;
            } 
        } 

        #endregion // Properties 

        #region Methods

        /// 
 
        /// Indicates whether the specified Object is equal to this RepeatBehavior.
        /// 
 
        ///  
        /// true if value is a RepeatBehavior and is equal to this instance; otherwise false.
        public override bool Equals(Object value) 
        {
            if (value is RepeatBehavior)
            {
                return this.Equals((RepeatBehavior)value); 
            }
            else 
            { 
                return false;
            } 
        }

        /// 

        /// Indicates whether the specified RepeatBehavior is equal to this RepeatBehavior. 
        /// 
        /// A RepeatBehavior to compare with this RepeatBehavior. 
        /// true if repeatBehavior is equal to this instance; otherwise false. 
        public bool Equals(RepeatBehavior repeatBehavior)
        { 
            if (_type == repeatBehavior._type)
            {
                switch (_type)
                { 
                    case RepeatBehaviorType.Forever:
 
                        return true; 

                    case RepeatBehaviorType.IterationCount: 

                        return _iterationCount == repeatBehavior._iterationCount;

                    case RepeatBehaviorType.RepeatDuration: 

                        return _repeatDuration == repeatBehavior._repeatDuration; 
 
                    default:
 
                        Debug.Fail("Unhandled RepeatBehaviorType");
                        return false;
                }
            } 
            else
            { 
                return false; 
            }
        } 

        /// 

        /// Indicates whether the specified RepeatBehaviors are equal to each other.
        /// 
 
        /// 
        ///  
        /// true if repeatBehavior1 and repeatBehavior2 are equal; otherwise false. 
        public static bool Equals(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        { 
            return repeatBehavior1.Equals(repeatBehavior2);
        }

        /// 
 
        /// Generates a hash code for this RepeatBehavior.
        /// 
 
        /// A hash code for this RepeatBehavior. 
        public override int GetHashCode()
        { 
            switch (_type)
            {
                case RepeatBehaviorType.IterationCount:
 
                    return _iterationCount.GetHashCode();
 
                case RepeatBehaviorType.RepeatDuration: 

                    return _repeatDuration.GetHashCode(); 

                case RepeatBehaviorType.Forever:

                    // We try to choose an unlikely hash code value for Forever. 
                    // All Forevers need to return the same hash code value.
                    return int.MaxValue - 42; 
 
                default:
 
                    Debug.Fail("Unhandled RepeatBehaviorType");
                    return base.GetHashCode();
            }
        } 

        /// 
 
        /// Creates a string representation of this RepeatBehavior based on the current culture. 
        /// 
        /// A string representation of this RepeatBehavior based on the current culture. 
        public override string ToString()
        {
            return InternalToString(null, null);
        } 

        /// 
 
        /// 
        /// 
        ///  
        /// 
        public string ToString(IFormatProvider formatProvider)
        {
            return InternalToString(null, formatProvider); 
        }
 
        /// 
 
        ///
        /// 
 
        /// 
        /// 
        /// 
        string IFormattable.ToString(string format, IFormatProvider formatProvider) 
        {
            return InternalToString(format, formatProvider); 
        } 

        /// 
 
        ///
        /// 
        /// 
        ///  
        /// 
        internal string InternalToString(string format, IFormatProvider formatProvider) 
        { 
            switch (_type)
            { 
                case RepeatBehaviorType.Forever:

                    return "Forever";
 
                case RepeatBehaviorType.IterationCount:
 
                    StringBuilder sb = new StringBuilder(); 

                    sb.AppendFormat( 
                        formatProvider,
                        "{0:" + format + "}x",
                        _iterationCount);
 
                    return sb.ToString();
 
                case RepeatBehaviorType.RepeatDuration: 

                    return _repeatDuration.ToString(); 

                default:

                    Debug.Fail("Unhandled RepeatBehaviorType."); 
                    return null;
            } 
        } 

        #endregion // Methods 

        #region Operators

        /// 
 
        /// Indicates whether the specified RepeatBehaviors are equal to each other.
        /// 
 
        ///  
        /// 
        /// true if repeatBehavior1 and repeatBehavior2 are equal; otherwise false. 
        public static bool operator ==(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        {
            return repeatBehavior1.Equals(repeatBehavior2);
        } 

        /// 
 
        /// Indicates whether the specified RepeatBehaviors are not equal to each other. 
        /// 
        ///  
        /// 
        /// true if repeatBehavior1 and repeatBehavior2 are not equal; otherwise false.
        public static bool operator !=(RepeatBehavior repeatBehavior1, RepeatBehavior repeatBehavior2)
        { 
            return !repeatBehavior1.Equals(repeatBehavior2);
        } 
 
        #endregion // Operators
 
        /// 

        /// An enumeration of the different types of RepeatBehavior behaviors.
        /// 
        private enum RepeatBehaviorType 
        {
            IterationCount, 
            RepeatDuration, 
            Forever
        } 
    }
}

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

                        

                        
                        

Link Menu

This book is available now!
Buy at Amazon US or
Buy at Amazon UK

• CryptoStream.cs
• DataObjectMethodAttribute.cs
• InfiniteIntConverter.cs
• PageAsyncTaskManager.cs
• AttachedPropertyMethodSelector.cs
• ExpressionParser.cs
• TargetInvocationException.cs
• XamlReaderConstants.cs
• LogicalExpressionTypeConverter.cs
• InvalidCommandTreeException.cs
• SqlTrackingService.cs
• CompressionTracing.cs
• PolicyLevel.cs
• XmlDocumentType.cs
• PackagingUtilities.cs
• CommandBinding.cs
• DataGridrowEditEndingEventArgs.cs
• AnnotationAuthorChangedEventArgs.cs
• Cursor.cs
• MatrixCamera.cs
• DefaultPropertyAttribute.cs
• X509Extension.cs
• PageCache.cs
• AssemblyCollection.cs
• HandledMouseEvent.cs
• BindingsSection.cs
• ProfilePropertyNameValidator.cs
• WebFaultClientMessageInspector.cs
• Label.cs
• XmlCDATASection.cs
• SqlBulkCopyColumnMapping.cs
• TemplateBuilder.cs
• TextFormatterContext.cs
• StylusPointProperty.cs
• TraceContextEventArgs.cs
• XmlUTF8TextReader.cs
• SEHException.cs
• controlskin.cs
• MaskPropertyEditor.cs
• XmlStreamNodeWriter.cs
• TransactionManager.cs
• RemotingConfiguration.cs
• StatusBarItem.cs
• AuthenticationException.cs
• HandoffBehavior.cs
• HttpProfileBase.cs
• MouseEventArgs.cs
• FileLoadException.cs
• QilGenerator.cs
• PixelFormatConverter.cs
• nulltextnavigator.cs
• ResourcesBuildProvider.cs
• securestring.cs
• Polygon.cs
• ColumnResizeUndoUnit.cs
• SafeThreadHandle.cs
• SmtpNegotiateAuthenticationModule.cs
• HostAdapter.cs
• HierarchicalDataTemplate.cs
• SpeakCompletedEventArgs.cs
• ToolCreatedEventArgs.cs
• OleAutBinder.cs
• RequestCachePolicyConverter.cs
• TextEditor.cs
• SafeNativeMethods.cs
• PrintDocument.cs
• SecurityPermission.cs
• LinkedResourceCollection.cs
• ValueOfAction.cs
• StatusBarAutomationPeer.cs
• DrawingAttributes.cs
• ShaderEffect.cs
• UserPreferenceChangingEventArgs.cs
• RecordBuilder.cs
• StylusPointPropertyInfo.cs
• DirectionalAction.cs
• XmlDataSource.cs
• AccessedThroughPropertyAttribute.cs
• CapacityStreamGeometryContext.cs
• VisualStyleTypesAndProperties.cs
• AnnotationMap.cs
• AddressUtility.cs
• StringStorage.cs
• TextParagraphProperties.cs
• MSAAEventDispatcher.cs
• SqlUDTStorage.cs
• FacetChecker.cs
• CommandLibraryHelper.cs
• ModifierKeysConverter.cs
• ActivityDesignerResources.cs
• ShortcutKeysEditor.cs
• CacheEntry.cs
• WebBrowsableAttribute.cs
• ipaddressinformationcollection.cs
• FileRecordSequenceHelper.cs
• SecurityTokenAuthenticator.cs
• RulePatternOps.cs
• ProtocolReflector.cs
• ArraySortHelper.cs
• DecimalStorage.cs