markdoccore IStepViewModel

IStepViewModel interface

Description

Interface for view models of plugin steps

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph MarkDoc.Core
  MarkDoc.Core.IStepViewModel[[IStepViewModel]]
  class MarkDoc.Core.IStepViewModel interfaceStyle;
  MarkDoc.Core.IViewModel[[IViewModel]]
  class MarkDoc.Core.IViewModel interfaceStyle;
  end
  subgraph System
System.IDisposable[[IDisposable]]
  end
MarkDoc.Core.IViewModel --> MarkDoc.Core.IStepViewModel
System.IDisposable --> MarkDoc.Core.IStepViewModel

Loading

Members

Properties

Public properties

Type	Name	Methods
string	Description Step description	get
string	Id Step view model Id	get
bool	IsValid Determines whether the step form is filled correctly	get
string	Title Step name	get

Methods

Public methods

Returns	Name
IReadOnlyDictionary	GetSettings() Retrieves current settings
ValueTask	SetPreviousSettings(IReadOnlyDictionary<string, IReadOnlyDictionary> settings)

Details

Summary

Interface for view models of plugin steps

Inheritance

• IViewModel
• IDisposable

Methods

GetSettings

public abstract IReadOnlyDictionary GetSettings()

Summary

Retrieves current settings

Returns

Current form settings

SetPreviousSettings

public abstract ValueTask SetPreviousSettings(IReadOnlyDictionary<string, IReadOnlyDictionary> settings)

Arguments

Type	Name	Description
IReadOnlyDictionary<string, IReadOnlyDictionary>	settings

Properties

IsValid

public abstract bool IsValid { get }

Summary

Determines whether the step form is filled correctly

Id

public abstract string Id { get }

Summary

Step view model Id

Remarks

This Id is required for referencing previous settings

Title

public abstract string Title { get }

Summary

Step name

Description

public abstract string Description { get }

Summary

Step description

Generated with MarkDoc