IMacroRecording Interface

public interface IMacroRecording

IMacroAction CurrentMacroAction { get; }

Property Value

IMacroAction:

The IMacroAction that is currently being recorded.

Remarks

This method returns null if no macro recording is currently taking place.

IMacroAction LastMacroAction { get; }

Property Value

IMacroAction:

The last IMacroAction that was recorded.

Remarks

After macro recording is stopped, this property contains what was recorded.

MacroRecordingState State { get; }

Property Value

MacroRecordingState:

A MacroRecordingState that specifies the state.

void Cancel()

Remarks

When macro recording is cancelled, the old value of the LastMacroAction property is not overwritten.

void NotifyEditAction(ITextView view, IEditAction action)

Parameter	Type	Description
view	ITextView	The ITextView in which the edit action will attempt to execute.
action	IEditAction	The IEditAction that will execute if its CanExecute(IEditorView) method returns true.

Remarks

Implementations of this method should append the IEditAction to the current macro being recorded if currently in a recording state and the action's CanRecordInMacro property is true.

void Pause()

Remarks

Use the Resume() method to resume recording.

void Record()

Remarks

Use the Stop() method to end recording and save the macro that was recorded.

void Resume()

Remarks

This method should be called after a Pause() to resume recording.

IMacroAction Stop()

Returns

IMacroAction:

The IMacroAction that was recorded.

Remarks

The IMacroAction that is recorded is stored in the LastMacroAction property. If no actions were recorded during this recording session, the old value of the LastMacroAction property will not be overwritten.