SearchBar 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
用于提供搜索框的 View 控件。
[Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._SearchBarRenderer))]
public class SearchBar : Xamarin.Forms.InputView, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.SearchBar>, Xamarin.Forms.Internals.IFontElement, Xamarin.Forms.ISearchBarControllertype SearchBar = class
inherit InputView
interface IFontElement
interface ISearchBarController
interface IElementConfiguration<SearchBar>- 继承
- 属性
- 实现
注解
以下示例演示了基本用法。
public class App : Application
{
Label resultsLabel;
SearchBar searchBar;
public App ()
{
resultsLabel = new Label {
Text = "Result will appear here.",
VerticalOptions = LayoutOptions.FillAndExpand,
FontSize = 25
};
searchBar = new SearchBar {
Placeholder = "Enter search term",
SearchCommand = new Command(() => {resultsLabel.Text = "Result: " + searchBar.Text + " is what you asked for.";})
};
MainPage = new ContentPage {
Content = new StackLayout {
VerticalOptions = LayoutOptions.Start,
Children = {
new Label {
HorizontalTextAlignment = TextAlignment.Center,
Text = "SearchBar",
FontSize = 50
},
searchBar,
new ScrollView
{
Content = resultsLabel,
VerticalOptions = LayoutOptions.FillAndExpand
}
},
Padding = new Thickness(10, Device.OnPlatform(20, 0, 0), 10, 5)
}
};
}
// OnStart, OnSleep, and OnResume implementations, & etc.
}
构造函数
| SearchBar() |
创建一个新的 SearchBar。 |
字段
| CancelButtonColorProperty |
CancelButtonColor 属性的后备存储。 |
| CharacterSpacingProperty |
用于提供搜索框的 View 控件。 |
| FontAttributesProperty |
FontAttributes 属性的后备存储。 |
| FontFamilyProperty |
FontFamily 属性的后备存储。 |
| FontSizeProperty |
FontSize 属性的后备存储。 |
| HorizontalTextAlignmentProperty |
HorizontalTextAlignment 属性的后备存储。 |
| PlaceholderColorProperty |
PlaceholderColor 属性的后备存储。 |
| PlaceholderProperty |
Placeholder 属性的后备存储。 |
| SearchCommandParameterProperty |
SearchCommandParameter 属性的后备存储。 |
| SearchCommandProperty |
SearchCommand 属性的后备存储。 |
| TextColorProperty |
TextColor 属性的后备存储。 |
| TextProperty |
Text 属性的后备存储。 |
| VerticalTextAlignmentProperty |
用于提供搜索框的 View 控件。 |
属性
| AnchorX |
获取或设置任何转换的中心点的 X 部分，相对于元素的边界。 这是一种可绑定属性。 (继承自 VisualElement) |
| AnchorY |
获取或设置任何转换的中心点的 Y 部分，相对于元素的边界。 这是一种可绑定属性。 (继承自 VisualElement) |
| AutomationId |
获取或设置允许自动化框架查找此元素并与其交互的值。 (继承自 Element) |
| Background |
用于提供搜索框的 View 控件。 (继承自 VisualElement) |
| BackgroundColor |
获取或设置将填充 VisualElement 背景的颜色。 这是一种可绑定属性。 (继承自 VisualElement) |
| Batched |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| Behaviors |
获取与此元素关联的 Behavior 列表。 这是一种可绑定属性。 (继承自 VisualElement) |
| BindingContext |
获取或设置对象，该对象包含将被属于此 BindableObject 的绑定属性设定为目标的属性。 (继承自 BindableObject) |
| Bounds |
获取元素的边界。 (继承自 VisualElement) |
| CancelButtonColor |
获取或设置取消按钮的颜色。 |
| CharacterSpacing |
获取或设置指明设备无关单位数的值，它应介于项显示的文本字符数之间。 适用于文本和占位符。 (继承自 InputView) |
| class |
用于提供搜索框的 View 控件。 (继承自 NavigableElement) |
| ClassId |
获取或设置用于标识语义相似元素集合的值。 (继承自 Element) |
| Clip |
用于提供搜索框的 View 控件。 (继承自 VisualElement) |
| DisableLayout |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| Dispatcher |
用于提供搜索框的 View 控件。 (继承自 BindableObject) |
| EffectControlProvider |
供 Xamarin.Forms 平台内部使用。 (继承自 Element) |
| Effects |
应用于此项的效果列表。 (继承自 Element) |
| FlowDirection |
获取或设置布局流方向。 (继承自 VisualElement) |
| FontAttributes |
获取用于指示搜索栏文本的字体是粗体、斜体还是两者皆否的值。 |
| FontFamily |
获取或设置搜索框文本的字体系列。 |
| FontSize |
获取该搜索栏中的文本字体大小。 |
| GestureController |
获取视图的手势控制器。 (继承自 View) |
| GestureRecognizers |
与此视图关联的手势识别器的集合。 (继承自 View) |
| Height |
获取此元素的当前呈现高度。 这是一种只读可绑定属性。 (继承自 VisualElement) |
| HeightRequest |
获取或设置此元素的所需高度替代。 (继承自 VisualElement) |
| HorizontalOptions |
获取或设置 LayoutOptions，它定义元素在布局周期中的布局方式。 这是一种可绑定属性。 (继承自 View) |
| HorizontalTextAlignment |
获取或设置水平文本对齐方式。 |
| Id |
获取可用于通过运行应用程序唯一地标识元素的值。 (继承自 Element) |
| InputTransparent |
获取或设置一个值，该值指示此元素是否应涉及用户交互周期。 这是一种可绑定属性。 (继承自 VisualElement) |
| IsEnabled |
获取或设置一个值，该值指示是否在用户界面中启用此元素。 这是一种可绑定属性。 (继承自 VisualElement) |
| IsFocused |
获取一个值，该值指示当前是否聚焦此元素。 这是一种可绑定属性。 (继承自 VisualElement) |
| IsInNativeLayout |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| IsNativeStateConsistent |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| IsPlatformEnabled |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| IsReadOnly |
获取或设置指明是否应阻止用户修改文本的值。 默认为 |
| IsSpellCheckEnabled |
获取或设置控制是否启用拼写检查的值。 (继承自 InputView) |
| IsTabStop |
获取或设置指明此元素是否包含在选项卡导航中的值。 这是一种可绑定属性。 (继承自 VisualElement) |
| IsVisible |
获取或设置一个值，该值确定此元素是否应属于可视化树的一部分。 这是一种可绑定属性。 (继承自 VisualElement) |
| Keyboard |
获取或设置 InputView 的 Keyboard。 这是一种可绑定属性。 (继承自 InputView) |
| LogicalChildren |
供 Xamarin.Forms 平台内部使用。 (继承自 Element) |
| Margin |
获取或设置视图的边距。 (继承自 View) |
| MaxLength |
获取或设置允许的最大输入长度。 (继承自 InputView) |
| MinimumHeightRequest |
获取或设置一个值，该值将替代元素在布局期间请求的最小高度。 (继承自 VisualElement) |
| MinimumWidthRequest |
获取或设置一个值，该值将替代元素在布局期间请求的最小宽度。 (继承自 VisualElement) |
| Navigation |
用于提供搜索框的 View 控件。 (继承自 NavigableElement) |
| NavigationProxy |
用于提供搜索框的 View 控件。 (继承自 NavigableElement) |
| Opacity |
获取或设置呈现元素时应用于元素的不透明度值。 这是一种可绑定属性。 (继承自 VisualElement) |
| Parent |
获取或设置元素的父元素。 (继承自 Element) |
| ParentView |
已过时.
获取作为 VisualElement 的此元素的最近的上级元素。 (继承自 Element) |
| Placeholder |
获取或设置在控件为空时显示的文本。 (继承自 InputView) |
| PlaceholderColor |
获取或设置占位符文本的颜色。 (继承自 InputView) |
| 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) |
| SearchCommand |
获取或设置在用户按搜索按钮时运行的命令。 |
| SearchCommandParameter |
获取或设置发送到 SearchCommand 的参数。 |
| Style |
用于提供搜索框的 View 控件。 (继承自 NavigableElement) |
| StyleClass |
用于提供搜索框的 View 控件。 (继承自 NavigableElement) |
| StyleId |
获取或设置用于唯一地标识元素的用户定义的值。 (继承自 Element) |
| TabIndex |
用于提供搜索框的 View 控件。 (继承自 VisualElement) |
| Text |
获取或设置输入视图的文本。 这是一种可绑定属性。 (继承自 InputView) |
| TextColor |
获取或设置文本颜色。 (继承自 InputView) |
| TextTransform |
用于提供搜索框的 View 控件。 (继承自 InputView) |
| TranslationX |
获取或设置元素的 X 转换增量。 (继承自 VisualElement) |
| TranslationY |
获取或设置元素的 Y 转换增量。 (继承自 VisualElement) |
| Triggers |
获取与此元素关联的 Trigger 列表。 这是一种可绑定属性。 (继承自 VisualElement) |
| VerticalOptions |
获取或设置 LayoutOptions，它定义元素在布局周期中的布局方式。 这是一种可绑定属性。 (继承自 View) |
| VerticalTextAlignment |
用于提供搜索框的 View 控件。 |
| Visual |
用于提供搜索框的 View 控件。 (继承自 VisualElement) |
| Width |
获取此元素的当前呈现宽度。 这是一种只读可绑定属性。 (继承自 VisualElement) |
| WidthRequest |
获取或设置此元素的所需宽度替代。 (继承自 VisualElement) |
| X |
获取此元素的当前 X 位置。 这是一种只读可绑定属性。 (继承自 VisualElement) |
| Y |
获取此元素的当前 Y 位置。 这是一种只读可绑定属性。 (继承自 VisualElement) |
方法
事件
| BatchCommitted |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| BindingContextChanged |
只要 BindingContext 属性更改就会引发。 (继承自 BindableObject) |
| ChildAdded |
每当将子元素添加到元素时就会发生。 (继承自 Element) |
| ChildRemoved |
每当从元素中删除子元素时就会发生。 (继承自 Element) |
| ChildrenReordered |
重新排序 VisualElement 的子级时发生。 (继承自 VisualElement) |
| DescendantAdded |
每当将子元素添加到元素子树时就会发生。 (继承自 Element) |
| DescendantRemoved |
每当从元素子树中删除子元素时就会发生。 (继承自 Element) |
| FocusChangeRequested |
供 Xamarin.Forms 平台内部使用。 (继承自 VisualElement) |
| Focused |
元素接收焦点时发生。 (继承自 VisualElement) |
| MeasureInvalidated |
可视元素的布局无效时引发的事件。 (继承自 VisualElement) |
| PlatformSet |
已过时.
用于提供搜索框的 View 控件。 (继承自 Element) |
| PropertyChanged |
在属性已更改时引发。 (继承自 BindableObject) |
| PropertyChanging |
在属性将要更改时引发。 (继承自 BindableObject) |
| SearchButtonPressed |
在用户按搜索按钮时引发的事件。 |
| SizeChanged |
当此元素上的 Width 或 Height 属性的值发生更改时发生。 (继承自 VisualElement) |
| TextChanged |
在编辑器的文本更改时引发的事件。 (继承自 InputView) |
| Unfocused |
当元素丢失焦点时发生。 (继承自 VisualElement) |
显式接口实现
| IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) |
供 Xamarin.Forms 平台内部使用。 (继承自 BindableObject) |
| IElementController.SetValueFromRenderer(BindableProperty, Object) |
供 Xamarin.Forms 平台内部使用。 (继承自 Element) |
| IFontElement.FontSizeDefaultValueCreator() |
供 Xamarin.Forms 平台内部使用。 |
| IFontElement.OnFontAttributesChanged(FontAttributes, FontAttributes) |
供 Xamarin.Forms 平台内部使用。 |
| IFontElement.OnFontChanged(Font, Font) |
供 Xamarin.Forms 平台内部使用。 |
| IFontElement.OnFontFamilyChanged(String, String) |
供 Xamarin.Forms 平台内部使用。 |
| IFontElement.OnFontSizeChanged(Double, Double) |
供 Xamarin.Forms 平台内部使用。 |
| IGestureController.CompositeGestureRecognizers |
供 Xamarin.Forms 平台内部使用。 (继承自 View) |
| INameScope.RegisterName(String, Object) |
仅限内部使用。 (继承自 Element) |
| IVisualElementController.EffectiveFlowDirection |
获取平台上元素的有效可视流方向，考虑区域设置和逻辑流设置。 (继承自 VisualElement) |
| IVisualElementController.InvalidateMeasure(InvalidationTrigger) |
此方法仅供内部使用。 (继承自 VisualElement) |