Interface IViewModelRelation

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents a view model relationship.

public interface IViewModelRelation

Properties

Embedded

Gets a value indicating whether the relation is embedded in the entityView.

bool Embedded { get; }

Property Value

bool

EntityViewPath

Gets the collection property path in the entityView parent which defines the relationship.

string EntityViewPath { get; }

Property Value

string

PropertyPath

Gets the path of the property in relation to the parent model which defines the relationship (reference or collection).

string PropertyPath { get; }

Property Value

string

Remarks

Actually, this is the name of the sub ui-view.

RelationPropertyName

Gets the property name of viewModel parent on which the relation depends.

The parent property must be an uiView or a collection of uiView.

[Obsolete("Use PropertyPath instead.")]
string RelationPropertyName { get; }

Property Value

string

Methods

GetCaption(IViewModel)

Gets the caption of the relation as defined in the entity view (for embedded relationship) or the name of sub UI view title (for non-embedded relationship).

string? GetCaption(IViewModel ownerViewModel)

Parameters

ownerViewModel IViewModel

The owner view model of the relationship.

Returns

string

The localized caption or the name.

GetViewModel<T>()

Gets the view model.

[Obsolete("Use ViewModel.GetSubViewModel instead.", true)]
ViewModel<T> GetViewModel<T>() where T : class, IUIView

Returns

ViewModel<T>

The view model.

Type Parameters

T

The type of UI view on which the view model is based.