Interface IFormula
Формула.
Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IFormula : IDeleteableApiObject, ICodeableApiObject, IBaseGroupMember, IAbleToHaveChangeableName, IAbleToHaveName, IAbleToHaveDescription, IAbleToHaveId, IApiObject, IApiEntity, INotifyPropertyChanged
Properties
AllAppointers
Возвращает все объекты, которые назначают данную формулу.
Declaration
IApiReadOnlyCollection<IFormulaAppointer> AllAppointers { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IFormulaAppointer> |
Body
Возвращает или задает тело формулы.
Declaration
string Body { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OwnerGroup
Возвращает группу-владелец.
Declaration
IFormulaGroup OwnerGroup { get; set; }
Property Value
| Type | Description |
|---|---|
| IFormulaGroup |
Parameters
Возвращает список параметров формулы.
Declaration
IApiReadOnlyCollection<IFormulaParameter> Parameters { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IFormulaParameter> |
Methods
CanMoveTo(IFormulaGroup)
Возвращает признак, может ли формула быть перемещена в указанную группу.
Declaration
bool CanMoveTo(IFormulaGroup destinationGroup)
Parameters
| Type | Name | Description |
|---|---|---|
| IFormulaGroup | destinationGroup | Группа назначения. |
Returns
| Type | Description |
|---|---|
| bool |
|
CopyTo(IFormulaGroup, string)
Копирует формулу в указанную группу.
Declaration
IFormula CopyTo(IFormulaGroup formulaGroup, string nameOfCopy)
Parameters
| Type | Name | Description |
|---|---|---|
| IFormulaGroup | formulaGroup | Группа назначения. |
| string | nameOfCopy | Имя скопированной формулы. |
Returns
| Type | Description |
|---|---|
| IFormula | Формулу-копию. |
CreateParameter(string, string, Guid?, ObjectStorageType)
Создает параметр формулы.
Declaration
IFormulaParameter CreateParameter(string name, string body, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Имя параметра формулы. |
| string | body | Тело параметра формулы. |
| Guid? | id | Уникальный идентификатор параметра формулы. |
| ObjectStorageType | storageType | Тип хранения. |
Returns
| Type | Description |
|---|---|
| IFormulaParameter | Созданный параметр формулы. |
Evaluate(IProperty)
Рассчитывает значение по свойству.
Declaration
IPropertyValueData Evaluate(IProperty property)
Parameters
| Type | Name | Description |
|---|---|---|
| IProperty | property | Свойство. |
Returns
| Type | Description |
|---|---|
| IPropertyValueData | Значение. |
EvaluateAsync()
Возвращает операцию, вычисляющую формулу во всех объектах.
Declaration
IAsyncOperation EvaluateAsync()
Returns
| Type | Description |
|---|---|
| IAsyncOperation | Асинхронная операция вычисления. |
MoveTo(IFormulaGroup)
Перемещает формулу в указанную группу.
Declaration
void MoveTo(IFormulaGroup destinationGroup)
Parameters
| Type | Name | Description |
|---|---|---|
| IFormulaGroup | destinationGroup | Группа назначения. |