PersistentDataAction

ObjectAction<1>ObjectActionAction

[IoId("00000000-3d0b-46ce-9370-059e4f011f28")] [UiName("Parameter Data")] public sealed class PersistentDataAction : ObjectAction<IParameter>

Undo action for parameter persistent data changes.

Constructors

PersistentDataAction

public PersistentDataAction(IParameter parameter, Guid actionIdentifier)

Create a new persistent data undo action.

Parameters:

parameter (IParameter)	Parameter whose persisent data to track.
actionIdentifier (Guid)	Runtime identifier. Subsequent actions for the same parameter with the same identifier are merged into a single action.

PersistentDataAction

public PersistentDataAction(IReader reader)

Parameters:

reader (IReader)

Properties

Data

public ITree Data { get; }

Id

public Guid Id { get; }

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

inherited fromObjectAction

Response

public Effects Response { get; }

Gets the automatic response required by this action.

inherited fromAction

State

public State State { get; }

Gets the state this action is in.

inherited fromAction

Methods

Extends

public override bool Extends(Action action)

Parameters:

action (Action)

Overrides: Action.Extends

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, IParameter obj)

Parameters:

doc (Document)
obj (IParameter)

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, IParameter obj)

Parameters:

doc (Document)
obj (IParameter)

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)