IDocumentDefaultProperties.AllowAnimation Property

Gets or sets whether image animation is allowed for the current Document’s tab.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

DefaultBoolean AllowAnimation { get; set; }

VB.NET

Property AllowAnimation As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	A DefaultBoolean value that specifies whether image animation is allowed for the current Document’s tab. Default value means a document will act according to its parent view’s IDocumentProperties.AllowAnimation property value.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

You can display an animated image (.GIF) within a Document’s tab by assigning the image to the Document’s BaseDocument.Image property. By default, image animation is allowed. If required, you can disable image animation for either a specific Document or for all Documents via the AllowAnimation and IDocumentProperties.AllowAnimation property, respectively.

When an animated image is assigned to the Document, the animation starts immediately, unless the image animation is disabled via the mentioned AllowAnimation properties. To manually pause the animation for a specific Document, you can call the Document.StopAnimation method. To pause the animation for all Documents, use TabbedView.StopAnimation. To restart paused animation, use the Document.StartAnimation or TabbedView.StartAnimation method.