Class Commands

Inheritance

System.Object

Commands

Implements

System.IDisposable

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.Commands

Assembly: Syncfusion.Spreadsheet.Windows.dll

Syntax

public class Commands : IDisposable

Constructors

Commands(Spreadsheet)

Declaration

public Commands(Spreadsheet sfSpreadsheet)

Parameters

Type	Name	Description
Spreadsheet	sfSpreadsheet

Properties

AutoFitCommand

Command used for performing AutoFit Operations for RowHeight and ColumnWidth

Declaration

public AutoFitCommand AutoFitCommand { get; set; }

Property Value

Type
AutoFitCommand

ClearContents

Clear the contents from the range.

Declaration

public ClearCommand ClearContents { get; set; }

Property Value

Type
ClearCommand

ConditionalFormattingColorScales

Command used for applying the databars for the cells

Declaration

public ConditionalFormattingColorScalesCommand ConditionalFormattingColorScales { get; set; }

Property Value

Type
ConditionalFormattingColorScalesCommand

ConditionalFormattingDataBars

Command used for applying the databars for the cells

Declaration

public ConditionalFormattingDataBarsCommand ConditionalFormattingDataBars { get; set; }

Property Value

Type
ConditionalFormattingDataBarsCommand

ConditionalFormattingIconSets

Command used for applying the databars for the cells

Declaration

public ConditionalFormattingIconSetsCommand ConditionalFormattingIconSets { get; set; }

Property Value

Type
ConditionalFormattingIconSetsCommand

ConditonalFormattingClearRules

Command used for applying Conditions for the cell

Declaration

public ConditionalFormattingClearRulesCommand ConditonalFormattingClearRules { get; set; }

Property Value

Type
ConditionalFormattingClearRulesCommand

ConditonalFormattingHighlightCellsRules

Command used for applying Conditions for the cell

Declaration

public ConditonalFormattingHighlightCellsRulesCommand ConditonalFormattingHighlightCellsRules { get; set; }

Property Value

Type
ConditonalFormattingHighlightCellsRulesCommand

Copy

Command used to Perform Copy Operation

Declaration

public CopyCommand Copy { get; set; }

Property Value

Type
CopyCommand

Cut

Command used to Perform Cut Operation

Declaration

public CutCommand Cut { get; set; }

Property Value

Type
CutCommand

DataValidation

Command used to apply DataValidation

Declaration

public DataValidationCommand DataValidation { get; set; }

Property Value

Type
DataValidationCommand

DecreaseIndent

Command used for Decreasing indent for the cells

Declaration

public DecreaseIndentCommand DecreaseIndent { get; set; }

Property Value

Type
DecreaseIndentCommand

DeleteCells

Command used for Deleting Rows/Columns

Declaration

public DeleteCellsCommand DeleteCells { get; set; }

Property Value

Type
DeleteCellsCommand

DeleteComment

Command used to delete comment for the currentcell

Declaration

public DeleteCommentCommand DeleteComment { get; set; }

Property Value

Type
DeleteCommentCommand

DeleteSheet

Command used for deleting the CurrentSheet

Declaration

public DeleteSheetCommand DeleteSheet { get; set; }

Property Value

Type
DeleteSheetCommand

DeleteSheetColumns

Command used for deleting columns

Declaration

public DeleteSheetColumnsCommand DeleteSheetColumns { get; set; }

Property Value

Type
DeleteSheetColumnsCommand

DeleteSheetRows

Command used for deleting rows

Declaration

public DeleteSheetRowsCommand DeleteSheetRows { get; set; }

Property Value

Type
DeleteSheetRowsCommand

EditComment

Command used to insert comment

Declaration

public EditCommentCommand EditComment { get; set; }

Property Value

Type
EditCommentCommand

FileClose

Command used for Exit the Application

Declaration

public FileCloseCommand FileClose { get; set; }

Property Value

Type
FileCloseCommand

FileEncrypt

Command used for Encrypting the Application with a Password

Declaration

public FileEncryptCommand FileEncrypt { get; set; }

Property Value

Type
FileEncryptCommand

FileNew

Command used for creating a new blank workbook

Declaration

public FileNewCommand FileNew { get; set; }

Property Value

Type
FileNewCommand

FileOpen

Command used for Open the excel files

Declaration

public FileOpenCommand FileOpen { get; set; }

Property Value

Type
FileOpenCommand

FileSave

Command used for Performing Save Operation as Excel File

Declaration

public FileSaveCommand FileSave { get; set; }

Property Value

