DXCore Services – BigHint
December 14th, 2010
The BigHint service provides methods for manipulating of big hints, such as creating new ones and showing at the specified position.
The following methods are available:
|
Name |
Description |
| DisableHint(HintBase) | Disables the specified hint. |
| DisableHintFeatureGroup(HintBase) | Disables the feature group of the specified hint. |
| GetFeatureGroup(HintBase) | Returns the FeatureGroup for the specified feature name. |
| GetHintStats(FeatureGroup, HintBase) | Returns the HintStats for the specified big hint text within the specified FeatureGroup. |
| HintIsEnabled(HintBase) | Returns true if it is OK to display the specified big hint. |
| RequestHint(BigHintBase) | Creates new hint if it is allowed. Returns null if the hint is not allowed to show. |
| ShowAt(SourcePoint, BigHintBase) | Displays the big hint at the specified SourcePoint. |
| ShowAt(Point, BigHintBase) | Displays the specified big hint at the given screen coordinates. |
| ShowAt(Control, BigHintBase) | Displays the specified big hint at the given control. |
| ShowAt(SourcePoint, String, String) | Displays the big hint at the specified SourcePoint with the specified title and text. |
| ShowAt(Point, String, String) | Displays the big hint at the specified screen coordinates with the specified title and text. |
| ShowAt(Int32, Int32, BigHintBase) | Displays the big hint at the specified line and column in the active view. |
| ShowAt(Control, String, String) | Displays the big hint at the specified control with the specified title and text. |
| ShowAt(SourcePoint, String, String, String) | Displays the big hint at the specified SourcePoint with the specified title, text and User Guide page. |
| ShowAt(Int32, Int32, String, String, String) | Displays the big hint at the specified line and column in the active view with the specified title, text and User Guide page. |
| ShowAtCaret(BigHintBase) | Displays the big hint at the editor caret with the specified title and text. |
| ShowAtCaret (String, String) | Displays the big hint at the editor caret with the specified title and text. |
| ShowAtCaret (String, String, String) | Displays the big hint at the editor caret with the specified title, text and User Guide page. |
| ShowAtLowerRight(Rectangle, Int32, BigHintBase) | Displays the big hint at the lower right angle of the specified rectangle. Takes the margin in pixels, to use as a parameter. |
| ShowUnderCaret(BigHintBase) | Displays the big hint at the editor caret. |
Properties:
|
Name |
Description |
| Enabled | Gets or sets the enabled state of big hinting. |
| FadeIn | Determines whether the big hint will fade in when it first appears. If false, big hints will simply appear. |
| FadeOut | Determines whether the big hint will fade out when it closes. If false, big hints will simply disappear. |