DocumentGroup.GetPinned(DependencyObject) Method
Returns a value indicating whether the tabbed DocumentPanel is pinned.
Namespace: DevExpress.Xpf.Docking
Assembly: DevExpress.Xpf.Docking.v19.1.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| obj | DependencyObject | An object for which the Pinned attached property’s value must be returned. |
Returns
| Type | Description |
|---|---|
| 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.
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.
<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>
To manually specify whether tabs are pinned or unpinned in a XAML mark-up, use the DocumentGroup.Pinned attached property. To do the same from code, use the DocumentGroup.SetPinned and GetPinned methods. The code below illustrates an example.
<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>