XtraTabbedMdiManager.CustomDocumentSelectorSettings Event

Allows you to customize the Document Selector’s settings, before it’s displayed on-screen.

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event CustomDocumentSelectorSettingsEventHandler CustomDocumentSelectorSettings

VB.NET

<DXCategory("Events")>
Public Event CustomDocumentSelectorSettings As CustomDocumentSelectorSettingsEventHandler

Event Data

The CustomDocumentSelectorSettings event's data class is DevExpress.XtraTabbedMdi.CustomDocumentSelectorSettingsEventArgs.

Remarks

The Document Selector feature allows you to enable the MS Visual Studio window selection style in your applications. The feature is supported if the XtraTabbedMdiManager.UseDocumentSelector property is set to True.

The CustomDocumentSelectorSettings event fires before the Document Selector is displayed on-screen. Use the properties provided by the event’s e.Selector parameter to customize various display settings.

Visually, the Document Selector consists of the Header, Footer, Preview and Item Selection areas (the Footer area is hidden in the image above). The Item Selection area is internally represented by a GalleryControl object, where each item is represented by a DocumentSelectorItem object (a GalleryItem descendant). Using the CustomDocumentSelectorSettings event’s parameters, you can customize the following Document Selector’s settings:

Option	Description
e.Selector.ShowHeader	Specifies the visibility of the Header area
e.Selector.ShowFooter	Specifies the visibility of the Footer area
e.Selector.HeaderHeight	Specifies the height of the Header area
e.Selector.FooterHeight	Specifies the height of the Footer area
e.Selector.GalleryColumnWidth	Specifies the width of the Item Selection area
e.Selector.GalleryMaxRows	Specifies the maximum number of visible rows in the Selection area

By default, the Footer area is hidden. You can make it visible via the e.Selector.ShowFooter parameter. Typically, you make the Footer visible to display custom information within the Footer when individual items are selected. To display custom information in the Footer and Header areas when particular items are selected, handle the XtraTabbedMdiManager.CustomDocumentSelectorItem event.

Example

This example demonstrates how to enable the Document Selector feature and customize the Document Selector's display settings.The Document Selector feature allows you to enable the MS Visual Studio window selection style in your applications. To show the Document Selector, an end-user needs to press and hold CTRL+TAB or CTRL+SHIFT+TAB. Then, while still holding the CTRL or CTRL+SHIFT key, you can navigate to another page by pressing TAB or Arrow keys. Or you can select the required page within the Document Selector by clicking it with the mouse.An in MS Visual Studio, if you quickly press and then release the CTRL+TAB, the previously active child window is activated. To activate the following child window, press and hold CTRL+TAB and then press TAB.The Document Selector feature is enabled via the XtraTabbedMdiManager.UseDocumentSelector property. The CustomDocumentSelectorSettings event is handled to customize the Document Selector's display settings. For instance, in this example the Footer and Header areas are made visible and their heights are changed. The CustomDocumentSelectorItem event is handled to display custom information within the Footer and Header areas when individual items are selected.Take note of the UseFormIconAsPageImage property that allows icons associated with child windows to be displayed in tab page headers.

The following image shows the result:

MainForm.cs

    /*** To show child forms' icons in page headers ***/
    xtraTabbedMdiManager1.UseFormIconAsPageImage = DefaultBoolean.True;
    /*** Enable the Document Selector feature (use CTRL+TAB) ***/
    xtraTabbedMdiManager1.UseDocumentSelector = DefaultBoolean.True;
void Form1_Load(object sender, EventArgs e) {
    AddChild("Recent", "Shows the recently viewed photos");
    AddChild("Favorites", "My favorite photos");
    AddChild("Published", "These photos are published in my blog");
    AddChild("Unsorted", "Not reviewed photos");
}
void AddChild(string category, string tag) {
    ChildForm categoryForm = new ChildForm();
    categoryForm.Text = category;
    categoryForm.MdiParent = this;
    categoryForm.Tag = tag;
    categoryForm.Show();
}
void xtraTabbedMdiManager1_CustomDocumentSelectorSettings(object sender, CustomDocumentSelectorSettingsEventArgs e) {
    // Define max visible row count (12 by default )
    e.Selector.GalleryMaxRows = 4;
    // Define width of item column (by default this value is calculated automatically)
    e.Selector.GalleryColumnWidth = 140;

    e.Selector.ShowHeader = true; 
    e.Selector.ShowFooter = true;

    e.Selector.HeaderHeight = 50;
    e.Selector.FooterHeight = 50;
}
void xtraTabbedMdiManager1_CustomDocumentSelectorItem(object sender, CustomDocumentSelectorItemEventArgs e) {
    e.Item.FooterText = (string)e.Item.Page.MdiChild.Tag;
    e.Item.HeaderText = string.Format("Photo Category: {0}", e.Item.Caption);
}

MainForm.vb

    '** To show child forms' icons in page headers **
    xtraTabbedMdiManager1.UseFormIconAsPageImage = DefaultBoolean.True
    '** Enable the Document Selector feature (use CTRL+TAB) **
    xtraTabbedMdiManager1.UseDocumentSelector = DefaultBoolean.True
Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    AddChild("Recent", "Shows the recently viewed photos")
    AddChild("Favorites", "My favorite photos")
    AddChild("Published", "These photos are published in my blog")
    AddChild("Unsorted", "Not reviewed photos")
End Sub
Private Sub AddChild(ByVal category As String, ByVal tag As String)
    Dim categoryForm As New ChildForm()
    categoryForm.Text = category
    categoryForm.MdiParent = Me
    categoryForm.Tag = tag
    categoryForm.Show()
End Sub
Private Sub xtraTabbedMdiManager1_CustomDocumentSelectorSettings(ByVal sender As Object, ByVal e As CustomDocumentSelectorSettingsEventArgs)
    ' Define max visible row count (12 by default )
    e.Selector.GalleryMaxRows = 4
    ' Define width of item column (by default this value is calculated automatically)
    e.Selector.GalleryColumnWidth = 140

    e.Selector.ShowHeader = True
    e.Selector.ShowFooter = True

    e.Selector.HeaderHeight = 50
    e.Selector.FooterHeight = 50
End Sub
Private Sub xtraTabbedMdiManager1_CustomDocumentSelectorItem(ByVal sender As Object, ByVal e As CustomDocumentSelectorItemEventArgs)
    e.Item.FooterText = CStr(e.Item.Page.MdiChild.Tag)
    e.Item.HeaderText = String.Format("Photo Category: {0}", e.Item.Caption)
End Sub