Skip to end of metadata
Go to start of metadata

Remarks

UXDock is inherited from ISItemsControl. For more information about selection control see ItemsControl Overview and Content Model Overview.

UXDock has certain layouting settings controlled by internal mechanism, so it is important to understand the layouting concept before trying to modify layouting aspects of UXDock.

Several properties that are locked are:

  • HorizontalAlignment
  • VerticalAlignment
  • Margin
  • Width / Height 

These properties are used in the internal mechanism to control the dock layouting,since the layoutingisquite complex we provide a simpler layoutingpropertycalled DockPosition and DockMargin.

The following is the structure illustration of UXDock.

Customizing UXDock Dimension

Depending on the DockPosition you can only control one of the dimension aspects at one time while MagnifiedSize propertycontrol the other dimension aspects.

For example:

  • If the DockPosition property is set to Bottom or Top the Width of UXDock is determined by the number of buttons, while the Height is determined by MagnifiedSize property.
  • If the DockPosition property is set to Left or Right the Height of UXDock is determined by the number of buttons, while the Width is determined by MagnifiedSize property.

Customizing Dock Position

UXDock positioning can be controlled using DockPosition property by default the DockPosition is set to Bottom. When you change this property the UXDock will transform all its elements such as reflection, tooltip position, stack button position etc accordingly.

XAML

Customizing Dock Margin

DockMargin provides space between UXDock and the container. In a sense it can also be uses to determine the reflection area.

AXML

Working with AudioSource Property

UXDock has the ability to play a short audio or voice clip when a button is clicked. To achieve this, you set the AudioSource property to a supported media type such as MP3 or WAV. Leave the property empty if you do not want to play an audio when the button is clicked.

XAML

This property is available UXDock level and UXDockButton level. Modifying the properties at UXDock level will apply to all buttons belong to UXDock.

On the other hand, modifying the value at UXDockButton level will only apply to that specified button.

Working with AutoHide Property

Auto hide feature allows UXDock to be hidden after a certain idle time.

To enable this feature, set the AutoHide property to True, and then configure the related properties if necessary. The following are settings related to auto hide feature:

  • AutoHideCollapsedHeight
    Indicates the height left after the auto hide is perform. This space is actually the space where you can mouse over to show the UXDock.
  • AutoHideInterval
    Indicates the length to wait before the auto hide mechanism is called.
  • AutoHideLatency
    Indicates the length of wait before the auto show mechanism is called.
  • AutoHideOpacity
    Indicates the opacity value when the UXDock is hidden.
XAML

Working with BackgroundMode Property and Background Template Property

UXDock has three of background mode you can choose from. The following are the list of background modes available in UXDock.

  • Simple
    Uses a simple border element named BackgroundElement. You can control the appearances from Background, BorderBrush, BorderThickness properties similar with any other Silverlight components, or you can just use the edit template and create a completely custom background inside the BackgroundElement.

    XAML

  • ComplexImages
    Uses three containers named BackgroundImageLeftElement, BackgroundImageRightElement and BackgroundImageCenterElement where you can specify the contents from BackgroundImageLeftBackgroundImageRight and BackgroundImageCenter properties.

    XAML

  • BackgroundTemplate
    Uses custom data templates.

    XAML

By default the background will adjust its width or height based when the zooming effect is applied. To turn off this feature, set the BackgroundBehavior property to Fix.

Working with ButtonMargin Property, ButtonSize Property, CustomZoomBoundary Property, MagnifiedSize Property, ZoomBoundaryMode Property and ZoomEffect Property

Zooming Effect of UXDock is determined by the following properties.

  • ButtonSize
    Determines the initial size of the button.
  • MagnifiedSize
    Determines the maximum size when the button is zoomed.
  • ButtonMargin
    Determines the space between buttons.
  • ZoomEffect
    Determines the number of buttons affected by the zoom area mechanism.

MagnifiedSize should never have lower value than ButtonSize.

XAML

There are also three types of ZoomBoundaryMode.

  • MinimumZoomScale
    The UXDock will start zooming when the cursor cross the minimum zoom scale boundary.
  • MaximumZoomScale
    The UXDock will start zooming when the cursor cross the maximum zoom scale boundary.
  • CustomZoomScale
    The UXDock will use the value in CustomZoomBoundary property as indicator when to start zooming.

Working with ButtonReflectionVisibility Property

By default, the button reflection is enabled. You can disable it through the ButtonReflectionVisibility property.

Note that disabling button reflection does not automatically collapse the reflection space. You need to modify the DockMargin if you want to reduce the space between the UXDock and its container.

XAML

This property is available UXDock level and UXDockButton level. Modifying the properties at UXDock level will apply to all buttons belong to UXDock.

On the other hand, modifying the value at UXDockButton level will only apply to that specified button.

Working with FlippingEffectEnabled Property