Type
FileSaveCommand

FileSaveAs

Command used for Save spreadsheet by user given name

Declaration

public FileSaveAsCommand FileSaveAs { get; set; }

Property Value

Type
FileSaveAsCommand

Filter

Command used to apply filtering to the selected ranges.

Declaration

public FilterCommand Filter { get; set; }

Property Value

Type
FilterCommand

FormatAsTable

Command used to table formats.

Declaration

public FormatAsTableCommand FormatAsTable { get; set; }

Property Value

Type
FormatAsTableCommand

FormatBorder

Command used for Applying Borders for cells

Declaration

public FormatBorderCommand FormatBorder { get; set; }

Property Value

Type
FormatBorderCommand

FormatCells

Commands used for formatting cells window.

Declaration

public FormatCellsCommand FormatCells { get; set; }

Property Value

Type
FormatCellsCommand

FormatCellStyle

Command used for applying styles for the Cell

Declaration

public FormatCellStyleCommand FormatCellStyle { get; set; }

Property Value

Type
FormatCellStyleCommand

FormatColumnWidth

Command used for assigning ColumnWidth for Columns

Declaration

public FormatColumnWidthCommand FormatColumnWidth { get; set; }

Property Value

Type
FormatColumnWidthCommand

FormatDefaultColumnWidth

Command used to set Default width

Declaration

public FormatDefaultColumnWidthCommand FormatDefaultColumnWidth { get; set; }

Property Value

Type
FormatDefaultColumnWidthCommand

FormatFontBold

Command used for Applying Font Weight as Bold

Declaration

public FormatFontBoldCommand FormatFontBold { get; set; }

Property Value

Type
FormatFontBoldCommand

FormatFontItalic

Command used for Applying Font Style as Italic

Declaration

public FormatFontItalicCommand FormatFontItalic { get; set; }

Property Value

Type
FormatFontItalicCommand

FormatFontStrikethrough

Command used for Applying TextDecorations as Underline

Declaration

public FormatFontStrikethroughCommand FormatFontStrikethrough { get; set; }

Property Value

Type
FormatFontStrikethroughCommand

FormatFontUnderline

Command used for Applying TextDecorations as Underline

Declaration

public FormatFontUnderlineCommand FormatFontUnderline { get; set; }

Property Value

Type
FormatFontUnderlineCommand

FormatHorizontalAlignment

Command used for Horizontal aligning of text

Declaration

public FormatHorizontalAlignmentCommand FormatHorizontalAlignment { get; set; }

Property Value

Type
FormatHorizontalAlignmentCommand

FormatNumber

Command used for applying Number Format for the cells

Declaration

public FormatNumberCommand FormatNumber { get; set; }

Property Value

Type
FormatNumberCommand

FormatRowHeight

Command used for assigning RowHeight for Rows

Declaration

public FormatRowHeightCommand FormatRowHeight { get; set; }

Property Value

Type
FormatRowHeightCommand

FormatVerticalAlignment

Command used for Vertical aligning of text

Declaration

public FormatVerticalAlignmentCommand FormatVerticalAlignment { get; set; }

Property Value

Type
FormatVerticalAlignmentCommand

FreezeFirstColumn

Command used to freeze the first column

Declaration

public FreezeFirstColumnCommand FreezeFirstColumn { get; set; }

Property Value

Type
FreezeFirstColumnCommand

FreezePanes

Command used to freeze the rows/columns

Declaration

public FreezePanesCommand FreezePanes { get; set; }

Property Value

Type
FreezePanesCommand

FreezeTopRow

Command used to freeze the top row

Declaration

public FreezeTopRowCommand FreezeTopRow { get; set; }

Property Value

Type
FreezeTopRowCommand

Group

Command used for Grouping Rows/Cells

Declaration

public GroupCommand Group { get; set; }

Property Value

Type
GroupCommand

GrowFontSize

Command used for Increasing font size

Declaration

public GrowFontSizeCommand GrowFontSize { get; set; }

Property Value

Type
GrowFontSizeCommand

HiddenCell

Command used for formula hidden in formula bar.

Declaration

public HiddenCellCommand HiddenCell { get; set; }

Property Value

Type
HiddenCellCommand

HideColumns

Command used for Hiding/Unhiding Columns

Declaration

public HideColumnsCommand HideColumns { get; set; }

Property Value

Type
HideColumnsCommand

HideRows

Command used for Hiding/Unhiding Rows

Declaration

public HideRowsCommand HideRows { get; set; }

Property Value

Type
HideRowsCommand

HideSheet

