DocumentGroup.Pinned Attached Property

Gets or sets whether the tabbed DocumentPanel is currently pinned. This is an attached property.

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

See GetPinned(DependencyObject) and SetPinned(DependencyObject, Boolean).

Returns

Type	Description
Boolean	true, if the tabbed DocumentPanel is currently 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 shown 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.

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

XAML

<dxdo:DockLayoutManager>
   <dxdo:LayoutGroup>
      <dxdo:DocumentGroup x:Name="DocumentGroup" Caption="DocumentGroup" MDIStyle="Tabbed">
          <dxdo:DocumentPanel x:Name="Document1" Caption="Document1" dxdo:DocumentGroup.ShowPinButton="True"/>
          <dxdo:DocumentPanel x:Name="Document2" Caption="Document2" dxdo:DocumentGroup.ShowPinButton="False"/>
          <dxdo:DocumentPanel x:Name="Document3" Caption="Document3" dxdo:DocumentGroup.ShowPinButton="True"/>
      </dxdo:DocumentGroup>
   </dxdo:LayoutGroup>
</dxdo:DockLayoutManager>

C#

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));

VB.NET

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))

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

XAML

<dxdo:DockLayoutManager>
   <dxdo:LayoutGroup>
      <dxdo:DocumentGroup x:Name="DocumentGroup" Caption="DocumentGroup" MDIStyle="Tabbed">
          <dxdo:DocumentPanel x:Name="Document1" Caption="Document1" dxdo:DocumentGroup.Pinned="True"/>
          <dxdo:DocumentPanel x:Name="Document2" Caption="Document2"/>
          <dxdo:DocumentPanel x:Name="Document3" Caption="Document3" dxdo:DocumentGroup.Pinned="False"/>
      </dxdo:DocumentGroup>
   </dxdo:LayoutGroup>
</dxdo:DockLayoutManager>

C#

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));

VB.NET

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))