CommandName Property (ButtonCellType)

In This Topic

Gets or sets the command name for the button.

Syntax

Visual Basic
C#

'Declaration
 
Public Property CommandName As String

'Usage
 
Dim instance As ButtonCellType
Dim value As String
 
instance.CommandName = value
 
value = instance.CommandName

public string CommandName {get; set;}

Property Value

String containing the name of the command

Example

This example shows the use of this method by creating a spreadsheet, setting the first two columns of cells to be button cells and constructing the buttons with a CommandNames of "MyRed" and "MyBlue". (In the ButtonCommand event, the CommandNames are queried and the background color of the spreadsheet is changed depending on the CommandName.)

FarPoint.Web.Spread.ButtonCellType btn = new FarPoint.Web.Spread.ButtonCellType("MyRed");
FarPoint.Web.Spread.ButtonCellType btn1 = new FarPoint.Web.Spread.ButtonCellType("MyBlue");
FarPoint.Web.Spread.StyleInfo style = new FarPoint.Web.Spread.StyleInfo();
FarPoint.Web.Spread.StyleInfo style1 = new FarPoint.Web.Spread.StyleInfo();
FpSpread1.Sheets[0].ColumnCount = 7;
FpSpread1.Sheets[0].RowCount = 50;
btn.ButtonType = FarPoint.Web.Spread.ButtonType.PushButton;
btn1.ButtonType = FarPoint.Web.Spread.ButtonType.PushButton;
btn.CommandName = "MyRed";
btn1.CommandName = "MyBlue";
style.CellType = btn;
style1.CellType = btn1;
FpSpread1.Sheets[0].SetStyleInfo(-1, 0, style);
FpSpread1.Sheets[0].SetStyleInfo(-1, 1, style1);

private void FpSpread1_ButtonCommand(object sender, FarPoint.Web.Spread.SpreadCommandEventArgs e)
{
    if(e.CommandName == "MyRed")
    {
        FpSpread1.BackColor = Color.Red;
    }
    else if(e.CommandName == "MyBlue")
    {
        FpSpread1.BackColor = Color.Blue;
    }
}

Visual Basic

Dim btn As New FarPoint.Web.Spread.ButtonCellType("MyRed")
Dim btn1 As New FarPoint.Web.Spread.ButtonCellType("MyBlue")
Dim style As New FarPoint.Web.Spread.StyleInfo()
Dim style1 As New FarPoint.Web.Spread.StyleInfo()
FpSpread1.Sheets(0).ColumnCount = 7
FpSpread1.Sheets(0).RowCount = 50
btn.ButtonType = FarPoint.Web.Spread.ButtonType.PushButton
btn1.ButtonType = FarPoint.Web.Spread.ButtonType.PushButton
btn.CommandName = "MyRed"
btn1.CommandName = "MyBlue"
style.CellType = btn
style1.CellType = btn1
FpSpread1.Sheets(0).SetStyleInfo(-1, 0, style)
FpSpread1.Sheets(0).SetStyleInfo(-1, 1, style1)

Private Sub FpSpread1_ButtonCommand(ByVal sender As Object, ByVal e As FarPoint.Web.Spread.SpreadCommandEventArgs) Handles
FpSpread1.ButtonCommand
    If e.CommandName = "MyRed" Then
        FpSpread1.BackColor = Color.Red
    ElseIf e.CommandName = "MyBlue" Then
        FpSpread1.BackColor = Color.Blue
    End If
End Sub

Reference

ButtonCellType Class
ButtonCellType Members

Product Support Forum | Print this page