Button クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
タッチ イベントに反応するボタン View。
[Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._ButtonRenderer))]
public class Button : Xamarin.Forms.View, Xamarin.Forms.IBorderElement, Xamarin.Forms.IButtonController, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.Button>, Xamarin.Forms.IImageController, Xamarin.Forms.IImageElement, Xamarin.Forms.Internals.IFontElementtype Button = class
inherit View
interface IFontElement
interface IBorderElement
interface IButtonController
interface IViewController
interface IVisualElementController
interface IElementController
interface IElementConfiguration<Button>
interface IImageController
interface IImageElement- 継承
- 属性
- 実装
注釈
ボタンの外観
Button クラスは、すべてのViewオブジェクトに共通する外観プロパティに加えて、、BorderWidth、BorderRadius、および の各プロパティをBorderColorImage提供します。
次の XAML コード スニペットは、これらのプロパティを使用して、"Press me!" というテキストを含む基本的なボタンを作成する方法を示しています。 ボタンが表示される画像は、レイアウトの開始側 (左から右の言語の左側) に表示されます。
<Button Text="Press me!"
Image="icon.png"
BackgroundColor="White"
BorderRadius="10"
BorderWidth="2"
BorderColor="Black"
HorizontalOptions="Center"/>
上記の XAML で画像を icon.png 表示するには、開発者は、各プラットフォーム プロジェクトに固有の適切なビルド アクションを使用して、適切な場所に配置する必要があります。 Images トピックでは、Xamarin.Forms でのイメージの操作に関するこれと他の重要な詳細について説明します。
Button イベント
ボタンは、および の各イベントを使用PressedReleasedして、プレス イベント、リリース イベント、およびClickedクリック イベントを開発者に通知します。
次の XAML は、これらのボタン イベントの 2 つにハンドラーを割り当てます。
<Button x:Name="PressMeButton"
Text="Press Me!"
Pressed="PressMeButton_Pressed"
Clicked="PressMeButton_Clicked"/>
上記の XAML では、分離コード ファイル内の次のイベント ハンドラーによって、これらのイベントが発生したときにボタンのテキストが変更されます。
private void PressMeButton_Pressed(object sender, EventArgs e)
{
(sender as Button).Text = "You pressed me!";
}
private void PressMeButton_Clicked(object sender, EventArgs e)
{
(sender as Button).Text = "I was just clicked!";
}
コマンド
ボタン用のコマンド API を使用すると、開発者は Clicked イベントに応答してコマンドを実行できます。
次の XAML は、ボタンがクリックされたときに実行するコマンドを指定します。 コマンドは、 という名前 modelUpdateCountのビュー モデル プロパティを更新します。このプロパティは、ボタンを使用してそのテキストを更新するために使用します。 (テキスト バインドは完全のために表示されます。関連するのはコマンド コードのみです。
<Button Text="{Binding modelUpdateCount, StringFormat='Number of updates to the model: {0:D}'}"
Command="{Binding IncrementLabelCommand}" />
上記の XAML では、開発者は最初にビュー モデルで プロパティを定義 IncrementLabelCommand し、後で コマンドをインスタンス化する メソッドを実装します。
public ICommand IncrementLabelCommand { get; private set; }
void IncrementLabel()
{
modelUpdateCount++;
}
次に、開発者は メソッド (またはアクション) を使用してコマンドを初期化します。
public ViewModelDemo()
{
IncrementLabelCommand = new Command(IncrementLabel);
}
最後に、開発者は、メイン ページのコンストラクターのバインド コンテキストを、 プロパティが実装されているビュー モデルのバインディング コンテキストに設定する必要があります。
public MainPage()
{
InitializeComponent();
BindingContext = new ViewModelDemo();
}
コンストラクター
| Button() |
Button クラスの新しいインスタンスを初期化します。 |
フィールド
| BorderColorProperty |
バインド可能なプロパティ BorderColor のバッキング ストア。 |
| BorderRadiusProperty |
互換性のために残されています。
バインド可能なプロパティ BorderRadius のバッキング ストア。 |
| BorderWidthProperty |
バインド可能なプロパティ BorderWidth のバッキング ストア。 |
| CharacterSpacingProperty |
バインド可能なプロパティ CharacterSpacing のバッキング ストア。 |
| CommandParameterProperty |
バインド可能なプロパティ CommandParameter のバッキング ストア。 |
| CommandProperty |
バインド可能なプロパティ Command のバッキング ストア。 |
| ContentLayoutProperty |
バインド可能なプロパティ ContentLayout のバッキング ストア。 |
| CornerRadiusProperty |
バインド可能なプロパティ CornerRadius のバッキング ストア。 |
| FontAttributesProperty |
バインド可能なプロパティ FontAttributes のバッキング ストア。 |
| FontFamilyProperty |
バインド可能なプロパティ FontFamily のバッキング ストア。 |
| FontProperty |
バインド可能なプロパティ Font のバッキング ストア。 |
| FontSizeProperty |
バインド可能なプロパティ FontSize のバッキング ストア。 |
| ImageProperty |
互換性のために残されています。
バインド可能なプロパティ Image のバッキング ストア。 |
| ImageSourceProperty |
バインド可能なプロパティ ImageSource のバッキング ストア。 |
| IsPressedProperty |
バインド可能なプロパティ IsPressed のバッキング ストア。 |
| PaddingProperty |
バインド可能なプロパティ Padding のバッキング ストア。 |
| TextColorProperty |
バインド可能なプロパティ TextColor のバッキング ストア。 |
| TextProperty |
バインド可能なプロパティ Text のバッキング ストア。 |
| TextTransformProperty |
バインド可能なプロパティ TextTransform のバッキング ストア。 |
プロパティ
| AnchorX |
すべての変換の中心点の X 座標を、要素の境界からの相対位置で取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| AnchorY |
すべての変換の中心点の Y 座標を、要素の境界からの相対位置で取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| AutomationId |
自動化フレームワークがこの要素を見つけ、対話することを可能にする値を取得または設定します。 (継承元 Element) |
| Background |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| BackgroundColor |
VisualElement の背景を塗りつぶす色を取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| Batched |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| Behaviors |
この要素に関連付けられている動作の一覧を取得します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| BindingContext |
バインドされたプロパティのうち、この BindableObject に属するプロパティの対象となるプロパティが含まれるオブジェクトを取得または設定します。 (継承元 BindableObject) |
| BorderColor |
ボタンの境界線のストローク色を表す色を取得または設定します。 これはバインド可能なプロパティです。 |
| BorderRadius |
互換性のために残されています。
境界線の角の半径を取得または設定します。 これはバインド可能なプロパティです。 |
| BorderWidth |
境界線の幅を取得または設定します。 これはバインド可能なプロパティです。 |
| Bounds |
要素の範囲を取得します。 (継承元 VisualElement) |
| CharacterSpacing |
タッチ イベントに反応するボタン View。 |
| class |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| ClassId |
意味的に同類の要素の集合を識別するために使用される値を取得または設定します。 (継承元 Element) |
| Clip |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| Command |
このボタンがアクティブになったときに呼び出すコマンドを取得または設定します。 これはバインド可能なプロパティです。 |
| CommandParameter |
Command プロパティに渡すパラメーターを取得または設定します。 これはバインド可能なプロパティです。 |
| ContentLayout |
ボタン画像の位置と、ボタン画像とボタンテキストの間隔を制御するオブジェクトを取得または設定します。 |
| CornerRadius |
デバイス非依存ユニットでボタンの角の半径を取得または設定します。 |
| DisableLayout |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| Dispatcher |
タッチ イベントに反応するボタン View。 (継承元 BindableObject) |
| EffectControlProvider |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| Effects |
この項目に適用される効果の一覧。 (継承元 Element) |
| FlowDirection |
レイアウトのフロー方向を取得または設定します。 (継承元 VisualElement) |
| Font |
ラベル テキストのフォントを取得または設定します。 これはバインド可能なプロパティです。 |
| FontAttributes |
ボタン テキストのフォントが太字か、斜体か、そのいずれでもないかを示す値を取得します。 |
| FontFamily |
ボタン テキストのフォントが属するフォント ファミリを取得します。 |
| FontSize |
ボタン テキストのフォントのサイズを取得または設定します。 |
| GestureController |
ビューのジェスチャのコントローラーを取得します。 (継承元 View) |
| GestureRecognizers |
このビューに関連付けられているジェスチャ レコグナイザーのコレクション。 (継承元 View) |
| Height |
この要素の描画時の現在の高さを取得します。 これはバインド可能な読み取り専用プロパティです。 (継承元 VisualElement) |
| HeightRequest |
この要素の必要な高さオーバーライドを取得または設定します。 (継承元 VisualElement) |
| HorizontalOptions |
レイアウト サイクルで要素がどのように配置されるかを定義する LayoutOptions を取得または設定します。 これはバインド可能なプロパティです。 (継承元 View) |
| Id |
アプリケーションの実行により要素を一意に識別するために使用できる値を取得します。 (継承元 Element) |
| Image |
互換性のために残されています。
ボタンのテキストの隣に表示される任意の画像ソースを取得または設定します。 これはバインド可能なプロパティです。 |
| ImageSource |
ボタンのビットマップ画像を表示します。 |
| InputTransparent |
この要素をユーザー インターフェイス サイクルに含めるかどうかを示す値を取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| IsEnabled |
この要素をユーザー インターフェイスで有効にするかどうかを示す値を取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| IsFocused |
この要素に現在フォーカスがあるかどうかを示す値を取得します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| IsInNativeLayout |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| IsNativeStateConsistent |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| IsPlatformEnabled |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| IsPressed |
Xamarin.Forms プラットフォームによる内部使用向け。 |
| IsTabStop |
この要素がタブ ナビゲーションに含まれるかどうかを示す値を取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| IsVisible |
要素をビジュアル ツリーに含めるかどうかを決定する値を取得します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| LogicalChildren |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| Margin |
ビューの余白を取得または設定します。 (継承元 View) |
| MinimumHeightRequest |
レイアウト時に要素によって要求される高さの最小値をオーバーライドする値を取得または設定します。 (継承元 VisualElement) |
| MinimumWidthRequest |
レイアウト時に要素によって要求される最小幅をオーバーライドする値を取得または設定します。 (継承元 VisualElement) |
| Navigation |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| NavigationProxy |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| Opacity |
描画時に要素に適用する不透明度値を取得または設定します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| Padding |
ボタンの埋め込みを取得または設定します。 |
| Parent |
要素の親要素を取得または設定します。 (継承元 Element) |
| ParentView |
互換性のために残されています。
この要素の最も近い祖先 (すなわち VisualElement) である要素を取得します。 (継承元 Element) |
| Platform |
互換性のために残されています。
タッチ イベントに反応するボタン View。 (継承元 Element) |
| RealParent |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| Resources |
ローカルのリソース ディクショナリを取得または設定します。 (継承元 VisualElement) |
| Rotation |
要素の描画時に、Z 軸を中心とする回転 (アフィン回転) (度単位) を取得または設定します。 (継承元 VisualElement) |
| RotationX |
要素の描画時に、X 軸を中心とする回転 (パースペクティブ回転) (度単位) を取得または設定します。 (継承元 VisualElement) |
| RotationY |
要素の描画時に、Y 軸を中心とする回転 (パースペクティブ回転) (度単位) を取得または設定します。 (継承元 VisualElement) |
| Scale |
要素に適用するスケール ファクターを取得または設定します。 (継承元 VisualElement) |
| ScaleX |
X 方向に適用するスケールの値を取得または設定します。 (継承元 VisualElement) |
| ScaleY |
Y 方向に適用するスケールの値を取得または設定します。 (継承元 VisualElement) |
| Style |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| StyleClass |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| StyleId |
要素を一意に識別するユーザー定義の値を取得または設定します。 (継承元 Element) |
| TabIndex |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| Text |
ボタンのコンテンツとして表示されるテキストを取得または設定します。 これはバインド可能なプロパティです。 |
| TextColor |
ボタンのテキストの Color を取得または設定します。 これはバインド可能なプロパティです。 |
| TextTransform |
タッチ イベントに反応するボタン View。 |
| TranslationX |
要素の X 変換差分を取得または設定します。 (継承元 VisualElement) |
| TranslationY |
要素の Y 変換差分を取得または設定します。 (継承元 VisualElement) |
| Triggers |
この要素に関連付けられているトリガーの一覧を取得します。 これはバインド可能なプロパティです。 (継承元 VisualElement) |
| VerticalOptions |
レイアウト サイクルで要素がどのように配置されるかを定義する LayoutOptions を取得または設定します。 これはバインド可能なプロパティです。 (継承元 View) |
| Visual |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| Width |
この要素の描画時の現在の幅を取得します。 これはバインド可能な読み取り専用プロパティです。 (継承元 VisualElement) |
| WidthRequest |
この要素の必要な幅オーバーライドを取得または設定します。 (継承元 VisualElement) |
| X |
この要素の現在の X 位置を取得します。 これはバインド可能な読み取り専用プロパティです。 (継承元 VisualElement) |
| Y |
この要素の現在の Y 位置を取得します。 これはバインド可能な読み取り専用プロパティです。 (継承元 VisualElement) |
メソッド
| ApplyBindings() |
BindingContext にバインディングを適用します。 (継承元 BindableObject) |
| BatchBegin() |
要素のプロパティに対する変更のバッチの開始を通知します。 (継承元 VisualElement) |
| BatchCommit() |
要素へのコマンドのバッチが終端に達したこと、およびこれらのコマンドを今コミットする必要があることを通知します。 (継承元 VisualElement) |
| ChangeVisualState() |
Xamarin.Forms プラットフォームによる内部使用向け。 |
| ClearValue(BindableProperty) |
|
| ClearValue(BindablePropertyKey) |
|
| CoerceValue(BindableProperty) |
タッチ イベントに反応するボタン View。 (継承元 BindableObject) |
| CoerceValue(BindablePropertyKey) |
タッチ イベントに反応するボタン View。 (継承元 BindableObject) |
| Descendants() |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| EffectIsAttached(String) |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| FindByName(String) |
指定した名前を持つ要素を返します。 (継承元 Element) |
| Focus() |
この要素にフォーカスを設定することを試みます。 (継承元 VisualElement) |
| GetChildElements(Point) |
視覚的に、指定した |
| GetSizeRequest(Double, Double) |
互換性のために残されています。
要素の SizeRequest を返します。 このメソッドを呼び出すと、レイアウト サイクルの測定パスが開始されます。 (継承元 VisualElement) |
| GetValue(BindableProperty) |
BindableProperty に含まれる値を返します。 (継承元 BindableObject) |
| GetValues(BindableProperty, BindableProperty) |
互換性のために残されています。
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 BindableObject) |
| GetValues(BindableProperty, BindableProperty, BindableProperty) |
互換性のために残されています。
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 BindableObject) |
| InvalidateMeasure() |
この VisualElement のレイアウトを無効にするために呼び出されるメソッド。 MeasureInvalidated イベントを発生させます。 (継承元 VisualElement) |
| InvalidateMeasureNonVirtual(InvalidationTrigger) |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| IsSet(BindableProperty) |
ターゲット プロパティが存在し、設定されている場合、 |
| Layout(Rectangle) |
レイアウト サイクル中に要素の境界を更新します。 (継承元 VisualElement) |
| Measure(Double, Double, MeasureFlags) |
ビジュアル要素をデバイスに表示するために必要な最小サイズを返します。 (継承元 VisualElement) |
| NativeSizeChanged() |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| On<T>() |
プラットフォーム固有のメソッドを呼び出すことができる、この Button のプラットフォーム固有のインスタンスを返します。 |
| OnBindingContextChanged() |
バインド コンテキストが変更されたときに発生するメソッド。 |
| OnChildAdded(Element) |
アプリケーション開発者は、子が追加されると応答するようにこのメソッドをオーバーライドすることができます。 (継承元 VisualElement) |
| OnChildRemoved(Element) |
互換性のために残されています。
アプリケーション開発者は、子が削除されると応答するようにこのメソッドをオーバーライドすることができます。 (継承元 VisualElement) |
| OnChildRemoved(Element, Int32) |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| OnChildrenReordered() |
ChildrenReordered イベントが生成される直前に毎回呼び出されます。 このイベントに対するクラス処理を追加するには、このメソッドを実装します。 (継承元 VisualElement) |
| OnMeasure(Double, Double) |
レイアウト測定が発生すると呼び出されるメソッド。 (継承元 VisualElement) |
| OnParentSet() |
タッチ イベントに反応するボタン View。 (継承元 NavigableElement) |
| OnPropertyChanged(String) |
バインドされたプロパティが変更されたときに呼び出されるメソッド。 (継承元 Element) |
| OnPropertyChanging(String) |
子クラスからこのメソッドを呼び出し、プロパティで変更が行われることを通知します。 (継承元 BindableObject) |
| OnSizeAllocated(Double, Double) |
レイアウト サイクル中に要素のサイズが設定されると、このメソッドが呼び出されます。 このメソッドは、SizeChanged イベントが生成される直前に呼び出されます。 このイベントに対するクラス処理を追加するには、このメソッドを実装します。 (継承元 VisualElement) |
| OnSizeRequest(Double, Double) |
互換性のために残されています。
このメソッドは、要素の目的のサイズを取得するために、レイアウト サイクルの測定パス中に呼び出されます。 (継承元 VisualElement) |
| OnTabIndexPropertyChanged(Int32, Int32) |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| OnTabStopPropertyChanged(Boolean, Boolean) |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| RemoveBinding(BindableProperty) |
以前に設定されたバインディングを削除します。 (継承元 BindableObject) |
| RemoveDynamicResource(BindableProperty) |
以前に設定された動的リソースを削除します (継承元 Element) |
| SendClicked() |
Xamarin.Forms プラットフォームによる内部使用向け。 |
| SendPressed() |
Xamarin.Forms プラットフォームによる内部使用向け。 |
| SendReleased() |
Xamarin.Forms プラットフォームによる内部使用向け。 |
| SetBinding(BindableProperty, BindingBase) |
プロパティにバインディングを割り当てます。 (継承元 BindableObject) |
| SetDynamicResource(BindableProperty, String) |
キーを指定した DynamicResource を介して更新するこの要素の BindableProperty プロパティを設定します。 (継承元 Element) |
| SetValue(BindableProperty, Object) |
指定したプロパティの値を設定します。 (継承元 BindableObject) |
| SetValue(BindablePropertyKey, Object) |
propertyKey の値を設定します。 (継承元 BindableObject) |
| SetValueCore(BindableProperty, Object, SetValueFlags) |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 BindableObject) |
| SetValueFromRenderer(BindableProperty, Object) |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| SetValueFromRenderer(BindablePropertyKey, Object) |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 Element) |
| SizeAllocated(Double, Double) |
SizeAllocated は、サブツリー レイアウトの開始を通知するためにレイアウト サイクル中に呼び出されます。 (継承元 VisualElement) |
| TabIndexDefaultValueCreator() |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| TabStopDefaultValueCreator() |
タッチ イベントに反応するボタン View。 (継承元 VisualElement) |
| UnapplyBindings() |
以前に設定されたバインディングをすべて解除します。 (継承元 BindableObject) |
| Unfocus() |
この要素へのフォーカスを設定解除します。 (継承元 VisualElement) |
| UpdateFormsText(String, TextTransform) |
タッチ イベントに反応するボタン View。 |
イベント
| BatchCommitted |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| BindingContextChanged |
BindingContext プロパティが変更されるたびに発生します。 (継承元 BindableObject) |
| ChildAdded |
子要素が要素に追加されるたびに発生します。 (継承元 Element) |
| ChildRemoved |
子要素が要素から削除されるたびに発生します。 (継承元 Element) |
| ChildrenReordered |
VisualElement の子の順序が変更されると発生します。 (継承元 VisualElement) |
| Clicked |
ボタンがクリックされたときに発生します。 |
| DescendantAdded |
子要素が要素サブツリーに追加されるたびに発生します。 (継承元 Element) |
| DescendantRemoved |
子要素が要素サブツリーから削除されるたびに発生します。 (継承元 Element) |
| FocusChangeRequested |
Xamarin.Forms プラットフォームによる内部使用向け。 (継承元 VisualElement) |
| Focused |
要素がフォーカスを受け取ると発生します。 (継承元 VisualElement) |
| MeasureInvalidated |
ビジュアル要素のレイアウトが無効になったときに発生するイベント。 (継承元 VisualElement) |
| PlatformSet |
互換性のために残されています。
タッチ イベントに反応するボタン View。 (継承元 Element) |
| Pressed |
ボタンが押されたときに発生します。 |
| PropertyChanged |
プロパティが変更されたときに発生します。 (継承元 BindableObject) |
| PropertyChanging |
プロパティが変更されようとしているときに発生します。 (継承元 BindableObject) |
| Released |
ボタンが放されたときに発生します。 |
| SizeChanged |
この要素の Width プロパティまたは Height プロパティの値が変更されると発生します。 (継承元 VisualElement) |
| Unfocused |
要素がフォーカスを失ったときに発生します。 (継承元 VisualElement) |