DocumentGroup.GetPinLocation(DependencyObject) Method

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

Namespace: DevExpress.Xpf.Docking

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

Declaration

C#

public static TabHeaderPinLocation GetPinLocation(
    DependencyObject obj
)

VB.NET

Public Shared Function GetPinLocation(
    obj As DependencyObject
) As TabHeaderPinLocation

Parameters

Name	Type	Description
obj	DependencyObject	An object for which the PinLocation attached property’s value must be returned.

Returns

Type	Description
DevExpress.Xpf.Layout.Core.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. 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. The figure below illustrates an example.

To specify where the pinned tabs are located, use DocumentGroup.PinLocation attached property in an XAML mark-up. To do the same from code, use the DocumentGroup.SetPinLocation and GetPinLocation methods. This code illustrates an example.

XAML

<dxdo:DockLayoutManager>
   <dxdo:LayoutGroup>
      <dxdo:DocumentGroup x:Name="Group1" Caption="DocumentGroup" >
         <dxdo:DocumentPanel x:Name="Document1" Caption="Document1" dxdo:DocumentGroup.PinLocation="Near"/>
         <dxdo:DocumentPanel x:Name="Document2" Caption="Document2"/>
         <dxdo:DocumentPanel x:Name="Document3" Caption="Document3"/>
         <dxdo:DocumentPanel x:Name="Document4" Caption="Document4" dxdo:DocumentGroup.PinLocation="Far"/>
      </dxdo:DocumentGroup>
  </dxdo:LayoutGroup>
</dxdo:DockLayoutManager>

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)