HypernovaDesktop Components · docs
Binarymission
WPF › Ribbon › BinaryRibbonScreenTipHelpRequestedEventArgs

BinaryRibbonScreenTipHelpRequestedEventArgs

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Controls.Office

The data for BinaryRibbonScreenTip.HelpRequestedEvent, raised when the user presses F1 while a screen tip is showing: which screen tip it was, and the help topic it names.

public class BinaryRibbonScreenTipHelpRequestedEventArgs : RoutedEventArgs

Inherits from / implements: RoutedEventArgs

Remarks

Open the application's help at HelpTopic in the handler. RoutedEventArgs.Source is the command the screen tip belongs to.

See also

Members at a glance

Constructors
BinaryRibbonScreenTipHelpRequestedEventArgsCreates the data for one help request.
Properties
HelpTopicGets the help topic the screen tip names.
ScreenTipGets the screen tip that was on screen when help was asked for.

Constructors

BinaryRibbonScreenTipHelpRequestedEventArgs

public BinaryRibbonScreenTipHelpRequestedEventArgs( RoutedEvent routedEvent, object source, BinaryRibbonScreenTip screenTip, string helpTopic) : base(routedEvent, source)

Creates the data for one help request.

Parameters
routedEvent
The event being raised.
source
The element the screen tip belongs to.
screenTip
The screen tip that was on screen.
helpTopic
The topic the screen tip carries, which may be null.

Properties

HelpTopic

public string HelpTopic

Gets the help topic the screen tip names.

Value
The topic, in whatever form the application's help understands – a page name, a URL, a context ID as text – or null if the screen tip does not name one.

ScreenTip

public BinaryRibbonScreenTip ScreenTip

Gets the screen tip that was on screen when help was asked for.

Value
The screen tip; its BinaryRibbonScreenTip.Title names the command.