In This Article

IParameterInfoSession Interface

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

public interface IParameterInfoSession : IIntelliPromptSession, IServiceLocator

Properties

Content

The content to display in the parameter info popup.

object? Content { get; }

Property Value

object

ControlKeyDownOpacity

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

double ControlKeyDownOpacity { get; }

Property Value

double:

The default value is 0.25.

Remarks

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

DisplaySelectedIndex

The one-based index of the Selection.

int DisplaySelectedIndex { get; }

Property Value

int

HasSelectionChanged

Indicates whether the selection has changed since the session opened.

bool HasSelectionChanged { get; }

Property Value

bool:

true if the selection has changed since the session opened; otherwise, false.

IsArrowKeySelectionEnabled

Indicates whether the up and down arrow keys can be used to change the Selection.

bool IsArrowKeySelectionEnabled { get; }

Property Value

bool:

true if the up and down arrow keys can be used to change the Selection; otherwise, false.

Items

The collection of ISignatureItem objects within the parameter info.

ISignatureItemCollection Items { get; }

Property Value

ISignatureItemCollection

MaxWidth

The quick info popup's maximum width.

double MaxWidth { get; }

Property Value

double:

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

SelectNextCommand

The ICommand that selects the next item.

ICommand SelectNextCommand { get; }

Property Value

ICommand

SelectPreviousCommand

The ICommand that selects the previous item.

ICommand SelectPreviousCommand { get; }

Property Value

ICommand

Selection

A ISignatureItem indicating the current selection within the parameter info.

ISignatureItem? Selection { get; set; }

Property Value

ISignatureItem

Methods

Refresh()

Refreshes the displayed content from the selected item's content provider, and repositions the popup.

void Refresh()

SelectNext()

Selects the next item.

void SelectNext()

SelectPrevious()

Selects the previous item.

void SelectPrevious()

Events

RequestNavigate

Occurs when a hyperlink is clicked that requests navigation.

event RequestNavigateEventHandler RequestNavigate

Event Type

RequestNavigateEventHandler

SelectionChanged

Occurs after the Selection has changed.

event EventHandler SelectionChanged

Event Type

EventHandler

Inherited Members

Extension Methods