Class BaseComponentViewModel

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the MVVM view model of a UI view or UI component.

[ExcludeFromCodeCoverage]
[SuppressMessage("Minor Code Smell", "S3717:Track use of \"NotImplementedException\"", Justification = "This is an abstraction. It has no implementation by nature.")]
public abstract class BaseComponentViewModel : IBaseViewModel

Inheritance

object

BaseComponentViewModel

Implements

IBaseViewModel

Derived

ComponentViewModel

ViewModel<TUIView>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ContextData

Gets a container to store data.

public IContextData ContextData { get; }

Property Value

IContextData

Remarks

Context data can only be used in the code and cannot be bound in the template.

Logger

Gets the logger.

protected INeosLogger Logger { get; }

Property Value

INeosLogger

Methods

ExportServerDataAsync(ServerDataExportOptions)

Exports data from the server.

public virtual Task ExportServerDataAsync(ServerDataExportOptions options)

Parameters

options ServerDataExportOptions

Server data export options.

Returns

Task

Task.

FindEnum(string)

Finds an enumeration type by its name.

public IEnumType FindEnum(string enumName)

Parameters

enumName string

Name of the enumeration.

Returns

IEnumType

The enumeration type if is has been found; otherwise null.

GetEnum(string)

Gets an enumeration type by its name.

public IEnumType GetEnum(string enumName)

Parameters

enumName string

Name of the enumeration.

Returns

IEnumType

The enumeration type.

GetMainViewModel()

Gets the highest view model in the view.

public ViewModel<IUIView> GetMainViewModel()

Returns

ViewModel<IUIView>

Highest view model in the view.

GetMainViewModel<TMainUIView>()

Gets the highest view model in the view.

public ViewModel<TMainUIView> GetMainViewModel<TMainUIView>() where TMainUIView : class, IUIView

Returns

ViewModel<TMainUIView>

Highest view model in the view.

Type Parameters

TMainUIView

Type of UI view associated to the main view model.

GetParentViewModel()

Gets the parent view model.

public ViewModel<IUIView>? GetParentViewModel()

Returns

ViewModel<IUIView>

Parent view model.

GetParentViewModel<TParentUIView>()

Gets the parent view model.

public ViewModel<TParentUIView>? GetParentViewModel<TParentUIView>() where TParentUIView : class, IUIView

Returns

ViewModel<TParentUIView>

Parent view model.

Type Parameters

TParentUIView

Type of UI view associated to the parent view model.

SelectDeferredFileAsync(int, params string[])

Selects a file to upload later.

public Task<DeferredFileReference?> SelectDeferredFileAsync(int maxSize, params string[] types)

Parameters

maxSize int

Maximum allowed file size in bytes.

types string[]

Accepted types. It can be a MIME type or a filename extension starting with a period character.

Returns

Task<DeferredFileReference>

A reference to the selected file or null.

SelectDeferredFileAsync(params string[])

Selects a file to upload later.

public Task<DeferredFileReference?> SelectDeferredFileAsync(params string[] types)

Parameters

types string[]

Accepted types. It can be a MIME type or a filename extension starting with a period character.

Returns

Task<DeferredFileReference>

A reference to the selected file or null.

SelectFileAsync(int, params string[])

Selects a file and immediately uploads it.

public Task<FileReference?> SelectFileAsync(int maxSize, params string[] types)

Parameters

maxSize int

Maximum allowed file size in bytes.

types string[]

Accepted types. It can be a MIME type or a filename extension starting with a period character.

Returns

Task<FileReference>

A reference to the selected file or null.

SelectFileAsync(params string[])

Selects a file and immediately uploads it.

public Task<FileReference?> SelectFileAsync(params string[] types)

Parameters

types string[]

Accepted types. It can be a MIME type or a filename extension starting with a period character.

Returns

Task<FileReference>

A reference to the selected file or null.

ShowError(Exception)

Shows a message displaying the specified exception.

public virtual void ShowError(Exception exception)

Parameters

exception Exception

The exception to display.

ShowMessageAsync(MessageType, string, string, params MessageButton[])

Shows a message.

public virtual Task<IMessageResponse> ShowMessageAsync(MessageType type, string title, string text, params MessageButton[] buttons)

Parameters

type MessageType

Severity of the message.

title string

Message title.

text string

Message text.

buttons MessageButton[]

Buttons.

Returns

Task<IMessageResponse>

A task that represents the asynchronous operation. The task result contains a IMessageResponse that contains the response.

Examples

The following example shows how to display a question and wait for the response.

// String literals here ("Question", "Are you ready?") are simplified for readability.
// Real rule/action/method code must use UIResources.[Module].[ResourceName] instead of hardcoded text.
IMessageResponse response = await ShowMessageAsync(MessageType.Info, "Question", "Are you ready?", new MessageButton(MessageButtonType.Yes, true), new MessageButton(MessageButtonType.No));
if (response.ButtonType == MessageButtonType.Yes)
{
    Start();
}

ShowMessageWithInputAsync(MessageType, string, string, params MessageButton[])

Shows a message with an input.

public virtual Task<IMessageResponse> ShowMessageWithInputAsync(MessageType type, string title, string text, params MessageButton[] buttons)

Parameters

type MessageType

Severity of the message.

title string

Message title.

text string

Message text.

buttons MessageButton[]

Buttons.

Returns

Task<IMessageResponse>

A task that represents the asynchronous operation. The task result contains a IMessageResponse that contains the response.

ShowMessageWithInputAsync(MessageType, string, string, Func<string?, string?>, params MessageButton[])

Shows a message with an input.

public virtual Task<IMessageResponse> ShowMessageWithInputAsync(MessageType type, string title, string text, Func<string?, string?> validateInput, params MessageButton[] buttons)

Parameters

type MessageType

Severity of the message.

title string

Message title.

text string

Message text.

validateInput Func<string, string>

Function returning an error message to display near the input when the input value is invalid.

buttons MessageButton[]

Buttons.

Returns

Task<IMessageResponse>

A task that represents the asynchronous operation. The task result contains a IMessageResponse that contains the response.

ShowToast(MessageType, string?, string, int?, bool, params ToastButton[])

Shows a toast.

public virtual void ShowToast(MessageType type, string? title, string text, int? duration = 3000, bool dismissible = true, params ToastButton[] buttons)

Parameters

type MessageType

Severity of the toast.

title string

Toast title.

text string

Toast text.

duration int?

Delay in milliseconds before automatically closing the toast.

dismissible bool

Indicates whether the toast can be closed manually.

buttons ToastButton[]

Buttons to display in the toast.

ToggleOverlay(ToggleOverlayOptions)

Toggles an overlay (Modal, Popover).

public void ToggleOverlay(ToggleOverlayOptions options)

Parameters

options ToggleOverlayOptions

Options.

ToggleOverlay(string)

Toggles an overlay (Modal, Popover).

public void ToggleOverlay(string overlayId)

Parameters

overlayId string

Overlay identifier.