Spread Windows Forms 7.0 Product Documentation
ButtonIndex Property
See Also  Example Support Options
FarPoint.Win Assembly > FarPoint.Win Namespace > SuperEditBase Class : ButtonIndex Property


Glossary Item Box

Gets or sets the index value for the button in the edit control.

Syntax

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

Property Value

Integer representing the index of the button

Remarks

This property lets you track how often the user clicks a controls buttons and which buttons are clicked. When the user clicks a button, the button index (the value of the ButtonIndex property) increments or decrements, depending on which button is clicked.

The button index increases when the user clicks the up spin arrow, pop-up, or right slide button. The button index decreases when the user clicks the down spin arrow, drop-down, or left slide button.

You can limit the range of the button index by setting the ButtonMax and ButtonMin properties. When the button index reaches the value of the ButtonMax or ButtonMin properties, the button index may or may not be reset, depending on the setting of the ButtonWrap property. If the ButtonWrap property is set to true, the button index is reset or wrapped.

The button index is independent of the contents of the edit control. Use the button index to customize button behavior.

To create buttons for an edit control, set the ButtonStyle property to a value other than ButtonStyle.None.

This property is available at run time only.

Example

This example shows the use of this property and setting of several other button-related properties.
C#Copy Code
private void Form1_Load(object sender, System.EventArgs e)
{
control.ButtonStyle=FarPoint.Win.ButtonStyle.Spin;
control.ButtonAlign=FarPoint.Win.ButtonAlign.Left;
control.ButtonIndex=5000;
control.ButtonMin=5;
control.ButtonMax=250000;
control.ButtonMargin=3;
control.ButtonMarginColor=Color.Pink;
control.ButtonColor=Color.Red;
control.ButtonWidth=5;
control.ButtonWrap = false;
}
private void button1_Click(object sender, System.EventArgs e)
{
control.ResetButtonColor();
}
Visual BasicCopy Code
Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
control.ButtonStyle = FarPoint.Win.ButtonStyle.Spin
control.ButtonAlign = FarPoint.Win.ButtonAlign.Left
control.ButtonIndex=5000
control.ButtonMin = 5
control.ButtonMax = 250000
control.ButtonMargin=3
control.ButtonMarginColor=Color.Pink
control.ButtonColor = Color.Red
control.ButtonWidth = 5
control.ButtonWrap = False
End Sub
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
control.ResetButtonColor()
End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

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