Class ToolTipService
Implements service for all Tool Tips
Inheritance
Inherited Members
Namespace: EmptyKeys.UserInterface.Controls
Assembly: EmptyKeys.UserInterface.dll
Syntax
public sealed class ToolTipService
Fields
HorizontalOffsetProperty
The horizontal offset property
Declaration
public static readonly DependencyProperty HorizontalOffsetProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
InitialShowDelayProperty
The initial show delay property
Declaration
public static readonly DependencyProperty InitialShowDelayProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
PlacementProperty
The placement property
Declaration
public static readonly DependencyProperty PlacementProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
PlacementTargetProperty
The placement target property
Declaration
public static readonly DependencyProperty PlacementTargetProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
ShowDurationProperty
The show duration property
Declaration
public static readonly DependencyProperty ShowDurationProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
ToolTipProperty
The tool tip property
Declaration
public static readonly DependencyProperty ToolTipProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
VerticalOffsetProperty
The vertical offset property
Declaration
public static readonly DependencyProperty VerticalOffsetProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
Properties
Instance
Gets the instance.
Declaration
public static ToolTipService Instance { get; }
Property Value
Type | Description |
---|---|
ToolTipService | The instance. |
Methods
FindToolTipParent(UIElement)
Finds the tool tip parent.
Declaration
public UIElement FindToolTipParent(UIElement element)
Parameters
Type | Name | Description |
---|---|---|
UIElement | element | The element. |
Returns
Type | Description |
---|---|
UIElement |
GetHorizontalOffset(DependencyObject)
Gets the horizontal offset.
Declaration
public static float GetHorizontalOffset(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
Returns
Type | Description |
---|---|
System.Single |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
GetInitialShowDelay(DependencyObject)
Gets the initial show delay.
Declaration
public static int GetInitialShowDelay(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
Returns
Type | Description |
---|---|
System.Int32 |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
GetPlacement(DependencyObject)
Gets the placement.
Declaration
public static PlacementMode GetPlacement(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
Returns
Type | Description |
---|---|
PlacementMode |
GetPlacementTarget(DependencyObject)
Gets the placement target.
Declaration
public static UIElement GetPlacementTarget(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
Returns
Type | Description |
---|---|
UIElement |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
GetShowDuration(DependencyObject)
Gets the duration of the show.
Declaration
public static int GetShowDuration(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
Returns
Type | Description |
---|---|
System.Int32 |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
GetToolTip(DependencyObject)
Gets the tool tip.
Declaration
public static object GetToolTip(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
Returns
Type | Description |
---|---|
System.Object |
GetVerticalOffset(DependencyObject)
Gets the vertical offset.
Declaration
public static float GetVerticalOffset(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
Returns
Type | Description |
---|---|
System.Single |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
SetHorizontalOffset(DependencyObject, Single)
Sets the horizontal offset.
Declaration
public static void SetHorizontalOffset(DependencyObject obj, float value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
System.Single | value | The value. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
SetInitialShowDelay(DependencyObject, Int32)
Sets the initial show delay.
Declaration
public static void SetInitialShowDelay(DependencyObject obj, int value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
System.Int32 | value | The value. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
SetPlacement(DependencyObject, PlacementMode)
Sets the placement.
Declaration
public static void SetPlacement(DependencyObject obj, PlacementMode value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
PlacementMode | value | The value. |
SetPlacementTarget(DependencyObject, UIElement)
Sets the placement target.
Declaration
public static void SetPlacementTarget(DependencyObject obj, UIElement value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
UIElement | value | The value. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
SetShowDuration(DependencyObject, Int32)
Sets the duration of the show.
Declaration
public static void SetShowDuration(DependencyObject obj, int value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The obj. |
System.Int32 | value | The value. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
SetToolTip(DependencyObject, Object)
Sets the tool tip.
Declaration
public static void SetToolTip(DependencyObject obj, object value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
System.Object | value | The value. |
SetVerticalOffset(DependencyObject, Single)
Sets the vertical offset.
Declaration
public static void SetVerticalOffset(DependencyObject obj, float value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | The object. |
System.Single | value | The value. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | obj |
Update(Double)
Updates tool tip state and timers
Declaration
public void Update(double elapsedGameTime)
Parameters
Type | Name | Description |
---|---|---|
System.Double | elapsedGameTime | The elapsed game time. |