ObjectDisplayAction

ObjectActionAction
[IoId("00000000-3589-490b-b625-004ae53156b3")] [UiName("Object Display")] public sealed class ObjectDisplayAction : ObjectAction
Undo action for object displays.

Constructors

ObjectDisplayAction

#
public ObjectDisplayAction(IDocumentObject obj)
Parameters:
obj (IDocumentObject)

ObjectDisplayAction

#
public ObjectDisplayAction(IReader reader)
Parameters:
reader (IReader)

Properties

Display

#
public ObjectDisplay Display { get; set; }

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 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 override void PerformRedoInternal(Document doc, IDocumentObject obj)
Parameters:
doc (Document)
obj (IDocumentObject)
Overrides: ObjectAction.PerformRedoInternal

PerformRedoInternal

protected sealed override void PerformRedoInternal(Document doc)
inherited fromObjectAction
Parameters:
doc (Document)
Overrides: Action.PerformRedoInternal

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 override void PerformUndoInternal(Document doc, IDocumentObject obj)
Parameters:
doc (Document)
obj (IDocumentObject)
Overrides: ObjectAction.PerformUndoInternal

PerformUndoInternal

protected sealed override void PerformUndoInternal(Document doc)
inherited fromObjectAction
Parameters:
doc (Document)
Overrides: Action.PerformUndoInternal

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 virtual void PrepareRedoInternal(Document doc, IDocumentObject obj)
inherited fromObjectAction
Parameters:
doc (Document)
obj (IDocumentObject)

PrepareRedoInternal

protected sealed override void PrepareRedoInternal(Document doc)
inherited fromObjectAction
Parameters:
doc (Document)
Overrides: Action.PrepareRedoInternal

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)

PrepareUndoInternal

protected virtual void PrepareUndoInternal(Document doc, IDocumentObject obj)
inherited fromObjectAction
Parameters:
doc (Document)
obj (IDocumentObject)

PrepareUndoInternal

protected sealed override void PrepareUndoInternal(Document doc)
inherited fromObjectAction
Parameters:
doc (Document)
Overrides: Action.PrepareUndoInternal

Store

#
public override void Store(IWriter writer)
Parameters:
writer (IWriter)
Overrides: ObjectAction.Store