Skip to main content

DocumentGroup.GetPinLocation(DependencyObject) Method

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

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

public static TabHeaderPinLocation GetPinLocation(
    DependencyObject obj
)

Parameters

Name Type Description
obj DependencyObject

An object for which the PinLocation attached property’s value must be returned.

Returns

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

DocumentPanel - PinButtons

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

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

<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>
DevExpress.Xpf.Docking.DocumentGroup.GetPinLocation(Document1);
DevExpress.Xpf.Docking.DocumentGroup.GetPinLocation(Document4);
See Also