Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / ColumnHeader Class / AutoTextIndex Property
Example


In This Topic
    AutoTextIndex Property (ColumnHeader)
    In This Topic
    Gets or sets which column header row displays the automatic text when there are multiple column header rows.
    Syntax
    'Declaration
     
    Public Property AutoTextIndex As Integer
    'Usage
     
    Dim instance As ColumnHeader
    Dim value As Integer
     
    instance.AutoTextIndex = value
     
    value = instance.AutoTextIndex
    public int AutoTextIndex {get; set;}

    Property Value

    Integer row index in the header
    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.AutoTextIndex property to specify which row header column displays the automatic text.

    If you set this property to specify a row to display the automatic text, for example, header row 3, and then later change the number of column header rows to be less than 3, the automatic text is displayed in the bottom row, as if the RowCount property is set to -1. However, if you then change the number of header rows to 3 or greater, the automatic text is again displayed in header row 3.

    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
    This example specifies which column header row displays the automatic label text when there are multiple column headers.
    fpSpread1.ActiveSheet.ColumnHeader.RowCount = 4;
    
    fpSpread1.ActiveSheet.ColumnHeader.AutoTextIndex = 1;
    fpSpread1.ActiveSheet.ColumnHeader.RowCount = 4
    
    fpSpread1.ActiveSheet.ColumnHeader.AutoTextIndex = 1
    See Also