BaseView.BackgroundImageLayoutMode Property
Gets or sets the background image layout as defined in the ImageLayoutMode enumeration.
Namespace: DevExpress.XtraBars.Docking2010.Views
Assembly: DevExpress.XtraBars.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
[DefaultValue(ImageLayoutMode.Default)]
public ImageLayoutMode BackgroundImageLayoutMode { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| ImageLayoutMode | Default | An ImageLayoutMode enumeration value specifying the background image layout. |
Available values:
| Name | Description |
|---|---|
| TopLeft | An image is vertically aligned at the top, and horizontally aligned on the left. |
| TopCenter | An image is vertically aligned at the top, and horizontally aligned at the center. |
| TopRight | An image is vertically aligned at the top, and horizontally aligned on the right. |
| MiddleLeft | An image is vertically aligned at the center, and horizontally aligned on the left. |
| MiddleCenter | An image is horizontally and vertically aligned at the center. |
| MiddleRight | An image is vertically aligned at the center, and horizontally aligned on the right. |
| BottomLeft | An image is vertically aligned at the bottom, and horizontally aligned on the left. |
| BottomCenter | An image is vertically aligned at the bottom, and horizontally aligned at the center. |
| BottomRight | An image is vertically aligned at the bottom, and horizontally aligned on the right. |
| Stretch | An image is stretched to fill the available client area. |
| ZoomInside | Zooms an image proportionally so that it’s displayed within the client area in its entirety. |
| ZoomOutside | Zooms an image proportionally, making its smaller side (width or height) to be displayed entirely. The image is centered, so the larger side (height or width) will not be displayed in its entirety. |
| StretchHorizontal | An image is stretched horizontally. |
| StretchVertical | An image is stretched vertically. |
| Default | The default layout. |
| Squeeze | An image is displayed as is, if its actual size is smaller than the size of the container. If the image size is larger than the container’s size, the image is shrunk proportionally to fit the container’s bounds. |
Remarks
You can set an image as a DocumentManager‘s background via the BaseView.BackgroundImage property. Use the BackgroundImageLayoutMode property to specify the position and stretching behavior of this background image.
The BackgroundImageLayoutMode property is ignored if the BaseView.BackgroundImageStretchMargins property is customized. See this topic to learn more.