To enable flipping effect on your UXDockButton, set the FlippingEffectEnabled property at UXDock level or UXDockButton level. Note that assigning properties at UXDock level will apply to all buttons.

XAML

Working with GlowingEffectEnabled Property

To enable glowing effect on your UXDockButton, set the GlowingEffectEnabled property at UXDock level or UXDockButton level. Note that assigning properties at UXDock level will apply to all buttons.

XMAL

Working with IndicatorHeight Property, IndicatorOffset Property, IndicatorSource Property and IndicatorWidth Property

Each button also has an indicator element, which indicated the last selected button.

Important thing to be noted is that by default each button has an indicator that take place below the button. You need to make sure that there is enough space specified from DockMargin. Alternatively you can change the position of Indicator from IndicatorOffset property.

Follows are settings related to indicator appearances:

  • IndicatorSource
    You can use your own indicator image instead of the built in one by specifying this property.
  • IndicatorHeight and IndicatorWidth
    Specify the dimension of the indicator object.
  • IndicatorOffset
    Specify the offset position of the indicator object. By default its positioned at (0,32) which mean 32 pixel lower.
XAML

Properties related to indicator settings are available UXDock level and UXDockButton level. Modifying the properties at UXDock level will apply to all buttons belong to UXDock.

On the other hand, modifying the value at UXDockButton level will only apply to that specified button.

Working with JumpingEffectEnabled Property

To enable jumping effect on your UXDockButton, set the JumpingEffectEnabled property at UXDock level or UXDockButton level. Note that assigning properties at UXDock level will apply to all buttons.

XAML

Working with SpotlightEffectEnabled Property and SpotlightEffectInitialOpacity Property

To enable spotlight effect simply, set the SpotlightEffectEnabled property to True. You can also controls the initial opacity from SpotlightEffectInitialOpacity property.

XAML

Working with TooltipMode Property and TooltipPosition Property

The tooltip of a button will be shown when the button is focused. It will display the text specified in Text property of a button.

There are two modes how the tooltip can be displayed:

  • Auto
    The tooltip positioning will follow the current scale of the focused button.
  • Fix
    Tooltip positioning will follow the magnified size scale of the focused button. You can adjust the distance between the tooltip and button using TooltipPosition property.
XAML

Definition

public class UXDock : ISDragableItemsControl

Summary

The following table summarizes the members exposed in this class.

Public Constructors

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

Public Properties

ActiveButtonGets the current active stack button.
AudioSourceGets or sets the audio source to be played when a UXDockButton is clicked.
AutoHideGets or sets a value indicating whether auto hide feature is enabled.
AutoHideCollapsedHeightGets or sets the hoverable height to auto show the UXDock when its in hidden state.
AutoHideIntervalGets or sets the time-wait interval before auto hide is executed.
AutoHideLatencyGets or sets the latency before auto show should be executed.
AutoHideOpacityGets or sets the UXDock opacity when its in hidden state.
BackgroundBehaviorGets or sets the background behavior when UXDock is zoomed.
BackgroundHeightGets or sets the height of the background.
BackgroundImageCenterGets or sets the center background image when background mode is set to ComplexImage.
BackgroundImageLeftGets or sets the left background image when background mode is set to ComplexImage.
BackgroundImageRightGets or sets the right background image when background mode is set to ComplexImage.
BackgroundModeGets or sets the background mode which determine the appearance of UXDock's background.
BackgroundTemplateGets or sets the template of the background.
BackgroundWidthGets or sets the width of the background.
ButtonMarginGets or sets the space between buttons.
ButtonReflectionVisibilityGets or sets a value that determines whether button reflection is visible.
ButtonSizeGets or sets the button size.
CustomZoomBoundaryGets or sets the custom zoom boundary.
DockMarginGets or sets the margin of UXDock. Margin bottom will determine the space of reflection area.
DockPositionGets or sets the dock position of UXDock.
EnableStartupAnimationGets or sets a value that determines whether start up animation is enabled.
FlippingEffectEnabledGets or sets a value that determines whether flipping effect is enabled.
FlippingEffectModeGets or sets a value that determines the orientation of the flipping animation.
FlippingEffectSpeedRatioGets or sets the flipping animation speed ratio.
GlowingEffectColorGets or sets the glowing effect's color.
GlowingEffectEnabledGets or sets a value that determines whether glowing effect is enabled.
GlowingEffectRadiusGets or sets the glowing effect radius.
GlowingEffectSpeedRatioGets or sets the glowing animation speed ratio.
HorizontalAlignmentInternal.
HorizontalContentAlignmentNot applicable.
ImageLoaderTextVisibilityGets or sets a value that determines whether image loader progress text is visible.
IndicatorEnabledGets or sets a value that determine whether button indicator is enabled.
IndicatorHeightGets or sets the height of the indicator.
IndicatorOffsetGets or sets the offset position of the indicator.
IndicatorSourceGets or sets the image source for the indicator object.
IndicatorWidthGets or sets the width of the indicator.
IsExpanded 
IsHiddenGets a value that indicates whether the UXDock is hidden.
IsSeparatorMemberPathGets or sets the is separator member path.
IsZoomedGets a value that indicates that the UXDock is zoomed.
IsZoomingGets a value that indicates that the UXDock is zooming (performing start up animation).
ItemsSourceGets or sets a collection used as the databinding source.
JumpingEffectDirectionGets or sets a value that determines the jumping direction.
JumpingEffectEnabledGets or sets a value that determines whether jumpping effect is enabled.
JumpingEffectHeightGets or sets the height of jumping animation.
JumpingEffectModeGets or sets a value that determines the jumping effects.
JumpingEffectRepeatBehaviorGets or sets the repeating behavior of the jumping animation.
JumpingEffectSpeedRatioGets or sets the jumping animation speed ratio.
MagnifiedSizeGets or sets the magnified size of the bottom. Must be larger than ButtonSize.
MarginInternal.
MinimumButtonSizeGets or sets the minimum button size. When this value is specfied (> -1), the auto adjust mechanism will be applied.
PaddingNot applicable.
PanelGets the panel reference that used in UXDock.
RootElementGets the root element.
SpotlightEffectEnabledGets or sets a value that determines whether spotlight effect is enabled.
SpotlightEffectInitialOpacityGets or sets the spotlight effect initial opacity.
StartUpAnimationBottomGets or sets the start up animation when DockMode is set to bottom.
StartUpAnimationLeftGets or sets the start up animation when DockMode is set to left.
StartUpAnimationRightGets or sets the start up animation when DockMode is set to right.
StartUpAnimationTopGets or sets the start up animation when DockMode is set to top.
TooltipModeGets or sets a value indicating the behavior of the tooltip. Fix mode means that the tooltip will stay at the same position. Auto mode means that the tooltip will follow the button scale position.
TooltipPositionGets or sets the tooltip position.
UseImageLoaderGets or sets a value that determines whether the image loader at UXDockButton and UXDockButton is used to download the image.
VerticalAlignmentInternal.
VerticalContentAlignmentNot applicable.
ZoomBoundaryModeGets or sets the zoom boundary mode.
ZoomEffectGets or sets the zoom effect of UXDock.

