markdoccore IPluginStep

IPluginStep interface

Description

Interface for plugin steps

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph MarkDoc.Core
  MarkDoc.Core.IPluginStep[[IPluginStep]]
  class MarkDoc.Core.IPluginStep interfaceStyle;
  end

Loading

Members

Properties

Public properties

Type	Name	Methods
string	Id Unique identifier of the step	get
bool	IsLastStep Determines whether this step is last in the step sequence	get
string	Name Step name	get
int	StepNumber Step order number	get

Methods

Public methods

Returns	Name
Task	GetStepViewAsync(IReadOnlyDictionary<string, string> settings, IReadOnlyDictionary<string, IReadOnlyDictionary> previousSettings)
string	GetViewId() Retrieves the id of the view

Details

Summary

Interface for plugin steps

Methods

GetStepViewAsync

public abstract Task GetStepViewAsync(IReadOnlyDictionary<string, string> settings, IReadOnlyDictionary<string, IReadOnlyDictionary> previousSettings)

Arguments

Type	Name	Description
IReadOnlyDictionary<string, string>	settings
IReadOnlyDictionary<string, IReadOnlyDictionary>	previousSettings

GetViewId

public abstract string GetViewId()

Summary

Retrieves the id of the view

Returns

View id

Properties

Id

public abstract string Id { get }

Summary

Unique identifier of the step

Name

public abstract string Name { get }

Summary

Step name

StepNumber

public abstract int StepNumber { get }

Summary

Step order number

IsLastStep

public abstract bool IsLastStep { get }

Summary

Determines whether this step is last in the step sequence

Generated with MarkDoc