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

NavigableSymbolSelector Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

Represents a control that contains drop-down lists of accessible symbols (typically types and members) for a document.

[ToolboxBitmap(typeof(NavigableSymbolSelector))]
public class NavigableSymbolSelector : DpiAwareControl, IDisposable, IDpiAwareElement
Inheritance:
object MarshalByRefObject Component Control DpiAwareControl object
Implements:
IDisposable IDpiAwareElement

Constructors

NavigableSymbolSelector()

Initializes an instance of the class.

public NavigableSymbolSelector()

Properties

AreMemberSymbolsSupported

Indicates whether the member symbols drop-down is displayed.

public bool AreMemberSymbolsSupported { get; set; }

Property Value

bool:

true if the member symbols drop-down is displayed; otherwise, false. The default value is true.

AreRootSymbolsSupported

Indicates whether the root symbols drop-down is displayed.

public bool AreRootSymbolsSupported { get; set; }

Property Value

bool:

true if the root symbols drop-down is displayed; otherwise, false. The default value is true.

IsInSelectedMemberSymbol

Indicates whether the attached SyntaxEditor's caret is within the SelectedMemberSymbol.

public bool IsInSelectedMemberSymbol { get; }

Property Value

bool:

true if the attached SyntaxEditor's caret is within the SelectedMemberSymbol; otherwise, false.

IsInSelectedRootSymbol

Indicates whether the attached SyntaxEditor's caret is within the SelectedRootSymbol.

public bool IsInSelectedRootSymbol { get; }

Property Value

bool:

true if the attached SyntaxEditor's caret is within the SelectedRootSymbol; otherwise, false.

MemberSymbols

The collection of member INavigableSymbol objects.

public IEnumerable<INavigableSymbol>? MemberSymbols { get; }

Property Value

IEnumerable<INavigableSymbol>

RootSymbols

The collection of root INavigableSymbol objects.

public IEnumerable<INavigableSymbol>? RootSymbols { get; }

Property Value

IEnumerable<INavigableSymbol>

SelectedMemberSymbol

The currently-selected INavigableSymbol for a member symbol.

[Browsable(false)]
public INavigableSymbol? SelectedMemberSymbol { get; set; }

Property Value

INavigableSymbol

SelectedRootSymbol

The currently-selected INavigableSymbol for a root symbol.

[Browsable(false)]
public INavigableSymbol? SelectedRootSymbol { get; set; }

Property Value

INavigableSymbol

SyntaxEditor

The SyntaxEditor to monitor.

public SyntaxEditor? SyntaxEditor { get; set; }

Property Value

SyntaxEditor

Methods

Dispose(bool)

Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

DpiScaleChanged(SizeF)

Called when the DPI-based scale factor of the element changes.

protected override void DpiScaleChanged(SizeF scaleFactor)
Parameter Type Description
scaleFactor SizeF

The new scale factor where Width is applied to the x-axis, and Height is applied to the y-axis.

See Also

OnInvalidated(InvalidateEventArgs)

Raises the Invalidated event.

protected override void OnInvalidated(InvalidateEventArgs e)
Parameter Type Description
e InvalidateEventArgs

An InvalidateEventArgs that contains the event data.

OnLayout(LayoutEventArgs)

Raises the Layout event.

protected override void OnLayout(LayoutEventArgs e)
Parameter Type Description
e LayoutEventArgs

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
Parameter Type Description
e PropertyChangedEventArgs

The event data.

OnPropertyChanged(string?)

Raises the PropertyChanged event.

protected void OnPropertyChanged(string? propertyName = null)
Parameter Type Description
propertyName string

(Optional) The name of the property that changed.

OnResize(EventArgs)

Raises the Resize event.

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

An EventArgs that contains the event data.

SetProperty<T>(ref T, T, string?)

Called from a property setter to change the backing field's value and raise PropertyChanged notification events if the new value is not equal to the current value.

protected bool SetProperty<T>(ref T field, T newValue, string? propertyName = null)
Type Parameters:
T -

The type of the property that changed.

Parameter Type Description
field T

The backing field that holds the property's value, which may be updated.
newValue T

The new property value.
propertyName string

(Optional) The name of the property that changed.

Returns

bool:

true if the property was changed; otherwise, false.

Events

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler

Inherited Members

Extension Methods