Interface IDisplayParameterService
Service to interact with parameters.
Namespace: MAT.Atlas.Client.Presentation.Services
Assembly: MAT.Atlas.Client.Presentation.dll
Syntax
public interface IDisplayParameterService : IDisposable
Properties
ParameterContainers
Get parameter containers. IDisplayParameterContainer
Declaration
IReadOnlyList<IDisplayParameterContainer> ParameterContainers { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyList<IDisplayParameterContainer> |
PrimaryParameters
Get primary parameters of the session. IDisplayParameter
Declaration
IReadOnlyList<IDisplayParameter> PrimaryParameters { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyList<IDisplayParameter> |
Methods
AddParameterContainer(String)
Add parameter container to the display. If identifier already exists it will not be added.
Declaration
void AddParameterContainer(string identifier)
Parameters
Type | Name | Description |
---|---|---|
System.String | identifier | Display parameter container's identifier. |
AddParameterContainer(String, Boolean)
Add parameter container to the display.
Declaration
void AddParameterContainer(string identifier, bool allowDuplicate)
Parameters
Type | Name | Description |
---|---|---|
System.String | identifier | Display parameter container's identifier. |
System.Boolean | allowDuplicate | Set to True to add multiple parameters with the same identifier. |
RemoveParameterContainer(String)
Remove a parameter container from a display.
Declaration
bool RemoveParameterContainer(string identifier)
Parameters
Type | Name | Description |
---|---|---|
System.String | identifier | Display parameter container's identifier. |
Returns
Type | Description |
---|---|
System.Boolean | True on success, else false. |