IGH_UndoAction

References
public interface IGH_UndoAction : GH_ISerializable
Base interface for all undo/redo actions

Properties

ExpiresDisplay

#
bool ExpiresDisplay { get; }
Gets the display expiration flag for this event. If True, the Rhino viewports will be redrawn once the entire undo record has been completed. If ExpiresSolution is set to true, ExpriresDisplay is implied.

ExpiresSolution

#
bool ExpiresSolution { get; }
Gets the solution expiration flag for this event. If True, the solution needs to be recalculated once the entire undo record has been completed.

State

#
GH_UndoState State { get; }
Gets the current state of the undo action.

Methods

Read

bool Read(GH_IReader reader)
This method is called whenever the instance is required to deserialize itself.
inherited fromGH_ISerializable
Parameters:
reader (GH_IReader)Reader object to deserialize from.
Returns: True on success, false on failure.

Redo

#
void Redo(GH_Document doc)
Redo the action stored in this record.
Parameters:
doc (GH_Document)The target document.
Exceptions:
GH_UndoExceptionThrown when the State flag conflicts with a redo action.

Undo

#
void Undo(GH_Document doc)
Undo the action stored in this record.
Parameters:
doc (GH_Document)The target document.
Exceptions:
GH_UndoExceptionThrown when the State flag conflicts with an undo action.

Write

bool Write(GH_IWriter writer)
This method is called whenever the instance is required to serialize itself.
inherited fromGH_ISerializable
Parameters:
writer (GH_IWriter)Writer object to serialize with.
Returns: True on success, false on failure.