ButtonWrap プロパティ

ボタンインデックスがButtonMinプロパティまたはButtonMaxプロパティで指定した値に達したとき折り返すどうかを取得または設定します。

構文

Visual Basic
C#

'Declaration
 
Public Overridable Property ButtonWrap As Boolean

'使用法
 
Dim instance As SuperEditBase
Dim value As Boolean
 
instance.ButtonWrap = value
 
value = instance.ButtonWrap

public virtual bool ButtonWrap {get; set;}

プロパティ値

Boolean 値：インデックスが終わりに達したときに最初のインデックスに折り返す場合は True、それ以外の場合は False

解説

ユーザーがボタンをクリックしたことで編集コントロールの値が変更されて許容最大値または最小値を超えると、コントロールの値は最小値と最大値の設定で指定された値の間を折り返します。

ButtonIndexプロパティを使用すると、ユーザーがコントロールのボタンをクリックした回数とクリックしたボタンを追跡できます。ユーザーがボタンをクリックすると、クリックしたボタンに応じてボタンインデックス（ButtonIndexプロパティの値）が増減します。

ボタンインデックスの範囲を制限するには、ButtonMaxプロパティとButtonMinプロパティを設定します。ボタンインデックスがButtonMaxプロパティまたはButtonMinプロパティの値に達したときにボタンインデックスがリセットされるかどうかは、ButtonWrapプロパティの設定によって決まります。ButtonWrapプロパティをTrueに設定した場合、ボタンインデックスはリセットされます（折り返されます）。

ButtonWrapプロパティをFalseに設定すると、ButtonMinまたはButtonMaxプロパティの値に達したとき、ボタンインデックスは折り返されません。ユーザーがボタンをクリックしたことでボタンインデックスがButtonMaxまたはButtonMinプロパティの値を超えると、UserErrorイベントが発生します。

ButtonWrapプロパティが効力を持つのは、ButtonStyleプロパティがButtonStyle.None以外の値に設定されている場合のみです。

例

次のサンプルコードは、このプロパティと、その他のいくつかのボタン関連プロパティの使用方法を示します。

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

参照

SuperEditBase クラス
 SuperEditBase メンバ
 ButtonIndex プロパティ
 ButtonMax プロパティ
 ButtonMin プロパティ
 ButtonStyle プロパティ
 UserError イベント