Protected Properties

ContainerItemsGets the container items
ContainerItemTypeGets the container item type.
ProductProduct Info.

Fields

AudioSourcePropertyIdentifies the AudioSource dependency property.
AutoHideCollapsedHeightPropertyIdentifies the AutoHideCollapsedHeight dependency property.
AutoHideIntervalPropertyIdentifies the AutoHideInterval dependency property.
AutoHideLatencyPropertyIdentifies the AutoHideLatency dependency property.
AutoHideOpacityPropertyIdentifies the AutoHideOpacity dependency property.
AutoHidePropertyIdentifies the AutoHide dependency property.
BackgroundBehaviorPropertyIdentifies the BackgroundBehavior dependency property.
BackgroundHeightPropertyIdentifies the BackgroundHeight dependency property.
BackgroundImageCenterPropertyIdentifies the BackgroundImageCenter dependency property.
BackgroundImageLeftPropertyIdentifies the BackgroundImageLeft dependency property.
BackgroundImageRightPropertyIdentifies the BackgroundImageRight dependency property.
BackgroundModePropertyIdentifies the BackgroundMode dependency property.
BackgroundTemplatePropertyIdentifies the BackgroundTemplate dependency property.
BackgroundWidthPropertyIdentifies the BackgroundWidth dependency property.
ButtonMarginPropertyIdentifies the ButtonMargin dependency property.
ButtonReflectionVisibilityPropertyIdentifies the ButtonReflectionVisibility dependency property.
ButtonSizePropertyIdentifies the ButtonSize dependency property.
CustomZoomBoundaryPropertyIdentifies the CustomZoomBoundary dependency property.
DockMarginPropertyIdentifies the DockMargin dependency property.
DockPositionPropertyIdentifies the DockPosition dependency property.
EnableStartupAnimationPropertyIdentifies the EnableStartupAnimation dependency property.
FlippingEffectEnabledPropertyIdentifies the FlippingEffectEnabled dependency property.
FlippingEffectModePropertyIdentifies the FlippingEffectMode dependency property.
FlippingEffectSpeedRatioPropertyIdentifies the FlippingEffectSpeedRatio dependency property.
GlowingEffectColorPropertyIdentifies the GlowingEffectInnerColor dependency property.
GlowingEffectEnabledPropertyIdentifies the GlowingEffectEnabled dependency property.
GlowingEffectRadiusPropertyIdentifies the GlowingEffectRadius dependency property.
GlowingEffectSpeedRatioPropertyIdentifies the GlowingEffectSpeedRatio dependency property.
ImageLoaderTextVisibilityPropertyIdentifies the ImageLoaderTextVisibility dependency property.
IndicatorEnabledPropertyIdentifies the IndicatorEnabled dependency property.
IndicatorHeightPropertyIdentifies the IndicatorHeight dependency property.
IndicatorOffsetPropertyIdentifies the IndicatorOffset dependency property.
IndicatorSourcePropertyIdentifies the IndicatorSource dependency property.
IndicatorWidthPropertyIdentifies the IndicatorWidth dependency property.
IsExpandedProperty 
IsSeparatorMemberPathPropertyIdentifies the IsSeparatorMember dependency property.
JumpingEffectDirectionPropertyIdentifies the JumpingEffectDirection dependency property.
JumpingEffectEnabledPropertyIdentifies the JumpingEffectEnabled dependency property.
JumpingEffectHeightPropertyIdentifies the JumpingEffectHeight dependency property.
JumpingEffectModePropertyIdentifies the JumpingEffectMode dependency property.
JumpingEffectRepeatBehaviorPropertyIdentifies the JumpingEffectRepeatBehavior dependency property.
JumpingEffectSpeedRatioPropertyIdentifies the JumpingEffectSpeedRatio dependency property.
MagnifiedSizePropertyIdentifies the MagnifiedSize dependency property.
MinimumButtonSizePropertyIdentifies the MinimumButtonSize dependency property.
SpotlightEffectEnabledPropertyIdentifies the SpotlightEffectEnabled dependency property.
SpotlightEffectInitialOpacityPropertyIdentifies the SpotlightEffectInitialOpacity dependency property.
StartUpAnimationBottomPropertyIdentifies the StartUpAnimationBottom dependency property.
StartUpAnimationLeftPropertyIdentifies the StartUpAnimationLeft dependency property.
StartUpAnimationRightPropertyIdentifies the StartUpAnimationRight dependency property.
StartUpAnimationTopPropertyIdentifies the StartUpAnimationTop dependency property.
TooltipModePropertyIdentifies the TooltipMode dependency property.
TooltipPositionPropertyIdentifies the TooltipPosition dependency property.
UseImageLoaderPropertyIdentifies the UseImageLoader dependency property.
ZoomBoundaryModePropertyIdentifies the ZoomBoundaryMode dependency property.
ZoomEffectPropertyIdentifies the ZoomEffect dependency property.

