ButtonWrap Property

Gets or sets whether the button index wraps when it reaches the values specified by the ButtonMin or ButtonMax properties.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Property ButtonWrap As Boolean

'Usage
 
Dim instance As SuperEditBase
Dim value As Boolean
 
instance.ButtonWrap = value
 
value = instance.ButtonWrap

public virtual bool ButtonWrap {get; set;}

Property Value

Boolean value: true for wrapping back to the beginning index when it reaches the end; false otherwise

Remarks

When the user clicks a button that would change the value of the edit control to exceed the maximum or minimum value allowed, the value in the control wraps at the value specified by the minimum and maximum value settings.

The ButtonIndex 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.

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.

When the ButtonWrap property is set to false, the button index does not wrap when it reaches the value of the ButtonMin or ButtonMax property and a UserError event occurs when the user clicks a button that would make the button index exceed the value of the ButtonMax or ButtonMin properties.

The ButtonWrap property has an effect only when the ButtonStyle property is set to a value other than ButtonStyle.None.

Example

This example shows the use of this property and setting of several other button-related properties.

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 Basic

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

Reference

SuperEditBase Class
SuperEditBase Members
ButtonIndex Property
ButtonMax Property
ButtonMin Property
ButtonStyle Property
UserError Event