ParameterInfoProviderBase Class
Implements an abstract base class for a parameter info provider.
public abstract class ParameterInfoProviderBase : IParameterInfoProvider, IOrderable, IKeyedObject- Inheritance:
- object object
- Implements:
- IParameterInfoProvider IOrderable IKeyedObject
Remarks
Instances of this object can be registered with an ISyntaxLanguage using the RegisterService(object, object) method. Once an instance is registered with the language as a service, its features can be used by the language.
Constructors
ParameterInfoProviderBase()
Initializes a new instance of the ParameterInfoProviderBase class.
protected ParameterInfoProviderBase()ParameterInfoProviderBase(string)
Initializes a new instance of the ParameterInfoProviderBase class.
protected ParameterInfoProviderBase(string key)| Parameter | Type | Description |
|---|---|---|
| key | string | The string-based key that identifies the provider. |
ParameterInfoProviderBase(string, params Ordering[])
Initializes a new instance of the ParameterInfoProviderBase class.
protected ParameterInfoProviderBase(string key, params Ordering[] orderings)| Parameter | Type | Description |
|---|---|---|
| key | string | The string-based key that identifies the provider. |
| orderings | Ordering[] | The array of Ordering objects, used to determine how this object is positioned relative to other objects. |
Properties
Key
Gets the string-based key that identifies the provider.
public string Key { get; }Property Value
- string:
The string-based key that identifies the provider.
Orderings
Gets the collection of Ordering objects, used to determine how this object is positioned relative to other objects.
public IEnumerable<Ordering> Orderings { get; }Property Value
- IEnumerable<Ordering>:
The collection of Ordering objects, used to determine how this object is positioned relative to other objects.
Methods
RequestSession(IEditorView)
Requests that an IParameterInfoSession be opened for the specified IEditorView.
public abstract bool RequestSession(IEditorView view)| Parameter | Type | Description |
|---|---|---|
| view | IEditorView | The IEditorView that will host the session. |
Returns
- bool:
trueif a session was opened; otherwise,false.