Skip to main content

IDocumentDefaultProperties.CanAnimate Property

Gets if a Document‘s tab icon can be animated.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[Browsable(false)]
bool CanAnimate { get; }

Property Value

Type Description
Boolean

true if a Document‘s tab icon can be animated; otherwise, false.

Remarks

You can set an animated icon for a document’s tab headers via the BaseDocument.Image property.

If an animated picture is used as a Document‘s icon, you can specify if its animation is allowed or not. The IDocumentProperties.AllowAnimation property manages icon animation availability for all tab icons within the View. You can override these settings for individual Documents via the IDocumentDefaultProperties.AllowAnimation property.

Use the TabbedView.StartAnimation and TabbedView.StopAnimation methods to start and stop icon animation. These methods are also available for individual Documents (see Document.StartAnimation and Document.StopAnimation).

Use the Document.IsAnimated property to determine if a tab icon animation for the specific Document is currently running. You can also use the CanAnimate property to determine if icon animation is allowed.

See Also