Home > Services > DXCore Services – Hints

DXCore Services – Hints

December 14th, 2011

The Hints DXCore service provides access to hinting services for showing/hiding Shortcut hints, BigFeedback hints, and other discoverability services.

Methods of this service:

Method Name

Description

GetAvailableShortcuts Collects all available shortcuts and descriptions for the current context for use in the Shortcuts hint.
HideFeatureActionsHint(HintWindowBase) Hides the specified Feature UI hint.
HideShortcutsHint Hides the active Shortcuts hint.
HideShortcutsHint(Boolean) Hides the active Shortcuts hint. The boolean parameters specify whether the hint animates the close, so the hint appears to drop down into it’s bottom line.
HideShortcutsHint(ShortcutsHint) Hides the specified Shortcuts hint.
HideShortcutsHint(ShortcutsHint, Boolean) Hides the specified Shortcuts hint. The boolean parameters specify whether the hint animates the close, so the hint appears to drop down into it’s bottom line.
HideSolutionProcessHint(HintWindowBase) Hides the SolutionProcess hint.
HideTooltip Hides the Tooltip previously displayed through a call to ShowTooltip.
IsHintSuppressed(ShortcutsHint) Returns true if the user has requested to suppress future appearances of the specified Shortcuts hint. Note that it is hidden from Intellisense.
IsHintSuppressed(String) Returns true if the user has requested to suppress future appearances of the specified hint. Note that it is hidden from Intellisense.
IsShortcutsHintVisible(ShortcutsHint) Return true if the specified Shortcuts hint is visible.
IsSolutionProcessHintVisible( HintWindowBase) Returns true if the SolutionProcess hint is visible.
RefreshForm Invalidates the Shortcuts hint form.
RefreshSolutionForm Invalidates the SolutionProcess hint form.
SetLastTooltipControlUnderMouse (ITooltipProvider, Control) Allows an ITooltipProvider to specify a control under the mouse. ITooltipProviders must call this method anytime the control under the mouse changes. When an ITooltipProvider is destroyed, it should call SetLastTooltipControlUnderMouse (null, null) if it previously called SetLastTooltipControlUnderMouse. This is to prevent an attempt to call back into it after the ITooltipProvider is destroyed.
ShowBigFeedback(HWND, String) Shows a BigFeedback message, centered in the specified HWND.
ShowBigFeedback(Rectangle, String) Shows a BigFeedback message, centered in the specified bounds.
ShowBigFeedback(String) Shows a BigFeedback message, centered in the active text view.
ShowFeatureActionsHint(HintWindowBase) Displays the Feature UI hint.
ShowShortcutsHint(ShortcutsHint) Displays the specified Shortcuts hint.
ShowShortcutsHint(ShortcutsHint, Boolean) Displays the specified Shortcuts hint.  If the boolean parameter is false, the Shortcuts hint will appear as long as it is not suppressed. If true, the Shortcuts hint will appear even if the user requested to suppress it in the past.
ShowShortcutsHint(ShortcutsHint, Boolean, Boolean) Displays the specified Shortcuts hint.  If the first boolean parameter is false, the Shortcuts hint will appear as long as it is not suppressed. If true, the Shortcuts hint will appear even if the user requested to suppress it in the past. The second boolean parameter specifies whether this hint should be displayed as a design-time preview. If true, clicking the red “X” button will close the hint list, but will not suppress further showings. Note that it is hidden from Intellisense.
ShowShortcutsHint(ShortcutsHint, Boolean, Boolean, String, String, String, String) Displays the specified Shortcuts hint with the specified UI text. Note that it is hidden from Intellisense.
ShowSolutionProcessHint(TextView, HintWindowBase) Displays the specified SolutionProcess hint.
ShowSolutionProcessHint(TextView, HintWindowBase, Boolean) Displays the specified SolutionProcess hint. Optionally specifies whether to locate the hint on the top of the text view.
ShowTooltip(Int32, Int32, String) Shows the Tooltip containing the specified text at the specified coordinates. Caller is responsible for hiding the Tooltip, through a call to HideTooltip().
SuppressFutureShortcutsHintAppearances( ShortcutsHint) Suppresses the appearance of future Shortcuts hints.
SuppressFutureShortcutsHintAppearances( String) Suppresses the appearance of future Shortcuts hints specified by the hint title.

Properties:

Property name

Description

FeatureActionsHintVisible Returns true if the Feature UI hint is visible.
Settings Settings for discoverability features, used by the Hint service.
ShortcutsHintBounds Returns the bounds of the currently active Shortcuts hint.
ShortcutsHintIsFocused Returns true if the Shortcuts hint is visible and focused.
ShortcutsHintIsUp Returns true if the Shortcuts hint has been created and displayed. Note that it is hidden from Intellisense.
SolutionProcessHintVisible Returns true if the SolutionProcess hint is visible.
—–
Products: DXCore
Versions: 11.2 and up
VS IDEs: any
Updated: Dec/15/2011
ID: D136

Similar Posts: