Skip to end of metadata
Go to start of metadata

Remarks

UXDesktopDock is an innovative navigation control power-packed with all features available in UXDock plus comprehensive application management features such as launching or closing an application. With state-of-the-art integration to UXDesktop, UXDesktopDock features complete taskbar interface enabling users to interact with the desktop and windows in the same way and manner as in a Windows orMac desktop.

UXDesktopDock automatically performs synchronization between the windows and task bar to provide intuitive desktop-style workspace. For instance, try to open the Bookshelf application from the dock button, notice that the dock button will show an active indicator as the application is launched. This feature is enabled by default without requiring extensive codes writing.

The simplest integration scenario is where a window is mapped in 1:1 to a button. In this scenario, you have a button that represents the window through its WindowName. Both the WindowName property of the button and the window should be identical, which is shown in the following example.

XAML

UXDesktopDock includes a multitude of advanced features which allow you to launch applications from a local XAML page or an external XAP package, open windows through commands, host minimized windows, and more.

The following illustration shows the benefits of the relation between windows and buttons in the UXDesktopDock.

For more information about using UXDesktopDock in details, see Window and Dialog Boxes Overview. For more information about advanced windowing topics, see Advanced Window Features.

Definition

public class UXDesktopDock : UXDock, ITaskBar

Summary

The following table summarizes the members exposed in this class.

Public Constructors

UXDesktopDock Constructor()Initializes a new instance of the UXDock class.

Public Properties

AnimationProviderSpecifies the provider for windowing-related animation.
BackgroundEffectGets or sets the Effect to apply to the background element.
LoadingProgressAnimationSpecifies the animation style that indicates the application loading progress.
LoadingProgressTextSpecifies the text that represents the loading progress of an application.
MinimizeButtonGroupSpecifies the name of the button that will be used as the reference point to host minimized windows.
OwnerThe owner of the control.

Protected Properties

Fields

AnimationProviderPropertyIdentifies the AnimationProvider dependency property.
BackgroundEffectPropertyIdentifies the BackgroundEffect dependency property.
LoadingProgressAnimationPropertyIdentifies the LoadingAnimationType dependency property.
LoadingProgressTextPropertyIdentifies the LoadingProgressText dependency property.
MinimizeButtonGroupPropertyIdentifies the MinimizeButtonGroup dependency property.
OwnerPropertyIdentifies the Owner dependency property.

Public Methods

FindButton(object, SearchFlags)Returns a UXDesktopDockButton instance based on specified search flag that matches the attributes defined in the target object.
GetAnimation(string)Get animation from animation provider.
GetPositionOffset()Get position offset.
GetSizeBoundary()Get size boundary.
GetWindowStateData(string)Get window state data.
PerformWindowOperation(IWindow, string)Perform window operation.
PrepareWindowOperation(IWindow, string)Prepare window operation.

Protected Methods

GetContainerForItemOverride()Creates or identifies the element that is used to display the given item.
IsItemItsOwnContainerOverride(object)Determines if the specified item is (or is eligible to be) its own container.
OnItemsChanged(NotifyCollectionChangedEventArgs)Called when the value of the System.Windows.Controls.ItemsControl.Items property changes.
OnItemsSourceCollectionChanged(object, NotifyCollectionChangedEventArgs)Called when the value of the item source collection changes.
OnLayoutUpdated()Called when the control's layout is updated.
OnPanelAvailable()Overridden. Called when the UXStackPanel of the control becomes available.
OverrideNewTransformObject()Override new transform object.
PrepareContainerForItemOverride(DependencyObject, object)Prepares the specified element to display the specified item.

Public Constructors

public UXDesktopDock()

Initializes a new instance of the UXDock class.

Public Properties

public DockAnimationProvider AnimationProvider { get; set; }

Specifies the provider for windowing-related animation.

public Effect BackgroundEffect { get; set; }

Gets or sets the Effect to apply to the background element.

public LoadingAnimation LoadingProgressAnimation { get; set; }

Specifies the animation style that indicates the application loading progress.

public string LoadingProgressText { get; set; }

Specifies the text that represents the loading progress of an application.

public string MinimizeButtonGroup { get; set; }

Specifies the name of the button that will be used as the reference point to host minimized windows.

public ISItemsControl Owner { get; set; }

The owner of the control.

Protected Properties

protected ContainerItemType ContainerItemType { get; }

Overridden.

Fields

public static readonly DependencyProperty AnimationProviderProperty

Identifies the AnimationProvider dependency property.

public static readonly DependencyProperty BackgroundEffectProperty

Identifies the BackgroundEffect dependency property.

public static readonly DependencyProperty LoadingProgressAnimationProperty

Identifies the LoadingAnimationType dependency property.

public static readonly DependencyProperty LoadingProgressTextProperty

Identifies the LoadingProgressText dependency property.

public static readonly DependencyProperty MinimizeButtonGroupProperty

Identifies the MinimizeButtonGroup dependency property.

public static readonly DependencyProperty OwnerProperty

Identifies the Owner dependency property.

Public Methods

public UXDesktopDockButton FindButton(object targetContext, SearchFlags searchButtonFlags)

Returns a UXDesktopDockButton instance based on specified search flag that matches the attributes defined in the target object.

Parameters

targetContextThe target object which attributes are queried.
searchButtonFlagsThe flags that control what search attributes to be included.

 

public Storyboard GetAnimation(string animationName)

Get animation from animation provider.

Parameters

animationNameAnimation name.

Return Types

Animation

 

public Point GetPositionOffset()

Get position offset.

Return Types

Offset.

 

public Size GetSizeBoundary()

Get size boundary.

Return Types

Size boundary.

 

public WindowStateData GetWindowStateData(string targetState)

Get window state data.

Parameters

targetStateTarget state.

Return Types

Window state data.

 

public bool PerformWindowOperation(IWindow window, string operation)

Perform window operation.

Parameters

windowTarger window
operationOperation mode.

 

public bool PrepareWindowOperation(IWindow window, string operation)

Prepare window operation.

Parameters

windowTarget window.
operationOperation mode.

 

Protected Methods

protected DependencyObject GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Return Types

The element that is used to display the given item.

 

protected bool IsItemItsOwnContainerOverride(object item)

Determines if the specified item is (or is eligible to be) its own container.

Parameters

itemThe item to check.

Return Types

true if the item is (or is eligible to be) its own container; otherwise, false.

 

protected void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Called when the value of the System.Windows.Controls.ItemsControl.Items property changes.

Parameters

eNotifyCollectionChangedEventArgs that contains the event data

 

protected void OnItemsSourceCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Called when the value of the item source collection changes.

Parameters

sender 
e 

 

protected void OnLayoutUpdated()

Called when the control's layout is updated.

protected void OnPanelAvailable()

Overridden. Called when the UXStackPanel of the control becomes available.

protected UXDockButton OverrideNewTransformObject()

Override new transform object.

Return Types

Transform object.

 

protected void PrepareContainerForItemOverride(DependencyObject element, object item)

Prepares the specified element to display the specified item.

Parameters

elementThe container element used to display the specified item.
itemThe item to display.
  • No labels