WpfAnimatedGif.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>WpfAnimatedGif</name>
  5. </assembly>
  6. <members>
  7. <member name="T:WpfAnimatedGif.ImageAnimationController">
  8. <summary>
  9. Provides a way to pause, resume or seek a GIF animation.
  10. </summary>
  11. </member>
  12. <member name="P:WpfAnimatedGif.ImageAnimationController.FrameCount">
  13. <summary>
  14. Returns the number of frames in the image.
  15. </summary>
  16. </member>
  17. <member name="P:WpfAnimatedGif.ImageAnimationController.Duration">
  18. <summary>
  19. Returns the duration of the animation.
  20. </summary>
  21. </member>
  22. <member name="P:WpfAnimatedGif.ImageAnimationController.IsPaused">
  23. <summary>
  24. Returns a value that indicates whether the animation is paused.
  25. </summary>
  26. </member>
  27. <member name="P:WpfAnimatedGif.ImageAnimationController.IsComplete">
  28. <summary>
  29. Returns a value that indicates whether the animation is complete.
  30. </summary>
  31. </member>
  32. <member name="M:WpfAnimatedGif.ImageAnimationController.GotoFrame(System.Int32)">
  33. <summary>
  34. Seeks the animation to the specified frame index.
  35. </summary>
  36. <param name="index">The index of the frame to seek to</param>
  37. </member>
  38. <member name="P:WpfAnimatedGif.ImageAnimationController.CurrentFrame">
  39. <summary>
  40. Returns the current frame index.
  41. </summary>
  42. </member>
  43. <member name="M:WpfAnimatedGif.ImageAnimationController.Pause">
  44. <summary>
  45. Pauses the animation.
  46. </summary>
  47. </member>
  48. <member name="M:WpfAnimatedGif.ImageAnimationController.Play">
  49. <summary>
  50. Starts or resumes the animation. If the animation is complete, it restarts from the beginning.
  51. </summary>
  52. </member>
  53. <member name="E:WpfAnimatedGif.ImageAnimationController.CurrentFrameChanged">
  54. <summary>
  55. Raised when the current frame changes.
  56. </summary>
  57. </member>
  58. <member name="M:WpfAnimatedGif.ImageAnimationController.Finalize">
  59. <summary>
  60. Finalizes the current object.
  61. </summary>
  62. </member>
  63. <member name="M:WpfAnimatedGif.ImageAnimationController.Dispose">
  64. <summary>
  65. Disposes the current object.
  66. </summary>
  67. </member>
  68. <member name="M:WpfAnimatedGif.ImageAnimationController.Dispose(System.Boolean)">
  69. <summary>
  70. Disposes the current object
  71. </summary>
  72. <param name="disposing">true to dispose both managed an unmanaged resources, false to dispose only managed resources</param>
  73. </member>
  74. <member name="T:WpfAnimatedGif.ImageBehavior">
  75. <summary>
  76. Provides attached properties that display animated GIFs in a standard Image control.
  77. </summary>
  78. </member>
  79. <member name="M:WpfAnimatedGif.ImageBehavior.GetAnimatedSource(System.Windows.Controls.Image)">
  80. <summary>
  81. Gets the value of the <c>AnimatedSource</c> attached property for the specified object.
  82. </summary>
  83. <param name="obj">The element from which to read the property value.</param>
  84. <returns>The currently displayed animated image.</returns>
  85. </member>
  86. <member name="M:WpfAnimatedGif.ImageBehavior.SetAnimatedSource(System.Windows.Controls.Image,System.Windows.Media.ImageSource)">
  87. <summary>
  88. Sets the value of the <c>AnimatedSource</c> attached property for the specified object.
  89. </summary>
  90. <param name="obj">The element on which to set the property value.</param>
  91. <param name="value">The animated image to display.</param>
  92. </member>
  93. <member name="F:WpfAnimatedGif.ImageBehavior.AnimatedSourceProperty">
  94. <summary>
  95. Identifies the <c>AnimatedSource</c> attached property.
  96. </summary>
  97. </member>
  98. <member name="M:WpfAnimatedGif.ImageBehavior.GetRepeatBehavior(System.Windows.Controls.Image)">
  99. <summary>
  100. Gets the value of the <c>RepeatBehavior</c> attached property for the specified object.
  101. </summary>
  102. <param name="obj">The element from which to read the property value.</param>
  103. <returns>The repeat behavior of the animated image.</returns>
  104. </member>
  105. <member name="M:WpfAnimatedGif.ImageBehavior.SetRepeatBehavior(System.Windows.Controls.Image,System.Windows.Media.Animation.RepeatBehavior)">
  106. <summary>
  107. Sets the value of the <c>RepeatBehavior</c> attached property for the specified object.
  108. </summary>
  109. <param name="obj">The element on which to set the property value.</param>
  110. <param name="value">The repeat behavior of the animated image.</param>
  111. </member>
  112. <member name="F:WpfAnimatedGif.ImageBehavior.RepeatBehaviorProperty">
  113. <summary>
  114. Identifies the <c>RepeatBehavior</c> attached property.
  115. </summary>
  116. </member>
  117. <member name="M:WpfAnimatedGif.ImageBehavior.GetAnimationSpeedRatio(System.Windows.DependencyObject)">
  118. <summary>
  119. Gets the value of the <c>AnimationSpeedRatio</c> attached property for the specified object.
  120. </summary>
  121. <param name="obj">The element from which to read the property value.</param>
  122. <returns>The speed ratio for the animated image.</returns>
  123. </member>
  124. <member name="M:WpfAnimatedGif.ImageBehavior.SetAnimationSpeedRatio(System.Windows.DependencyObject,System.Nullable{System.Double})">
  125. <summary>
  126. Sets the value of the <c>AnimationSpeedRatio</c> attached property for the specified object.
  127. </summary>
  128. <param name="obj">The element on which to set the property value.</param>
  129. <param name="value">The speed ratio of the animated image.</param>
  130. <remarks>The <c>AnimationSpeedRatio</c> and <c>AnimationDuration</c> properties are mutually exclusive, only one can be set at a time.</remarks>
  131. </member>
  132. <member name="F:WpfAnimatedGif.ImageBehavior.AnimationSpeedRatioProperty">
  133. <summary>
  134. Identifies the <c>AnimationSpeedRatio</c> attached property.
  135. </summary>
  136. </member>
  137. <member name="M:WpfAnimatedGif.ImageBehavior.GetAnimationDuration(System.Windows.DependencyObject)">
  138. <summary>
  139. Gets the value of the <c>AnimationDuration</c> attached property for the specified object.
  140. </summary>
  141. <param name="obj">The element from which to read the property value.</param>
  142. <returns>The duration for the animated image.</returns>
  143. </member>
  144. <member name="M:WpfAnimatedGif.ImageBehavior.SetAnimationDuration(System.Windows.DependencyObject,System.Nullable{System.Windows.Duration})">
  145. <summary>
  146. Sets the value of the <c>AnimationDuration</c> attached property for the specified object.
  147. </summary>
  148. <param name="obj">The element on which to set the property value.</param>
  149. <param name="value">The duration of the animated image.</param>
  150. <remarks>The <c>AnimationSpeedRatio</c> and <c>AnimationDuration</c> properties are mutually exclusive, only one can be set at a time.</remarks>
  151. </member>
  152. <member name="F:WpfAnimatedGif.ImageBehavior.AnimationDurationProperty">
  153. <summary>
  154. Identifies the <c>AnimationDuration</c> attached property.
  155. </summary>
  156. </member>
  157. <member name="M:WpfAnimatedGif.ImageBehavior.GetAnimateInDesignMode(System.Windows.DependencyObject)">
  158. <summary>
  159. Gets the value of the <c>AnimateInDesignMode</c> attached property for the specified object.
  160. </summary>
  161. <param name="obj">The element from which to read the property value.</param>
  162. <returns>true if GIF animations are shown in design mode; false otherwise.</returns>
  163. </member>
  164. <member name="M:WpfAnimatedGif.ImageBehavior.SetAnimateInDesignMode(System.Windows.DependencyObject,System.Boolean)">
  165. <summary>
  166. Sets the value of the <c>AnimateInDesignMode</c> attached property for the specified object.
  167. </summary>
  168. <param name="obj">The element on which to set the property value.</param>
  169. <param name="value">true to show GIF animations in design mode; false otherwise.</param>
  170. </member>
  171. <member name="F:WpfAnimatedGif.ImageBehavior.AnimateInDesignModeProperty">
  172. <summary>
  173. Identifies the <c>AnimateInDesignMode</c> attached property.
  174. </summary>
  175. </member>
  176. <member name="M:WpfAnimatedGif.ImageBehavior.GetAutoStart(System.Windows.Controls.Image)">
  177. <summary>
  178. Gets the value of the <c>AutoStart</c> attached property for the specified object.
  179. </summary>
  180. <param name="obj">The element from which to read the property value.</param>
  181. <returns>true if the animation should start immediately when loaded. Otherwise, false.</returns>
  182. </member>
  183. <member name="M:WpfAnimatedGif.ImageBehavior.SetAutoStart(System.Windows.Controls.Image,System.Boolean)">
  184. <summary>
  185. Sets the value of the <c>AutoStart</c> attached property for the specified object.
  186. </summary>
  187. <param name="obj">The element from which to read the property value.</param>
  188. <param name="value">true if the animation should start immediately when loaded. Otherwise, false.</param>
  189. <remarks>The default value is true.</remarks>
  190. </member>
  191. <member name="F:WpfAnimatedGif.ImageBehavior.AutoStartProperty">
  192. <summary>
  193. Identifies the <c>AutoStart</c> attached property.
  194. </summary>
  195. </member>
  196. <member name="M:WpfAnimatedGif.ImageBehavior.GetAnimationController(System.Windows.Controls.Image)">
  197. <summary>
  198. Gets the animation controller for the specified <c>Image</c> control.
  199. </summary>
  200. <param name="imageControl"></param>
  201. <returns></returns>
  202. </member>
  203. <member name="M:WpfAnimatedGif.ImageBehavior.GetIsAnimationLoaded(System.Windows.Controls.Image)">
  204. <summary>
  205. Gets the value of the <c>IsAnimationLoaded</c> attached property for the specified object.
  206. </summary>
  207. <param name="image">The element from which to read the property value.</param>
  208. <returns>true if the animation is loaded. Otherwise, false.</returns>
  209. </member>
  210. <member name="F:WpfAnimatedGif.ImageBehavior.IsAnimationLoadedProperty">
  211. <summary>
  212. Identifies the <c>IsAnimationLoaded</c> attached property.
  213. </summary>
  214. </member>
  215. <member name="F:WpfAnimatedGif.ImageBehavior.AnimationLoadedEvent">
  216. <summary>
  217. Identifies the <c>AnimationLoaded</c> attached event.
  218. </summary>
  219. </member>
  220. <member name="M:WpfAnimatedGif.ImageBehavior.AddAnimationLoadedHandler(System.Windows.Controls.Image,System.Windows.RoutedEventHandler)">
  221. <summary>
  222. Adds a handler for the AnimationLoaded attached event.
  223. </summary>
  224. <param name="image">The UIElement that listens to this event.</param>
  225. <param name="handler">The event handler to be added.</param>
  226. </member>
  227. <member name="M:WpfAnimatedGif.ImageBehavior.RemoveAnimationLoadedHandler(System.Windows.Controls.Image,System.Windows.RoutedEventHandler)">
  228. <summary>
  229. Removes a handler for the AnimationLoaded attached event.
  230. </summary>
  231. <param name="image">The UIElement that listens to this event.</param>
  232. <param name="handler">The event handler to be removed.</param>
  233. </member>
  234. <member name="F:WpfAnimatedGif.ImageBehavior.AnimationCompletedEvent">
  235. <summary>
  236. Identifies the <c>AnimationCompleted</c> attached event.
  237. </summary>
  238. </member>
  239. <member name="M:WpfAnimatedGif.ImageBehavior.AddAnimationCompletedHandler(System.Windows.Controls.Image,System.Windows.RoutedEventHandler)">
  240. <summary>
  241. Adds a handler for the AnimationCompleted attached event.
  242. </summary>
  243. <param name="d">The UIElement that listens to this event.</param>
  244. <param name="handler">The event handler to be added.</param>
  245. </member>
  246. <member name="M:WpfAnimatedGif.ImageBehavior.RemoveAnimationCompletedHandler(System.Windows.Controls.Image,System.Windows.RoutedEventHandler)">
  247. <summary>
  248. Removes a handler for the AnimationCompleted attached event.
  249. </summary>
  250. <param name="d">The UIElement that listens to this event.</param>
  251. <param name="handler">The event handler to be removed.</param>
  252. </member>
  253. </members>
  254. </doc>