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

DocumentGroup.SetPinned(DependencyObject, Boolean) Method

Set a value indicating whether the tabbed DocumentPanel is pinned.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v24.2.dll

NuGet Package: DevExpress.Wpf.Docking

#Declaration

public static void SetPinned(
    DependencyObject obj,
    bool value
)

#Parameters

Name Type Description
obj DependencyObject

An object for which the Pinned attached property’s value is set.

value Boolean

true, if the tabbed DocumentPanel is pinned; otherwise, false.

#Remarks

The DocumentGroup object contains child DocumentPanel objects that allow you to create a tabbed or MDI interface. To create a tabbed interface, set the DocumentGroup.MDIStyle property to MDIStyle.Tabbed.

If DocumentPanels are represented as tabs, they can display Pin buttons that allow an end-user to pin and unpin a current tab at runtime. Pinned tabs are stacked to either the left or right side, depending on the DocumentGroup.PinLocation property value. The figure below illustrates an example.

DocumentPanel - PinButtons

To specify the pin button visibility in an XAML mark-up, use the DocumentGroup.ShowPinButton attached property. To do the same from code, use the DocumentGroup.SetShowPinButton and DocumentGroup.GetShowPinButton methods. The code below illustrates an example.

DevExpress.Xpf.Docking.DocumentGroup.SetShowPinButton(Document1, true);
DevExpress.Xpf.Docking.DocumentGroup.SetShowPinButton(Document2, false);
DevExpress.Xpf.Docking.DocumentGroup.SetShowPinButton(Document3, DevExpress.Xpf.Docking.DocumentGroup.GetShowPinButton(Document1));

To manually specify whether tabs are pinned or unpinned in an XAML mark-up, use the DocumentGroup.Pinned attached property. To do the same from code, use the SetPinned and DocumentGroup.GetPinned methods. The code below illustrates an example.

DevExpress.Xpf.Docking.DocumentGroup.SetPinned(Document1, true);
DevExpress.Xpf.Docking.DocumentGroup.SetPinned(Document2, false);
DevExpress.Xpf.Docking.DocumentGroup.SetPinned(Document3, DevExpress.Xpf.Docking.DocumentGroup.GetPinned(Document2));
See Also