Version

PinButtonBehavior Property (GroupSettings)

Returns or sets which panes are pinned or unpinned when the pin button on the tab group caption is pressed.
Syntax
'Declaration
 
Public Property PinButtonBehavior As PinButtonBehavior
public PinButtonBehavior PinButtonBehavior {get; set;}
Remarks

Depending on the setting of this property, clicking the pin button for a pane in a tab group will either pin the entire group's panes or only the pane that was selected when the button was clicked.

Example
The following code initializes various properties on the ultradockmanager component.

Imports Infragistics.Shared
 Imports Infragistics.Win
 Imports Infragistics.Win.UltraWinDock

 Private Sub InitializeDockManager(ByVal dockManager As UltraDockManager)

     ' Disable window xp themes
     dockManager.SupportThemes = False

     ' Wait 2 seconds before hiding the flyout
     ' window containing a non active control pane
     dockManager.AutoHideDelay = 2000

     ' Increate the flyout animation speed
     dockManager.AnimationSpeed = AnimationSpeed.StandardSpeedPlus3

     ' Using the window style captions and tabs
     dockManager.WindowStyle = WindowStyle.Windows

     ' When available, drag a layered window instead
     ' of the standard outline rect
     dockManager.DragWindowStyle = DragWindowStyle.LayeredWindow

     ' Disable the context menus displayed when you right click
     ' on the unpinned tab areas and the window captions
     dockManager.UseDefaultContextMenus = False

     ' Enable hot tracking
     dockManager.HotTracking = True

     ' Initialize the hot track forecolor for a pane and tab captions
     dockManager.DefaultPaneSettings.HotTrackingCaptionAppearance.ForeColor = SystemColors.HotTrack
     dockManager.DefaultPaneSettings.HotTrackingTabAppearance.ForeColor = SystemColors.HotTrack

     ' Create a gradient for the active pane's caption
     dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackColor = SystemColors.ActiveCaption
     dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackColor2 = SystemColors.ActiveCaptionText
     dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackGradientStyle = GradientStyle.Horizontal

     ' Hide disabled buttons
     dockManager.ShowDisabledButtons = False

     ' Display the maximize button to allow a single pane
     ' within a vertical or horizontally split group of
     ' panes to be maximized.
     dockManager.ShowMaximizeButton = True

     ' Initialize the splitter bars
     dockManager.BorderStyleSplitterBars = UIElementBorderStyle.Dotted
     dockManager.SplitterBarWidth = 3

     ' When the close button for a pane in a tab group
     ' is pressed, close all the items in the group
     dockManager.DefaultGroupSettings.CloseButtonBehavior = CloseButtonBehavior.CloseTabGroup

     ' When the pin button for a pane in a tab group is
     ' pressed, pin/unpin all the members in the group
     dockManager.DefaultGroupSettings.PinButtonBehavior = PinButtonBehavior.PinTabGroup

      ' Initialize the image sizes
     dockManager.ImageSizeCaption = New Size(16, 16)
     dockManager.ImageSizeTab = New Size(20, 20)

' Scale images down to the specified sizes for the 'ImageSizeCaption'
' and 'ImageSizeTab' when the image size exceeds the specified size.
dockManager.ScaleImages = ScaleImage.OnlyWhenNeeded

     ' Initialize the color to mask from images
     dockManager.ImageTransparentColor = Color.Magenta

    ' Unhide any closed or unpinned panes
     dockManager.ShowAll(True)

 End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinDock;
using System.Diagnostics;

private void InitializeDockManager(UltraDockManager dockManager)
{

	// Disable window xp themes
	dockManager.SupportThemes = false;

	// Wait 2 seconds before hiding the flyout
	// window containing a non active control pane
	dockManager.AutoHideDelay = 2000;

	// Increate the flyout animation speed
	dockManager.AnimationSpeed = AnimationSpeed.StandardSpeedPlus3;

	// Using the window style captions and tabs
	dockManager.WindowStyle = WindowStyle.Windows;

	// When available, drag a layered window instead
	// of the standard outline rect
	dockManager.DragWindowStyle = DragWindowStyle.LayeredWindow;

	// Disable the context menus displayed when you right click
	// on the unpinned tab areas and the window captions
	dockManager.UseDefaultContextMenus = false;

	// Enable hot tracking
	dockManager.HotTracking = true;

	// Initialize the hot track forecolor for a pane and tab captions
	dockManager.DefaultPaneSettings.HotTrackingCaptionAppearance.ForeColor = SystemColors.HotTrack;
	dockManager.DefaultPaneSettings.HotTrackingTabAppearance.ForeColor = SystemColors.HotTrack;

	// Create a gradient for the active pane's caption
	dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackColor = SystemColors.ActiveCaption;
	dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackColor2 = SystemColors.ActiveCaptionText;
	dockManager.DefaultPaneSettings.ActiveCaptionAppearance.BackGradientStyle = GradientStyle.Horizontal;

	// Hide disabled buttons
	dockManager.ShowDisabledButtons = false;

	// Display the maximize button to allow a single pane
	// within a vertical or horizontally split group of
	// panes to be maximized.
	dockManager.ShowMaximizeButton = true;

	// Initialize the splitter bars
	dockManager.BorderStyleSplitterBars = UIElementBorderStyle.Dotted;
	dockManager.SplitterBarWidth = 3;

	// When the close button for a pane in a tab group
	// is pressed, close all the items in the group
	dockManager.DefaultGroupSettings.CloseButtonBehavior = CloseButtonBehavior.CloseTabGroup;

	// When the pin button for a pane in a tab group is
	// pressed, pin/unpin all the members in the group
	dockManager.DefaultGroupSettings.PinButtonBehavior = PinButtonBehavior.PinTabGroup;

	// Initialize the image sizes
	dockManager.ImageSizeCaption = new Size(16, 16);
	dockManager.ImageSizeTab = new Size(20, 20);

	// Scale images down to the specified sizes for the 'ImageSizeCaption'
	// and 'ImageSizeTab' when the image size exceeds the specified size.
	dockManager.ScaleImages = ScaleImage.OnlyWhenNeeded;

	// Initialize the color to mask from images
	dockManager.ImageTransparentColor = Color.Magenta;

	// Unhide any closed or unpinned panes
	dockManager.ShowAll(true);

}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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

See Also