Table of Contents

Interface IPropertiesEditor

Namespace
ATAS.Indicators
Assembly
ATAS.Indicators.dll

The settings editor (property grid) that shows the settings of an indicator; lets the indicator expand and collapse setting categories and expandable properties. The platform passes it through PropertiesEditor.

public interface IPropertiesEditor
Extension Methods

Methods

BeginInit()

Starts a batch of changes: until EndInit() is called, expand and collapse requests are queued instead of being applied.

void BeginInit()

EndInit()

Ends the batch started by BeginInit() and applies the queued expand and collapse requests.

Task EndInit()

Returns

Task

A task that completes when the queued requests have been applied.

GetIsExpandedCategory(string?)

Gets whether the settings category (group) with the specified name is expanded.

bool? GetIsExpandedCategory(string? categoryName)

Parameters

categoryName string

The name of the category.

Returns

bool?

true if the category is expanded, false if it is collapsed, or null if categoryName is null or white space.

GetIsExpandedProperty(string?)

Gets whether the expandable property with the specified name is expanded.

bool? GetIsExpandedProperty(string? propertyName)

Parameters

propertyName string

The name of the property.

Returns

bool?

true if the property is expanded, false if it is collapsed, or null if propertyName is null or white space.

Refresh()

Refreshes the property grid to reflect changes in property visibility or values.

Added in ATAS 8.0.15.

void Refresh()

SetIsExpandedCategory(string?, bool)

Expands or collapses the settings category (group) with the specified name.

void SetIsExpandedCategory(string? categoryName, bool isExpanded)

Parameters

categoryName string

The name of the category.

isExpanded bool

true to expand the category; false to collapse it.

SetIsExpandedProperty(string?, bool)

Expands or collapses the expandable property with the specified name.

void SetIsExpandedProperty(string? propertyName, bool isExpanded)

Parameters

propertyName string

The name of the property.

isExpanded bool

true to expand the property; false to collapse it.