Public Methods

AddChild(int, UXDockButton)Add new element into specified index.
AttachEventHandlers()Attach built-in event handlers to control templates. Call this method if necessary.
DetachedEventHandlers()Detach built-in event handlers from control templates. Call this method if necessary.
Dispose() 
InitializeTemplates()Initializes control templates.
MoveChild(int, int)Move the element from current index to target index.
OnApplyTemplate()Builds the visual tree for the UXDock when a new template is applied.
PerformAutoHide(bool)Perform auto hide.
PerformAutoShow(bool)Perform auto show.
RemoveChild(UXDockButton)Removed the specified button.
RemoveChild(int)Removed the button at specified index.
ShowStartupAnimation()Show start up animation.
TransformObject(FrameworkElement)Transforms the dragged object into the instance that matches the item type of the UXDock control.

Protected Methods

ApplyBinding(DependencyObject, object)Applies item binding for each generated element.
ClearContainerForItemOverride(DependencyObject, object)Undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.
GetContainerForItemOverride()Creates or identifies the element that is used to display the given item.
GetContainerFromIndex(int)Gets container from index.
IsItemItsOwnContainerOverride(object)Determines if the specified item is (or is eligible to be) its own container.
MeasureOverride(Size)Provides the behavior for the Measure pass of Silverlight layout.
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()On layout updated.
OnMouseEnter(MouseEventArgs)Called before MouseEnter event occurs.
OnMouseLeave(MouseEventArgs)Called before the MouseLeave event occurs.
OnMouseLeftButtonDown(MouseButtonEventArgs)Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.
OnMouseMove(MouseEventArgs)Called before the MouseMove event occurs.
OnPanelAvailable()Called when the UXStackPanel of the control becomes available.
OverrideNewTransformObject()Override new transform object.
Panel_DragEnd(object, DragEventArgs)Occurs at origin panel, when drag is end.
Panel_DragEnded(object, DragEventArgs)Occurs when an item is entering this panel.
Panel_DragInit(object, DragEventArgs)Occurs at origin panel, when drag is initializing.
Panel_DragLeave(object, DragEventArgs)Occurs when an item is leaving this panel.
Panel_DragOver(object, DragEventArgs)Occurs when an item is hovering this panel (after drag enter).
Panel_DragReturn(object, DragEventArgs)Occurs at origin panel, when drag object is returning.
Panel_DragReturned(object, DragEventArgs)Occurs at origin panel and target panel, when drag object is returned.
Panel_DragStart(object, DragEventArgs)Occurs when an item is about to be dragged.
Panel_Drop(object, DragEventArgs)Occurs when an item is dropped into this panel.
Panel_Inserted(object, UXPanelActionEventArgs)Occurs when an item is inserted to the panel.
Panel_Moved(object, UXPanelActionEventArgs)Occurs when an item is moved inside panel.
Panel_PrepareDrop(object, DragEventArgs)Occurs when an item is about to be dropped in to the panel (preview).
Panel_Removed(object, UXPanelActionEventArgs)Occurs when an item is removed from panel.
PrepareContainerForItemOverride(DependencyObject, object)Prepares the specified element to display the specified item.
RefreshImageBinding()Refresh image member path binding.
Stack_Closed(object, ISRoutedEventArgs)On stack menu closed.
Stack_Opened(object, ISRoutedEventArgs)On stack menu opened.

