ModularVisibilityAction

ObjectAction<1>ObjectActionAction

[IoId("00000000-9e21-4a3b-b6c8-3f51d2e7a405")] [UiName("Modular Visibility")] public sealed class ModularVisibilityAction : ObjectAction<ModularComponent>

Undo action for hiding or showing an optional parameter on a ModularComponent. It records both the visibility flag and the cached wire string stored in the parameter's CustomValues so that both pieces of state are reverted together.

Constructors

ModularVisibilityAction

public ModularVisibilityAction(IReader reader)

Parameters:

reader (IReader)

ModularVisibilityAction

public ModularVisibilityAction(ModularComponent component, Side side, int index, bool oldVisible, bool newVisible, string oldHiddenWires, string newHiddenWires)

Parameters:

component (ModularComponent)
side (Side)
index (int)
oldVisible (bool)
newVisible (bool)
oldHiddenWires (string)
newHiddenWires (string)

Properties

Id

public Guid Id { get; }

Gets the IDocumentObject.InstanceId of the object associated with this action.

inherited fromObjectAction

Index

public int Index { get; }

NewHiddenWires

public string NewHiddenWires { get; }

NewVisible

public bool NewVisible { get; }

OldHiddenWires

public string OldHiddenWires { get; }

OldVisible

public bool OldVisible { get; }

Response

public Effects Response { get; }

Gets the automatic response required by this action.

inherited fromAction

Side

public Side Side { get; }

State

public State State { get; }

Gets the state this action is in.

inherited fromAction

Methods

Extends

public virtual bool Extends(Action action)

Override this method to indicate this action extends another action, and can thus be dropped from a sequence of actions.

inherited fromAction

Parameters:

action (Action)

PerformRedo

public bool PerformRedo(Document doc)

Redo this action. This is only allowed if the Action.State equals State.Redo.

inherited fromAction

Parameters:

doc (Document)

PerformRedoInternal

protected sealed override void PerformRedoInternal(Document doc, IDocumentObject obj)

inherited fromObjectAction<T>

Parameters:

doc (Document)
obj (IDocumentObject)

Overrides: ObjectAction.PerformRedoInternal

PerformRedoInternal

protected sealed override void PerformRedoInternal(Document doc)

inherited fromObjectAction

Parameters:

doc (Document)

Overrides: Action.PerformRedoInternal

PerformRedoInternalT

protected override void PerformRedoInternalT(Document doc, ModularComponent obj)

Parameters:

doc (Document)
obj (ModularComponent)

Overrides: ObjectAction<T>.PerformRedoInternalT

PerformUndo

public bool PerformUndo(Document doc)

Undo this action. This is only allowed if the Action.State equals State.Undo.

inherited fromAction

Parameters:

doc (Document)

PerformUndoInternal

protected sealed override void PerformUndoInternal(Document doc, IDocumentObject obj)

inherited fromObjectAction<T>

Parameters:

doc (Document)
obj (IDocumentObject)

Overrides: ObjectAction.PerformUndoInternal

PerformUndoInternal

protected sealed override void PerformUndoInternal(Document doc)

inherited fromObjectAction

Parameters:

doc (Document)

Overrides: Action.PerformUndoInternal

PerformUndoInternalT

protected override void PerformUndoInternalT(Document doc, ModularComponent obj)

Parameters:

doc (Document)
obj (ModularComponent)

Overrides: ObjectAction<T>.PerformUndoInternalT

PrepareRedo

public bool PrepareRedo(Document doc)

Run the preperatory work for a redo operation. The Action.PerformRedo(Document) method ought never be called without a preceding call to Action.PrepareRedo(Document), although note that a call to Action.PrepareRedo(Document) is not necessarily followed by a call to Action.PerformRedo(Document).

inherited fromAction

Parameters:

doc (Document)

PrepareRedoInternal

protected sealed override void PrepareRedoInternal(Document doc, IDocumentObject obj)

inherited fromObjectAction<T>

Parameters:

doc (Document)
obj (IDocumentObject)

Overrides: ObjectAction.PrepareRedoInternal

PrepareRedoInternal

protected sealed override void PrepareRedoInternal(Document doc)

inherited fromObjectAction

Parameters:

doc (Document)

Overrides: Action.PrepareRedoInternal

PrepareRedoInternalT

protected virtual void PrepareRedoInternalT(Document doc, T obj)

inherited fromObjectAction<T>

Parameters:

doc (Document)
obj (T)

PrepareUndo

public bool PrepareUndo(Document doc)

Run the preperatory work for an undo operation. The Action.PerformUndo(Document) method ought never be called without a preceding call to Action.PrepareUndo(Document), although note that a call to Action.PrepareUndo(Document) is not necessarily followed by a call to Action.PerformUndo(Document).

inherited fromAction

Parameters:

doc (Document)