In This Article

IQuickInfoSession Interface

Provides the base requirements for an object that represents an IntelliPrompt quick info session.

public interface IQuickInfoSession : IIntelliPromptSession, IServiceLocator

Properties

Content

Gets the content to display in the quick info popup.

object Content { get; }

Property Value

object:

The content to display in the quick info popup.

Context

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

object Context { get; }

Property Value

object:

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

ControlKeyDownOpacity

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

double ControlKeyDownOpacity { get; }

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.

MaxWidth

Gets the quick info popup's maximum width.

int MaxWidth { get; }

Property Value

int:

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

Placement

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

PlacementMode Placement { get; }

Property Value

PlacementMode:

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

PlacementRectangle

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

Rectangle PlacementRectangle { get; }

Property Value

Rectangle:

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

PlacementTarget

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

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

Methods

Open(IEditorView, PlacementMode, IUIElement, Rectangle)

Opens the session around a placement target, attaching to the specified IEditorView.

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.

Inherited Members