Public Constructors

public UXDock()

Initializes a new instance of the UXDock class.

Public Properties

public UXDockButton ActiveButton { get; }

Gets the current active stack button.

public string AudioSource { get; set; }

Gets or sets the audio source to be played when a UXDockButton is clicked.

public bool AutoHide { get; set; }

Gets or sets a value indicating whether auto hide feature is enabled.

public double AutoHideCollapsedHeight { get; set; }

Gets or sets the hoverable height to auto show the UXDock when its in hidden state.

public double AutoHideInterval { get; set; }

Gets or sets the time-wait interval before auto hide is executed.

public double AutoHideLatency { get; set; }

Gets or sets the latency before auto show should be executed.

public double AutoHideOpacity { get; set; }

Gets or sets the UXDock opacity when its in hidden state.

public BackgroundBehavior BackgroundBehavior { get; set; }

Gets or sets the background behavior when UXDock is zoomed.

public double BackgroundHeight { get; set; }

Gets or sets the height of the background.

public ImageSource BackgroundImageCenter { get; set; }

Gets or sets the center background image when background mode is set to ComplexImage.

public ImageSource BackgroundImageLeft { get; set; }

Gets or sets the left background image when background mode is set to ComplexImage.

public ImageSource BackgroundImageRight { get; set; }

Gets or sets the right background image when background mode is set to ComplexImage.

public BackgroundMode BackgroundMode { get; set; }

Gets or sets the background mode which determine the appearance of UXDock's background.

public DataTemplate BackgroundTemplate { get; set; }

Gets or sets the template of the background.

public double BackgroundWidth { get; set; }

Gets or sets the width of the background.

public double ButtonMargin { get; set; }

Gets or sets the space between buttons.

public Visibility ButtonReflectionVisibility { get; set; }

Gets or sets a value that determines whether button reflection is visible.

public double ButtonSize { get; set; }

Gets or sets the button size.

public double CustomZoomBoundary { get; set; }

Gets or sets the custom zoom boundary.

public Thickness DockMargin { get; set; }

Gets or sets the margin of UXDock. Margin bottom will determine the space of reflection area.

public Dock DockPosition { get; set; }

Gets or sets the dock position of UXDock.

public bool EnableStartupAnimation { get; set; }

Gets or sets a value that determines whether start up animation is enabled.

public bool FlippingEffectEnabled { get; set; }

Gets or sets a value that determines whether flipping effect is enabled.

public FlipMode FlippingEffectMode { get; set; }

Gets or sets a value that determines the orientation of the flipping animation.

public double FlippingEffectSpeedRatio { get; set; }

Gets or sets the flipping animation speed ratio.

public Brush GlowingEffectColor { get; set; }

Gets or sets the glowing effect's color.

public bool GlowingEffectEnabled { get; set; }

Gets or sets a value that determines whether glowing effect is enabled.

public double GlowingEffectRadius { get; set; }

Gets or sets the glowing effect radius.

public double GlowingEffectSpeedRatio { get; set; }

Gets or sets the glowing animation speed ratio.

public HorizontalAlignment HorizontalAlignment { get; set; }

Internal.

public HorizontalAlignment HorizontalContentAlignment { get; set; }

Not applicable.

public Visibility ImageLoaderTextVisibility { get; set; }

Gets or sets a value that determines whether image loader progress text is visible.

public bool IndicatorEnabled { get; set; }

Gets or sets a value that determine whether button indicator is enabled.

public double IndicatorHeight { get; set; }

Gets or sets the height of the indicator.

public Thickness IndicatorOffset { get; set; }

Gets or sets the offset position of the indicator.

public ImageSource IndicatorSource { get; set; }

Gets or sets the image source for the indicator object.

public double IndicatorWidth { get; set; }

Gets or sets the width of the indicator.

public bool IsExpanded { get; set; }

 

public bool IsHidden { get; }

Gets a value that indicates whether the UXDock is hidden.

public string IsSeparatorMemberPath { get; set; }

Gets or sets the is separator member path.

public bool IsZoomed { get; }

Gets a value that indicates that the UXDock is zoomed.

public bool IsZooming { get; }

Gets a value that indicates that the UXDock is zooming (performing start up animation).

public IEnumerable ItemsSource { get; set; }

Gets or sets a collection used as the databinding source.

public JumpingDirection JumpingEffectDirection { get; set; }

Gets or sets a value that determines the jumping direction.

public bool JumpingEffectEnabled { get; set; }

Gets or sets a value that determines whether jumpping effect is enabled.

public double JumpingEffectHeight { get; set; }

Gets or sets the height of jumping animation.

public JumpingMode JumpingEffectMode { get; set; }

Gets or sets a value that determines the jumping effects.

public int JumpingEffectRepeatBehavior { get; set; }

Gets or sets the repeating behavior of the jumping animation.

public double JumpingEffectSpeedRatio { get; set; }

Gets or sets the jumping animation speed ratio.

public double MagnifiedSize { get; set; }

Gets or sets the magnified size of the bottom. Must be larger than ButtonSize.

public Thickness Margin { get; set; }

Internal.

public double MinimumButtonSize { get; set; }

Gets or sets the minimum button size. When this value is specfied (> -1), the auto adjust mechanism will be applied.

public Thickness Padding { get; set; }

Not applicable.

public UXStackPanel Panel { get; }

Gets the panel reference that used in UXDock.

public Grid RootElement { get; }

Gets the root element.

public bool SpotlightEffectEnabled { get; set; }

Gets or sets a value that determines whether spotlight effect is enabled.

public double SpotlightEffectInitialOpacity { get; set; }

Gets or sets the spotlight effect initial opacity.

public Storyboard StartUpAnimationBottom { get; set; }

Gets or sets the start up animation when DockMode is set to bottom.

public Storyboard StartUpAnimationLeft { get; set; }

Gets or sets the start up animation when DockMode is set to left.

public Storyboard StartUpAnimationRight { get; set; }

Gets or sets the start up animation when DockMode is set to right.

public Storyboard StartUpAnimationTop { get; set; }

Gets or sets the start up animation when DockMode is set to top.

public TooltipMode TooltipMode { get; set; }

Gets or sets a value indicating the behavior of the tooltip. Fix mode means that the tooltip will stay at the same position. Auto mode means that the tooltip will follow the button scale position.

public double TooltipPosition { get; set; }

Gets or sets the tooltip position.

public bool UseImageLoader { get; set; }

Gets or sets a value that determines whether the image loader at UXDockButton and UXDockButton is used to download the image.

public VerticalAlignment VerticalAlignment { get; set; }

Internal.

public VerticalAlignment VerticalContentAlignment { get; set; }

Not applicable.

public ZoomBoundaryMode ZoomBoundaryMode { get; set; }

Gets or sets the zoom boundary mode.

public int ZoomEffect { get; set; }

Gets or sets the zoom effect of UXDock.

Protected Properties

protected IList ContainerItems { get; }

Gets the container items

protected ContainerItemType ContainerItemType { get; }

Gets the container item type.

protected ProductInfo Product { get; }

Product Info.

Fields

public static readonly DependencyProperty AudioSourceProperty

Identifies the AudioSource dependency property.

public static readonly DependencyProperty AutoHideCollapsedHeightProperty

Identifies the AutoHideCollapsedHeight dependency property.

public static readonly DependencyProperty AutoHideIntervalProperty

Identifies the AutoHideInterval dependency property.

public static readonly DependencyProperty AutoHideLatencyProperty

Identifies the AutoHideLatency dependency property.

public static readonly DependencyProperty AutoHideOpacityProperty

Identifies the AutoHideOpacity dependency property.

public static readonly DependencyProperty AutoHideProperty

Identifies the AutoHide dependency property.

public static readonly DependencyProperty BackgroundBehaviorProperty

Identifies the BackgroundBehavior dependency property.

public static readonly DependencyProperty BackgroundHeightProperty

Identifies the BackgroundHeight dependency property.

public static readonly DependencyProperty BackgroundImageCenterProperty

Identifies the BackgroundImageCenter dependency property.

public static readonly DependencyProperty BackgroundImageLeftProperty

Identifies the BackgroundImageLeft dependency property.

public static readonly DependencyProperty BackgroundImageRightProperty

Identifies the BackgroundImageRight dependency property.

public static readonly DependencyProperty BackgroundModeProperty

Identifies the BackgroundMode dependency property.

public static readonly DependencyProperty BackgroundTemplateProperty

Identifies the BackgroundTemplate dependency property.

public static readonly DependencyProperty BackgroundWidthProperty

Identifies the BackgroundWidth dependency property.

public static readonly DependencyProperty ButtonMarginProperty

Identifies the ButtonMargin dependency property.

public static readonly DependencyProperty ButtonReflectionVisibilityProperty

Identifies the ButtonReflectionVisibility dependency property.

public static readonly DependencyProperty ButtonSizeProperty

Identifies the ButtonSize dependency property.

public static readonly DependencyProperty CustomZoomBoundaryProperty

Identifies the CustomZoomBoundary dependency property.

public static readonly DependencyProperty DockMarginProperty

Identifies the DockMargin dependency property.

public static readonly DependencyProperty DockPositionProperty

Identifies the DockPosition dependency property.

public static readonly DependencyProperty EnableStartupAnimationProperty

Identifies the EnableStartupAnimation dependency property.

public static readonly DependencyProperty FlippingEffectEnabledProperty

Identifies the FlippingEffectEnabled dependency property.

public static readonly DependencyProperty FlippingEffectModeProperty

Identifies the FlippingEffectMode dependency property.

public static readonly DependencyProperty FlippingEffectSpeedRatioProperty

Identifies the FlippingEffectSpeedRatio dependency property.

public static readonly DependencyProperty GlowingEffectColorProperty

Identifies the GlowingEffectInnerColor dependency property.

public static readonly DependencyProperty GlowingEffectEnabledProperty

Identifies the GlowingEffectEnabled dependency property.

public static readonly DependencyProperty GlowingEffectRadiusProperty

Identifies the GlowingEffectRadius dependency property.

public static readonly DependencyProperty GlowingEffectSpeedRatioProperty

Identifies the GlowingEffectSpeedRatio dependency property.

public static readonly DependencyProperty ImageLoaderTextVisibilityProperty

Identifies the ImageLoaderTextVisibility dependency property.

public static readonly DependencyProperty IndicatorEnabledProperty

Identifies the IndicatorEnabled dependency property.

public static readonly DependencyProperty IndicatorHeightProperty

Identifies the IndicatorHeight dependency property.

public static readonly DependencyProperty IndicatorOffsetProperty

Identifies the IndicatorOffset dependency property.

public static readonly DependencyProperty IndicatorSourceProperty

Identifies the IndicatorSource dependency property.

public static readonly DependencyProperty IndicatorWidthProperty

Identifies the IndicatorWidth dependency property.

public static readonly DependencyProperty IsExpandedProperty

 

public static readonly DependencyProperty IsSeparatorMemberPathProperty

Identifies the IsSeparatorMember dependency property.

public static readonly DependencyProperty JumpingEffectDirectionProperty

Identifies the JumpingEffectDirection dependency property.

public static readonly DependencyProperty JumpingEffectEnabledProperty

Identifies the JumpingEffectEnabled dependency property.

public static readonly DependencyProperty JumpingEffectHeightProperty

Identifies the JumpingEffectHeight dependency property.

public static readonly DependencyProperty JumpingEffectModeProperty

Identifies the JumpingEffectMode dependency property.

public static readonly DependencyProperty JumpingEffectRepeatBehaviorProperty

Identifies the JumpingEffectRepeatBehavior dependency property.

public static readonly DependencyProperty JumpingEffectSpeedRatioProperty

Identifies the JumpingEffectSpeedRatio dependency property.

public static readonly DependencyProperty MagnifiedSizeProperty

Identifies the MagnifiedSize dependency property.

public static readonly DependencyProperty MinimumButtonSizeProperty

Identifies the MinimumButtonSize dependency property.

public static readonly DependencyProperty SpotlightEffectEnabledProperty

Identifies the SpotlightEffectEnabled dependency property.

public static readonly DependencyProperty SpotlightEffectInitialOpacityProperty

Identifies the SpotlightEffectInitialOpacity dependency property.

public static readonly DependencyProperty StartUpAnimationBottomProperty

Identifies the StartUpAnimationBottom dependency property.

public static readonly DependencyProperty StartUpAnimationLeftProperty

Identifies the StartUpAnimationLeft dependency property.

public static readonly DependencyProperty StartUpAnimationRightProperty

Identifies the StartUpAnimationRight dependency property.

public static readonly DependencyProperty StartUpAnimationTopProperty

Identifies the StartUpAnimationTop dependency property.

public static readonly DependencyProperty TooltipModeProperty

Identifies the TooltipMode dependency property.

public static readonly DependencyProperty TooltipPositionProperty

Identifies the TooltipPosition dependency property.

public static readonly DependencyProperty UseImageLoaderProperty

Identifies the UseImageLoader dependency property.

public static readonly DependencyProperty ZoomBoundaryModeProperty

Identifies the ZoomBoundaryMode dependency property.

public static readonly DependencyProperty ZoomEffectProperty

Identifies the ZoomEffect dependency property.

Public Methods

public void AddChild(int index, UXDockButton button)

Add new element into specified index.

Parameters

indexIndex.
buttonButton.

 

public void AttachEventHandlers()

Attach built-in event handlers to control templates. Call this method if necessary.

public void DetachedEventHandlers()

Detach built-in event handlers from control templates. Call this method if necessary.

public void Dispose()

 

public void InitializeTemplates()

Initializes control templates.

public void MoveChild(int currentIndex, int targetIndex)

Move the element from current index to target index.

Parameters

currentIndexCurrent index.
targetIndexTarget index.

 

public void OnApplyTemplate()

Builds the visual tree for the UXDock when a new template is applied.

public void PerformAutoHide(bool force)

Perform auto hide.

Parameters

force 

 

public void PerformAutoShow(bool force)

Perform auto show.

Parameters

force 

 

public void RemoveChild(UXDockButton button)

Removed the specified button.

Parameters

buttonButton that going to be removed.

 

public void RemoveChild(int index)

Removed the button at specified index.

Parameters

indexIndex.

 

public void ShowStartupAnimation()

Show start up animation.

public FrameworkElement TransformObject(FrameworkElement element)

Transforms the dragged object into the instance that matches the item type of the UXDock control.

Parameters

elementDrag drop element.

Return Types

Transformed element.

 

Protected Methods

protected void ApplyBinding(DependencyObject element, object item)

Applies item binding for each generated element.

Parameters

elementContainer element.
itemItem.

 

protected void ClearContainerForItemOverride(DependencyObject element, object item)

Undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.

Parameters

elementThe container element.
itemThe item.

 

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 DependencyObject GetContainerFromIndex(int index)

Gets container from index.

Parameters

indexIndex

Return Types

Container

 

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 Size MeasureOverride(Size availableSize)

Provides the behavior for the Measure pass of Silverlight layout.

Parameters

availableSizeThe available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available.

Return Types

The size that this object determines it needs during layout, based on its calculations of child object allotted sizes.

 

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()

On layout updated.

protected void OnMouseEnter(MouseEventArgs e)

Called before MouseEnter event occurs.

Parameters

eThe data for the event.

 

protected void OnMouseLeave(MouseEventArgs e)

Called before the MouseLeave event occurs.

Parameters

eThe data for the event.

 

protected void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.

Parameters

eThe data for the event.

 

protected void OnMouseMove(MouseEventArgs e)

Called before the MouseMove event occurs.

Parameters

eThe data for the event.

 

protected void OnPanelAvailable()

Called when the UXStackPanel of the control becomes available.

protected UXDockButton OverrideNewTransformObject()

Override new transform object.

Return Types

Transform object.

 

protected void Panel_DragEnd(object sender, DragEventArgs e)

Occurs at origin panel, when drag is end.

Parameters

sender 
e 

 

protected void Panel_DragEnded(object sender, DragEventArgs e)

Occurs when an item is entering this panel.

Parameters

sender 
e 

 

protected void Panel_DragInit(object sender, DragEventArgs e)

Occurs at origin panel, when drag is initializing.

Parameters

sender 
e 

 

protected void Panel_DragLeave(object sender, DragEventArgs e)

Occurs when an item is leaving this panel.

Parameters

sender 
e 

 

protected void Panel_DragOver(object sender, DragEventArgs e)

Occurs when an item is hovering this panel (after drag enter).

Parameters

sender 
e 

 

protected void Panel_DragReturn(object sender, DragEventArgs e)

Occurs at origin panel, when drag object is returning.

Parameters

sender 
e 

 

protected void Panel_DragReturned(object sender, DragEventArgs e)

Occurs at origin panel and target panel, when drag object is returned.

Parameters

sender 
e 

 

protected void Panel_DragStart(object sender, DragEventArgs e)

Occurs when an item is about to be dragged.

Parameters

sender 
e 

 

protected void Panel_Drop(object sender, DragEventArgs e)

Occurs when an item is dropped into this panel.

Parameters

sender 
e 

 

protected void Panel_Inserted(object sender, UXPanelActionEventArgs e)

Occurs when an item is inserted to the panel.

Parameters

sender 
e 

 

protected void Panel_Moved(object sender, UXPanelActionEventArgs e)

Occurs when an item is moved inside panel.

Parameters

sender 
e 

 

protected void Panel_PrepareDrop(object sender, DragEventArgs e)

Occurs when an item is about to be dropped in to the panel (preview).

Parameters

sender 
e 

 

protected void Panel_Removed(object sender, UXPanelActionEventArgs e)

Occurs when an item is removed from panel.

Parameters

sender 
e 

 

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.

 

protected void RefreshImageBinding()

Refresh image member path binding.

protected void Stack_Closed(object sender, ISRoutedEventArgs e)

On stack menu closed.

Parameters

sender 
e 

 

protected void Stack_Opened(object sender, ISRoutedEventArgs e)

On stack menu opened.

Parameters

sender 
e 

DockMargin

  • No labels