ScreenTipService Class

Namespace:: ActiproSoftware.Windows.Controls.Ribbon.UI

Assembly:: ActiproSoftware.Ribbon.Wpf.dll

Represents a service that provides properties and events to control the display and behavior of screen tips.

public class ScreenTipService

Inheritance:: object object

Constructors

ScreenTipService()

Initializes an instance of the class.

public ScreenTipService()

Properties

AllowScreenTipsOnContextMenus

Gets or sets whether screen tips are allowed to display on context menus.

public static bool AllowScreenTipsOnContextMenus { get; set; }

Property Value

bool:: true if screen tips are allowed to display on context menus; otherwise, false. The default value is false.

Remarks

If this property is set to false, no screen tips will appear on context menu items.

AllowScreenTipsOnInactiveWindows

Gets or sets whether screen tips are allowed to display on inactive windows.

public static bool AllowScreenTipsOnInactiveWindows { get; set; }

Property Value

bool:: true if screen tips are allowed to display on inactive windows; otherwise, false. The default value is false.

Remarks

If this property is set to false, no screen tips will appear when the containing window is inactive.

CurrentScreenTip

Gets the ScreenTip that is currently visible, if any.

public static ScreenTip CurrentScreenTip { get; }

Property Value

ScreenTip:: The ScreenTip that is currently visible, if any.

IsEnabled

Gets or sets whether global mouse tracking is enabled for determining when screen tips should display.

public static bool IsEnabled { get; set; }

Property Value

bool:: true if global mouse tracking is enabled; otherwise, false. The default value is true.

Remarks

If this property is set to false, no screen tips in the application will display.

Methods

AddScreenTipClosingHandler(DependencyObject, RoutedEventHandler)

Adds an event handler for the attached ScreenTipClosingEvent event.

public static void AddScreenTipClosingHandler(DependencyObject obj, RoutedEventHandler handler)

Parameter	Type	Description
obj	DependencyObject	The object from which the attached event is read.
handler	RoutedEventHandler	The event handler.

AddScreenTipOpeningHandler(DependencyObject, RoutedEventHandler)

Adds an event handler for the attached ScreenTipOpeningEvent event.

public static void AddScreenTipOpeningHandler(DependencyObject obj, RoutedEventHandler handler)

Parameter	Type	Description
obj	DependencyObject	The object from which the attached event is read.
handler	RoutedEventHandler	The event handler.

GetCanDeriveKeyboardShortcutFromCommand(DependencyObject)

Gets the value of the CanDeriveKeyboardShortcutFromCommand attached property for the specified object.