Command used for hiding CurrentSheet

Declaration

public HideSheetCommand HideSheet { get; set; }

Property Value

Type
HideSheetCommand

IncreaseDecreaseDecimalCommand

Command used for Increasing the Decimal Digits

Declaration

public IncreaseDecreaseDecimalCommand IncreaseDecreaseDecimalCommand { get; set; }

Property Value

Type
IncreaseDecreaseDecimalCommand

IncreaseIndent

Command used for Increasing indent for the cells

Declaration

public IncreaseIndentCommand IncreaseIndent { get; set; }

Property Value

Type
IncreaseIndentCommand

InsertCells

Command used for Inseting Rows/Columns

Declaration

public InsertCellsCommand InsertCells { get; set; }

Property Value

Type
InsertCellsCommand

InsertCutCopiedCells

Command used for inserting cut/copied cells in worksheet.

Declaration

public InsertCutCopiedCellsCommand InsertCutCopiedCells { get; set; }

Property Value

Type
InsertCutCopiedCellsCommand

InsertHyperlink

Command used for navigate cells/sheets using Hyperlinks

Declaration

public InsertHyperlinkCommand InsertHyperlink { get; set; }

Property Value

Type
InsertHyperlinkCommand

InsertSheet

Command used for inserting sheets

Declaration

public InsertSheetCommand InsertSheet { get; set; }

Property Value

Type
InsertSheetCommand

InsertSheetColumns

Command used for inserting columns

Declaration

public InsertSheetColumnsCommand InsertSheetColumns { get; set; }

Property Value

Type
InsertSheetColumnsCommand

InsertSheetRows

Command used for inserting Rows

Declaration

public InsertSheetRowsCommand InsertSheetRows { get; set; }

Property Value

Type
InsertSheetRowsCommand

LockCell

Command used for Lock or UnLock the cells

Declaration

public LockCellCommand LockCell { get; set; }

Property Value

Type
LockCellCommand

MergeCells

Command used for Performing Merge Operations like Merge and Center,Merge Across, Merge cells and unmerge cells

Declaration

public MergeCellsCommand MergeCells { get; set; }

Property Value

Type
MergeCellsCommand

NameManager

Declaration

public NameManagerCommand NameManager { get; set; }

Property Value

Type
NameManagerCommand

NewComment

Command used to insert comment

Declaration

public NewCommentCommand NewComment { get; set; }

Property Value

Type
NewCommentCommand

NewNameRange

Command used for show the new name range window

Declaration

public NewNameRangeCommand NewNameRange { get; set; }

Property Value

Type
NewNameRangeCommand

OpenHyperlink

Command used for open the hyperlink

Declaration

public OpenHyperlinkCommand OpenHyperlink { get; set; }

Property Value

Type
OpenHyperlinkCommand

Orientation

Gets or sets a value that indicates the command to rotate the text for the cells.

Declaration

public OrientationCommand Orientation { get; set; }

Property Value

Type
OrientationCommand

OutlineSettings

Command Used to set the Outline Settings

Declaration

public OutlineSettingsCommand OutlineSettings { get; set; }

Property Value

Type
OutlineSettingsCommand

Paste

Command used to perform Paste Operation

Declaration

public PasteCommand Paste { get; set; }

Property Value

Type
PasteCommand

ProtectSheet

Command used for Protecting the Current Sheet

Declaration

public ProtectSheetCommand ProtectSheet { get; set; }

Property Value

Type
ProtectSheetCommand

ProtectWorkbook

Command used for Protecting Workbook

Declaration

public ProtectWorkbookCommand ProtectWorkbook { get; set; }

Property Value

Type
ProtectWorkbookCommand

RemoveHyperlink

Command used for remove the hyperlinks from the range.

Declaration

public RemoveHyperlinkCommand RemoveHyperlink { get; set; }

Property Value

Type
RemoveHyperlinkCommand

RenameSheetCommand

Command used for Renaming the Current Sheet

Declaration

public RenameSheetCommand RenameSheetCommand { get; set; }

Property Value

Type
RenameSheetCommand

ShowFormulaBar

Used to Set the FormulaBar Visibility

Declaration

public FormulaBarVisibilityCommand ShowFormulaBar { get; set; }

Property Value

Type
FormulaBarVisibilityCommand

ShowGridLines

Used to set the GridLinesVisibility

Declaration

public GridLinesVisibilityCommand ShowGridLines { get; set; }

Property Value

Type
GridLinesVisibilityCommand

ShowHeadings

