Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

ParameterInfoSession Class

Namespace:
ActiproSoftware.Windows.Controls.SyntaxEditor.IntelliPrompt.Implementation
Assembly:
ActiproSoftware.SyntaxEditor.Wpf.dll

Represents an IntelliPrompt parameter info session.

public class ParameterInfoSession : IntelliPromptSessionBase, IParameterInfoSession, IIntelliPromptSession, IServiceLocator, IEditorViewKeyInputEventSink, IEditorViewPointerInputEventSink, IEditorViewSelectionChangeEventSink
Inheritance:
object IntelliPromptSessionBase object
Implements:
IParameterInfoSession IIntelliPromptSession IServiceLocator IEditorViewKeyInputEventSink IEditorViewPointerInputEventSink IEditorViewSelectionChangeEventSink

Constructors

ParameterInfoSession()

Initializes a new instance of the ParameterInfoSession class.

public ParameterInfoSession()

Properties

Bounds

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

public override Rect? Bounds { get; }

Property Value

Rect?:

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

ClosesOnLostFocus

Returns whether this session auto-closes when the editor or any IntelliPrompt popups lose focus.

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.

Content

Gets or sets the content to display in the parameter info popup.

public object Content { get; set; }

Property Value

object:

The content to display in the parameter info popup.

ControlKeyDownOpacity

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

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.

DisplaySelectedIndex

Gets the one-based index of the Selection.

public int DisplaySelectedIndex { get; }

Property Value

int:

The one-based index of the Selection.

HasSelectionChanged

Gets whether the selection has changed since the session opened.

public bool HasSelectionChanged { get; }

Property Value

bool:

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

IsArrowKeySelectionEnabled

Gets or sets whether the up and down arrow keys can be used to change the Selection.

public bool IsArrowKeySelectionEnabled { get; set; }

Property Value

bool:

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

Items

Gets the collection of ISignatureItem objects within the parameter info.

public ISignatureItemCollection Items { get; }

Property Value

ISignatureItemCollection:

The collection of ISignatureItem objects within the parameter info.

MaxWidth

Gets or sets the quick info popup's maximum width.

public double MaxWidth { get; set; }

Property Value

double:

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

SelectNextCommand

Gets the ICommand that selects the next item.

public ICommand SelectNextCommand { get; }

Property Value

ICommand:

The ICommand that selects the next item.

SelectPreviousCommand

Gets the ICommand that selects the previous item.

public ICommand SelectPreviousCommand { get; }

Property Value

ICommand:

The ICommand that selects the previous item.

Selection

Gets or sets a ISignatureItem indicating the current selection within the parameter info.

public ISignatureItem Selection { get; set; }

Property Value

ISignatureItem:

A ISignatureItem indicating the current selection within the parameter info.

SessionType

Gets the IIntelliPromptSessionType that identifies the type of session.

public override IIntelliPromptSessionType SessionType { get; }

Property Value

IIntelliPromptSessionType:

The IIntelliPromptSessionType that identifies the type of session.

Methods

CreatePopupContent()

Creates an IntelliPromptParameterInfo that is to be displayed in a popup.

protected virtual IntelliPromptParameterInfo CreatePopupContent()

Returns

IntelliPromptParameterInfo:

The control that was created.

NotifyPropertyChanged(string)

Notifies that a property's value has changed.

protected void NotifyPropertyChanged(string name)
Parameter Type Description
name string

The name of the property.

OnClosed(CancelEventArgs)

Raises the Closed event.

protected override void OnClosed(CancelEventArgs e)
Parameter Type Description
e CancelEventArgs

An CancelEventArgs that contains the event data.

OnOpened(EventArgs)

Raises the Opened event.

protected override void OnOpened(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

OnRequestNavigate(RequestNavigateEventArgs)

Raises the RequestNavigate event.

protected virtual void OnRequestNavigate(RequestNavigateEventArgs e)
Parameter Type Description
e RequestNavigateEventArgs

An RequestNavigateEventArgs that contains the event data.

OnSelectionChanged(EventArgs)

Raises the SelectionChanged event.

protected virtual void OnSelectionChanged(EventArgs e)
Parameter Type Description
e EventArgs

An EventArgs that contains the event data.

OnViewKeyDown(IEditorView, KeyEventArgs)

Occurs when a key is pressed down while focus is in the specified IEditorView.

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.

OnViewKeyUp(IEditorView, KeyEventArgs)

Occurs when a key is released while focus is in the specified IEditorView.

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.

OnViewPointerPressed(IEditorView, InputPointerButtonEventArgs)

Occurs when a pointer button is pressed over the specified IEditorView.

protected virtual void OnViewPointerPressed(IEditorView view, InputPointerButtonEventArgs e)
Parameter Type Description
view IEditorView

The IEditorView that received the event.
e InputPointerButtonEventArgs

The InputPointerButtonEventArgs that contains the event data.

OnViewSelectionChanged(IEditorView, EditorViewSelectionEventArgs)

Occurs when the selection is changed in the specified IEditorView.

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.

Refresh()

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

public void Refresh()

Reposition()

Notifies the session that it should reposition its user interface.

public override void Reposition()

SelectNext()

Selects the next item.

public void SelectNext()

SelectPrevious()

Selects the previous item.

public void SelectPrevious()

Events

PropertyChanged

Occurs when a property value is changed.

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

RequestNavigate

Occurs when a hyperlink is clicked that requests navigation.

public event RequestNavigateEventHandler RequestNavigate

Event Type

RequestNavigateEventHandler

SelectionChanged

Occurs after the Selection has changed.

public event EventHandler SelectionChanged

Event Type

EventHandler

Inherited Members