public static bool GetCanDeriveKeyboardShortcutFromCommand(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

bool:: The object's value.

GetScreenTipDescription(DependencyObject)

Gets the value of the ScreenTipDescription attached property for the specified object.

public static object GetScreenTipDescription(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

object:: The object's value.

GetScreenTipFooter(DependencyObject)

Gets the value of the ScreenTipFooter attached property for the specified object.

public static object GetScreenTipFooter(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

object:: The object's value.

GetScreenTipHeader(DependencyObject)

Gets the value of the ScreenTipHeader attached property for the specified object.

public static object GetScreenTipHeader(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

object:: The object's value.

GetScreenTipHelpUri(DependencyObject)

Gets the value of the ScreenTipHelpUri attached property for the specified object.

public static Uri GetScreenTipHelpUri(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

Uri:: The object's value.

GetScreenTipImageSource(DependencyObject)

Gets the value of the ScreenTipImageSource attached property for the specified object.

public static ImageSource GetScreenTipImageSource(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

ImageSource:: The object's value.

GetScreenTipIsEnabled(DependencyObject)

Gets the value of the ScreenTipIsEnabled attached property for the specified object.

public static bool GetScreenTipIsEnabled(DependencyObject obj)

Parameter	Type	Description
obj	DependencyObject	The object from which the property value is read.

Returns

bool:: The object's value.

RemoveScreenTipClosingHandler(DependencyObject, RoutedEventHandler)

Removes an event handler for the attached ScreenTipClosingEvent event.

public static void RemoveScreenTipClosingHandler(DependencyObject obj, RoutedEventHandler handler)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached event is written.
handler	RoutedEventHandler	The event handler.

RemoveScreenTipOpeningHandler(DependencyObject, RoutedEventHandler)

Removes an event handler for the attached ScreenTipOpeningEvent event.

public static void RemoveScreenTipOpeningHandler(DependencyObject obj, RoutedEventHandler handler)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached event is written.
handler	RoutedEventHandler	The event handler.

SetCanDeriveKeyboardShortcutFromCommand(DependencyObject, bool)

Sets the value of the CanDeriveKeyboardShortcutFromCommand attached property to the specified object.

public static void SetCanDeriveKeyboardShortcutFromCommand(DependencyObject obj, bool value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	bool	The value to set.

SetScreenTipDescription(DependencyObject, object)

Sets the value of the ScreenTipDescription attached property to the specified object.

public static void SetScreenTipDescription(DependencyObject obj, object value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	object	The value to set.

SetScreenTipFooter(DependencyObject, object)

Sets the value of the ScreenTipFooter attached property to the specified object.

public static void SetScreenTipFooter(DependencyObject obj, object value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	object	The value to set.

SetScreenTipHeader(DependencyObject, object)

Sets the value of the ScreenTipHeader attached property to the specified object.

public static void SetScreenTipHeader(DependencyObject obj, object value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	object	The value to set.

SetScreenTipHelpUri(DependencyObject, Uri)

Sets the value of the ScreenTipHelpUri attached property to the specified object.

public static void SetScreenTipHelpUri(DependencyObject obj, Uri value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	Uri	The value to set.

SetScreenTipImageSource(DependencyObject, ImageSource)

Sets the value of the ScreenTipImageSource attached property to the specified object.

public static void SetScreenTipImageSource(DependencyObject obj, ImageSource value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	ImageSource	The value to set.

SetScreenTipIsEnabled(DependencyObject, bool)

Sets the value of the ScreenTipIsEnabled attached property to the specified object.

public static void SetScreenTipIsEnabled(DependencyObject obj, bool value)

Parameter	Type	Description
obj	DependencyObject	The object to which the attached property is written.
value	bool	The value to set.

Fields

CanDeriveKeyboardShortcutFromCommandProperty

Identifies the CanDeriveKeyboardShortcutFromCommand dependency property. This field is read-only.

public static readonly DependencyProperty CanDeriveKeyboardShortcutFromCommandProperty

ScreenTipClosingEvent

Identifies the ScreenTipClosing routed event. This field is read-only.

public static readonly RoutedEvent ScreenTipClosingEvent

ScreenTipDescriptionProperty

Identifies the ScreenTipDescription dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipDescriptionProperty

ScreenTipFooterProperty

Identifies the ScreenTipFooter dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipFooterProperty

ScreenTipHeaderProperty

Identifies the ScreenTipHeader dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipHeaderProperty

ScreenTipHelpUriProperty

Identifies the ScreenTipHelpUri dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipHelpUriProperty

ScreenTipImageSourceProperty

Identifies the ScreenTipImageSource dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipImageSourceProperty

ScreenTipIsEnabledProperty

Identifies the ScreenTipIsEnabled dependency property. This field is read-only.

public static readonly DependencyProperty ScreenTipIsEnabledProperty

ScreenTipOpeningEvent

Identifies the ScreenTipOpening routed event. This field is read-only.

public static readonly RoutedEvent ScreenTipOpeningEvent

In This Article

ScreenTipService Class

Constructors

ScreenTipService()

Properties

AllowScreenTipsOnContextMenus

Property Value

Remarks

AllowScreenTipsOnInactiveWindows

Property Value

Remarks

CurrentScreenTip

Property Value

IsEnabled

Property Value

Remarks

Methods

AddScreenTipClosingHandler(DependencyObject, RoutedEventHandler)

AddScreenTipOpeningHandler(DependencyObject, RoutedEventHandler)

GetCanDeriveKeyboardShortcutFromCommand(DependencyObject)

Returns

GetScreenTipDescription(DependencyObject)

Returns

GetScreenTipFooter(DependencyObject)

Returns

GetScreenTipHeader(DependencyObject)

Returns

GetScreenTipHelpUri(DependencyObject)

Returns

GetScreenTipImageSource(DependencyObject)

Returns

GetScreenTipIsEnabled(DependencyObject)

Returns

RemoveScreenTipClosingHandler(DependencyObject, RoutedEventHandler)

RemoveScreenTipOpeningHandler(DependencyObject, RoutedEventHandler)

SetCanDeriveKeyboardShortcutFromCommand(DependencyObject, bool)

SetScreenTipDescription(DependencyObject, object)

SetScreenTipFooter(DependencyObject, object)

SetScreenTipHeader(DependencyObject, object)

SetScreenTipHelpUri(DependencyObject, Uri)

SetScreenTipImageSource(DependencyObject, ImageSource)

SetScreenTipIsEnabled(DependencyObject, bool)

Fields

CanDeriveKeyboardShortcutFromCommandProperty

ScreenTipClosingEvent

ScreenTipDescriptionProperty

ScreenTipFooterProperty

ScreenTipHeaderProperty

ScreenTipHelpUriProperty

ScreenTipImageSourceProperty

ScreenTipIsEnabledProperty

ScreenTipOpeningEvent

Inherited Members