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 |
取得與此元素關聯的行為清單。 這是可繫結屬性。 (繼承來源 VisualElement) |
| BindingContext |
取得或設定物件，這個物件包含屬於此 BindableObject 屬性繫結屬性將設為目標的屬性。 (繼承來源 BindableObject) |
| Bounds |
取得項目的界限。 (繼承來源 VisualElement) |
| CancelButtonColor |
取得或設定 [取消] 按鈕的色彩。 |
| CharacterSpacing |
取得或設定值，指出由 Entry 顯示之文字中的字元之間應該有的裝置獨立單位數目。 適用於文字與預留位置。 (繼承來源 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 的鍵盤。 這是可繫結屬性。 (繼承來源 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 |
取得與此項目建立關聯的觸發程序清單。 這是可繫結屬性。 (繼承來源 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 |
當 Editor 的文字變更時引發的事件。 (繼承來源 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) |