Used to Set the HeaderRowColumn Visibility

Declaration

public HeadingsVisibilityCommand ShowHeadings { get; set; }

Property Value

Type
HeadingsVisibilityCommand

ShrinkFontSize

Command used for Decreasing font size

Declaration

public ShrinkFontSizeCommand ShrinkFontSize { get; set; }

Property Value

Type
ShrinkFontSizeCommand

Spreadsheet

Gets or sets the instance of Spreadsheet.

Declaration

protected Spreadsheet Spreadsheet { get; set; }

Property Value

Type
Spreadsheet

UnFreezePanes

Command used to unfreeze the rows/columns

Declaration

public UnFreezePanesCommand UnFreezePanes { get; set; }

Property Value

Type
UnFreezePanesCommand

Ungroup

Command used for Ungrouping Rows/Columns

Declaration

public UngroupCommand Ungroup { get; set; }

Property Value

Type
UngroupCommand

WrapText

Command used for Wrapping text in cells

Declaration

public WrapTextCommand WrapText { get; set; }

Property Value

Type
WrapTextCommand

Methods

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnCellClick()

Used to Notify when the cell is clicked

Declaration

protected virtual void OnCellClick()

OnClipboardCopy()

used to notify when copy the content

Declaration

protected virtual void OnClipboardCopy()

OnCommentEditing()

Used to Notify when Comment is in Editing

Declaration

protected virtual void OnCommentEditing()

OnCommentEndEdit()

Used to Notify when Editing Comment gets complete

Declaration

protected virtual void OnCommentEndEdit()

OnCurrentCellActivated()

Declaration

protected virtual void OnCurrentCellActivated()

OnCurrentCellEditing()

Used to Notify when Current Cell is in Editing

Declaration

protected virtual void OnCurrentCellEditing()

OnCurrentCellEndEdit()

Used to Notify when Editing complete for the Currentcell

Declaration

protected virtual void OnCurrentCellEndEdit()

OnDeleteComment()

Used to Notify when deleting the Comment from the Current cell

Declaration

protected virtual void OnDeleteComment()

OnFontSizeChanged()

Used to Notify when Increase/Decrease the font size.

Declaration

protected virtual void OnFontSizeChanged()

OnGraphicCellSelectionChanged()

Used to Notify when the Grahich Cells is selected

Declaration

protected virtual void OnGraphicCellSelectionChanged()

OnInitializeCommands()

Declaration

protected virtual void OnInitializeCommands()

OnOrientationChanged()

Used to Notify when Orientation changed.

Declaration

protected virtual void OnOrientationChanged()

OnProtectSheet(IWorksheet)

Used to Notigt when Protecting Sheet

Declaration

protected virtual void OnProtectSheet(IWorksheet worksheet)

Parameters

Type	Name	Description
IWorksheet	worksheet	Worksheet to be protected

OnProtecWorkbook()

Used to Notify when Protecting Workbook

Declaration

protected virtual void OnProtecWorkbook()

OnSelectionChanged()

Used to Notify when Selection is Changed

Declaration

protected virtual void OnSelectionChanged()

OnSheetNavigating()

Used to Notify when sheet nagivated

Declaration

protected virtual void OnSheetNavigating()

OnSheetVisiblityChanged()

Used to notify when hide the sheet

Declaration

protected virtual void OnSheetVisiblityChanged()

OnUnProtectSheet(IWorksheet)

Used to Notify when UnProtecting sheet

Declaration

protected virtual void OnUnProtectSheet(IWorksheet worksheet)

Parameters

Type	Name	Description
IWorksheet	worksheet

OnUnProtectWorkbook()

Used to Notify when Unprotecting Workbook

Declaration

protected virtual void OnUnProtectWorkbook()

RaiseCommandExecuted(String)

Declaration

protected virtual void RaiseCommandExecuted(string commandName)

Parameters

Type	Name	Description
System.String	commandName

RaiseCommandExecuting(String)

Declaration

protected virtual bool RaiseCommandExecuting(string commandName)

Parameters

Type	Name	Description
System.String	commandName

Returns

Type
System.Boolean

Events

CommandExecuted

This event will be triggered after the command is executed.

Declaration

public event CommandExecutionEventHandler CommandExecuted

Event Type

Type
CommandExecutionEventHandler

CommandExecuting

This event will be triggered before executing the command. Command execution can be stopped by setting Cancel property of event argument as true.

Declaration

public event CommandExecutingEventHandler CommandExecuting

Event Type

Type
CommandExecutingEventHandler

Implements

System.IDisposable