Class HistoryCommand
A class that encapsulates a command to be executed at a later point in time.
Inheritance
System.Object
HistoryCommand
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Spreadsheet.History
Assembly: Syncfusion.Spreadsheet.Windows.dll
Syntax
public abstract class HistoryCommand : HistoryCommandBaseRemarks
The Execute(CommandMode) method is overriden in specialized command classes and performs the command that is saved in this command.
Constructors
HistoryCommand()
Initializes a new HistoryCommand.
Declaration
protected HistoryCommand()HistoryCommand(Spreadsheet)
Initializes a new HistoryCommand and associates it with a
Declaration
protected HistoryCommand(Spreadsheet sfSpreadsheet)Parameters
| Type | Name | Description |
|---|---|---|
| Spreadsheet | sfSpreadsheet |
Properties
Description
Gets a description for the command.
Declaration
public override string Description { get; }Property Value
| Type |
|---|
| System.String |
Overrides
Methods
Execute(CommandMode)
Executes the transaction command in Spreadsheet.
Declaration
public override void Execute(CommandMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| CommandMode | mode | Holds the current process in SfSpreadsheet(either undo or redo). |
Overrides
Pop(CommandMode)
Returns a reference to the latest command in the stack and removes the command from the stack.
Declaration
public HistoryCommandBase Pop(CommandMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| CommandMode | mode |
Returns
| Type | Description |
|---|---|
| HistoryCommandBase | A reference to the latest HistoryCommandBase command. |
SetDescription(String)
Changes the description of this command.
Declaration
protected void SetDescription(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | The new description text. |