QuickInfoSession Class

public class QuickInfoSession : IntelliPromptSessionBase, IEditorDocumentTextChangeEventSink, IEditorViewKeyInputEventSink, IEditorViewSelectionChangeEventSink, IQuickInfoSession, IIntelliPromptSession, IServiceLocator

public QuickInfoSession()

public override Rectangle? Bounds { get; }

Property Value

Rectangle?:

The view-relative bounds of the session's open popup, if available.

public override bool ClosesOnLostFocus { get; }

Property Value

bool:

true if this session auto-closes when the editor or any IntelliPrompt popups lose focus; otherwise, false.

public object Content { get; set; }

Property Value

object:

The content to display in the quick info popup.

public object Context { get; set; }

Property Value

object:

An object that describes the context in which the quick info popup is displayed.

public double ControlKeyDownOpacity { get; set; }

Property Value

double:

The opacity of the popup while the control key is pressed.

Remarks

Set the value to 1.0 to prevent opacity changes when the control key is pressed.

public int MaxWidth { get; set; }

Property Value

int:

The quick info popup's maximum width, or NaN to indicate no constraint. The default value is 1000.

public PlacementMode Placement { get; }

Property Value

PlacementMode:

The PlacementMode describing where to place the popup when a PlacementTarget is specified.

public Rectangle PlacementRectangle { get; protected set; }

Property Value

Rectangle:

The PlacementTarget-relative bounds for where to target the popup when a PlacementTarget is specified.

public IUIElement PlacementTarget { get; }

Property Value

IUIElement:

The visual element against which to target the popup when not opening the session for a text range.

See Also

• Open(IEditorView, PlacementMode, IUIElement, Rectangle)

public override IIntelliPromptSessionType SessionType { get; }

Property Value

IIntelliPromptSessionType:

The IIntelliPromptSessionType that identifies the type of session.

protected virtual IntelliPromptQuickInfo CreatePopupContent()

Returns

IntelliPromptQuickInfo:

The control that was created.

protected void NotifyPropertyChanged(string name)

Parameter	Type	Description
name	string	The name of the property.

protected override void OnClosed(CancelEventArgs e)

Parameter	Type	Description
e	CancelEventArgs	An CancelEventArgs that contains the event data.

protected virtual void OnDocumentTextChanged(SyntaxEditor editor, EditorSnapshotChangedEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangedEventArgs	The EditorSnapshotChangedEventArgs that contains the event data.

protected virtual void OnDocumentTextChanging(SyntaxEditor editor, EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangingEventArgs	The EditorSnapshotChangingEventArgs that contains the event data.

protected override void OnOpened(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnViewKeyDown(IEditorView view, KeyEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected virtual void OnViewKeyUp(IEditorView view, KeyEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected virtual void OnViewSelectionChanged(IEditorView view, EditorViewSelectionEventArgs e)

Parameter	Type	Description
view	IEditorView	The IEditorView that received the event.
e	EditorViewSelectionEventArgs	The EditorViewSelectionEventArgs that contains the event data.

public void Open(IEditorView view, PlacementMode placement, IUIElement placementTarget, Rectangle placementRectangle)

Parameter	Type	Description
view	IEditorView	The IEditorView in which the session is opened.
placement	PlacementMode	A PlacementMode indicating the mode by which to display the quick info.
placementTarget	IUIElement	The target IUIElement for placing the quick info.
placementRectangle	Rectangle	The target-relative Rectangle around which to display the quick info.

public override void Reposition()

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler