Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

IDocumentProperties.ThumbnailCaptionFormat Property

Gets or sets the format of a text, displayed within document thumbnails in a Windows task bar.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

string ThumbnailCaptionFormat { get; set; }

#Property Value

Type Description
String

A String value that is the format of a text, displayed within document thumbnails in a Windows task bar.

#Remarks

Each document in a Tabbed View can display its own thumbnail in the Windows task bar if the DocumentManager.ShowThumbnailsInTaskBar property equals DefaultBoolean.True. By default, these thumbnails display text that consists of the parent form’s caption and the document caption (see the figure below).

DocumentManager - Thumbnail Caption Format

This default text representation is built according to the {0} - {1} format, where the {0} string is automatically replaced with the parent form caption, the {1} string is replaced with the document caption. Use the ThumbnailCaptionFormat property to set your own thumbnail caption format.

To set a different thumbnail caption format for an individual tabbed document, use the IDocumentDefaultProperties.ThumbnailCaptionFormat property instead.

See Also