DocumentGroup.SetPinLocation(DependencyObject, TabHeaderPinLocation) Method

Set a value indicating where the pinned tabbed DocumentPanel is located.

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

C#

public static void SetPinLocation(
    DependencyObject obj,
    TabHeaderPinLocation value
)

VB.NET

Public Shared Sub SetPinLocation(
    obj As DependencyObject,
    value As TabHeaderPinLocation
)

Parameters

Name	Type	Description
obj	DependencyObject	An object for which the PinLocation attached property’s value is set.
value	TabHeaderPinLocation	A value that specifies where the pinned tabbed DocumentPanel is located.

Remarks

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

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:

Use the DocumentGroup.PinLocation attached property in an XAML markup to specify where the pinned tabs are located.

Use the SetPinLocation and the DocumentGroup.GetPinLocation methods to do the same from code:

The following code sample sets the DocumentGroup.PinLocation attached property:

XAML

<dx:ThemedWindow 
  ...
  xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
  xmlns:dxdo="http://schemas.devexpress.com/winfx/2008/xaml/docking">
  <dxdo:DockLayoutManager>
    <dxdo:LayoutGroup>
      <dxdo:DocumentGroup x:Name="Group1" Caption="DocumentGroup" >
         <dxdo:DocumentPanel x:Name="Document1" Caption="Document1"/>
         <dxdo:DocumentPanel x:Name="Document2" Caption="Document2"/>
         <dxdo:DocumentPanel x:Name="Document3" Caption="Document3"/>
         <dxdo:DocumentPanel x:Name="Document4" Caption="Document4"/>
      </dxdo:DocumentGroup>
    </dxdo:LayoutGroup>
  </dxdo:DockLayoutManager>
</dx:ThemedWindow>

C#

DevExpress.Xpf.Docking.DocumentGroup.SetPinLocation(Document1, DevExpress.Xpf.Layout.Core.TabHeaderPinLocation.Near);
DevExpress.Xpf.Docking.DocumentGroup.SetPinLocation(Document4, DevExpress.Xpf.Layout.Core.TabHeaderPinLocation.Far);

VB.NET

DevExpress.Xpf.Docking.DocumentGroup.SetPinLocation(Document1, DevExpress.Xpf.Layout.Core.TabHeaderPinLocation.Near)
DevExpress.Xpf.Docking.DocumentGroup.SetPinLocation(Document4, DevExpress.Xpf.Layout.Core.TabHeaderPinLocation.Far)