IsPinned Property

Returns/sets a boolean indicating whether the pane should be displayed within an UnpinnedTabArea

Syntax

Visual Basic

'Declaration
 
Public Property IsPinned As Boolean

C#

public bool IsPinned {get; set;}

Remarks

By default, IsPinned is true meaning that the pane will be displayed based on its current location. When set to false, the pane will be removed from its current location and displayed within the UnpinnedTabArea of the containing XamDockManager.

Example

This example uses the pinning related properties of the ContentPane class to control whether the pane is unpinned and whether the end user is allowed to change that state.

Visual Basic

Imports Infragistics.Windows.DockManager

Private Sub InitializeDmPinning(ByVal dockManager As XamDockManager)
    ' ContentPanes that are docked to an edge of 
    ' the XamDockManager can be unpinned. When 
    ' unpinned they are represented by a tab in 
    ' the unpinned tab area along the corresponding 
    ' edge of the dockmanager. 


    ' The IsPinned property is used to indicate 
    ' the pinned state. ContentPanes are pinned 
    ' by default. 
    Dim cpPinned As New ContentPane()
    cpPinned.Header = "Starts Pinned"

    Dim cpUnpinned As New ContentPane()
    cpUnpinned.Header = "Starts Unpinned"
    cpUnpinned.IsPinned = False

    Dim splitBottom As New SplitPane()
    splitBottom.SplitterOrientation = Orientation.Vertical
    XamDockManager.SetInitialLocation(splitBottom, InitialPaneLocation.DockedBottom)
    splitBottom.Panes.Add(cpPinned)
    splitBottom.Panes.Add(cpUnpinned)
    dockManager.Panes.Add(splitBottom)

    ' AllowPinning is used to indicate whether 
    ' the end user may change the IsPinned state. 
    Dim cpPinnedAlways As New ContentPane()
    cpPinnedAlways.Header = "Always Pinned"
    cpPinnedAlways.AllowPinning = False

    Dim cpUnpinnedAlways As New ContentPane()
    cpUnpinnedAlways.Header = "Always Unpinned"
    cpUnpinnedAlways.AllowPinning = False
    cpUnpinnedAlways.IsPinned = False

    Dim splitLeft As New SplitPane()
    splitLeft.SplitterOrientation = Orientation.Horizontal
    XamDockManager.SetInitialLocation(splitLeft, InitialPaneLocation.DockedLeft)
    splitLeft.Panes.Add(cpPinnedAlways)
    splitLeft.Panes.Add(cpUnpinnedAlways)
    dockManager.Panes.Add(splitLeft)
End Sub

C#

using Infragistics.Windows.DockManager;

private void InitializeDmPinning(XamDockManager dockManager)
{
	// ContentPanes that are docked to an edge of 
	// the XamDockManager can be unpinned. When 
	// unpinned they are represented by a tab in 
	// the unpinned tab area along the corresponding 
	// edge of the dockmanager.


	// The IsPinned property is used to indicate 
	// the pinned state. ContentPanes are pinned
	// by default.
	ContentPane cpPinned = new ContentPane();
	cpPinned.Header = "Starts Pinned";

	ContentPane cpUnpinned = new ContentPane();
	cpUnpinned.Header = "Starts Unpinned";
	cpUnpinned.IsPinned = false;

	SplitPane splitBottom = new SplitPane();
	splitBottom.SplitterOrientation = Orientation.Vertical;
	XamDockManager.SetInitialLocation(splitBottom, InitialPaneLocation.DockedBottom);
	splitBottom.Panes.Add(cpPinned);
	splitBottom.Panes.Add(cpUnpinned);
	dockManager.Panes.Add(splitBottom);

	// AllowPinning is used to indicate whether 
	// the end user may change the IsPinned state.
	ContentPane cpPinnedAlways = new ContentPane();
	cpPinnedAlways.Header = "Always Pinned";
	cpPinnedAlways.AllowPinning = false;

	ContentPane cpUnpinnedAlways = new ContentPane();
	cpUnpinnedAlways.Header = "Always Unpinned";
	cpUnpinnedAlways.AllowPinning = false;
	cpUnpinnedAlways.IsPinned = false;

	SplitPane splitLeft = new SplitPane();
	splitLeft.SplitterOrientation = Orientation.Horizontal;
	XamDockManager.SetInitialLocation(splitLeft, InitialPaneLocation.DockedLeft);
	splitLeft.Panes.Add(cpPinnedAlways);
	splitLeft.Panes.Add(cpUnpinnedAlways);
	dockManager.Panes.Add(splitLeft);
}

XAML

<!-- ContentPanes that are docked to an edge of 
     the XamDockManager can be unpinned. When 
     unpinned they are represented by a tab in 
     the unpinned tab area along the corresponding 
     edge of the dockmanager. -->
<igDock:XamDockManager>
    <igDock:XamDockManager.Panes>
        <!-- The IsPinned property is used to indicate 
             the pinned state. ContentPanes are pinned
             by default. -->
        <igDock:SplitPane SplitterOrientation="Vertical"
            igDock:XamDockManager.InitialLocation="DockedBottom">
            <igDock:ContentPane Header="Starts Pinned" />
            <igDock:ContentPane Header="Starts Unpinned"
                                IsPinned="False" />
        </igDock:SplitPane>
        <!-- AllowPinning is used to indicate whether 
             the end user may change the IsPinned state. -->
        <igDock:SplitPane SplitterOrientation="Horizontal"
            igDock:XamDockManager.InitialLocation="DockedLeft">
            <igDock:ContentPane Header="Always Pinned"
                                AllowPinning="False" />
            <igDock:ContentPane Header="Always Unpinned"
                                AllowPinning="False"
                                IsPinned="False" />
        </igDock:SplitPane>
    </igDock:XamDockManager.Panes>
</igDock:XamDockManager>

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2