IBaseDocumentDefaultProperties.UseFormIconAsDocumentImage Property
Gets or sets whether a corresponding form’s icon is used as the current document’s image.
Namespace: DevExpress.XtraBars.Docking2010.Views
Assembly: DevExpress.XtraBars.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
Property Value
| Type | Description |
|---|---|
| DefaultBoolean | A DefaultBoolean value that specifies whether a corresponding form’s icon is used as a document’s image. |
Available values:
| Name | Description | Return Value |
|---|---|---|
| True | The value is true. |
|
| False | The value is false. |
|
| Default | The value is specified by a global option or a higher-level object. |
|
Remarks
Documents within a DocumentManager display underlying Form objects as tabs (within a TabbedView) or as regular windows (within a NativeMdiView). If you want to apply a form’s Icon to a corresponding document, use the UseFormIconAsDocumentImage properties provided by a View and document objects. A View’s IBaseDocumentProperties.UseFormIconAsDocumentImage property specifies whether all documents within a View use forms’ icons. A document’s UseFormIconAsDocumentImage property allows you to override this setting for individual documents.
If the UseFormIconAsDocumentImage setting is set to DefaultBoolean.Default, the actual setting is specified by the View’s IBaseDocumentProperties.UseFormIconAsDocumentImage property. Otherwise, the actual setting is specified by the UseFormIconAsDocumentImage property.
A View’s IBaseDocumentProperties.UseFormIconAsDocumentImage property is accessible via the BaseView.DocumentProperties object. A document’s UseFormIconAsDocumentImage property is accessible via the BaseDocument.Properties object.
Instead of using a form’s Icon, you can directly assign images to a document via the BaseDocument.Image property. See this topic, to learn about the places where icons(images) are displayed.