Spread for ASP.NET 7.0 Product Documentation
AutoTextIndex Property
See Also  Example Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > ColumnHeader Class : AutoTextIndex Property


Glossary Item Box

Gets or sets which column header row displays the automatic text when there are multiple column header rows.

Syntax

Visual Basic (Declaration) 
Public Property AutoTextIndex As Integer
Visual Basic (Usage)Copy Code
Dim instance As ColumnHeader
Dim value As Integer
 
instance.AutoTextIndex = value
 
value = instance.AutoTextIndex
C# 
public int AutoTextIndex {get; set;}

Property Value

Integer number representing the zero-based row index

Remarks

If your header has multiple column header rows, you can specify which header row displays the automatic text by setting this property. To specify the index, set the property to a value between 0 and n-1, where 0 is the top row and n is the number of header rows. Any value above n-1 simply puts the automatic text in the bottom row.

The automatic text is the text automatically assigned to header cells by Spread. By default, for columns the automatic text is letters. Use the AutoText property to change the automatic text to blank or to numbers. Use the AutoText property to specify what automatic text, if any, is displayed in the column headers. If you set the AutoText property to Blank, the column header row specified by the AutoTextIndex property is blank. Use the RowCount property  to specify how many column header rows the component displays. Use the RowHeader object AutoTextIndex property to specify which row header column displays the automatic text.

For best results set the RowCount property before setting the AutoFilterIndex property.

This property does not have an effect unless the Visible property (or the SheetView ColumnHeaderVisible property) is set to true and the column header rows are not hidden.

For more information about automatic text, see Customizing the Default Header Labels.

Example

C#Copy Code
FarPoint.Web.Spread.ColumnHeader colhdr;
colhdr = FpSpread1.ActiveSheetView.ColumnHeader;
colhdr.RowCount = 3;                                              //  column header has three rows 
colhdr.AutoText = FarPoint.Web.Spread.HeaderAutoText.Letters;     //  column header displays letters 
colhdr.AutoTextIndex = 1;                                         //  automatic text in second zero-index row 
Visual BasicCopy Code
Dim colhdr As FarPoint.Web.Spread.ColumnHeader
colhdr = FpSpread1.ActiveSheetView.ColumnHeader
colhdr.RowCount = 3                                              ' column header has three rows         
colhdr.AutoText = FarPoint.Web.Spread.HeaderAutoText.Letters     ' column header displays letters
colhdr.AutoTextIndex = 1                                         ' automatic text in second zero-index row

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.