GetDirectAltRowName Method (DefaultSheetStyleModel)

In This Topic

Gets the style name for an alternating row style.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function GetDirectAltRowName( _
   ByVal index As Integer _
) As String

'Usage
 
Dim instance As DefaultSheetStyleModel
Dim index As Integer
Dim value As String
 
value = instance.GetDirectAltRowName(index)

public virtual string GetDirectAltRowName( 
   int index
)

Parameters

index: Index of the alternating row style to set

Return Value

String containing the name of the style of the specified alternating row, or an empty string if the specified alternating row index has no named style assigned

Exceptions

Exception	Description
System.IndexOutOfRangeException	Specified index is not valid; must be between 0 and the total number of styles

Remarks

The index must be between 0 and the value of the AltRowCount property minus 1

Example

This example creates a new NamedStyle object. The name and the background color properties of the NamedStyle are set, and the name of the NamedStyle is retrieved using this method.

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;

model.SetDirectAltRowInfo(0,style);
ListBox1.Items.Add("StyleName:"+model.GetDirectAltRowName(0));

FarPoint.Web.Spread.StyleInfostyle1=model.GetDirectAltRowInfo(0,null);
ListBox1.Items.Add("BackColor:"+style1.BackColor.ToString());
}

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

model.SetDirectAltRowInfo(0,style)
ListBox1.Items.Add("StyleName:"&model.GetDirectAltRowName(0))

Dim style1 As FarPoint.Web.Spread.StyleInfo=model.GetDirectAltRowInfo(0,NoThing)
ListBox1.Items.Add("BackColor:"&style1.BackColor.ToString())
End Sub

Reference

DefaultSheetStyleModel Class
DefaultSheetStyleModel Members
GetDirectAltRowInfo Method
SetDirectAltRowInfo Method
GetDirectName Method
SetDirectAltRowName Method
AltRowCount Property
NamedStyles Property

Product Support Forum | Print this page