GetDirectName Method (DefaultSheetStyleModel)

In This Topic

Gets the name of the direct style assigned to a cell, column, row, or model default.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function GetDirectName( _
   ByVal row As Integer, _
   ByVal column As Integer _
) As String

'Usage
 
Dim instance As DefaultSheetStyleModel
Dim row As Integer
Dim column As Integer
Dim value As String
 
value = instance.GetDirectName(row, column)

public virtual string GetDirectName( 
   int row,
   int column
)

Parameters

row: Model row index of the cell, or -1 to specify a column or model default
column: Model column index of the cell, or -1 to specify a row or model default

Return Value

String containing the name of the style for the specified cell, column, row, or model, or an empty string if the specified cell, column, row, or model has no named style assigned.

Exceptions

Exception	Description
System.IndexOutOfRangeException	Specified row index is not valid; must be between -1 and the total number of rows
System.IndexOutOfRangeException	Specified column index is not valid; must be between -1 and the total number of columns

Remarks

Direct cell styles override direct row styles, which override direct column styles, which override model default styles. Direct row styles use -1 for the column, direct column styles use -1 for the row, and model default styles use -1 for both the row and column.

Example

This example creates a new NamedStyle object. The background color of the NamedStyle is set to yellow and the Name is set to "Yellow Cell". The value from the GetDirectName method is returned to a list box.

private void Page_Load(object sender,System.EventArgs e)
{
if(this.IsPostBack)return;

FarPoint.Web.Spread.Model.DefaultSheetStyleModel model=(FarPoint.Web.Spread.Model.DefaultSheetStyleModel)FpSpread1.Sheets[0].StyleModel;
FarPoint.Web.Spread.NamedStyle style=new FarPoint.Web.Spread.NamedStyle();
style.Name="YellowCell";
style.BackColor=Color.Yellow;
FpSpread1.NamedStyles.Add(style);

model.SetDirectName(0,0,"YellowCell");
ListBox1.Items.Add(model.GetDirectName(0,0));
}

Visual Basic

Private Sub Page_Load(ByVal sender As System.Object,ByVal e As System.EventArgs)Handles MyBase.Load
If(IsPostBack)Then Return

Dim model As FarPoint.Web.Spread.Model.DefaultSheetStyleModel=FpSpread1.Sheets(0).StyleModel
Dim style As New FarPoint.Web.Spread.NamedStyle()
style.Name="YellowCell"
style.BackColor=Color.Yellow
FpSpread1.NamedStyles.Add(style)

model.SetDirectName(0,0,"YellowCell")
ListBox1.Items.Add(model.GetDirectName(0,0))
End Sub

Reference

DefaultSheetStyleModel Class
DefaultSheetStyleModel Members
GetDirectAltRowName Method
GetDirectInfo Method
SetDirectInfo Method
SetDirectName Method
NamedStyles Property

Product Support Forum | Print this page