diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ActionButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ActionButton.md new file mode 100644 index 0000000000..53415d738f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ActionButton.md @@ -0,0 +1,178 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ActionButton Class + +A button that can be used in an AppBar. + +```csharp +public class ActionButton : Tizen.UI.Components.Material.IconButton, +Tizen.UI.Components.Material.IAppBarContent +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') 🡒 ActionButton + +Implements [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') +### Constructors + + + +## ActionButton() Constructor + +Constructs a button. + +```csharp +public ActionButton(); +``` + + + +## ActionButton(string) Constructor + +Constructs a button. + +```csharp +public ActionButton(string iconResourceUrl); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ActionButton(string, IconButtonVariables) Constructor + +Constructs a button. + +```csharp +public ActionButton(string iconResourceUrl, Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The resource url of the icon. + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables to apply to the button. + + + +## ActionButton(IconButtonVariables) Constructor + +Constructs a button. + +```csharp +public ActionButton(Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables to apply to the button. +### Methods + + + +## ActionButton.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +public void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +Implements [ApplyUnifiedContentColor(Color)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color) 'Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color)') + + + +## ActionButton.OnAttached(AppBar) Method + +Called when the content is attached to AppBar. + +```csharp +public virtual void OnAttached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnAttached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar)') + + + +## ActionButton.OnDetached(AppBar) Method + +Called when the content is detected from AppBar. + +```csharp +public virtual void OnDetached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnDetached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AdapterView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AdapterView.md new file mode 100644 index 0000000000..8b284daca9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AdapterView.md @@ -0,0 +1,263 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AdapterView Class + +A loopable scroll view that displays recycling items in specific layouts with adapter. + +```csharp +public abstract class AdapterView : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 AdapterView + +Derived +↳ [LoopedAdapterView](Tizen.UI.Components.Material.LoopedAdapterView.md 'Tizen.UI.Components.Material.LoopedAdapterView') +### Constructors + + + +## AdapterView() Constructor + +Creates a new instance of a AdapterView. + +```csharp +public AdapterView(); +``` +### Properties + + + +## AdapterView.InnerMargin Property + +The margin offset of recycler view. +ScrollBar will not be affected. To place all contents, use [Padding](Tizen.UI.Components.Material.AdapterView.md#Tizen.UI.Components.Material.AdapterView.Padding 'Tizen.UI.Components.Material.AdapterView.Padding') + +```csharp +public Tizen.UI.Thickness InnerMargin { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AdapterView.ItemDecorations Property + +The list of decoration helper for items. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Components.Recycler.IItemDecoration> ItemDecorations { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.Components.Recycler.IItemDecoration[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## AdapterView.ItemsSource Property + +The data source for the view. The data source is a collection of items that will be displayed in the view. +The items must implement the INotifyPropertyChanged interface to notify the view of changes. Default is null. + +```csharp +public System.Collections.IEnumerable ItemsSource { get; set; } +``` + +#### Property Value +[System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') + + + +## AdapterView.ItemTemplate Property + +The item template for the view. The item template is a data template that defines how each item will be displayed in the. + +```csharp +public Tizen.UI.ViewTemplate ItemTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## AdapterView.Padding Property + +The padding of the view. +If you want to modify the place with an offset on RecyclerView, use [InnerMargin](Tizen.UI.Components.Material.AdapterView.md#Tizen.UI.Components.Material.AdapterView.InnerMargin 'Tizen.UI.Components.Material.AdapterView.InnerMargin'). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AdapterView.PrefetchBaseSize Property + +The prefetch base size for the view. The prefetch base size determines how many items are preloaded before and after the visible area. Default is 300.0f. + +```csharp +public float PrefetchBaseSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AdapterView.ScrollBarVisibility Property + +The visibility of the scroll bar for the grid view. The scroll bar visibility can be set to Always, Auto, or Never. Default is Never. + +```csharp +public Tizen.UI.ScrollBarVisibility ScrollBarVisibility { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollBarVisibility +### Methods + + + +## AdapterView.SetScrollBar(IScrollBar) Method + +Sets the scroll bar for the view. The scroll bar can be used to indicate the current position and range of the scrollable content. Default is null. + +```csharp +public void SetScrollBar(Tizen.UI.IScrollBar scrollBar); +``` +#### Parameters + + + +`scrollBar` Tizen.UI.IScrollBar + +The scroll bar to set. +### Events + + + +## AdapterView.DragFinished Event + +Event for drag ended. Invoked when dragging ends. + +```csharp +public event EventHandler<DragEventArgs> DragFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## AdapterView.Dragging Event + +Event for dragging. Invoked when dragging happens. + +```csharp +public event EventHandler<DragEventArgs> Dragging; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## AdapterView.DragStarted Event + +Event for drag started. Invoked when dragging starts. + +```csharp +public event EventHandler<DragEventArgs> DragStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## AdapterView.ScrollFinished Event + +Event for scroll finished. Invoked when scrolling finishs. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## AdapterView.Scrolling Event + +Event for scrolling. Invoked when scrolling happens. + +```csharp +public event EventHandler<ScrollEventArgs> Scrolling; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## AdapterView.ScrollStarted Event + +Event for scroll started. Invoked when scrolling starts. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialog.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialog.md new file mode 100644 index 0000000000..3d41c2b889 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialog.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AlertDialog Class + +An alert dialog component containing [Title](Tizen.UI.Components.Material.AlertDialog.md#Tizen.UI.Components.Material.AlertDialog.Title 'Tizen.UI.Components.Material.AlertDialog.Title'), [Message](Tizen.UI.Components.Material.AlertDialog.md#Tizen.UI.Components.Material.AlertDialog.Message 'Tizen.UI.Components.Material.AlertDialog.Message'), and action buttons. +AlertDialog can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. + +```csharp +public class AlertDialog : Tizen.UI.Components.Material.Dialog +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Dialog](Tizen.UI.Components.Material.Dialog.md 'Tizen.UI.Components.Material.Dialog') 🡒 AlertDialog +### Constructors + + + +## AlertDialog() Constructor + +Constructs a alert dialog. + +```csharp +public AlertDialog(); +``` + + + +## AlertDialog(AlertDialogVariables) Constructor + +Constructs an alert dialog. + +```csharp +public AlertDialog(Tizen.UI.Components.Material.AlertDialogVariables variables); +``` +#### Parameters + + + +`variables` [AlertDialogVariables](Tizen.UI.Components.Material.AlertDialogVariables.md 'Tizen.UI.Components.Material.AlertDialogVariables') + +The variables to apply to the alert dialog. +### Properties + + + +## AlertDialog.Message Property + +Text string of alert dialog message. + +```csharp +public string Message { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +Text string of alert dialog message. + + + +## AlertDialog.Title Property + +Text string of alert dialog title. + +```csharp +public string Title { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +Text string of alert dialog title. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialogVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialogVariables.md new file mode 100644 index 0000000000..e9430516e7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialogVariables.md @@ -0,0 +1,399 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AlertDialogVariables Class + +Variables used for alert dialog. + +```csharp +public class AlertDialogVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.AlertDialogVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 AlertDialogVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[AlertDialogVariables](Tizen.UI.Components.Material.AlertDialogVariables.md 'Tizen.UI.Components.Material.AlertDialogVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## AlertDialogVariables.ActionButtonBackgroundColor Property + +Gets or sets action button fill color. + +```csharp +public Tizen.UI.Color ActionButtonBackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AlertDialogVariables.ActionButtonCornerRadius Property + +Gets or sets action button corner radius. + +```csharp +public Tizen.UI.CornerRadius ActionButtonCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## AlertDialogVariables.ActionButtonFontFamily Property + +Gets or sets action button text font family. + +```csharp +public string ActionButtonFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## AlertDialogVariables.ActionButtonFontSize Property + +Gets or sets action button text font size. + +```csharp +public float ActionButtonFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.ActionButtonMinimumHeight Property + +Gets or sets action button minimum height. + +```csharp +public float ActionButtonMinimumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.ActionButtonMinimumWidth Property + +Gets or sets action button minimum width. + +```csharp +public float ActionButtonMinimumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.ActionButtonPadding Property + +Gets or sets action button padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness ActionButtonPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AlertDialogVariables.ActionButtonSpacing Property + +Gets or sets spacing between action buttons. + +```csharp +public float ActionButtonSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.ActionButtonTextColor Property + +Gets or sets action button text color. + +```csharp +public Tizen.UI.Color ActionButtonTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AlertDialogVariables.BackgroundColor Property + +Gets or sets app bar fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AlertDialogVariables.BodyPadding Property + +Gets or sets padding of BodyView. + +```csharp +public Tizen.UI.Thickness BodyPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AlertDialogVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## AlertDialogVariables.Default Property + +Default alert dialog variables. + +```csharp +public static Tizen.UI.Components.Material.AlertDialogVariables Default { get; } +``` + +#### Property Value +[AlertDialogVariables](Tizen.UI.Components.Material.AlertDialogVariables.md 'Tizen.UI.Components.Material.AlertDialogVariables') + + + +## AlertDialogVariables.DefaultHeight Property + +Gets or sets alert dialog height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.DefaultWidth Property + +Gets or sets alert dialog width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.FooterPadding Property + +Gets or sets padding of FooterView. + +```csharp +public Tizen.UI.Thickness FooterPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AlertDialogVariables.HeaderPadding Property + +Gets or sets padding of HeaderView. + +```csharp +public Tizen.UI.Thickness HeaderPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AlertDialogVariables.MessageFontFamily Property + +Gets or sets message text font family. + +```csharp +public string MessageFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## AlertDialogVariables.MessageFontSize Property + +Gets or sets message text font size. + +```csharp +public float MessageFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.MessageTextColor Property + +Gets or sets message text color. + +```csharp +public Tizen.UI.Color MessageTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AlertDialogVariables.Padding Property + +Gets or sets alert dialog padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AlertDialogVariables.Spacing Property + +Gets or sets spacing among HeaderView, BodyView, and FooterView. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.TitleFontFamily Property + +Gets or sets title text font family. + +```csharp +public string TitleFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## AlertDialogVariables.TitleFontSize Property + +Gets or sets title text font size. + +```csharp +public float TitleFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AlertDialogVariables.TitleTextColor Property + +Gets or sets title text color. + +```csharp +public Tizen.UI.Color TitleTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AlertDialogVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AnimatedImage.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AnimatedImage.md new file mode 100644 index 0000000000..178f1e42ec --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AnimatedImage.md @@ -0,0 +1,251 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AnimatedImage Class + +AnimatedImage is a control for displaying an animated image resource such as gif, webp and sequential images. + +```csharp +public class AnimatedImage : Tizen.UI.Components.Material.Image, +Tizen.UI.Components.IAnimatedImage +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 [Image](Tizen.UI.Components.Material.Image.md 'Tizen.UI.Components.Material.Image') 🡒 AnimatedImage + +Implements Tizen.UI.Components.IAnimatedImage +### Constructors + + + +## AnimatedImage() Constructor + +Creates an instance of an AnimatedImage. + +```csharp +public AnimatedImage(); +``` + + + +## AnimatedImage(string) Constructor + +Creates an instance of an AnimatedImage. + +```csharp +public AnimatedImage(string resourceUrl); +``` +#### Parameters + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## AnimatedImage(IEnumerable<string>, int, int) Constructor + +Creates an instance of an AnimatedImage. + +```csharp +public AnimatedImage(System.Collections.Generic.IEnumerable<string> sequentialResourceUrls, int preloadingBatchSize=1, int cacheSize=1); +``` +#### Parameters + + + +`sequentialResourceUrls` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The list of resource urls to be played sequentially. + + + +`preloadingBatchSize` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The size of the batch to preload. + + + +`cacheSize` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of images to keep cached ahead during playback. +### Properties + + + +## AnimatedImage.CurrentFrame Property + +Gets or sets the current frame of the animation. + +```csharp +public int CurrentFrame { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## AnimatedImage.FrameSpeedFactor Property + +Gets or sets a speed factor for the animated image frame. + +```csharp +public float FrameSpeedFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The speed factor is a multiplier of the normal velocity of the animation. Values between [0,1] will +slow down the animation and values above one will speed up the animation. +The range of this value is clamped between [0.01f ~ 100.0f]. + + + +## AnimatedImage.IsLooping Property + +Gets or sets whether the animation should loop. + +```csharp +public bool IsLooping { get; set; } +``` + +Implements IsLooping + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## AnimatedImage.RepeatCount Property + +Gets or sets the number of times the animation should repeat. + +```csharp +public int RepeatCount { get; set; } +``` + +Implements RepeatCount + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## AnimatedImage.RepeatMode Property + +Gets or sets the mode of animation repetition. + +```csharp +public Tizen.UI.AnimationRepeatMode RepeatMode { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationRepeatMode + + + +## AnimatedImage.StopBehavior Property + +Gets or sets the behavior of the animation when it stops. + +```csharp +public Tizen.UI.AnimationStopBehavior StopBehavior { get; set; } +``` + +Implements StopBehavior + +#### Property Value +Tizen.UI.AnimationStopBehavior + + + +## AnimatedImage.TotalFrame Property + +Gets the total number of frames in the animation. + +```csharp +public int TotalFrame { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## AnimatedImage.SetSequentialResourceUrls(IEnumerable<string>, int, int) Method + +Sets the resource urls to be played sequentially. + +```csharp +public void SetSequentialResourceUrls(System.Collections.Generic.IEnumerable<string> sequentialResourceUrls, int preloadingBatchSize=1, int cacheSize=1); +``` +#### Parameters + + + +`sequentialResourceUrls` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The list of resource urls to be played sequentially. + + + +`preloadingBatchSize` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The size of the batch to preload. + + + +`cacheSize` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of images to keep cached ahead during playback. + +### Remarks +This will ignore the value of [Image.ResourceUrl](https://docs.microsoft.com/en-us/dotnet/api/Image.ResourceUrl 'Image.ResourceUrl'). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBar.md new file mode 100644 index 0000000000..7988aaa87b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBar.md @@ -0,0 +1,227 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AppBar Class + +The AppBar providing a layout for leading, title, action buttons, and trailing contents. + +```csharp +public class AppBar : Tizen.UI.ContentView, +Tizen.UI.Components.IColorProvider, +Tizen.UI.Components.ITitle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 AppBar + +Implements Tizen.UI.Components.IColorProvider, Tizen.UI.Components.ITitle +### Constructors + + + +## AppBar() Constructor + +Constructs an app bar. + +```csharp +public AppBar(); +``` + + + +## AppBar(bool, AppBarVariables) Constructor + +Constructs an app bar. + +```csharp +public AppBar(bool useUniformedContentColor, Tizen.UI.Components.Material.AppBarVariables variables); +``` +#### Parameters + + + +`useUniformedContentColor` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +`variables` [AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') + + + +## AppBar(AppBarVariables) Constructor + +Constructs an app bar. + +```csharp +public AppBar(Tizen.UI.Components.Material.AppBarVariables variables); +``` +#### Parameters + + + +`variables` [AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') +### Properties + + + +## AppBar.ActionButtons Property + +Gets a list of action buttons. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> ActionButtons { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## AppBar.DominantColor Property + +Gets a color of the object. + +```csharp +public Tizen.UI.Color DominantColor { get; set; } +``` + +Implements DominantColor + +#### Property Value +Tizen.UI.Color + + + +## AppBar.Leading Property + +Gets or sets a leading content. It will be placed in the head of app bar. + +```csharp +public Tizen.UI.View Leading { get; set; } +``` + +#### Property Value +Tizen.UI.View + +### Remarks +There are predefined contents such as [BackButton](Tizen.UI.Components.Material.BackButton.md 'Tizen.UI.Components.Material.BackButton'). + + + +## AppBar.Title Property + +Gets or sets a title text of [TitleContent](Tizen.UI.Components.Material.AppBar.md#Tizen.UI.Components.Material.AppBar.TitleContent 'Tizen.UI.Components.Material.AppBar.TitleContent') . + +```csharp +public string Title { get; set; } +``` + +Implements Title + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## AppBar.TitleContent Property + +Gets or sets a title content. It will be placed in the center of app bar. + +```csharp +public Tizen.UI.View TitleContent { get; set; } +``` + +#### Property Value +Tizen.UI.View + +### Remarks +There are predefined contents such as [Components.Title](https://docs.microsoft.com/en-us/dotnet/api/Components.Title 'Components.Title') and [DoubleTitle](Tizen.UI.Components.Material.DoubleTitle.md 'Tizen.UI.Components.Material.DoubleTitle'). + + + +## AppBar.Trailing Property + +Gets or sets a trailing content. It will be placed in the tail of app bar. + +```csharp +public Tizen.UI.View Trailing { get; set; } +``` + +#### Property Value +Tizen.UI.View + +### Remarks +There are predefined contents such as [MoreButton](Tizen.UI.Components.Material.MoreButton.md 'Tizen.UI.Components.Material.MoreButton'). + + + +## AppBar.UnifiedContentColor Property + +Gets or sets the color of contents. This color is used when `useUnifiedContentColor` is set to true in constructor. + +```csharp +public Tizen.UI.Color UnifiedContentColor { get; } +``` + +#### Property Value +Tizen.UI.Color +### Events + + + +## AppBar.DominantColorChanged Event + +Invoked when the dominant color is changed. + +```csharp +public event EventHandler DominantColorChanged; +``` + +Implements DominantColorChanged + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBarVariables.md new file mode 100644 index 0000000000..f2d02a2448 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBarVariables.md @@ -0,0 +1,207 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## AppBarVariables Class + +Variables used for app bar. + +```csharp +public class AppBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.AppBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 AppBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## AppBarVariables.ActionButtonSpacing Property + +Gets or sets app bar action button spacing. + +```csharp +public float ActionButtonSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.BackgroundColor Property + +Gets or sets app bar fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## AppBarVariables.Default Property + +Default app bar variables. + +```csharp +public static Tizen.UI.Components.Material.AppBarVariables Default { get; } +``` + +#### Property Value +[AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') + + + +## AppBarVariables.ExtraTitleStartPadding Property + +Gets or sets a start padding be added to title padding when leading item is missing. + +```csharp +public float ExtraTitleStartPadding { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.Padding Property + +Gets or sets app bar padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## AppBarVariables.SpaceBetweenActionButtonsTrailing Property + +Gets or sets app bar space between action buttons and trailing. +This will be ignored when action buttons area or trailing is missing. + +```csharp +public float SpaceBetweenActionButtonsTrailing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.SpaceBetweenLeadingAndTitle Property + +Gets or sets app bar space between leading and title. +This will be ignored when leading item is missing. + +```csharp +public float SpaceBetweenLeadingAndTitle { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.SpaceBetweenTitleAndActionButtons Property + +Gets or sets app bar space between title and action buttons. +This will be ignored when action buttons area is missing. + +```csharp +public float SpaceBetweenTitleAndActionButtons { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.Thickness Property + +Gets or sets app bar height. + +```csharp +public float Thickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AppBarVariables.Transparent Property + +Transparent app bar variables. + +```csharp +public static Tizen.UI.Components.Material.AppBarVariables Transparent { get; } +``` + +#### Property Value +[AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') + + + +## AppBarVariables.UnifiedContentColor Property + +Gets or sets app bar content color. + +```csharp +public Tizen.UI.Color UnifiedContentColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BackButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BackButton.md new file mode 100644 index 0000000000..60af8503b7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BackButton.md @@ -0,0 +1,167 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BackButton Class + +Back button is a button that go back within given navigator when clicked. +If no navigator is specified it will use default navigator. + +```csharp +public class BackButton : Tizen.UI.Components.Material.IconButton, +Tizen.UI.Components.Material.IAppBarContent +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') 🡒 BackButton + +Implements [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') +### Constructors + + + +## BackButton() Constructor + +Constructs a button. + +```csharp +public BackButton(); +``` + + + +## BackButton(IconButtonVariables) Constructor + +Constructs a button. + +```csharp +public BackButton(Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') +### Properties + + + +## BackButton.ExitOnRoot Property + +Whether exit the application on root of given navigator. Default value is true. +If true, the it terminate the window when back to root page. + +```csharp +public bool ExitOnRoot { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## BackButton.Navigation Property + +Gets or sets the navigation handle to be used when go back. + +```csharp +public Tizen.UI.Components.INavigation Navigation { get; set; } +``` + +#### Property Value +Tizen.UI.Components.INavigation +### Methods + + + +## BackButton.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +public void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +Implements [ApplyUnifiedContentColor(Color)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color) 'Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color)') + + + +## BackButton.OnAttached(AppBar) Method + +Called when the content is attached to AppBar. + +```csharp +public virtual void OnAttached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnAttached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar)') + + + +## BackButton.OnDetached(AppBar) Method + +Called when the content is detected from AppBar. + +```csharp +public virtual void OnDetached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnDetached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar.md new file mode 100644 index 0000000000..4e399b0a51 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomBar Class + +A [BottomBar<T>](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>') with default item type of [TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem'). + +```csharp +public class BottomBar : Tizen.UI.Components.Material.BottomBar<Tizen.UI.Components.Material.TabItem> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.SelectionGroupBox<[TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem')> 🡒 [Tizen.UI.Components.Material.TabBar<](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>')[TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem')[>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') 🡒 [Tizen.UI.Components.Material.BottomBar<](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>')[TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem')[>](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>') 🡒 BottomBar +### Constructors + + + +## BottomBar() Constructor + +Construct a new instance. + +```csharp +public BottomBar(); +``` + + + +## BottomBar(TabBarVariables) Constructor + +Construct a new instance. + +```csharp +public BottomBar(Tizen.UI.Components.Material.TabBarVariables variables); +``` +#### Parameters + + + +`variables` [TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + +The variables to configure the bottom bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar_T_.md new file mode 100644 index 0000000000..ca8b0308fb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar_T_.md @@ -0,0 +1,94 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomBar<T> Class + +TabBar provides a horizontal layout to display TabItems. + +```csharp +public class BottomBar<T> : Tizen.UI.Components.Material.TabBar<T> + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.SelectionGroupBox<[T](Tizen.UI.Components.Material.BottomBar_T_.md#Tizen.UI.Components.Material.BottomBar_T_.T 'Tizen.UI.Components.Material.BottomBar<T>.T')> 🡒 [Tizen.UI.Components.Material.TabBar<](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>')[T](Tizen.UI.Components.Material.BottomBar_T_.md#Tizen.UI.Components.Material.BottomBar_T_.T 'Tizen.UI.Components.Material.BottomBar<T>.T')[>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') 🡒 BottomBar<T> + +Derived +↳ [BottomBar](Tizen.UI.Components.Material.BottomBar.md 'Tizen.UI.Components.Material.BottomBar') +### Constructors + + + +## BottomBar() Constructor + +Construct a new instance. + +```csharp +public BottomBar(); +``` + + + +## BottomBar(TabBarVariables) Constructor + +Construct a new instance. + +```csharp +public BottomBar(Tizen.UI.Components.Material.TabBarVariables variables); +``` +#### Parameters + + + +`variables` [TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + +The variables to configure the bottom bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheet.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheet.md new file mode 100644 index 0000000000..2c19f7a72b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheet.md @@ -0,0 +1,130 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomSheet Class + +A bottom sheet component containing [Content](Tizen.UI.Components.Material.BottomSheet.md#Tizen.UI.Components.Material.BottomSheet.Content 'Tizen.UI.Components.Material.BottomSheet.Content'). +BottomSheet can be set to [ModalContent](Tizen.UI.Components.Material.BottomSheetContainer.md#Tizen.UI.Components.Material.BottomSheetContainer.ModalContent 'Tizen.UI.Components.Material.BottomSheetContainer.ModalContent') to be shown as modal bottom sheet. + +```csharp +public class BottomSheet : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 BottomSheet +### Constructors + + + +## BottomSheet() Constructor + +Constructs a bottom sheet. + +```csharp +public BottomSheet(); +``` + + + +## BottomSheet(BottomSheetVariables) Constructor + +Constructs a bottom sheet. + +```csharp +public BottomSheet(Tizen.UI.Components.Material.BottomSheetVariables variables); +``` +#### Parameters + + + +`variables` [BottomSheetVariables](Tizen.UI.Components.Material.BottomSheetVariables.md 'Tizen.UI.Components.Material.BottomSheetVariables') + +The variables to apply to the bottom sheet. +### Properties + + + +## BottomSheet.Anchors Property + +The list of anchor of the bottom sheet. +Each anchor indicates the height of the bottom sheet. + +```csharp +public System.Collections.Generic.IReadOnlyList<float> Anchors { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') +The list of anchor + + + +## BottomSheet.Content Property + +Content view of the bottom sheet. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View +Content view + + + +## BottomSheet.DefaultAnchorIndex Property + +The default anchor index of [Anchors](Tizen.UI.Components.Material.BottomSheet.md#Tizen.UI.Components.Material.BottomSheet.Anchors 'Tizen.UI.Components.Material.BottomSheet.Anchors'). + +```csharp +public int DefaultAnchorIndex { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The default anchor index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainer.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainer.md new file mode 100644 index 0000000000..911c2cae86 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainer.md @@ -0,0 +1,196 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomSheetContainer Class + +A container that can show a bottom sheet. It should have a scrim to block the background. It also has animation for showing and hiding bottom sheet. +[BottomSheet](Tizen.UI.Components.Material.BottomSheet.md 'Tizen.UI.Components.Material.BottomSheet') can be set to [ModalContent](Tizen.UI.Components.Material.BottomSheetContainer.md#Tizen.UI.Components.Material.BottomSheetContainer.ModalContent 'Tizen.UI.Components.Material.BottomSheetContainer.ModalContent') to be shown as modal bottom sheet. + +```csharp +public class BottomSheetContainer : Tizen.UI.ContentView, +Tizen.UI.Components.IModalContainer, +Tizen.UI.Components.INavigationAnimation +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 BottomSheetContainer + +Implements Tizen.UI.Components.IModalContainer, Tizen.UI.Components.INavigationAnimation +### Constructors + + + +## BottomSheetContainer() Constructor + +Constructs a bottom sheet container. + +```csharp +public BottomSheetContainer(); +``` + + + +## BottomSheetContainer(BottomSheetContainerVariables) Constructor + +Constructs a bottom sheet container. + +```csharp +public BottomSheetContainer(Tizen.UI.Components.Material.BottomSheetContainerVariables variables); +``` +#### Parameters + + + +`variables` [BottomSheetContainerVariables](Tizen.UI.Components.Material.BottomSheetContainerVariables.md 'Tizen.UI.Components.Material.BottomSheetContainerVariables') + +The variables to apply to the bottom sheet container. +### Properties + + + +## BottomSheetContainer.ModalContent Property + +A modal content to be shown in this container. +A bottom sheet is set as modal content. + +```csharp +public Tizen.UI.View ModalContent { get; set; } +``` + +Implements ModalContent + +#### Property Value +Tizen.UI.View +A bottom sheet + + + +## BottomSheetContainer.PopAnimation Property + +Function called for transition animation of navigation pop. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopAnimation { get; } +``` + +Implements PopAnimation + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.Components.INavigationAnimationController[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the view to be popped. The fist View will be removed from the navigation stack. + + + +## BottomSheetContainer.PopModalAnimation Property + +Function called for transition animation of modal pop. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopModalAnimation { get; } +``` + +Implements PopModalAnimation + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.Components.INavigationAnimationController[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the modal view to be popped. The fist View will be removed from the modal stack. + + + +## BottomSheetContainer.PushAnimation Property + +Function called for transition animation of navigation push. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushAnimation { get; } +``` + +Implements PushAnimation + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.Components.INavigationAnimationController[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the view to be pushed. The fist View will be the top view. + + + +## BottomSheetContainer.PushModalAnimation Property + +Function called for transition animation of modal push. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushModalAnimation { get; } +``` + +Implements PushModalAnimation + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.Components.INavigationAnimationController[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the modal view to be pushed. The fist View will be the top view. + + + +## BottomSheetContainer.Scrim Property + +A scrim to block the background when the modal content is shown. + +```csharp +public Tizen.UI.View Scrim { get; set; } +``` + +Implements Scrim + +#### Property Value +Tizen.UI.View +UIView with dimmed background color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainerVariables.md new file mode 100644 index 0000000000..4d0b1360aa --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainerVariables.md @@ -0,0 +1,113 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomSheetContainerVariables Class + +Variables used for bottom sheet container. + +```csharp +public class BottomSheetContainerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.BottomSheetContainerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 BottomSheetContainerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[BottomSheetContainerVariables](Tizen.UI.Components.Material.BottomSheetContainerVariables.md 'Tizen.UI.Components.Material.BottomSheetContainerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## BottomSheetContainerVariables.Default Property + +Default bottom sheet container variables. + +```csharp +public static Tizen.UI.Components.Material.BottomSheetContainerVariables Default { get; } +``` + +#### Property Value +[BottomSheetContainerVariables](Tizen.UI.Components.Material.BottomSheetContainerVariables.md 'Tizen.UI.Components.Material.BottomSheetContainerVariables') + + + +## BottomSheetContainerVariables.FlickVelocity Property + +Gets or sets bottom sheet flick velocity. + +```csharp +public float FlickVelocity { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetContainerVariables.ScrimBlur Property + +Gets or sets scrim blur. + +```csharp +public float ScrimBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetContainerVariables.ScrimColor Property + +Gets or sets scrim color. + +```csharp +public Tizen.UI.Color ScrimColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetVariables.md new file mode 100644 index 0000000000..7c06315e52 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetVariables.md @@ -0,0 +1,321 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BottomSheetVariables Class + +Variables used for bottom sheet. + +```csharp +public class BottomSheetVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.BottomSheetVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 BottomSheetVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[BottomSheetVariables](Tizen.UI.Components.Material.BottomSheetVariables.md 'Tizen.UI.Components.Material.BottomSheetVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## BottomSheetVariables.Anchors Property + +Gets or sets bottom sheet anchors. + +```csharp +public System.Collections.Generic.IEnumerable<float> Anchors { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + +## BottomSheetVariables.BackgroundBlur Property + +Gets or sets the back drop blur level. + +```csharp +public float BackgroundBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.BackgroundColor Property + +Gets or sets app bar fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## BottomSheetVariables.BorderlineColor Property + +Gets or sets bottom sheet borderline color. + +```csharp +public Tizen.UI.Color BorderlineColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## BottomSheetVariables.BorderlineOffset Property + +Gets or sets bottom sheet borderline offset. + +```csharp +public float BorderlineOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.BorderlineWidth Property + +Gets or sets bottom sheet borderline width. + +```csharp +public float BorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## BottomSheetVariables.Default Property + +Default bottom sheet variables. + +```csharp +public static Tizen.UI.Components.Material.BottomSheetVariables Default { get; } +``` + +#### Property Value +[BottomSheetVariables](Tizen.UI.Components.Material.BottomSheetVariables.md 'Tizen.UI.Components.Material.BottomSheetVariables') + + + +## BottomSheetVariables.DefaultAnchorIndex Property + +Gets or sets the default index of bottom sheet among bottom sheet anchors. + +```csharp +public int DefaultAnchorIndex { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## BottomSheetVariables.DefaultHeight Property + +Gets or sets bottom sheet height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.DefaultWidth Property + +Gets or sets bottom sheet width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.DragHandleColor Property + +Gets or sets bottom sheet drag handle color. + +```csharp +public Tizen.UI.Color DragHandleColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## BottomSheetVariables.DragHandleCornerRadius Property + +Gets or sets bottom sheet drag handle corner radius. + +```csharp +public Tizen.UI.CornerRadius DragHandleCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## BottomSheetVariables.DragHandleHeight Property + +Gets or sets bottom sheet drag handle height. + +```csharp +public float DragHandleHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.DragHandleWidth Property + +Gets or sets bottom sheet drag handle width. + +```csharp +public float DragHandleWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.HeaderHeight Property + +Gets or sets bottom sheet header height. + +```csharp +public float HeaderHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.MaximumHeight Property + +Gets or sets bottom sheet maximum height. + +```csharp +public float MaximumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.MinimumHeight Property + +Gets or sets bottom sheet minimum height. + +```csharp +public float MinimumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BottomSheetVariables.Padding Property + +Gets or sets bottom sheet padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## BottomSheetVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BounceEdgeEffect.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BounceEdgeEffect.md new file mode 100644 index 0000000000..187cdaf1eb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BounceEdgeEffect.md @@ -0,0 +1,235 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## BounceEdgeEffect Class + +Bounce Edge effect. + +```csharp +public class BounceEdgeEffect : +Tizen.UI.Components.IEdgeEffect +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BounceEdgeEffect + +Implements Tizen.UI.Components.IEdgeEffect +### Constructors + + + +## BounceEdgeEffect(View) Constructor + +Bounce edge effect contructor. + +```csharp +public BounceEdgeEffect(Tizen.UI.View parent); +``` +#### Parameters + + + +`parent` Tizen.UI.View + +the parent view of edge effect. + + + +## BounceEdgeEffect(View, float) Constructor + +Bounce edge effect contructor. + +```csharp +public BounceEdgeEffect(Tizen.UI.View parent, float maxDistance); +``` +#### Parameters + + + +`parent` Tizen.UI.View + +The parent view of edge effect. + + + +`maxDistance` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The max distance value. +### Properties + + + +## BounceEdgeEffect.EdgeDirection Property + +The direction of edge. [EdgeDirection](Tizen.UI.Components.Material.BounceEdgeEffect.md#Tizen.UI.Components.Material.BounceEdgeEffect.EdgeDirection 'Tizen.UI.Components.Material.BounceEdgeEffect.EdgeDirection'). + +```csharp +public Tizen.UI.Components.EdgeDirection EdgeDirection { get; set; } +``` + +Implements EdgeDirection + +#### Property Value +Tizen.UI.Components.EdgeDirection + + + +## BounceEdgeEffect.MaxDistance Property + +The Maximum distance of touch pull over the parent view. + +```csharp +public float MaxDistance { get; set; } +``` + +Implements MaxDistance + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BounceEdgeEffect.SourceView Property + +The source view who will reflect the edge effect. + +```csharp +public Tizen.UI.View SourceView { get; set; } +``` + +Implements SourceView + +#### Property Value +Tizen.UI.View + + + +## BounceEdgeEffect.State Property + +The state of edge effect. Tizen.UI.Components.EdgeState. + +```csharp +public Tizen.UI.Components.EdgeState State { get; set; } +``` + +Implements State + +#### Property Value +Tizen.UI.Components.EdgeState +### Methods + + + +## BounceEdgeEffect.Finish() Method + +Finish edge effect immediately. + +```csharp +public virtual void Finish(); +``` + +Implements Finish() + + + +## BounceEdgeEffect.OnAbsorb(float) Method + +Call when the effect absorbs an impact at the given velocity. + +```csharp +public virtual void OnAbsorb(float velocity); +``` +#### Parameters + + + +`velocity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The velocity to absorb. + +Implements OnAbsorb(float)') + + + +## BounceEdgeEffect.OnPull(float, float) Method + +A view should call this when content is pulled over form the edge. + +```csharp +public virtual float OnPull(float deltaDistance, float displacement=0.5f); +``` +#### Parameters + + + +`deltaDistance` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Change in distance since the last call. Values may be 0 to 1.f or negative values. + + + +`displacement` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The displacement from the side of the point initiating the pull. value may be from 0 to 1. + +Implements OnPull(float, float)') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The amount of deltaDistance that was consumed. + + + +## BounceEdgeEffect.OnRelease() Method + +Call when the object is released after being pulled. + +```csharp +public virtual void OnRelease(); +``` + +Implements OnRelease() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Button.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Button.md new file mode 100644 index 0000000000..8c4dc47fcd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Button.md @@ -0,0 +1,254 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Button Class + +A Tizen.UI.Components.Clickable component containing single text. + +```csharp +public class Button : Tizen.UI.Components.Clickable, +Tizen.UI.IText, +Tizen.UI.Components.IFlexibleText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Button + +Implements Tizen.UI.IText, Tizen.UI.Components.IFlexibleText +### Constructors + + + +## Button() Constructor + +Constructs an empty button. + +```csharp +public Button(); +``` + + + +## Button(string) Constructor + +Constructs a button with text. + +```csharp +public Button(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Button(string, ButtonVariables) Constructor + +Constructs a button with text. + +```csharp +public Button(string text, Tizen.UI.Components.Material.ButtonVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') + + + +## Button(ButtonVariables) Constructor + +Constructs an empty button. + +```csharp +public Button(Tizen.UI.Components.Material.ButtonVariables variables); +``` +#### Parameters + + + +`variables` [ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') +### Properties + + + +## Button.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + + + +## Button.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Button.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Button.IsProgressing Property + +Gets or sets whether the progress mode is enabled. + +```csharp +public bool IsProgressing { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Button.Padding Property + +Gets or sets the padding of button. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## Button.Text Property + +Gets or sets the text of the button. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Button.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## Button.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow + +#### Property Value +Tizen.UI.TextOverflow +### Methods + + + +## Button.GetTouchEffectTarget() Method + +Get the target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectTarget(); +``` + +Implements GetTouchEffectTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ButtonVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ButtonVariables.md new file mode 100644 index 0000000000..2db61b8be0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ButtonVariables.md @@ -0,0 +1,249 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ButtonVariables Class + +Variables used for button. + +```csharp +public class ButtonVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.ButtonVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ButtonVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ButtonVariables.BackgroundColor Property + +Button fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ButtonVariables.CornerRadius Property + +Button corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ButtonVariables.Default Property + +Default button variables. + +```csharp +public static Tizen.UI.Components.Material.ButtonVariables Default { get; } +``` + +#### Property Value +[ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') + + + +## ButtonVariables.Flat Property + +Flat button variables. (No background) + +```csharp +public static Tizen.UI.Components.Material.ButtonVariables Flat { get; } +``` + +#### Property Value +[ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') + + + +## ButtonVariables.FontFamily Property + +Button text font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ButtonVariables.FontSize Property + +Button text font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ButtonVariables.Padding Property + +Button padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ButtonVariables.ProgressIconHeight Property + +Button progress icon height. + +```csharp +public float ProgressIconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ButtonVariables.ProgressIconResourceUrl Property + +Button progress icon image. + +```csharp +public string ProgressIconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ButtonVariables.ProgressIconWidth Property + +Button progress icon width. + +```csharp +public float ProgressIconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ButtonVariables.TextColor Property + +Button text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ButtonVariables.TextUnderline Property + +Button text underline. + +```csharp +public System.Nullable<Tizen.UI.Underline> TextUnderline { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## ButtonVariables.TouchEdgeInsets Property + +Gets or sets the expanded touch area offset. + +```csharp +public Tizen.UI.Thickness TouchEdgeInsets { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + +### Remarks +For example, the `Thickness(-5, -20, 10, 15)` will expend touch area to left 5, top 20, right 10, bottom 15. (total 15 horizontally, 35 vertically) + + + +## ButtonVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Card.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Card.md new file mode 100644 index 0000000000..60bbeafa3c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Card.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Card Class + +A Card component + +```csharp +public class Card : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Card +### Constructors + + + +## Card() Constructor + +Constructs a card. + +```csharp +public Card(); +``` + + + +## Card(CardVariables) Constructor + +Constructs a Card with variables. + +```csharp +public Card(Tizen.UI.Components.Material.CardVariables variables); +``` +#### Parameters + + + +`variables` [CardVariables](Tizen.UI.Components.Material.CardVariables.md 'Tizen.UI.Components.Material.CardVariables') + +Custom Card variables. +### Properties + + + +## Card.Content Property + +Gets or sets the content of Card. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CardVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CardVariables.md new file mode 100644 index 0000000000..ee6dec238a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CardVariables.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## CardVariables Class + +Variables used for switch. + +```csharp +public class CardVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.CardVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 CardVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[CardVariables](Tizen.UI.Components.Material.CardVariables.md 'Tizen.UI.Components.Material.CardVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## CardVariables.BackgroundColor Property + +Background color + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## CardVariables.CornerRadius Property + +Corner radius + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## CardVariables.Default Property + +Default switch variables. + +```csharp +public static Tizen.UI.Components.Material.CardVariables Default { get; } +``` + +#### Property Value +[CardVariables](Tizen.UI.Components.Material.CardVariables.md 'Tizen.UI.Components.Material.CardVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Checkbox.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Checkbox.md new file mode 100644 index 0000000000..dfdc7b48fb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Checkbox.md @@ -0,0 +1,101 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Checkbox Class + +Checkbox is a component that toggle on and off by click event. + +```csharp +public class Checkbox : Tizen.UI.Components.Selectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Checkbox +### Constructors + + + +## Checkbox() Constructor + +Constructs a new checkbox. + +```csharp +public Checkbox(); +``` + + + +## Checkbox(CheckboxVariables) Constructor + +Constructs a new checkbox. + +```csharp +public Checkbox(Tizen.UI.Components.Material.CheckboxVariables variables); +``` +#### Parameters + + + +`variables` [CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') + +The variables for the checkbox. +### Methods + + + +## Checkbox.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CheckboxVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CheckboxVariables.md new file mode 100644 index 0000000000..006bc4fffd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CheckboxVariables.md @@ -0,0 +1,181 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## CheckboxVariables Class + +Variables used for checkbox. + +```csharp +public class CheckboxVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.CheckboxVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 CheckboxVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## CheckboxVariables.Default Property + +Default checkbox variables. + +```csharp +public static Tizen.UI.Components.Material.CheckboxVariables Default { get; } +``` + +#### Property Value +[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') + + + +## CheckboxVariables.Ghost Property + +Ghost checkbox variables. + +```csharp +public static Tizen.UI.Components.Material.CheckboxVariables Ghost { get; } +``` + +#### Property Value +[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') + + + +## CheckboxVariables.IconColor Property + +Checkbox icon color. + +```csharp +public Tizen.UI.Color IconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## CheckboxVariables.IconGenerator Property + +Checkbox icon generator. + +```csharp +public System.Func<Tizen.UI.Components.Material.CheckboxVariables,Tizen.UI.Components.Material.SelectableLottieImage> IconGenerator { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[SelectableLottieImage](Tizen.UI.Components.Material.SelectableLottieImage.md 'Tizen.UI.Components.Material.SelectableLottieImage')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## CheckboxVariables.IconHeight Property + +Checkbox icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CheckboxVariables.IconWidth Property + +Checkbox icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CheckboxVariables.Padding Property + +Checkbox padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## CheckboxVariables.SelectedIconColor Property + +Checkbox icon selected color. + +```csharp +public Tizen.UI.Color SelectedIconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## CheckboxVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButton.md new file mode 100644 index 0000000000..fa2a897f43 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButton.md @@ -0,0 +1,161 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## CircleButton Class + +A Tizen.UI.Components.Clickable component containing single icon. +The main difference from an [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') is that it can have a Tizen.UI.Components.UIState.Progressing like [Button](Tizen.UI.Components.Material.Button.md 'Tizen.UI.Components.Material.Button'). + +```csharp +public class CircleButton : Tizen.UI.Components.Clickable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 CircleButton +### Constructors + + + +## CircleButton() Constructor + +Constructs an empty button. + +```csharp +public CircleButton(); +``` + + + +## CircleButton(string) Constructor + +Constructs a button with icon resource url. + +```csharp +public CircleButton(string iconResourceUrl); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## CircleButton(string, CircleButtonVariables) Constructor + +Constructs a button with icon resource url. + +```csharp +public CircleButton(string iconResourceUrl, Tizen.UI.Components.Material.CircleButtonVariables variables); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables') + + + +## CircleButton(CircleButtonVariables) Constructor + +Constructs an empty button. + +```csharp +public CircleButton(Tizen.UI.Components.Material.CircleButtonVariables variables); +``` +#### Parameters + + + +`variables` [CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables') +### Properties + + + +## CircleButton.IsProgressing Property + +Gets or sets whether the progress mode is enabled. + +```csharp +public bool IsProgressing { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## CircleButton.Padding Property + +Gets or sets the padding of button. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness +### Methods + + + +## CircleButton.GetTouchEffectTarget() Method + +Get the target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectTarget(); +``` + +Implements GetTouchEffectTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButtonVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButtonVariables.md new file mode 100644 index 0000000000..2ff8c5e1c4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButtonVariables.md @@ -0,0 +1,259 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## CircleButtonVariables Class + +Variables used for circle button. + +```csharp +public class CircleButtonVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.CircleButtonVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 CircleButtonVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## CircleButtonVariables.BackgroundColor Property + +Gets or sets the circle button fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## CircleButtonVariables.Default Property + +Default circle button variables. + +```csharp +public static Tizen.UI.Components.Material.CircleButtonVariables Default { get; } +``` + +#### Property Value +[CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables') + + + +## CircleButtonVariables.DefaultHeight Property + +Gets or sets the circle button default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.DefaultWidth Property + +Gets or sets the circle button default width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.IconCornerRadius Property + +Gets or sets the icon corner radius. + +```csharp +public Tizen.UI.CornerRadius IconCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## CircleButtonVariables.IconHeight Property + +Gets or sets the icon height size. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## CircleButtonVariables.IconResourceUrl Property + +Gets or sets the icon resource url. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## CircleButtonVariables.IconWidth Property + +Gets or sets the icon width size. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.Padding Property + +Gets or sets the circle button padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## CircleButtonVariables.ProgressIconHeight Property + +Gets or sets the progress icon height. + +```csharp +public float ProgressIconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.ProgressIconResourceUrl Property + +Gets or sets the progress icon image. + +```csharp +public string ProgressIconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## CircleButtonVariables.ProgressIconWidth Property + +Gets or sets the progress icon width. + +```csharp +public float ProgressIconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CircleButtonVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + +## CircleButtonVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Dialog.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Dialog.md new file mode 100644 index 0000000000..ee9f0bb856 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Dialog.md @@ -0,0 +1,132 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Dialog Class + +A dialog component containing [HeaderView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.HeaderView 'Tizen.UI.Components.Material.Dialog.HeaderView'), [BodyView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.BodyView 'Tizen.UI.Components.Material.Dialog.BodyView'), and [FooterView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.FooterView 'Tizen.UI.Components.Material.Dialog.FooterView'). +Dialog can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. + +```csharp +public class Dialog : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Dialog + +Derived +↳ [AlertDialog](Tizen.UI.Components.Material.AlertDialog.md 'Tizen.UI.Components.Material.AlertDialog') +### Constructors + + + +## Dialog() Constructor + +Constructs a dialog. + +```csharp +public Dialog(); +``` + + + +## Dialog(DialogVariables) Constructor + +Constructs a dialog. + +```csharp +public Dialog(Tizen.UI.Components.Material.DialogVariables variables); +``` +#### Parameters + + + +`variables` [DialogVariables](Tizen.UI.Components.Material.DialogVariables.md 'Tizen.UI.Components.Material.DialogVariables') + +The variables to apply to the dialog. +### Properties + + + +## Dialog.BodyView Property + +Body view of the dialog. + +```csharp +public Tizen.UI.View BodyView { get; set; } +``` + +#### Property Value +Tizen.UI.View +A view of body + + + +## Dialog.FooterView Property + +Footer view of the dialog. + +```csharp +public Tizen.UI.View FooterView { get; set; } +``` + +#### Property Value +Tizen.UI.View +A view of footer + + + +## Dialog.HeaderView Property + +Header view of the dialog. + +```csharp +public Tizen.UI.View HeaderView { get; set; } +``` + +#### Property Value +Tizen.UI.View +A view of header + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainer.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainer.md new file mode 100644 index 0000000000..a41dff2787 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainer.md @@ -0,0 +1,155 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DialogContainer Class + +A container that can show a dialog. It should have a scrim to block the background. It also has animation for showing and hiding dialog. +[Dialog](Tizen.UI.Components.Material.Dialog.md 'Tizen.UI.Components.Material.Dialog') and [AlertDialog](Tizen.UI.Components.Material.AlertDialog.md 'Tizen.UI.Components.Material.AlertDialog') can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. + +```csharp +public class DialogContainer : Tizen.UI.ContentView, +Tizen.UI.Components.IModalContainer +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 DialogContainer + +Implements Tizen.UI.Components.IModalContainer +### Constructors + + + +## DialogContainer() Constructor + +Constructs a dialog container. + +```csharp +public DialogContainer(); +``` + + + +## DialogContainer(DialogContainerVariables) Constructor + +Constructs a dialog container. + +```csharp +public DialogContainer(Tizen.UI.Components.Material.DialogContainerVariables variables); +``` +#### Parameters + + + +`variables` [DialogContainerVariables](Tizen.UI.Components.Material.DialogContainerVariables.md 'Tizen.UI.Components.Material.DialogContainerVariables') + +The variables to apply to the dialog container. +### Properties + + + +## DialogContainer.ModalContent Property + +A modal content to be shown in this container. +A dialog is set as modal content. + +```csharp +public Tizen.UI.View ModalContent { get; set; } +``` + +Implements ModalContent + +#### Property Value +Tizen.UI.View +A dialog + + + +## DialogContainer.Scrim Property + +A scrim to block the background when the modal content is shown. + +```csharp +public Tizen.UI.View Scrim { get; set; } +``` + +Implements Scrim + +#### Property Value +Tizen.UI.View +UIView with dimmed background color +### Methods + + + +## DialogContainer.SwapModalContent(View) Method + +Sets a modal content to be shown in this container with the content swap animation. +A dialog is set as modal content. +If ModalContent is null, it will not show the content swap animation. + +```csharp +public System.Threading.Tasks.Task SwapModalContent(Tizen.UI.View newModalContent); +``` +#### Parameters + + + +`newModalContent` Tizen.UI.View + +New modal content. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +Task of the content swap animation. + +### Remarks +For the continuation task, please specify [System.Threading.Tasks.TaskScheduler](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.TaskScheduler 'System.Threading.Tasks.TaskScheduler') as the current synchronization context to ensure that the continuation runs on the UI thread. +For example, + +```csharp +dialogContainer.SwapModalContent(newModalContent).ContinueWith(finishedCallback, TaskScheduler.FromCurrentSynchronizationContext()); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainerVariables.md new file mode 100644 index 0000000000..e2d60203e1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainerVariables.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DialogContainerVariables Class + +Variables used for dialog container. + +```csharp +public class DialogContainerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.DialogContainerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DialogContainerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DialogContainerVariables](Tizen.UI.Components.Material.DialogContainerVariables.md 'Tizen.UI.Components.Material.DialogContainerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DialogContainerVariables.Default Property + +Default dialog container variables. + +```csharp +public static Tizen.UI.Components.Material.DialogContainerVariables Default { get; } +``` + +#### Property Value +[DialogContainerVariables](Tizen.UI.Components.Material.DialogContainerVariables.md 'Tizen.UI.Components.Material.DialogContainerVariables') + + + +## DialogContainerVariables.ScrimBlur Property + +Gets or sets scrim blur. + +```csharp +public float ScrimBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DialogContainerVariables.ScrimColor Property + +Gets or sets scrim color. + +```csharp +public Tizen.UI.Color ScrimColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogVariables.md new file mode 100644 index 0000000000..b9b98e204f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogVariables.md @@ -0,0 +1,204 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DialogVariables Class + +Variables used for dialog. + +```csharp +public class DialogVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.DialogVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DialogVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DialogVariables](Tizen.UI.Components.Material.DialogVariables.md 'Tizen.UI.Components.Material.DialogVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DialogVariables.BackgroundColor Property + +Gets or sets app bar fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DialogVariables.BodyPadding Property + +Gets or sets padding of BodyView. + +```csharp +public Tizen.UI.Thickness BodyPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DialogVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## DialogVariables.Default Property + +Default dialog variables. + +```csharp +public static Tizen.UI.Components.Material.DialogVariables Default { get; } +``` + +#### Property Value +[DialogVariables](Tizen.UI.Components.Material.DialogVariables.md 'Tizen.UI.Components.Material.DialogVariables') + + + +## DialogVariables.DefaultHeight Property + +Gets or sets dialog height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DialogVariables.DefaultWidth Property + +Gets or sets dialog width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DialogVariables.FooterPadding Property + +Gets or sets padding of FooterView. + +```csharp +public Tizen.UI.Thickness FooterPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DialogVariables.HeaderPadding Property + +Gets or sets padding of HeaderView. + +```csharp +public Tizen.UI.Thickness HeaderPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DialogVariables.Padding Property + +Gets or sets dialog padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DialogVariables.Spacing Property + +Gets or sets spacing among HeaderView, BodyView, and FooterView. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DialogVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Divider.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Divider.md new file mode 100644 index 0000000000..5ce7ebcb85 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Divider.md @@ -0,0 +1,165 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Divider Class + +Represents a divider component with different styles and directions. + +```csharp +public class Divider : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Divider +### Constructors + + + +## Divider() Constructor + +Constructs a new divider. + +```csharp +public Divider(); +``` + + + +## Divider(DividerDirection) Constructor + +Constructs a new divider with specified direction and default variables. + +```csharp +public Divider(Tizen.UI.Components.Material.DividerDirection direction); +``` +#### Parameters + + + +`direction` [DividerDirection](Tizen.UI.Components.Material.DividerDirection.md 'Tizen.UI.Components.Material.DividerDirection') + +The direction of the divider. + + + +## Divider(DividerDirection, DividerVariables) Constructor + +Constructs a new divider with specified direction and variables. + +```csharp +public Divider(Tizen.UI.Components.Material.DividerDirection direction, Tizen.UI.Components.Material.DividerVariables variables); +``` +#### Parameters + + + +`direction` [DividerDirection](Tizen.UI.Components.Material.DividerDirection.md 'Tizen.UI.Components.Material.DividerDirection') + +The direction of the divider. + + + +`variables` [DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables') + +The variables for the divider. + + + +## Divider(DividerVariables) Constructor + +Constructs a new divider with default direction(horizontal) and specified variables. + +```csharp +public Divider(Tizen.UI.Components.Material.DividerVariables variables); +``` +#### Parameters + + + +`variables` [DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables') + +The variables for the divider. +### Properties + + + +## Divider.DividerColor Property + +Gets or sets the color of the divider. + +```csharp +public Tizen.UI.Color DividerColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Divider.Style Property + +Gets or sets the style of the divider. + +```csharp +public Tizen.UI.Components.Material.DividerStyle Style { get; set; } +``` + +#### Property Value +[DividerStyle](Tizen.UI.Components.Material.DividerStyle.md 'Tizen.UI.Components.Material.DividerStyle') + + + +## Divider.Thickness Property + +Gets or sets the thickness of the divider. + +```csharp +public float Thickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerDirection.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerDirection.md new file mode 100644 index 0000000000..34cae980f2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerDirection.md @@ -0,0 +1,67 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DividerDirection Enum + +Represents the direction of the divider. + +```csharp +public enum DividerDirection +``` +### Fields + + + +`Horizontal` 0 + +Represents a horizontal divider. + + + +`Vertical` 1 + +Represents a vertical divider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerStyle.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerStyle.md new file mode 100644 index 0000000000..828e9ef3b0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerStyle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DividerStyle Enum + +Represents the style of the divider. + +```csharp +public enum DividerStyle +``` +### Fields + + + +`Dashed` 1 + +Represents a dashed line divider. + + + +`Dotted` 2 + +Represents a dotted line divider. + + + +`Line` 0 + +Represents a solid line divider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerVariables.md new file mode 100644 index 0000000000..9d3ae22459 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerVariables.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DividerVariables Class + +Variables used for divider. + +```csharp +public class DividerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.DividerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DividerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DividerVariables.Color Property + +Divider color. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DividerVariables.Default Property + +Default divider variables. + +```csharp +public static Tizen.UI.Components.Material.DividerVariables Default { get; } +``` + +#### Property Value +[DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables') + + + +## DividerVariables.Thickness Property + +Divider thickness. + +```csharp +public float Thickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitle.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitle.md new file mode 100644 index 0000000000..16d2eb3788 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitle.md @@ -0,0 +1,193 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DoubleTitle Class + +The title component with main title and subtitle. It can be used as a app bar title content. + +```csharp +public class DoubleTitle : Tizen.UI.Layouts.VStack, +Tizen.UI.Components.IDoubleTitle, +Tizen.UI.Components.ITitle, +Tizen.UI.Components.Material.IAppBarContent +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Layouts.Layout 🡒 Tizen.UI.Layouts.StackBase 🡒 Tizen.UI.Layouts.VStack 🡒 DoubleTitle + +Implements Tizen.UI.Components.IDoubleTitle, Tizen.UI.Components.ITitle, [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') +### Constructors + + + +## DoubleTitle(string, string) Constructor + +Constructs a double title. + +```csharp +public DoubleTitle(string title, string subtitle); +``` +#### Parameters + + + +`title` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`subtitle` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DoubleTitle(string, string, DoubleTitleVariables) Constructor + +Constructs a title. + +```csharp +public DoubleTitle(string title, string subtitle, Tizen.UI.Components.Material.DoubleTitleVariables variables); +``` +#### Parameters + + + +`title` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`subtitle` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [DoubleTitleVariables](Tizen.UI.Components.Material.DoubleTitleVariables.md 'Tizen.UI.Components.Material.DoubleTitleVariables') +### Properties + + + +## DoubleTitle.ItemSpacing Property + +Gets or sets padding double title item spacing. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DoubleTitle.Subtitle Property + +Gets or sets the sub title. + +```csharp +public string Subtitle { get; set; } +``` + +Implements Subtitle + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DoubleTitle.SubtitleLabel Property + +Gets a reference to the subtitle label. + +```csharp +public Tizen.UI.Components.Material.Label SubtitleLabel { get; } +``` + +#### Property Value +[Label](Tizen.UI.Components.Material.Label.md 'Tizen.UI.Components.Material.Label') + + + +## DoubleTitle.Title Property + +Gets or sets the main title. + +```csharp +public string Title { get; set; } +``` + +Implements Title + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DoubleTitle.TitleLabel Property + +Gets a reference to the title label. + +```csharp +public Tizen.UI.Components.Material.Label TitleLabel { get; } +``` + +#### Property Value +[Label](Tizen.UI.Components.Material.Label.md 'Tizen.UI.Components.Material.Label') +### Methods + + + +## DoubleTitle.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +public void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +Implements [ApplyUnifiedContentColor(Color)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color) 'Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitleVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitleVariables.md new file mode 100644 index 0000000000..1174306c26 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitleVariables.md @@ -0,0 +1,204 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DoubleTitleVariables Class + +Variables used for double title which has main and sub titles. + +```csharp +public class DoubleTitleVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.DoubleTitleVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DoubleTitleVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DoubleTitleVariables](Tizen.UI.Components.Material.DoubleTitleVariables.md 'Tizen.UI.Components.Material.DoubleTitleVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DoubleTitleVariables.Default Property + +Default double title variables. + +```csharp +public static Tizen.UI.Components.Material.DoubleTitleVariables Default { get; } +``` + +#### Property Value +[DoubleTitleVariables](Tizen.UI.Components.Material.DoubleTitleVariables.md 'Tizen.UI.Components.Material.DoubleTitleVariables') + + + +## DoubleTitleVariables.ItemSpacing Property + +Gets or sets double title item spacing. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DoubleTitleVariables.Padding Property + +Gets or sets double title padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DoubleTitleVariables.SubtitleColor Property + +Gets or sets the sub title color. + +```csharp +public Tizen.UI.Color SubtitleColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DoubleTitleVariables.SubtitleFontFamily Property + +Gets or sets the sub title font family. + +```csharp +public string SubtitleFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DoubleTitleVariables.SubtitleFontSize Property + +Gets or sets the sub title font size. + +```csharp +public float SubtitleFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DoubleTitleVariables.SubtitleTextOverflow Property + +Gets or sets the sub title overflow mode. + +```csharp +public Tizen.UI.TextOverflow SubtitleTextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + +## DoubleTitleVariables.TitleColor Property + +Gets or sets the main title color. + +```csharp +public Tizen.UI.Color TitleColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DoubleTitleVariables.TitleFontFamily Property + +Gets or sets the main title font family. + +```csharp +public string TitleFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DoubleTitleVariables.TitleFontSize Property + +Gets or sets the main title font size. + +```csharp +public float TitleFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DoubleTitleVariables.TitleTextOverflow Property + +Gets or sets the main title overflow mode. + +```csharp +public Tizen.UI.TextOverflow TitleTextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItem.md new file mode 100644 index 0000000000..8df4d54b65 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItem.md @@ -0,0 +1,236 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DrawerItem Class + +DrawerItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. + +```csharp +public class DrawerItem : Tizen.UI.Components.GroupSelectable, +Tizen.UI.IText, +Tizen.UI.Components.IFlexibleText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 DrawerItem + +Implements Tizen.UI.IText, Tizen.UI.Components.IFlexibleText +### Constructors + + + +## DrawerItem() Constructor + +Constructs a default Drawer item. + +```csharp +public DrawerItem(); +``` + + + +## DrawerItem(string) Constructor + +Constructs a Drawer item with specified text. + +```csharp +public DrawerItem(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display on the Drawer item. + + + +## DrawerItem(string, DrawerItemVariables) Constructor + +Constructs a Drawer item with specified text and variables. + +```csharp +public DrawerItem(string text, Tizen.UI.Components.Material.DrawerItemVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display on the Drawer item. + + + +`variables` [DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables') + +Custom variables for the Drawer item. + + + +## DrawerItem(DrawerItemVariables) Constructor + +Constructs an empty Drawer item with specified variables. + +```csharp +public DrawerItem(Tizen.UI.Components.Material.DrawerItemVariables variables); +``` +#### Parameters + + + +`variables` [DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables') + +Custom variables for the Drawer item. +### Properties + + + +## DrawerItem.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + + + +## DrawerItem.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DrawerItem.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawerItem.Text Property + +Gets or sets the text of the Drawer item. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DrawerItem.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## DrawerItem.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow + +#### Property Value +Tizen.UI.TextOverflow +### Methods + + + +## DrawerItem.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItemVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItemVariables.md new file mode 100644 index 0000000000..9391b4cf40 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItemVariables.md @@ -0,0 +1,194 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DrawerItemVariables Class + +Variables used for DrawerItem. + +```csharp +public class DrawerItemVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.DrawerItemVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DrawerItemVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DrawerItemVariables.BackgroundColor Property + +DrawerItem fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DrawerItemVariables.CornerRadius Property + +DrawerItem corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## DrawerItemVariables.Default Property + +Default DrawerItem variables. + +```csharp +public static Tizen.UI.Components.Material.DrawerItemVariables Default { get; } +``` + +#### Property Value +[DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables') + + + +## DrawerItemVariables.FontFamily Property + +DrawerItem text font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DrawerItemVariables.FontSize Property + +DrawerItem text font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawerItemVariables.Padding Property + +DrawerItem padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DrawerItemVariables.SelectedBackgroundColor Property + +DrawerItem fill color when selected. + +```csharp +public Tizen.UI.Color SelectedBackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DrawerItemVariables.SelectedFontFamily Property + +DrawerItem text font family when selected. + +```csharp +public string SelectedFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DrawerItemVariables.TextColor Property + +DrawerItem text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DrawerItemVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Drawer_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Drawer_T_.md new file mode 100644 index 0000000000..f8c3a07575 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Drawer_T_.md @@ -0,0 +1,459 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Drawer<T> Class + +This component supports both modal and static types of drawers. + +```csharp +public abstract class Drawer<T> : Tizen.UI.ContentView, +Tizen.UI.Components.ISelectionGroup, +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Drawer<T> + +Derived +↳ [ModalDrawer<T>](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>') +↳ [StaticDrawer<T>](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>') + +Implements Tizen.UI.Components.ISelectionGroup, [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## Drawer() Constructor + +Initializes a new instance of the Drawer class with default settings. + +```csharp +public Drawer(); +``` + + + +## Drawer(ModalDrawerVariables) Constructor + +Initializes a new instance of the Drawer class with specified variables. + +```csharp +public Drawer(Tizen.UI.Components.Material.ModalDrawerVariables variables); +``` +#### Parameters + + + +`variables` [ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') + +The DrawerVariables object containing configuration for the drawer. +### Properties + + + +## Drawer<T>.Content Property + +Gets or sets the content of the Drawer. + +```csharp +public abstract Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## Drawer<T>.Count Property + +Gets the number of child items. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Drawer<T>.IsReadOnly Property + +Gets a value indicating whether the list of child items is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Drawer<T>.Items Property + +Gets or sets the index of the currently selected child item. + +```csharp +public System.Collections.Generic.IList<T> Items { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## Drawer<T>.ItemSpacing Property + +Gets or sets the spacing between child items. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Drawer<T>.SelectedIndex Property + +Gets the current selected item index. + +```csharp +public int SelectedIndex { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Drawer<T>.SelectedItem Property + +Gets the current selected item. + +```csharp +public T SelectedItem { get; } +``` + +#### Property Value +[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + + + +## Drawer<T>.SelectionChangedCommand Property + +Selected child changed event command. [SelectionChanged](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.SelectionChanged 'Tizen.UI.Components.Material.Drawer<T>.SelectionChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.GroupSelectionChangedEventArgs> SelectionChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')Tizen.UI.Components.GroupSelectionChangedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## Drawer<T>.this[int] Property + +Gets or sets the tab items. + +```csharp +public T this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') +### Methods + + + +## Drawer<T>.Add(T) Method + +Adds an item to the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public void Add(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + +The object to add to the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +Implements [Add(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + +#### Exceptions + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + + + +## Drawer<T>.Clear() Method + +Removes all child items from the list of child items. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## Drawer<T>.Contains(T) Method + +Checks if the list of child items contains the specified child item. + +```csharp +public bool Contains(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + +The child item to check for. + +Implements [Contains(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Contains#System_Collections_Generic_ICollection_1_Contains__0_ 'System.Collections.Generic.ICollection`1.Contains(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the list of child items contains the child item, false otherwise. + + + +## Drawer<T>.CopyTo(T[], int) Method + +Copies the child items in the list of child items to the specified array, starting at the specified index. + +```csharp +public void CopyTo(T[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the child items to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + +Implements [CopyTo(T[], int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.CopyTo#System_Collections_Generic_ICollection_1_CopyTo__0[],System_Int32_ 'System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)') + + + +## Drawer<T>.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +public System.Collections.Generic.IEnumerator<T> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the list of child items. + + + +## Drawer<T>.IndexOf(T) Method + +Gets the index of the specified child item in the list of child items. + +```csharp +public int IndexOf(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + +The child item to find the index of. + +Implements [IndexOf(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.IndexOf#System_Collections_Generic_IList_1_IndexOf__0_ 'System.Collections.Generic.IList`1.IndexOf(`0)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the child item, or -1 if it is not found. + + + +## Drawer<T>.Insert(int, T) Method + +Inserts a child item at the specified index in the list of child items. + +```csharp +public void Insert(int index, T item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child item at. + + + +`item` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + +The child item to insert. + +Implements [Insert(int, T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Insert#System_Collections_Generic_IList_1_Insert_System_Int32,_0_ 'System.Collections.Generic.IList`1.Insert(System.Int32,`0)') + + + +## Drawer<T>.RemoveAt(int) Method + +Removes the child item at the specified index from the list of child items. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the child item to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Events + + + +## Drawer<T>.SelectionChanged Event + +Event that is triggered when the selected item in the drawer changes. + +```csharp +public event EventHandler<GroupSelectionChangedEventArgs> SelectionChanged; +``` + +Implements SelectionChanged + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.Components.GroupSelectionChangedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') +### Explicit Interface Implementations + + + +## Drawer<T>.System.Collections.Generic.ICollection<T>.Remove(T) Method + +Removes the item from drawer. + +```csharp +bool System.Collections.Generic.ICollection<T>.Remove(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.Drawer_T_.md#Tizen.UI.Components.Material.Drawer_T_.T 'Tizen.UI.Components.Material.Drawer<T>.T') + +The child item to be removed. + +Implements [Remove(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## Drawer<T>.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + +## Drawer<T>.Tizen.UI.Components.ISelectionGroup.Selected Property + +The selected child in the group. + +```csharp +Tizen.UI.Components.IGroupSelectable Tizen.UI.Components.ISelectionGroup.Selected { get; } +``` + +Implements Selected + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownActionItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownActionItem.md new file mode 100644 index 0000000000..f736752d95 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownActionItem.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownActionItem Class + +It is uesed as an item of DropdownList. It focuses an action to be executed when clicked rather than the expressing selection among the other items. + +```csharp +public class DropdownActionItem : Tizen.UI.Components.Material.DropdownItem +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 [DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem') 🡒 DropdownActionItem +### Constructors + + + +## DropdownActionItem() Constructor + +Construct a new instance. + +```csharp +public DropdownActionItem(); +``` + + + +## DropdownActionItem(string) Constructor + +Construct a new instance. + +```csharp +public DropdownActionItem(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownActionItem(string, DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownActionItem(string text, Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## DropdownActionItem(DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownActionItem(Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownCheckItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownCheckItem.md new file mode 100644 index 0000000000..fa55c202c3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownCheckItem.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownCheckItem Class + +DropdownCheckItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. + +```csharp +public class DropdownCheckItem : Tizen.UI.Components.Material.DropdownItem +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 [DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem') 🡒 DropdownCheckItem +### Constructors + + + +## DropdownCheckItem() Constructor + +Construct a new instance. + +```csharp +public DropdownCheckItem(); +``` + + + +## DropdownCheckItem(string) Constructor + +Construct a new instance. + +```csharp +public DropdownCheckItem(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownCheckItem(string, DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownCheckItem(string text, Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## DropdownCheckItem(DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownCheckItem(Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItem.md new file mode 100644 index 0000000000..297fbb5e60 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItem.md @@ -0,0 +1,310 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownItem Class + +DropdownListItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. + +```csharp +public class DropdownItem : Tizen.UI.Components.GroupSelectable, +Tizen.UI.Components.IFlexibleText, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 DropdownItem + +Derived +↳ [DropdownActionItem](Tizen.UI.Components.Material.DropdownActionItem.md 'Tizen.UI.Components.Material.DropdownActionItem') +↳ [DropdownCheckItem](Tizen.UI.Components.Material.DropdownCheckItem.md 'Tizen.UI.Components.Material.DropdownCheckItem') + +Implements Tizen.UI.Components.IFlexibleText, Tizen.UI.IText +### Constructors + + + +## DropdownItem() Constructor + +Construct a new instance. + +```csharp +public DropdownItem(); +``` + + + +## DropdownItem(string) Constructor + +Construct a new instance. + +```csharp +public DropdownItem(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItem(string, DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownItem(string text, Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## DropdownItem(DropdownItemVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownItem(Tizen.UI.Components.Material.DropdownItemVariables variables); +``` +#### Parameters + + + +`variables` [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') +### Properties + + + +## DropdownItem.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + + + +## DropdownItem.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItem.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItem.IconMultipliedColor Property + +Gets or sets the mix color of the icon. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItem.IconPlacement Property + +Gets or sets the placement of the icon. + +```csharp +public Tizen.UI.Components.IconPlacement IconPlacement { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IconPlacement + + + +## DropdownItem.IconResourceUrl Property + +Gets or sets the resource URL of the icon image. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItem.ItemSpacing Property + +Gets or sets the spacing between icon and text. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItem.Padding Property + +Gets or sets the padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DropdownItem.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## DropdownItem.Text Property + +Gets or sets the text of the tab item. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItem.TextColor Property + +Gets or sets the text color of the label. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## DropdownItem.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow + +#### Property Value +Tizen.UI.TextOverflow +### Methods + + + +## DropdownItem.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItemVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItemVariables.md new file mode 100644 index 0000000000..24977ece0d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItemVariables.md @@ -0,0 +1,311 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownItemVariables Class + +Variables used for DropdownListItem. + +```csharp +public class DropdownItemVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.DropdownItemVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DropdownItemVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DropdownItemVariables.BackgroundColor Property + +Gets or sets the fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.Check Property + +The dropdown item variables with check icon. + +```csharp +public static Tizen.UI.Components.Material.DropdownItemVariables Check { get; } +``` + +#### Property Value +[DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## DropdownItemVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## DropdownItemVariables.Default Property + +Default dropdown item variables. + +```csharp +public static Tizen.UI.Components.Material.DropdownItemVariables Default { get; } +``` + +#### Property Value +[DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## DropdownItemVariables.FontFamily Property + +Gets or sets the text font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItemVariables.FontSize Property + +Gets or sets the text font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItemVariables.IconHeight Property + +Gets or sets the icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItemVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.IconPlacement Property + +Gets or sets the icon placement. + +```csharp +public Tizen.UI.Components.IconPlacement IconPlacement { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IconPlacement + + + +## DropdownItemVariables.IconResourceUrl Property + +Gets or sets the icon resource url. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItemVariables.IconWidth Property + +Gets or sets the icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItemVariables.ItemSpacing Property + +Gets or sets the item spacing between text and icon. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownItemVariables.Padding Property + +Gets or sets the padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DropdownItemVariables.SelectedBackgroundColor Property + +Gets or sets the selected fill color. + +```csharp +public Tizen.UI.Color SelectedBackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.SelectedFontFamily Property + +Gets or sets the text font family when selected. + +```csharp +public string SelectedFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DropdownItemVariables.SelectedIconMultipliedColor Property + +Gets or sets the selected icon mix color. + +```csharp +public Tizen.UI.Color SelectedIconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.SelectedTextColor Property + +Gets or sets the selected text color. + +```csharp +public Tizen.UI.Color SelectedTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.TextColor Property + +Gets or sets the text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownItemVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList.md new file mode 100644 index 0000000000..3ed1fd5029 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownList Class + +A [DropdownList<T>](Tizen.UI.Components.Material.DropdownList_T_.md 'Tizen.UI.Components.Material.DropdownList<T>') with default item type of [DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem'). + +```csharp +public class DropdownList : Tizen.UI.Components.Material.DropdownList<Tizen.UI.Components.Material.DropdownItem> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Tizen.UI.Components.Material.DropdownList<](Tizen.UI.Components.Material.DropdownList_T_.md 'Tizen.UI.Components.Material.DropdownList<T>')[DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem')[>](Tizen.UI.Components.Material.DropdownList_T_.md 'Tizen.UI.Components.Material.DropdownList<T>') 🡒 DropdownList +### Constructors + + + +## DropdownList() Constructor + +Construct a new instance. + +```csharp +public DropdownList(); +``` + + + +## DropdownList(DropdownListVariables) Constructor + +Construct a new instance. + +```csharp +public DropdownList(Tizen.UI.Components.Material.DropdownListVariables variables); +``` +#### Parameters + + + +`variables` [DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables') + +The variables to configure the tab bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownListVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownListVariables.md new file mode 100644 index 0000000000..8a1a0bb7f6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownListVariables.md @@ -0,0 +1,217 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownListVariables Class + +Variables used for DropdownList. + +```csharp +public class DropdownListVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.DropdownListVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 DropdownListVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## DropdownListVariables.BackgroundBlur Property + +Gets or sets the icon button back drop blur level. + +```csharp +public float BackgroundBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownListVariables.BackgroundColor Property + +Color of the background. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownListVariables.BoundaryPadding Property + +Gets or sets boundary padding of modal container. + +```csharp +public Tizen.UI.Thickness BoundaryPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DropdownListVariables.CornerRadius Property + +DropdownList corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## DropdownListVariables.Default Property + +Default variables for DropdownList. + +```csharp +public static Tizen.UI.Components.Material.DropdownListVariables Default { get; } +``` + +#### Property Value +[DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables') + + + +## DropdownListVariables.DefaultWidth Property + +Gets or sets default width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownListVariables.MaximumWidth Property + +Gets or sets the maximum width. + +```csharp +public float MaximumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownListVariables.MinimumWidth Property + +Gets or sets the maximum width. + +```csharp +public float MinimumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownListVariables.Padding Property + +DropdownList padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## DropdownListVariables.ScrimBlur Property + +Gets or sets scrim blur of modal container. + +```csharp +public float ScrimBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DropdownListVariables.ScrimColor Property + +Gets or sets scrim color of modal container. + +```csharp +public Tizen.UI.Color ScrimColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## DropdownListVariables.UnderShadows Property + +Gets or sets the box shadow. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList_T_.md new file mode 100644 index 0000000000..ae3832b197 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList_T_.md @@ -0,0 +1,651 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DropdownList<T> Class + +The selectable item container desinged to be posted above the other objects. + +```csharp +public class DropdownList<T> : Tizen.UI.ContentView, +Tizen.UI.Components.IAnchoredModal, +Tizen.UI.Components.ISelectionGroup, +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable, Tizen.UI.Components.IClickable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 DropdownList<T> + +Derived +↳ [DropdownList](Tizen.UI.Components.Material.DropdownList.md 'Tizen.UI.Components.Material.DropdownList') + +Implements Tizen.UI.Components.IAnchoredModal, Tizen.UI.Components.ISelectionGroup, [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## DropdownList() Constructor + +Creates a new instance. + +```csharp +public DropdownList(); +``` + + + +## DropdownList(DropdownListVariables) Constructor + +Creates a new instance. + +```csharp +public DropdownList(Tizen.UI.Components.Material.DropdownListVariables variables); +``` +#### Parameters + + + +`variables` [DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables') +### Properties + + + +## DropdownList<T>.Count Property + +Gets the number of child items. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## DropdownList<T>.DismissedCommand Property + +Dismissed event command. [Dismissed](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.Dismissed 'Tizen.UI.Components.Material.DropdownList<T>.Dismissed'). + +```csharp +public System.Action<object,System.EventArgs> DismissedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## DropdownList<T>.EmptySelectionAllowed Property + +Gets or sets a value indicating whether empty selection is allowed. +If it is set to true, it allows the no selection state when initializing or when deselecting selected item by code. + +```csharp +public bool EmptySelectionAllowed { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## DropdownList<T>.HiddenCommand Property + +Dismissed event command. [Hidden](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.Hidden 'Tizen.UI.Components.Material.DropdownList<T>.Hidden'). + +```csharp +public System.Action<object,System.EventArgs> HiddenCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## DropdownList<T>.IsReadOnly Property + +Gets a value indicating whether the list of child items is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## DropdownList<T>.ItemClickedCommand Property + +ItemClicked event command. [ItemClicked](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.ItemClicked 'Tizen.UI.Components.Material.DropdownList<T>.ItemClicked'). + +```csharp +public System.Action<object,Tizen.UI.Components.SelectionGroupItemClickedEventArgs> ItemClickedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')Tizen.UI.Components.SelectionGroupItemClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## DropdownList<T>.Items Property + +Gets or sets the index of the currently selected child item. + +```csharp +public System.Collections.Generic.IList<T> Items { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## DropdownList<T>.ModalPivot Property + +Gets or sets the modal pivot. It is used to calculate the position when it is posted. + +```csharp +public Tizen.UI.Components.ModalPivot ModalPivot { get; set; } +``` + +Implements ModalPivot + +#### Property Value +Tizen.UI.Components.ModalPivot + +### Remarks +Changing this property after the dropdown list is added to the scene graph will have no effect. + + + +## DropdownList<T>.SelectedIndex Property + +Gets the current selected item index. + +```csharp +public int SelectedIndex { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## DropdownList<T>.SelectedItem Property + +Gets the current selected item. + +```csharp +public T SelectedItem { get; } +``` + +#### Property Value +[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + + + +## DropdownList<T>.SelectionChangedCommand Property + +Selected item changed event command. [SelectionChanged](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.SelectionChanged 'Tizen.UI.Components.Material.DropdownList<T>.SelectionChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.GroupSelectionChangedEventArgs> SelectionChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')Tizen.UI.Components.GroupSelectionChangedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## DropdownList<T>.this[int] Property + +Gets or sets the items. + +```csharp +public T this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') +### Methods + + + +## DropdownList<T>.Add(T) Method + +Adds an item to the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public void Add(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + +The object to add to the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +Implements [Add(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + +#### Exceptions + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + + + +## DropdownList<T>.Clear() Method + +Removes all child items from the list of child items. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## DropdownList<T>.Contains(T) Method + +Checks if the list of child items contains the specified child item. + +```csharp +public bool Contains(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + +The child item to check for. + +Implements [Contains(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Contains#System_Collections_Generic_ICollection_1_Contains__0_ 'System.Collections.Generic.ICollection`1.Contains(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the list of child items contains the child item, false otherwise. + + + +## DropdownList<T>.CopyTo(T[], int) Method + +Copies the child items in the list of child items to the specified array, starting at the specified index. + +```csharp +public void CopyTo(T[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the child items to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + +Implements [CopyTo(T[], int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.CopyTo#System_Collections_Generic_ICollection_1_CopyTo__0[],System_Int32_ 'System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)') + + + +## DropdownList<T>.Dismiss() Method + +Dismiss the modal from the window. + +```csharp +public void Dismiss(); +``` + + + +## DropdownList<T>.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +public System.Collections.Generic.IEnumerator<T> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the list of child items. + + + +## DropdownList<T>.IndexOf(T) Method + +Gets the index of the specified child item in the list of child items. + +```csharp +public int IndexOf(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + +The child item to find the index of. + +Implements [IndexOf(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.IndexOf#System_Collections_Generic_IList_1_IndexOf__0_ 'System.Collections.Generic.IList`1.IndexOf(`0)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the child item, or -1 if it is not found. + + + +## DropdownList<T>.Insert(int, T) Method + +Inserts a child item at the specified index in the list of child items. + +```csharp +public void Insert(int index, T item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child item at. + + + +`item` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + +The child item to insert. + +Implements [Insert(int, T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Insert#System_Collections_Generic_IList_1_Insert_System_Int32,_0_ 'System.Collections.Generic.IList`1.Insert(System.Int32,`0)') + + + +## DropdownList<T>.Post() Method + +Post as a modal content. + +```csharp +public void Post(); +``` + + + +## DropdownList<T>.Post(Rect) Method + +Post as a modal content with anchor data. + +```csharp +public void Post(Tizen.UI.Rect anchorBounds); +``` +#### Parameters + + + +`anchorBounds` Tizen.UI.Rect + +The bounds of the anchor object. It should be relative to the window's coordinate system. + + + +## DropdownList<T>.Post(Window) Method + +Post as a modal content to the given window. If no window is specified, it uses default window. + +```csharp +public void Post(Tizen.UI.Window window); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +## DropdownList<T>.Post(Window, Rect) Method + +Post as a modal content to the given window with anchor data. + +```csharp +public void Post(Tizen.UI.Window window, Tizen.UI.Rect anchorBounds); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +`anchorBounds` Tizen.UI.Rect + +The bounds of the anchor object. It should be relative to the window's coordinate system. + +Implements Post(Window, Rect)') + + + +## DropdownList<T>.Post(Window, Rect, Rect) Method + +Post as a modal content to the given window. If no window is specified, it uses default window. + +```csharp +public void Post(Tizen.UI.Window window, Tizen.UI.Rect anchorBounds, Tizen.UI.Rect restrictBounds); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +`anchorBounds` Tizen.UI.Rect + +The bounds of the anchor object. It should be relative to the window's coordinate system. + + + +`restrictBounds` Tizen.UI.Rect + +The bounds to restrict the modal to. It should be relative to the window's coordinate system. + + + +## DropdownList<T>.RemoveAt(int) Method + +Removes the child item at the specified index from the list of child items. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the child item to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Events + + + +## DropdownList<T>.Dismissed Event + +Occurred when the dismiss requested. + +```csharp +public event EventHandler Dismissed; +``` + +Implements Dismissed + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## DropdownList<T>.Hidden Event + +Occurred when the dropdown list is fully dismissed (animation finished). + +```csharp +public event EventHandler Hidden; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## DropdownList<T>.ItemClicked Event + +Occurs when the one of item has clicked. + +```csharp +public event EventHandler<SelectionGroupItemClickedEventArgs> ItemClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.Components.SelectionGroupItemClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## DropdownList<T>.SelectionChanged Event + +Occurs when the selected item is changed. [SelectedItem](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.SelectedItem 'Tizen.UI.Components.Material.DropdownList<T>.SelectedItem'). + +```csharp +public event EventHandler<GroupSelectionChangedEventArgs> SelectionChanged; +``` + +Implements SelectionChanged + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.Components.GroupSelectionChangedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') +### Explicit Interface Implementations + + + +## DropdownList<T>.System.Collections.Generic.ICollection<T>.Remove(T) Method + +Removes the item. + +```csharp +bool System.Collections.Generic.ICollection<T>.Remove(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.Material.DropdownList_T_.md#Tizen.UI.Components.Material.DropdownList_T_.T 'Tizen.UI.Components.Material.DropdownList<T>.T') + +The child item to be removed. + +Implements [Remove(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## DropdownList<T>.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + +## DropdownList<T>.Tizen.UI.Components.ISelectionGroup.Selected Property + +The selected child in the group. + +```csharp +Tizen.UI.Components.IGroupSelectable Tizen.UI.Components.ISelectionGroup.Selected { get; } +``` + +Implements Selected + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DynamicType.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DynamicType.md new file mode 100644 index 0000000000..60906cf3e7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DynamicType.md @@ -0,0 +1,54 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## DynamicType Enum + +Vector Property + +```csharp +public enum DynamicType +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md new file mode 100644 index 0000000000..a0546d09fc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md @@ -0,0 +1,203 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## FloatingActionButtonScrollBar Class + +A class representing a scroll bar with a floating icon. + +```csharp +public class FloatingActionButtonScrollBar : Tizen.UI.Components.Material.ScrollBar +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Components.ScrollBarBase 🡒 [ScrollBar](Tizen.UI.Components.Material.ScrollBar.md 'Tizen.UI.Components.Material.ScrollBar') 🡒 FloatingActionButtonScrollBar + +Derived +↳ [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') +### Constructors + + + +## FloatingActionButtonScrollBar() Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class. + +```csharp +public FloatingActionButtonScrollBar(); +``` + + + +## FloatingActionButtonScrollBar(ScrollBarVariables) Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class. + +```csharp +public FloatingActionButtonScrollBar(Tizen.UI.Components.Material.ScrollBarVariables varables); +``` +#### Parameters + + + +`varables` [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + + + +## FloatingActionButtonScrollBar(ScrollBarVariables, IconButtonVariables) Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class with variables. + +```csharp +public FloatingActionButtonScrollBar(Tizen.UI.Components.Material.ScrollBarVariables variables, Tizen.UI.Components.Material.IconButtonVariables iconVariables); +``` +#### Parameters + + + +`variables` [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + +The variables for the scroll bar. + + + +`iconVariables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables for the go to top icon. +### Properties + + + +## FloatingActionButtonScrollBar.FloatingActionButton Property + +Gets or sets a floating action button. +This button will be placed at the bottom right corner of the scaffold above the content. + +```csharp +public Tizen.UI.Components.Material.IconButton FloatingActionButton { get; set; } +``` + +#### Property Value +[IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') + +### Remarks +There are predefined contents such as [FloatingActionButton](Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md#Tizen.UI.Components.Material.FloatingActionButtonScrollBar.FloatingActionButton 'Tizen.UI.Components.Material.FloatingActionButtonScrollBar.FloatingActionButton'). + + + +## FloatingActionButtonScrollBar.FloatingIcon Property + +Clickable Go-To-Top icon. + +```csharp +public Tizen.UI.Components.Material.IconButton FloatingIcon { get; } +``` + +#### Property Value +[IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') + + + +## FloatingActionButtonScrollBar.FloatingOffset Property + +The relative offset of the floating action button from the bottom edge of the scaffold. + +```csharp +public Tizen.UI.Point FloatingOffset { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## FloatingActionButtonScrollBar.FloatingOrigin Property + +Gets or sets a origin type of floating action button regarding positioning. +This may change position and pivot properties of the floating action button. + +```csharp +public Tizen.UI.Components.FloatingOrigin FloatingOrigin { get; set; } +``` + +#### Property Value +Tizen.UI.Components.FloatingOrigin +### Methods + + + +## FloatingActionButtonScrollBar.SetExtraFloatingOffsetY(float) Method + +Sets an additional vertical offset for floating components. +Adjusts the Y position of the scaffold's floating action button by applying the specified offset. + +```csharp +public void SetExtraFloatingOffsetY(float extra); +``` +#### Parameters + + + +`extra` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## FloatingActionButtonScrollBar.UpdateScrollPosition(Point) Method + +Updates the scroll position of the target view. + +```csharp +public override void UpdateScrollPosition(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` Tizen.UI.Point + +The new scroll position. + +Implements UpdateScrollPosition(Point)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GoToTopScrollBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GoToTopScrollBar.md new file mode 100644 index 0000000000..6d1dcf6439 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GoToTopScrollBar.md @@ -0,0 +1,126 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## GoToTopScrollBar Class + +A class representing a scroll bar with a Got-o-top icon. + +```csharp +public class GoToTopScrollBar : Tizen.UI.Components.Material.FloatingActionButtonScrollBar +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Components.ScrollBarBase 🡒 [ScrollBar](Tizen.UI.Components.Material.ScrollBar.md 'Tizen.UI.Components.Material.ScrollBar') 🡒 [FloatingActionButtonScrollBar](Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md 'Tizen.UI.Components.Material.FloatingActionButtonScrollBar') 🡒 GoToTopScrollBar +### Constructors + + + +## GoToTopScrollBar() Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class. + +```csharp +public GoToTopScrollBar(); +``` + + + +## GoToTopScrollBar(ScrollBarVariables) Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class. + +```csharp +public GoToTopScrollBar(Tizen.UI.Components.Material.ScrollBarVariables varables); +``` +#### Parameters + + + +`varables` [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + + + +## GoToTopScrollBar(ScrollBarVariables, IconButtonVariables) Constructor + +Initializes a new instance of the [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') class with variables. + +```csharp +public GoToTopScrollBar(Tizen.UI.Components.Material.ScrollBarVariables variables, Tizen.UI.Components.Material.IconButtonVariables iconVariables); +``` +#### Parameters + + + +`variables` [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + +The variables for the scroll bar. + + + +`iconVariables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables for the go to top icon. +### Methods + + + +## GoToTopScrollBar.UpdateScrollPosition(Point) Method + +Updates the scroll position of the target view. + +```csharp +public override void UpdateScrollPosition(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` Tizen.UI.Point + +The new scroll position. + +Implements UpdateScrollPosition(Point)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GridView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GridView.md new file mode 100644 index 0000000000..bd9d393ce5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GridView.md @@ -0,0 +1,227 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## GridView Class + +A scroll view that displays recycling items in a grid layout. +It supports horizontal and vertical scrolling. The items can be bound to a data source using an item template. +The grid view can be customized with various properties such as span count, prefetch base size, and scroll bar visibility. +The grid view uses a recycler view internally to efficiently manage the display of items. +The grid view can be used to create a variety of layouts such as a photo gallery or a product catalog. + +```csharp +public class GridView : Tizen.UI.Components.Material.LoopedAdapterView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [AdapterView](Tizen.UI.Components.Material.AdapterView.md 'Tizen.UI.Components.Material.AdapterView') 🡒 [LoopedAdapterView](Tizen.UI.Components.Material.LoopedAdapterView.md 'Tizen.UI.Components.Material.LoopedAdapterView') 🡒 GridView +### Constructors + + + +## GridView() Constructor + +Creates a new instance of a GridView. + +```csharp +public GridView(); +``` +### Properties + + + +## GridView.GroupBodyTemplate Property + +The group body template for the list view. This template defines the appearance of the group bodies. Default is null. + +```csharp +public Tizen.UI.ViewTemplate GroupBodyTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## GridView.GroupHeaderTemplate Property + +The group header template for the grid view. This template defines the appearance of the group headers. Default is null. + +```csharp +public Tizen.UI.ViewTemplate GroupHeaderTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## GridView.HorizontalEdgeEffect Property + +Tizen.UI.Components.IEdgeEffect of horizontal scroll direction. + edge effect will be come when scroll over the edge of horizontal direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect HorizontalEdgeEffect { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IEdgeEffect + + + +## GridView.IsGrouped Property + +Boolean property indicating whether the grid view is grouped. Default is false. + +```csharp +public bool IsGrouped { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridView.IsHorizontal Property + +Boolean property indicating whether the grid view is arranged horizontally or vertically. Default is false. + +```csharp +public bool IsHorizontal { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridView.ItemAnimator Property + +Gets or sets the ItemAnimator for the GridView. + +```csharp +public Tizen.UI.Components.Recycler.IItemAnimator ItemAnimator { get; set; } +``` + +#### Property Value +Tizen.UI.Components.Recycler.IItemAnimator + + + +## GridView.OverScrollMode Property + +Set over scroll mode as type of [OverScrollMode](Tizen.UI.Components.Material.GridView.md#Tizen.UI.Components.Material.GridView.OverScrollMode 'Tizen.UI.Components.Material.GridView.OverScrollMode'). +Default mode is Tizen.UI.Components.OverScrollMode.ContentScrolls. + +```csharp +public Tizen.UI.Components.OverScrollMode OverScrollMode { get; set; } +``` + +#### Property Value +Tizen.UI.Components.OverScrollMode + + + +## GridView.SpanCount Property + +The span count for the grid view. The span count determines how many columns or rows are displayed in the grid. Default is 1. + +```csharp +public uint SpanCount { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## GridView.VerticalEdgeEffect Property + +Tizen.UI.Components.IEdgeEffect of vertical scroll direction. + edge effect will be come when scroll over the edge of vertical direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect VerticalEdgeEffect { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IEdgeEffect +### Methods + + + +## GridView.ScrollTo(int, ScrollToPosition, bool) Method + +Scrolls the RecyclerView to show the index position item in specified position with animation. + +```csharp +public System.Threading.Tasks.Task ScrollTo(int position, Tizen.UI.ScrollToPosition scrollToPosition=Tizen.UI.ScrollToPosition.MakeVisible, bool animation=true); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item to be shown. + + + +`scrollToPosition` Tizen.UI.ScrollToPosition + +The position to scroll to. It can be Start, Center, or End. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether the scrolling should be animated or not. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task representing the asynchronous operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IAppBarContent.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IAppBarContent.md new file mode 100644 index 0000000000..2bbffd0890 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IAppBarContent.md @@ -0,0 +1,107 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## IAppBarContent Interface + +Interface for AppBar content. It notify when an object is attached or detached. + +```csharp +public interface IAppBarContent +``` + +Derived +↳ [ActionButton](Tizen.UI.Components.Material.ActionButton.md 'Tizen.UI.Components.Material.ActionButton') +↳ [BackButton](Tizen.UI.Components.Material.BackButton.md 'Tizen.UI.Components.Material.BackButton') +↳ [DoubleTitle](Tizen.UI.Components.Material.DoubleTitle.md 'Tizen.UI.Components.Material.DoubleTitle') +↳ [MoreButton](Tizen.UI.Components.Material.MoreButton.md 'Tizen.UI.Components.Material.MoreButton') +↳ [Title](Tizen.UI.Components.Material.Title.md 'Tizen.UI.Components.Material.Title') +### Methods + + + +## IAppBarContent.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## IAppBarContent.OnAttached(AppBar) Method + +Called when the content is attached to AppBar. + +```csharp +void OnAttached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + + + +## IAppBarContent.OnDetached(AppBar) Method + +Called when the content is detected from AppBar. + +```csharp +void OnDetached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPageIndicator.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPageIndicator.md new file mode 100644 index 0000000000..2d1192a29d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPageIndicator.md @@ -0,0 +1,132 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## IPageIndicator Interface + +A Page indicator interface. + +```csharp +public interface IPageIndicator +``` + +Derived +↳ [PageIndicator](Tizen.UI.Components.Material.PageIndicator.md 'Tizen.UI.Components.Material.PageIndicator') +### Properties + + + +## IPageIndicator.CurrentPage Property + +Gets sets the current page. + +```csharp +int CurrentPage { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## IPageIndicator.PageAdapter Property + +Adapter who connects pager and indicator. + +```csharp +Tizen.UI.Components.Material.PageAdapter PageAdapter { get; set; } +``` + +#### Property Value +[PageAdapter](Tizen.UI.Components.Material.PageAdapter.md 'Tizen.UI.Components.Material.PageAdapter') + + + +## IPageIndicator.PageCount Property + +Gets sets the page count. + +```csharp +int PageCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## IPageIndicator.AddPage(int) Method + +Add page at the end. + +```csharp +void AddPage(int pageIndex); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The adding page index. + + + +## IPageIndicator.RemovePage(int) Method + +Remove page. + +```csharp +void RemovePage(int pageIndex); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The removing page index. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPager.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPager.md new file mode 100644 index 0000000000..a72d818bb6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPager.md @@ -0,0 +1,143 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## IPager Interface + +A Pager interface. + +```csharp +public interface IPager +``` + +Derived +↳ [PageScroller](Tizen.UI.Components.Material.PageScroller.md 'Tizen.UI.Components.Material.PageScroller') +### Properties + + + +## IPager.CurrentPage Property + +Gets sets the current page. + +```csharp +int CurrentPage { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## IPager.PageAdapter Property + +Adapter who connects pager and indicator. + +```csharp +Tizen.UI.Components.Material.PageAdapter PageAdapter { get; set; } +``` + +#### Property Value +[PageAdapter](Tizen.UI.Components.Material.PageAdapter.md 'Tizen.UI.Components.Material.PageAdapter') + + + +## IPager.PageCount Property + +Gets sets the page count. + +```csharp +int PageCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## IPager.this[int] Property + +Gets sets the page on index. + +```csharp +Tizen.UI.View this[int index] { get; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +#### Property Value +Tizen.UI.View +### Methods + + + +## IPager.ShowPage(int, bool) Method + +Show page in pager. + +```csharp +System.Threading.Tasks.Task ShowPage(int pageIndex, bool animation); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The page index to be shown. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +the visual object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButton.md new file mode 100644 index 0000000000..407109764c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButton.md @@ -0,0 +1,157 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## IconButton Class + +A [Button](Tizen.UI.Components.Material.Button.md 'Tizen.UI.Components.Material.Button') containing a single icon. + +```csharp +public class IconButton : Tizen.UI.Components.Clickable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 IconButton + +Derived +↳ [ActionButton](Tizen.UI.Components.Material.ActionButton.md 'Tizen.UI.Components.Material.ActionButton') +↳ [BackButton](Tizen.UI.Components.Material.BackButton.md 'Tizen.UI.Components.Material.BackButton') +↳ [MoreButton](Tizen.UI.Components.Material.MoreButton.md 'Tizen.UI.Components.Material.MoreButton') +### Constructors + + + +## IconButton() Constructor + +Constructs an empty button. + +```csharp +public IconButton(); +``` + + + +## IconButton(string) Constructor + +Constructs a button with icon resource url. + +```csharp +public IconButton(string iconResourceUrl); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The icon image url. + + + +## IconButton(string, IconButtonVariables) Constructor + +Constructs a button with icon resource url. + +```csharp +public IconButton(string iconResourceUrl, Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`iconResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The icon image url. + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables to apply to the button. + + + +## IconButton(IconButtonVariables) Constructor + +Constructs an empty button. + +```csharp +public IconButton(Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + +The variables to apply to the button. +### Properties + + + +## IconButton.IconCornerRadius Property + +Gets or sets the corner radius of the icon. + +```csharp +public Tizen.UI.CornerRadius IconCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## IconButton.Padding Property + +Gets or sets the padding of icon button. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButtonVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButtonVariables.md new file mode 100644 index 0000000000..e274739b1a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButtonVariables.md @@ -0,0 +1,327 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## IconButtonVariables Class + +Variables used for icon button. + +```csharp +public class IconButtonVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.IconButtonVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 IconButtonVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## IconButtonVariables.ActionButton Property + +Action button variables for app bar. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables ActionButton { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.BackButton Property + +Back button variables for app bar. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables BackButton { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.BackgroundBlur Property + +Gets or sets the icon button back drop blur level. + +```csharp +public float BackgroundBlur { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IconButtonVariables.BackgroundColor Property + +Gets or sets the icon button fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## IconButtonVariables.CornerRadius Property + +Gets or sets the icon button corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## IconButtonVariables.Default Property + +Default icon button variables. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables Default { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.DefaultHeight Property + +Gets or sets the icon button default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IconButtonVariables.DefaultWidth Property + +Gets or sets the icon button default width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IconButtonVariables.FAB Property + +Floating action button variables. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables FAB { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.GoToTop Property + +Go-to-top button variables. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables GoToTop { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.IconCornerRadius Property + +Gets or sets the icon corner radius. + +```csharp +public Tizen.UI.CornerRadius IconCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## IconButtonVariables.IconHeight Property + +Gets or sets the icon height size. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IconButtonVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## IconButtonVariables.IconResourceUrl Property + +Gets or sets the icon resource url. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IconButtonVariables.IconWidth Property + +Gets or sets the icon width size. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IconButtonVariables.MoreButton Property + +MoreVertical button variables for app bar. + +```csharp +public static Tizen.UI.Components.Material.IconButtonVariables MoreButton { get; } +``` + +#### Property Value +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## IconButtonVariables.Padding Property + +Gets or sets the icon button padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## IconButtonVariables.TouchEdgeInsets Property + +Gets or sets the icon expanded touch area offset. + +```csharp +public Tizen.UI.Thickness TouchEdgeInsets { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + +### Remarks +For example, the `Thickness(-5, -20, 10, 15)` will expend touch area to left 5, top 20, right 10, bottom 15. (total 15 horizontally, 35 vertically) + + + +## IconButtonVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + +## IconButtonVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Image.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Image.md new file mode 100644 index 0000000000..3db13fc681 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Image.md @@ -0,0 +1,147 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Image Class + +Image is a control for displaying an image resource. + +```csharp +public class Image : Tizen.UI.ImageView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 Image + +Derived +↳ [AnimatedImage](Tizen.UI.Components.Material.AnimatedImage.md 'Tizen.UI.Components.Material.AnimatedImage') +↳ [LottieImage](Tizen.UI.Components.Material.LottieImage.md 'Tizen.UI.Components.Material.LottieImage') +### Constructors + + + +## Image() Constructor + +Creates an instance of an Image. + +```csharp +public Image(); +``` + + + +## Image(string) Constructor + +Creates an instance of an Image. + +```csharp +public Image(string resourceUrl); +``` +#### Parameters + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## Image.SetDesiredTextureSize(float, float) Method + +(Not implemented) Sets the desired texture size. + +```csharp +public void SetDesiredTextureSize(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired width of the texture. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired height of the texture. + + + +## Image.SetMaskingMode(ImageMaskingMode) Method + +Sets the masking mode for the ImageVisual. + +```csharp +public void SetMaskingMode(Tizen.UI.ImageMaskingMode mode); +``` +#### Parameters + + + +`mode` Tizen.UI.ImageMaskingMode + +The masking mode to use. + + + +## Image.SetPixelArea(Rect) Method + +Sets the image area to be displayed. +It is a rectangular area. +The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively. +If not specified, the default value is UIRect (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image. +For normal quad images only. + +```csharp +public void SetPixelArea(Tizen.UI.Rect area); +``` +#### Parameters + + + +`area` Tizen.UI.Rect + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditor.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditor.md new file mode 100644 index 0000000000..2b2336b3ea --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditor.md @@ -0,0 +1,1066 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputEditor Class + +A multi-line text input control that supports various text editing features. + +```csharp +public class InputEditor : Tizen.UI.View, +Tizen.UI.IText, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextEditable, +Tizen.UI.ITextPadding, +Tizen.UI.Components.IDecoratableText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 InputEditor + +Implements Tizen.UI.IText, Tizen.UI.ITextAlignment, Tizen.UI.ITextEditable, Tizen.UI.ITextPadding, Tizen.UI.Components.IDecoratableText +### Constructors + + + +## InputEditor() Constructor + +Constructs an InputEditor. + +```csharp +public InputEditor(); +``` + + + +## InputEditor(InputEditorVariables) Constructor + +Constructs an InputEditor. + +```csharp +public InputEditor(Tizen.UI.Components.Material.InputEditorVariables variables); +``` +#### Parameters + + + +`variables` [InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables') +### Properties + + + +## InputEditor.AdjustedFontSizeScale Property + +Gets the adjusted font size scale used for rendering after applying all constraints, +including the current [MinimumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale'), [MaximumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale'), +and system font size scale adjustments. + +```csharp +public float AdjustedFontSizeScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If [MinimumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale') is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale') +(an inverted range), the [MinimumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale') value takes precedence +and is used as the adjusted scale. + + + +## InputEditor.CursorPosition Property + +Gets or sets the cursor position. + +```csharp +public int CursorPosition { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputEditor.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputEditor.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputEditor.FontSizeScale Property + +Gets or sets the scaling value of the font size. + +```csharp +public float FontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputEditor.FontSlant Property + +Gets or sets the font style weight such as Tizen.UI.FontSlant.Italic. + +```csharp +public Tizen.UI.FontSlant FontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## InputEditor.FontWeight Property + +Gets or sets the font style weight such as Tizen.UI.FontWeight.Bold. + +```csharp +public Tizen.UI.FontWeight FontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## InputEditor.FontWidth Property + +Gets or sets the font style width such as Tizen.UI.FontWidth.Condensed. + +```csharp +public Tizen.UI.FontWidth FontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## InputEditor.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements HorizontalAlignment + +#### Property Value +Tizen.UI.TextAlignment + + + +## InputEditor.InputColor Property + +Gets or sets the input color for the text will be added to the input area from now on. + +```csharp +public Tizen.UI.Color InputColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputEditor.InputFontFamily Property + +Gets or sets the input font family for the text will be added to the input area from now on. + +```csharp +public string InputFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputEditor.InputFontSize Property + +Gets or sets the input font size for the text will be added to the input area from now on. + +```csharp +public float InputFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputEditor.InputFontSlant Property + +Gets or sets the input font style weight such as Tizen.UI.FontSlant.Italic for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontSlant InputFontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## InputEditor.InputFontWeight Property + +Gets or sets the input font style weight such as Tizen.UI.FontWeight.Bold for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWeight InputFontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## InputEditor.InputFontWidth Property + +Gets or sets the input font style width such as Tizen.UI.FontWidth.Condensed for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWidth InputFontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## InputEditor.InputMethodContext Property + +Gets the input method context. + +```csharp +public Tizen.UI.InputMethodContext InputMethodContext { get; } +``` + +Implements InputMethodContext + +#### Property Value +Tizen.UI.InputMethodContext + + + +## InputEditor.IsAbsoluteLineHeight Property + +Gets or sets the line height policy. This value will determine how the line height is calculated. +If the value is false, the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is false with value 1.0f. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.IsEditable Property + +Gets or sets whether the text can be edited. + +```csharp +public bool IsEditable { get; set; } +``` + +Implements IsEditable + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.LineHeight Property + +Gets or sets the minimum line height. If the value is smaller than the natural line height, the natural line height will be used instead. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +This property is treated differently by the [LineHeightPolicy](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy 'LineHeightPolicy'). If the value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative'), the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative') with value 1.0f. + + + +## InputEditor.LineWLineBreakModerapMode Property + +Gets or sets the line break mode of the text. + +```csharp +public Tizen.UI.LineBreakMode LineWLineBreakModerapMode { get; set; } +``` + +#### Property Value +Tizen.UI.LineBreakMode + + + +## InputEditor.MaximumFontSizeScale Property + +Gets or sets the maximum allowable font size scale. + +```csharp +public float MaximumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is less than [MinimumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MinimumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.AdjustedFontSizeScale 'Tizen.UI.Components.Material.InputEditor.AdjustedFontSizeScale') will follow the minimum value. + + + +## InputEditor.MaximumLength Property + +Gets or sets the maximum length of the text. + +```csharp +public int MaximumLength { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputEditor.MinimumFontSizeScale Property + +Gets or sets the minimum allowable font size scale. + +```csharp +public float MinimumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputEditor.MaximumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.AdjustedFontSizeScale 'Tizen.UI.Components.Material.InputEditor.AdjustedFontSizeScale') will follow this minimum value. + + + +## InputEditor.Outline Property + +Gets or sets the outline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Outline> Outline { get; set; } +``` + +Implements Outline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Outline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputEditor.PlaceholderText Property + +Gets or sets the placeholder text. + +```csharp +public string PlaceholderText { get; set; } +``` + +Implements PlaceholderText + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputEditor.PlaceholderTextColor Property + +Gets or sets the placeholder text color. + +```csharp +public Tizen.UI.Color PlaceholderTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputEditor.SelectedText Property + +Gets the currently selected text. + +```csharp +public string SelectedText { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputEditor.SelectedTextIndex Property + +Gets the index range of the currently selected text. + +```csharp +public Tizen.UI.Components.ClosedRange<int> SelectedTextIndex { get; } +``` + +#### Property Value +Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + + + +## InputEditor.SelectionEnabled Property + +Gets or sets whether the text selection is enabled. + +```csharp +public bool SelectionEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.Strikethrough Property + +Gets or sets the strike through style for the text. + +```csharp +public System.Nullable<Tizen.UI.Strikethrough> Strikethrough { get; set; } +``` + +Implements Strikethrough + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Strikethrough[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputEditor.SystemFontFamilyEnabled Property + +Gets or sets whether the [FontFamily](Tizen.UI.Components.Material.InputEditor.md#Tizen.UI.Components.Material.InputEditor.FontFamily 'Tizen.UI.Components.Material.InputEditor.FontFamily') should be determined based on the system settings. + +```csharp +public bool SystemFontFamilyEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditor.Text Property + +Gets or sets the text to display in the UTF-8 format. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputEditor.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## InputEditor.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + +## InputEditor.TextShadow Property + +Gets or sets the drop shadow for the text. + +```csharp +public System.Nullable<Tizen.UI.TextShadow> TextShadow { get; set; } +``` + +Implements TextShadow + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.TextShadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputEditor.Underline Property + +Gets or sets the underline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Underline> Underline { get; set; } +``` + +Implements Underline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputEditor.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements VerticalAlignment + +#### Property Value +Tizen.UI.TextAlignment +### Methods + + + +## InputEditor.ClearSelection() Method + +Clears the current selection. + +```csharp +public void ClearSelection(); +``` + + + +## InputEditor.GetLineCount() Method + +Gets the number of lines of text. + +```csharp +public int GetLineCount(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputEditor.SelectText(int, int) Method + +Selects the text within the specified index range. + +```csharp +public void SelectText(int startIndex, int endIndex); +``` +#### Parameters + + + +`startIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The start index of the selection. + + + +`endIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The end index of the selection. + + + +## InputEditor.SelectWholeText() Method + +Selects the whole text. + +```csharp +public void SelectWholeText(); +``` + + + +## InputEditor.SetCursorBlink(float, float) Method + +Enables cursor blink. + +```csharp +public void SetCursorBlink(float interval, float duration); +``` +#### Parameters + + + +`interval` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The interval between blinks. + + + +`duration` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The duration of each blink. + + + +## InputEditor.SetCursorColor(Color) Method + +Sets the cursor color. + +```csharp +public void SetCursorColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputEditor.SetCursorWidth(int) Method + +Sets the cursor width. + +```csharp +public void SetCursorWidth(int width); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the cursor. + + + +## InputEditor.SetFontVariation(string, float) Method + +Sets Font Variation with string tag. + +```csharp +public void SetFontVariation(string tag, float value); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag of font variation. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of font variation. + + + +## InputEditor.SetInputFilter(string, string) Method + +Set input filter. + +```csharp +public void SetInputFilter(string include, string exclude=null); +``` +#### Parameters + + + +`include` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A regular expression in the set of characters to be accepted. + + + +`exclude` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A regular expression in the set of characters to be rejected. + + + +## InputEditor.SetInputMethodActionButtonTitle(ActionButtonTitle) Method + +Sets the input method's action button title. + +```csharp +public void SetInputMethodActionButtonTitle(Tizen.UI.ActionButtonTitle actionButtonTitle); +``` +#### Parameters + + + +`actionButtonTitle` Tizen.UI.ActionButtonTitle + +The title of the action button. + + + +## InputEditor.SetInputMethodCapitalMode(AutoCapital) Method + +Sets the input method's capital mode. + +```csharp +public void SetInputMethodCapitalMode(Tizen.UI.AutoCapital capitalMode); +``` +#### Parameters + + + +`capitalMode` Tizen.UI.AutoCapital + +The capital mode of the input method. + + + +## InputEditor.SetInputMethodPanelType(PanelLayout) Method + +Sets the input method's panel layout. + +```csharp +public void SetInputMethodPanelType(Tizen.UI.PanelLayout panelLayout); +``` +#### Parameters + + + +`panelLayout` Tizen.UI.PanelLayout + +The panel layout of the input method. + + + +## InputEditor.SetSecondaryCursorColor(Color) Method + +Sets the secondary cursor color. + +```csharp +public void SetSecondaryCursorColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputEditor.SetSelectionColor(Color) Method + +Sets the selection area color. + +```csharp +public void SetSelectionColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputEditor.SetSelectionHandleImage(string, string) Method + +Sets the selection handle images. + +```csharp +public void SetSelectionHandleImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputEditor.SetSelectionHandlePressedImage(string, string) Method + +Sets the pressed selection handle images. + +```csharp +public void SetSelectionHandlePressedImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputEditor.SetTextPadding(Thickness) Method + +Sets the padding for the text within the view. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` Tizen.UI.Thickness + +The padding thickness. + +Implements SetTextPadding(Thickness)') + + + +## InputEditor.UnsetCursorBlink() Method + +Disables the cursor blink. + +```csharp +public void UnsetCursorBlink(); +``` +### Events + + + +## InputEditor.AnchorClicked Event + +Occurs when the anchor is clicked in markup. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.AnchorClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InputEditor.CursorMoved Event + +Occurs when the cursor moved. + +```csharp +public event EventHandler CursorMoved; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputEditor.KeyPressed Event + +Occurs when any key is pressed. + +```csharp +public event EventHandler<string> KeyPressed; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InputEditor.MaximumLengthReached Event + +Occurs when the text has reached to the specified maximum length. + +```csharp +public event EventHandler MaximumLengthReached; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputEditor.SelectionChanged Event + +Occurs when the seledction changed. + +```csharp +public event EventHandler SelectionChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputEditor.SelectionCleared Event + +Occurs when the selection is cleared. + +```csharp +public event EventHandler SelectionCleared; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputEditor.SelectionStarted Event + +Occurs when the selection is started. + +```csharp +public event EventHandler SelectionStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputEditor.TextChanged Event + +Occurs when the text is changed. + +```csharp +public event EventHandler TextChanged; +``` + +Implements TextChanged + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditorVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditorVariables.md new file mode 100644 index 0000000000..44922f7f49 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditorVariables.md @@ -0,0 +1,74 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputEditorVariables Class + +Variables used for input editor. + +```csharp +public class InputEditorVariables : Tizen.UI.Components.Material.InputTextVariables, +System.IEquatable<Tizen.UI.Components.Material.InputEditorVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 [InputTextVariables](Tizen.UI.Components.Material.InputTextVariables.md 'Tizen.UI.Components.Material.InputTextVariables') 🡒 InputEditorVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## InputEditorVariables.Default Property + +Default input field variables. + +```csharp +public static Tizen.UI.Components.Material.InputEditorVariables Default { get; } +``` + +#### Property Value +[InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputField.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputField.md new file mode 100644 index 0000000000..1f0aefa19a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputField.md @@ -0,0 +1,1047 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputField Class + +A single-line text input control that supports various text editing features. + +```csharp +public class InputField : Tizen.UI.View, +Tizen.UI.IText, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextEditable, +Tizen.UI.ITextPadding, +Tizen.UI.Components.IDecoratableText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 InputField + +Implements Tizen.UI.IText, Tizen.UI.ITextAlignment, Tizen.UI.ITextEditable, Tizen.UI.ITextPadding, Tizen.UI.Components.IDecoratableText +### Constructors + + + +## InputField() Constructor + +Constructs an InputField. + +```csharp +public InputField(); +``` + + + +## InputField(InputFieldVariables) Constructor + +Constructs an InputField. + +```csharp +public InputField(Tizen.UI.Components.Material.InputFieldVariables variables); +``` +#### Parameters + + + +`variables` [InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables') +### Properties + + + +## InputField.AdjustedFontSizeScale Property + +Gets the adjusted font size scale used for rendering after applying all constraints, +including the current [MinimumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputField.MinimumFontSizeScale'), [MaximumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputField.MaximumFontSizeScale'), +and system font size scale adjustments. + +```csharp +public float AdjustedFontSizeScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If [MinimumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputField.MinimumFontSizeScale') is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputField.MaximumFontSizeScale') +(an inverted range), the [MinimumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputField.MinimumFontSizeScale') value takes precedence +and is used as the adjusted scale. + + + +## InputField.ClearFocusOnExecutionKey Property + +Whether to clear focus when getting a return key pressed. + +```csharp +public bool ClearFocusOnExecutionKey { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.CursorPosition Property + +Gets or sets the cursor position. + +```csharp +public int CursorPosition { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputField.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputField.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputField.FontSizeScale Property + +Gets or sets the scaling value of the font size. + +```csharp +public float FontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputField.FontSlant Property + +Gets or sets the font style weight such as Tizen.UI.FontSlant.Italic. + +```csharp +public Tizen.UI.FontSlant FontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## InputField.FontWeight Property + +Gets or sets the font style weight such as Tizen.UI.FontWeight.Bold. + +```csharp +public Tizen.UI.FontWeight FontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## InputField.FontWidth Property + +Gets or sets the font style width such as [FontStyleWidth.Condensed](https://docs.microsoft.com/en-us/dotnet/api/FontStyleWidth.Condensed 'FontStyleWidth.Condensed'). + +```csharp +public Tizen.UI.FontWidth FontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## InputField.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements HorizontalAlignment + +#### Property Value +Tizen.UI.TextAlignment + + + +## InputField.InputColor Property + +Gets or sets the input color for the text will be added to the input area from now on. + +```csharp +public Tizen.UI.Color InputColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputField.InputFontFamily Property + +Gets or sets the input font family for the text will be added to the input area from now on. + +```csharp +public string InputFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputField.InputFontSize Property + +Gets or sets the input font size for the text will be added to the input area from now on. + +```csharp +public float InputFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputField.InputFontSlant Property + +Gets or sets the input font style weight such as Tizen.UI.FontSlant.Italic for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontSlant InputFontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## InputField.InputFontWeight Property + +Gets or sets the input font style weight such as Tizen.UI.FontWeight.Bold for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWeight InputFontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## InputField.InputFontWidth Property + +Gets or sets the input font style width such as [FontStyleWidth.Condensed](https://docs.microsoft.com/en-us/dotnet/api/FontStyleWidth.Condensed 'FontStyleWidth.Condensed') for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWidth InputFontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## InputField.InputMethodContext Property + +Gets the input method context. + +```csharp +public Tizen.UI.InputMethodContext InputMethodContext { get; } +``` + +Implements InputMethodContext + +#### Property Value +Tizen.UI.InputMethodContext + + + +## InputField.IsEditable Property + +Gets or sets whether the text can be edited. + +```csharp +public bool IsEditable { get; set; } +``` + +Implements IsEditable + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.MaximumFontSizeScale Property + +Gets or sets the maximum allowable font size scale. + +```csharp +public float MaximumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is less than [MinimumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MinimumFontSizeScale 'Tizen.UI.Components.Material.InputField.MinimumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.AdjustedFontSizeScale 'Tizen.UI.Components.Material.InputField.AdjustedFontSizeScale') will follow the minimum value. + + + +## InputField.MaximumLength Property + +Gets or sets the maximum length of the text. + +```csharp +public int MaximumLength { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputField.MinimumFontSizeScale Property + +Gets or sets the minimum allowable font size scale. + +```csharp +public float MinimumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.MaximumFontSizeScale 'Tizen.UI.Components.Material.InputField.MaximumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.AdjustedFontSizeScale 'Tizen.UI.Components.Material.InputField.AdjustedFontSizeScale') will follow this minimum value. + + + +## InputField.Outline Property + +Gets or sets the outline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Outline> Outline { get; set; } +``` + +Implements Outline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Outline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputField.PasswordMode Property + +Gets or sets the password mode. + +```csharp +public Tizen.UI.HiddenInputMode PasswordMode { get; set; } +``` + +#### Property Value +Tizen.UI.HiddenInputModeH + + + +## InputField.PlaceholderText Property + +Gets or sets the placeholder text. + +```csharp +public string PlaceholderText { get; set; } +``` + +Implements PlaceholderText + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputField.PlaceholderTextColor Property + +Gets or sets the placeholder text color. + +```csharp +public Tizen.UI.Color PlaceholderTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputField.SelectedText Property + +Gets the currently selected text. + +```csharp +public string SelectedText { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputField.SelectedTextIndex Property + +Gets the index range of the currently selected text. + +```csharp +public Tizen.UI.Components.ClosedRange<int> SelectedTextIndex { get; } +``` + +#### Property Value +Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + + + +## InputField.SelectionEnabled Property + +Gets or sets whether the text selection is enabled. + +```csharp +public bool SelectionEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.ShowPlaceholderTextOnFocus Property + +Whether to keep showing the placeholder when the field is focused. + +```csharp +public bool ShowPlaceholderTextOnFocus { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.Strikethrough Property + +Gets or sets the strike through style for the text. + +```csharp +public System.Nullable<Tizen.UI.Strikethrough> Strikethrough { get; set; } +``` + +Implements Strikethrough + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Strikethrough[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputField.SystemFontFamilyEnabled Property + +Gets or sets whether the [FontFamily](Tizen.UI.Components.Material.InputField.md#Tizen.UI.Components.Material.InputField.FontFamily 'Tizen.UI.Components.Material.InputField.FontFamily') should be determined based on the system settings. + +```csharp +public bool SystemFontFamilyEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputField.Text Property + +Gets or sets the text to display in the UTF-8 format. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputField.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## InputField.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + +## InputField.TextShadow Property + +Gets or sets the drop shadow for the text. + +```csharp +public System.Nullable<Tizen.UI.TextShadow> TextShadow { get; set; } +``` + +Implements TextShadow + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.TextShadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputField.Underline Property + +Gets or sets the underline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Underline> Underline { get; set; } +``` + +Implements Underline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputField.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements VerticalAlignment + +#### Property Value +Tizen.UI.TextAlignment +### Methods + + + +## InputField.ClearSelection() Method + +Clears the current selection. + +```csharp +public void ClearSelection(); +``` + + + +## InputField.SelectText(int, int) Method + +Selects the text within the specified index range. + +```csharp +public void SelectText(int startIndex, int endIndex); +``` +#### Parameters + + + +`startIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The start index of the selection. + + + +`endIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The end index of the selection. + + + +## InputField.SelectWholeText() Method + +Selects the whole text. + +```csharp +public void SelectWholeText(); +``` + + + +## InputField.SetCursorBlink(float, float) Method + +Enables cursor blink. + +```csharp +public void SetCursorBlink(float interval, float duration); +``` +#### Parameters + + + +`interval` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The interval between blinks. + + + +`duration` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The duration of each blink. + + + +## InputField.SetCursorColor(Color) Method + +Sets the cursor color. + +```csharp +public void SetCursorColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputField.SetCursorWidth(int) Method + +Sets the cursor width. + +```csharp +public void SetCursorWidth(int width); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the cursor. + + + +## InputField.SetFontVariation(string, float) Method + +Sets Font Variation with string tag. + +```csharp +public void SetFontVariation(string tag, float value); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag of font variation. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of font variation. + + + +## InputField.SetInputFilter(string, string) Method + +Set input filter. + +```csharp +public void SetInputFilter(string include, string exclude=null); +``` +#### Parameters + + + +`include` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A regular expression in the set of characters to be accepted. + + + +`exclude` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A regular expression in the set of characters to be rejected. + + + +## InputField.SetInputMethodActionButtonTitle(ActionButtonTitle) Method + +Sets the input method's action button title. + +```csharp +public void SetInputMethodActionButtonTitle(Tizen.UI.ActionButtonTitle actionButtonTitle); +``` +#### Parameters + + + +`actionButtonTitle` Tizen.UI.ActionButtonTitle + +The title of the action button. + + + +## InputField.SetInputMethodCapitalMode(AutoCapital) Method + +Sets the input method's capital mode. + +```csharp +public void SetInputMethodCapitalMode(Tizen.UI.AutoCapital capitalMode); +``` +#### Parameters + + + +`capitalMode` Tizen.UI.AutoCapital + +The capital mode of the input method. + + + +## InputField.SetInputMethodPanelType(PanelLayout) Method + +Sets the input method's panel layout. + +```csharp +public void SetInputMethodPanelType(Tizen.UI.PanelLayout panelLayout); +``` +#### Parameters + + + +`panelLayout` Tizen.UI.PanelLayout + +The panel layout of the input method. + + + +## InputField.SetSecondaryCursorColor(Color) Method + +Sets the secondary cursor color. + +```csharp +public void SetSecondaryCursorColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputField.SetSelectionColor(Color) Method + +Sets the selection area color. + +```csharp +public void SetSelectionColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputField.SetSelectionHandleImage(string, string) Method + +Sets the selection handle images. + +```csharp +public void SetSelectionHandleImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputField.SetSelectionHandlePressedImage(string, string) Method + +Sets the pressed selection handle images. + +```csharp +public void SetSelectionHandlePressedImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputField.SetTextPadding(Thickness) Method + +Sets the padding for the text within the view. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` Tizen.UI.Thickness + +The padding thickness. + +Implements SetTextPadding(Thickness)') + + + +## InputField.UnsetCursorBlink() Method + +Disables the cursor blink. + +```csharp +public void UnsetCursorBlink(); +``` +### Events + + + +## InputField.AnchorClicked Event + +Occurs when the anchor is clicked in markup. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.AnchorClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InputField.CursorMoved Event + +Occurs when the cursor moved. + +```csharp +public event EventHandler CursorMoved; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputField.KeyPressed Event + +Occurs when any key is pressed. + +```csharp +public event EventHandler<string> KeyPressed; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InputField.MaximumLengthReached Event + +Occurs when the text has reached to the specified maximum length. + +```csharp +public event EventHandler MaximumLengthReached; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputField.SelectionChanged Event + +Occurs when the seledction changed. + +```csharp +public event EventHandler SelectionChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputField.SelectionCleared Event + +Occurs when the selection is cleared. + +```csharp +public event EventHandler SelectionCleared; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputField.SelectionStarted Event + +Occurs when the selection is started. + +```csharp +public event EventHandler SelectionStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputField.TextChanged Event + +Occurs when the text is changed. + +```csharp +public event EventHandler TextChanged; +``` + +Implements TextChanged + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputFieldVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputFieldVariables.md new file mode 100644 index 0000000000..944c69e582 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputFieldVariables.md @@ -0,0 +1,74 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputFieldVariables Class + +Variables used for input field. + +```csharp +public class InputFieldVariables : Tizen.UI.Components.Material.InputTextVariables, +System.IEquatable<Tizen.UI.Components.Material.InputFieldVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 [InputTextVariables](Tizen.UI.Components.Material.InputTextVariables.md 'Tizen.UI.Components.Material.InputTextVariables') 🡒 InputFieldVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## InputFieldVariables.Default Property + +Default input field variables. + +```csharp +public static Tizen.UI.Components.Material.InputFieldVariables Default { get; } +``` + +#### Property Value +[InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputPicker.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputPicker.md new file mode 100644 index 0000000000..74ed05ebf7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputPicker.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputPicker Class + +Represents a picker component that only shows an input field for direct value entry. + +```csharp +public class InputPicker : Tizen.UI.Components.Material.PickerBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [PickerBase](Tizen.UI.Components.Material.PickerBase.md 'Tizen.UI.Components.Material.PickerBase') 🡒 InputPicker +### Constructors + + + +## InputPicker(ClosedRange<int>) Constructor + +Initializes a new instance of the InputPicker class with the specified range and default variables. + +```csharp +public InputPicker(Tizen.UI.Components.ClosedRange<int> range); +``` +#### Parameters + + + +`range` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + +The range of values that the picker can select. + + + +## InputPicker(ClosedRange<int>, PickerVariables) Constructor + +Initializes a new instance of the InputPicker class with the specified range and variables. + +```csharp +public InputPicker(Tizen.UI.Components.ClosedRange<int> range, Tizen.UI.Components.Material.PickerVariables variables); +``` +#### Parameters + + + +`range` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + +The range of values that the picker can select. + + + +`variables` [PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables') + +The variables that define the picker's styling and behavioral properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputTextVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputTextVariables.md new file mode 100644 index 0000000000..3a0c17d225 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputTextVariables.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## InputTextVariables Class + +Variables used for input text. + +```csharp +public class InputTextVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.InputTextVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 InputTextVariables + +Derived +↳ [InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables') +↳ [InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables') + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[InputTextVariables](Tizen.UI.Components.Material.InputTextVariables.md 'Tizen.UI.Components.Material.InputTextVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## InputTextVariables.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputTextVariables.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputTextVariables.PlaceholderColor Property + +Gets or sets the placeholder text color. + +```csharp +public Tizen.UI.Color PlaceholderColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputTextVariables.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Label.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Label.md new file mode 100644 index 0000000000..11ffd0d265 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Label.md @@ -0,0 +1,774 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Label Class + +A text control that displays a short to medium length string of text. + +```csharp +public class Label : Tizen.UI.View, +Tizen.UI.IText, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextPadding, +Tizen.UI.ITextFormatting, +Tizen.UI.Components.IFlexibleText, +Tizen.UI.Components.IDecoratableText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Label + +Derived +↳ [Title](Tizen.UI.Components.Material.Title.md 'Tizen.UI.Components.Material.Title') + +Implements Tizen.UI.IText, Tizen.UI.ITextAlignment, Tizen.UI.ITextPadding, Tizen.UI.ITextFormatting, Tizen.UI.Components.IFlexibleText, Tizen.UI.Components.IDecoratableText +### Constructors + + + +## Label() Constructor + +Constructs a TextView. + +```csharp +public Label(); +``` + + + +## Label(string) Constructor + +Constructs a TextView with text. + +```csharp +public Label(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display. + + + +## Label(string, LabelVariables) Constructor + +Constructs a TextView with text. + +```csharp +public Label(string text, Tizen.UI.Components.Material.LabelVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display. + + + +`variables` [LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') + +The variables to apply to the text. + + + +## Label(LabelVariables) Constructor + +Constructs a TextView. + +```csharp +public Label(Tizen.UI.Components.Material.LabelVariables variables); +``` +#### Parameters + + + +`variables` [LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') + +The variables to apply to the text. +### Properties + + + +## Label.AdjustedFontSize Property + +Gets the adjusted font size after fitting the text by [AutoFontSize](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.AutoFontSize 'Tizen.UI.Components.Material.Label.AutoFontSize'). + +```csharp +public float AdjustedFontSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Label.AdjustedFontSizeScale Property + +Gets the adjusted font size scale used for rendering after applying all constraints, +including the current [MinimumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MinimumFontSizeScale 'Tizen.UI.Components.Material.Label.MinimumFontSizeScale'), [MaximumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MaximumFontSizeScale 'Tizen.UI.Components.Material.Label.MaximumFontSizeScale'), +and system font size scale adjustments. + +```csharp +public float AdjustedFontSizeScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If [MinimumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MinimumFontSizeScale 'Tizen.UI.Components.Material.Label.MinimumFontSizeScale') is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MaximumFontSizeScale 'Tizen.UI.Components.Material.Label.MaximumFontSizeScale') +(an inverted range), the [MinimumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MinimumFontSizeScale 'Tizen.UI.Components.Material.Label.MinimumFontSizeScale') value takes precedence +and is used as the adjusted scale. + + + +## Label.AnchorClickedColor Property + +Gets or sets the color of the anchor text when it is clicked in markup. + +```csharp +public Tizen.UI.Color AnchorClickedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Label.AnchorColor Property + +Gets or sets the color of the anchor text in markup. + +```csharp +public Tizen.UI.Color AnchorColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Label.AutoFontSize Property + +Gets or sets the auto font size options to fit text in the boundary of label. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + +### Remarks +The [FontSize](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.FontSize 'Tizen.UI.Components.Material.Label.FontSize') value will be ignored if this is not [AutoFontSize.None](https://docs.microsoft.com/en-us/dotnet/api/AutoFontSize.None 'AutoFontSize.None'). + + + +## Label.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Label.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Label.FontSizeScale Property + +Gets or sets the scaling value of the font size. + +```csharp +public float FontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Label.FontSlant Property + +Gets or sets the font style weight such as [FontStyleSlant.Italic](https://docs.microsoft.com/en-us/dotnet/api/FontStyleSlant.Italic 'FontStyleSlant.Italic'). + +```csharp +public Tizen.UI.FontSlant FontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## Label.FontWeight Property + +Gets or sets the font style weight such as [FontStyleWeight.Bold](https://docs.microsoft.com/en-us/dotnet/api/FontStyleWeight.Bold 'FontStyleWeight.Bold'). + +```csharp +public Tizen.UI.FontWeight FontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## Label.FontWidth Property + +Gets or sets the font style width such as [FontStyleWidth.Condensed](https://docs.microsoft.com/en-us/dotnet/api/FontStyleWidth.Condensed 'FontStyleWidth.Condensed'). + +```csharp +public Tizen.UI.FontWidth FontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## Label.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements HorizontalAlignment + +#### Property Value +Tizen.UI.TextAlignment + + + +## Label.IsAbsoluteLineHeight Property + +Gets or sets the line height policy. This value will determine how the line height is calculated. +If the value is false, the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is false with value 1.0f. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool IsMultiline { get; set; } +``` + +Implements IsMultiline + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.IsTextCutout Property + +Gets or sets whether to enable cutout of the text. + +```csharp +public bool IsTextCutout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.LineBreakMode Property + +Gets or sets the line break mode of the text. + +```csharp +public Tizen.UI.LineBreakMode LineBreakMode { get; set; } +``` + +#### Property Value +Tizen.UI.LineBreakMode + + + +## Label.LineHeight Property + +Gets or sets the minimum line height. If the value is smaller than the natural line height, the natural line height will be used instead. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +This property is treated differently by the [LineHeightPolicy](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy 'LineHeightPolicy'). If the value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative'), the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative') with value 1.0f. + + + +## Label.MaximumFontSizeScale Property + +Gets or sets the maximum allowable font size scale. + +```csharp +public float MaximumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is less than [MinimumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MinimumFontSizeScale 'Tizen.UI.Components.Material.Label.MinimumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.AdjustedFontSizeScale 'Tizen.UI.Components.Material.Label.AdjustedFontSizeScale') will follow the minimum value. + + + +## Label.MinimumFontSizeScale Property + +Gets or sets the minimum allowable font size scale. + +```csharp +public float MinimumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is greater than [MaximumFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.MaximumFontSizeScale 'Tizen.UI.Components.Material.Label.MaximumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.AdjustedFontSizeScale 'Tizen.UI.Components.Material.Label.AdjustedFontSizeScale') will follow this minimum value. + + + +## Label.Outline Property + +Gets or sets the outline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Outline> Outline { get; set; } +``` + +Implements Outline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Outline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Label.Strikethrough Property + +Gets or sets the strike through style for the text. + +```csharp +public System.Nullable<Tizen.UI.Strikethrough> Strikethrough { get; set; } +``` + +Implements Strikethrough + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Strikethrough[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Label.SystemFontFamilyEnabled Property + +Gets or sets whether the [FontFamily](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.FontFamily 'Tizen.UI.Components.Material.Label.FontFamily') should be determined based on the system settings. + +```csharp +public bool SystemFontFamilyEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Label.Text Property + +Gets or sets the text to display in the UTF-8 format. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Label.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## Label.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow, TextOverflow + +#### Property Value +Tizen.UI.TextOverflow + + + +## Label.TextShadow Property + +Gets or sets the drop shadow for the text. + +```csharp +public System.Nullable<Tizen.UI.TextShadow> TextShadow { get; set; } +``` + +Implements TextShadow + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.TextShadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Label.Underline Property + +Gets or sets the underline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Underline> Underline { get; set; } +``` + +Implements Underline + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Label.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements VerticalAlignment + +#### Property Value +Tizen.UI.TextAlignment +### Methods + + + +## Label.GetLineCount() Method + +Gets the number of lines of text within the current caluted width. +Note that it will not return valid count if the layout is not finished. + +```csharp +public int GetLineCount(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Label.GetLineCount(float) Method + +Gets the number of lines of text within given width. + +```csharp +public int GetLineCount(float width); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Label.Measure(float, float) Method + +Measures the view based on the available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +Tizen.UI.Size +The measured size of the view. + + + +## Label.SetFontVariation(string, float) Method + +Sets Font Variation with string tag. + +```csharp +public void SetFontVariation(string tag, float value); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag of font variation. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of font variation. + + + +## Label.SetMarqueeGap(float) Method + +Sets the gap before marquee wraps. + +```csharp +public void SetMarqueeGap(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The gap. + + + +## Label.SetMarqueeLoopCount(int) Method + +Sets the number of complete loops for marquee. + +```csharp +public void SetMarqueeLoopCount(int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of loops. + + + +## Label.SetMarqueeLoopDelay(float) Method + +Sets the amount of time to delay the starting time of marquee and further loops. + +```csharp +public void SetMarqueeLoopDelay(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The delay time in seconds. + + + +## Label.SetMarqueeSpeed(int) Method + +Sets the marquee speed. + +```csharp +public void SetMarqueeSpeed(int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The marquee speed in pixels per second. + + + +## Label.SetTextPadding(Thickness) Method + +Sets the padding for the text within the label. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` Tizen.UI.Thickness + +The padding thickness. + +Implements SetTextPadding(Thickness)') +### Events + + + +## Label.AnchorClicked Event + +Occurs when the anchor is clicked in markup. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.AnchorClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Label.FontSizeAdjusted Event + +Occurs when the font size is adjusted by [AutoFontSize](Tizen.UI.Components.Material.Label.md#Tizen.UI.Components.Material.Label.AutoFontSize 'Tizen.UI.Components.Material.Label.AutoFontSize'). + +```csharp +public event EventHandler FontSizeAdjusted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LabelVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LabelVariables.md new file mode 100644 index 0000000000..7605a87fe7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LabelVariables.md @@ -0,0 +1,116 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LabelVariables Class + +Variables used for label. + +```csharp +public class LabelVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.LabelVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 LabelVariables + +Derived +↳ [TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables') + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## LabelVariables.Default Property + +Default lavel variables. + +```csharp +public static Tizen.UI.Components.Material.LabelVariables Default { get; } +``` + +#### Property Value +[LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') + + + +## LabelVariables.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## LabelVariables.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LabelVariables.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBar.md new file mode 100644 index 0000000000..e3ba0301b0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBar.md @@ -0,0 +1,136 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LevelBar Class + +A level bar is a discrete slider with a specific GUI. +It can be used to select a value by moving the trail along the track. + +```csharp +public class LevelBar : Tizen.UI.Components.InteractiveProgress +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.InteractiveProgress 🡒 LevelBar +### Constructors + + + +## LevelBar(float, float, int) Constructor + +Constructs a new progress bar. + +```csharp +public LevelBar(float minimumValue, float maximumValue, int valueStepCount); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`valueStepCount` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LevelBar(float, float, int, LevelBarVariables) Constructor + +Constructs a new progress bar. + +```csharp +public LevelBar(float minimumValue, float maximumValue, int valueStepCount, Tizen.UI.Components.Material.LevelBarVariables variables); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`valueStepCount` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`variables` [LevelBarVariables](Tizen.UI.Components.Material.LevelBarVariables.md 'Tizen.UI.Components.Material.LevelBarVariables') +### Properties + + + +## LevelBar.Padding Property + +Gets or sets the padding of button. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## LevelBar.TrackThickness Property + +The thickness of the track. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBarVariables.md new file mode 100644 index 0000000000..80dbbcd80f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBarVariables.md @@ -0,0 +1,204 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LevelBarVariables Class + +Variables used for level bar. + +```csharp +public class LevelBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.LevelBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 LevelBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[LevelBarVariables](Tizen.UI.Components.Material.LevelBarVariables.md 'Tizen.UI.Components.Material.LevelBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## LevelBarVariables.Default Property + +Default variables for level bar. + +```csharp +public static Tizen.UI.Components.Material.LevelBarVariables Default { get; } +``` + +#### Property Value +[LevelBarVariables](Tizen.UI.Components.Material.LevelBarVariables.md 'Tizen.UI.Components.Material.LevelBarVariables') + + + +## LevelBarVariables.DividerColor Property + +Level bar divider color. + +```csharp +public Tizen.UI.Color DividerColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## LevelBarVariables.DividerOffset Property + +Level bar divider offset. + +```csharp +public float DividerOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LevelBarVariables.HandleAlignmentEnabled Property + +Level bar handle alignment enabled. + +```csharp +public bool HandleAlignmentEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LevelBarVariables.HandleColor Property + +Level bar handle color. + +```csharp +public Tizen.UI.Color HandleColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## LevelBarVariables.HandleHeight Property + +Level bar handle height. + +```csharp +public float HandleHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LevelBarVariables.HandleWidth Property + +Level bar handle width. + +```csharp +public float HandleWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LevelBarVariables.Padding Property + +Level bar padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## LevelBarVariables.TrackColor Property + +Level bar track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## LevelBarVariables.TrackThickness Property + +Level bar track thickness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LevelBarVariables.TrailColor Property + +Slider trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ListView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ListView.md new file mode 100644 index 0000000000..2c8e612453 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ListView.md @@ -0,0 +1,279 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ListView Class + +A scroll view that displays recycling items in a linear layout. +It supports horizontal and vertical scrolling. The items can be bound to a data source using an item template. +The list view can be customized with various properties such as prefetch base size, and scroll bar visibility. +The list view uses a recycler view internally to efficiently manage the display of items. + +```csharp +public class ListView : Tizen.UI.Components.Material.LoopedAdapterView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [AdapterView](Tizen.UI.Components.Material.AdapterView.md 'Tizen.UI.Components.Material.AdapterView') 🡒 [LoopedAdapterView](Tizen.UI.Components.Material.LoopedAdapterView.md 'Tizen.UI.Components.Material.LoopedAdapterView') 🡒 ListView +### Constructors + + + +## ListView() Constructor + +Creates a new instance of a list view. + +```csharp +public ListView(); +``` +### Properties + + + +## ListView.DividerTemplate Property + +The divider template for the list view. This template defines the appearance of the dividers between items. Default is null. + +```csharp +public Tizen.UI.ViewTemplate DividerTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## ListView.GroupBodyTemplate Property + +The group body template for the list view. This template defines the appearance of the group bodies. Default is null. + +```csharp +public Tizen.UI.ViewTemplate GroupBodyTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## ListView.GroupFooterTemplate Property + +The group footer template for the list view. This template defines the appearance of the group footers. Default is null. + +```csharp +public Tizen.UI.ViewTemplate GroupFooterTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## ListView.GroupHeaderTemplate Property + +The group header template for the list view. This template defines the appearance of the group headers. Default is null. + +```csharp +public Tizen.UI.ViewTemplate GroupHeaderTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## ListView.HasDivider Property + +Boolean property indicating whether the list view has dividers between items. Default is false. + +```csharp +public bool HasDivider { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ListView.HorizontalEdgeEffect Property + +Tizen.UI.Components.IEdgeEffect of horizontal scroll direction. + edge effect will be come when scroll over the edge of horizontal direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect HorizontalEdgeEffect { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IEdgeEffect + + + +## ListView.IsGrouped Property + +Boolean property indicating whether the list view is grouped. Default is false. + +```csharp +public bool IsGrouped { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ListView.IsHorizontal Property + +Boolean property indicating whether the list view is arranged horizontally or vertically. Default is false. + +```csharp +public bool IsHorizontal { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ListView.IsStickyHeader Property + +Boolean property indicating whether the list view has sticky headers. +Default is false. When true, the first item in each group will stick to the top of the list view when scrolling. + +```csharp +public bool IsStickyHeader { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ListView.ItemAnimator Property + +Gets or sets the ItemAnimator for the items animation. + +```csharp +public Tizen.UI.Components.Recycler.IItemAnimator ItemAnimator { get; set; } +``` + +#### Property Value +Tizen.UI.Components.Recycler.IItemAnimator + + + +## ListView.ItemTouchHelper Property + +The touch helper for item touch actions. see[ItemTouchHelper](Tizen.UI.Components.Material.ListView.md#Tizen.UI.Components.Material.ListView.ItemTouchHelper 'Tizen.UI.Components.Material.ListView.ItemTouchHelper'). + +```csharp +public Tizen.UI.Components.Recycler.ItemTouchHelper ItemTouchHelper { get; set; } +``` + +#### Property Value +Tizen.UI.Components.Recycler.ItemTouchHelper + + + +## ListView.OverScrollMode Property + +Set over scroll mode as type of [OverScrollMode](Tizen.UI.Components.Material.ListView.md#Tizen.UI.Components.Material.ListView.OverScrollMode 'Tizen.UI.Components.Material.ListView.OverScrollMode'). +Default mode is Tizen.UI.Components.OverScrollMode.ContentScrolls. + +```csharp +public Tizen.UI.Components.OverScrollMode OverScrollMode { get; set; } +``` + +#### Property Value +Tizen.UI.Components.OverScrollMode + + + +## ListView.VerticalEdgeEffect Property + +Tizen.UI.Components.IEdgeEffect of vertical scroll direction. + edge effect will be come when scroll over the edge of vertical direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect VerticalEdgeEffect { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IEdgeEffect +### Methods + + + +## ListView.ScrollTo(int, ScrollToPosition, bool) Method + +Scrolls the RecyclerView to show the index position item in specified position with animation. + +```csharp +public System.Threading.Tasks.Task ScrollTo(int position, Tizen.UI.ScrollToPosition scrollToPosition=Tizen.UI.ScrollToPosition.MakeVisible, bool animation=true); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item to be shown. + + + +`scrollToPosition` Tizen.UI.ScrollToPosition + +The position to scroll to. It can be Start, Center, or End. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether the scrolling should be animated or not. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task representing the asynchronous operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LoopedAdapterView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LoopedAdapterView.md new file mode 100644 index 0000000000..cc17e74243 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LoopedAdapterView.md @@ -0,0 +1,76 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LoopedAdapterView Class + +A loopable scroll view that displays recycling items in specific layouts with adapter. + +```csharp +public abstract class LoopedAdapterView : Tizen.UI.Components.Material.AdapterView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [AdapterView](Tizen.UI.Components.Material.AdapterView.md 'Tizen.UI.Components.Material.AdapterView') 🡒 LoopedAdapterView + +Derived +↳ [GridView](Tizen.UI.Components.Material.GridView.md 'Tizen.UI.Components.Material.GridView') +↳ [ListView](Tizen.UI.Components.Material.ListView.md 'Tizen.UI.Components.Material.ListView') +### Properties + + + +## LoopedAdapterView.IsLooping Property + +The boolean flag indicating whether the view should loop its items. +If true, the view will wrap around when reaching the end of the list. Default is false. + +```csharp +public bool IsLooping { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImage.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImage.md new file mode 100644 index 0000000000..9cf7478143 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImage.md @@ -0,0 +1,625 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LottieImage Class + +LottieImage is a control for displaying Lottie animations. + +```csharp +public class LottieImage : Tizen.UI.Components.Material.Image, +Tizen.UI.Components.IAnimatedImage +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 [Image](Tizen.UI.Components.Material.Image.md 'Tizen.UI.Components.Material.Image') 🡒 LottieImage + +Derived +↳ [SelectableLottieImage](Tizen.UI.Components.Material.SelectableLottieImage.md 'Tizen.UI.Components.Material.SelectableLottieImage') + +Implements Tizen.UI.Components.IAnimatedImage +### Constructors + + + +## LottieImage() Constructor + +Creates a LottieAnimationView. + +```csharp +public LottieImage(); +``` + + + +## LottieImage(string) Constructor + +Creates a LottieAnimationView. + +```csharp +public LottieImage(string resourceUrl); +``` +#### Parameters + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Properties + + + +## LottieImage.CurrentFrame Property + +Gets or sets the current frame of the animation. + +```csharp +public int CurrentFrame { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieImage.FrameSpeedFactor Property + +Specifies a speed factor for the animated image frame. + +```csharp +public float FrameSpeedFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The speed factor is a multiplier of the normal velocity of the animation. Values between [0,1] will +slow down the animation and values above one will speed up the animation. +The range of this value is clamped between [0.01f ~ 100.0f]. +The default is 1.0f. + + + +## LottieImage.IsLooping Property + +Gets or sets whether the animation should loop. + +```csharp +public bool IsLooping { get; set; } +``` + +Implements IsLooping + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LottieImage.PlayState Property + +Gets the current play state of the animation. + +```csharp +public Tizen.UI.AnimationState PlayState { get; } +``` + +#### Property Value +Tizen.UI.AnimationState + + + +## LottieImage.RedrawInScalingDown Property + +Whether to redraw the image when the visual is scaled down. + +```csharp +public bool RedrawInScalingDown { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +### Remarks +Inhouse API. The default is true. + + + +## LottieImage.RepeatCount Property + +Gets or sets the number of times the animation should repeat. + +```csharp +public int RepeatCount { get; set; } +``` + +Implements RepeatCount + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieImage.RepeatMode Property + +Gets or sets the mode of animation repetition. + +```csharp +public Tizen.UI.AnimationRepeatMode RepeatMode { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationRepeatMode + + + +## LottieImage.StopBehavior Property + +Gets or sets the behavior of the animation when it stops. + +```csharp +public Tizen.UI.AnimationStopBehavior StopBehavior { get; set; } +``` + +Implements StopBehavior + +#### Property Value +Tizen.UI.AnimationStopBehavior + + + +## LottieImage.TotalFrame Property + +Gets the total number of frames in the animation. + +```csharp +public int TotalFrame { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## LottieImage.ClearDynamicProperties() Method + +Clear registered dynamic properties. + +```csharp +public void ClearDynamicProperties(); +``` + + + +## LottieImage.GetContentInfo() Method + +Gets the content information of the animation. + +```csharp +public System.Collections.Generic.IList<(string,int,int)> GetContentInfo(); +``` + +#### Returns +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') +of tuples containing the layer name, start frame index, and end frame index. + + + +## LottieImage.GetMarkerInfo() Method + +Gets the marker information of the animation. + +```csharp +public System.Collections.Generic.IList<(string,int,int)> GetMarkerInfo(); +``` + +#### Returns +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') +of tuples containing the marker name, start frame index, and end frame index. + + + +## LottieImage.Pause() Method + +Pauses the animation. + +```csharp +public override void Pause(); +``` + +Implements Pause() + + + +## LottieImage.Play() Method + +Plays the animation. + +```csharp +public override void Play(); +``` + +Implements Play() + + + +## LottieImage.Play(int) Method + +Plays the animation from the specified frame. + +```csharp +public virtual void Play(int startFrame); +``` +#### Parameters + + + +`startFrame` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieImage.Play(int, int) Method + +Plays the animation with range. + +```csharp +public virtual void Play(int startFrame, int maxFrame); +``` +#### Parameters + + + +`startFrame` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`maxFrame` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieImage.Play(string) Method + +Plays the animation based on the given marker. +Animation will play between the start frame index and the end frame index of the specified marker. + +```csharp +public virtual void Play(string marker); +``` +#### Parameters + + + +`marker` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## LottieImage.Play(string, string) Method + +Plays the animation based on the given markers. +Animation will play between the start frame index of the startMarker and the end frame index of the endMarker. + +```csharp +public virtual void Play(string startMarker, string endMarker); +``` +#### Parameters + + + +`startMarker` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`endMarker` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## LottieImage.RegisterDynamicBackgroundColor(string, Func<int,Color>) Method + +Register a dynamic fill color (R, G, B, A) property. + +```csharp +public void RegisterDynamicBackgroundColor(string path, System.Func<int,Tizen.UI.Color> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +### Remarks +This can overwrite or overwritten by RegisterDynamicFillOpacity. +If you want to use both fill color and opacity, use only RegisterDynamicBackgroundColor with proper alpha value. + + + +## LottieImage.RegisterDynamicFillOpacity(string, Func<int,float>) Method + +Register a dynamic fill opacity property. + +```csharp +public void RegisterDynamicFillOpacity(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +### Remarks +This can overwrite or overwritten by RegisterDynamicBackgroundColor. +If you want to use both fill color and opacity, use only RegisterDynamicBackgroundColor with proper alpha value. + + + +## LottieImage.RegisterDynamicStrokeColor(string, Func<int,Color>) Method + +Register a dynamic stroke color (R, G, B, A) property. + +```csharp +public void RegisterDynamicStrokeColor(string path, System.Func<int,Tizen.UI.Color> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +### Remarks +This can overwrite or overwritten by RegisterDynamicStrokeOpacity. +If you want to use both stroke color and opacity, use only RegisterDynamicStrokeColor with proper alpha value. + + + +## LottieImage.RegisterDynamicStrokeOpacity(string, Func<int,float>) Method + +Register a dynamic stroke opacity property. + +```csharp +public void RegisterDynamicStrokeOpacity(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +### Remarks +This can overwrite or overwritten by RegisterDynamicStrokeColor. +If you want to use both stroke color and opacity, use only RegisterDynamicStrokeColor with proper alpha value. + + + +## LottieImage.RegisterDynamicStrokeWidth(string, Func<int,float>) Method + +Register a dynamic stroke width property. + +```csharp +public void RegisterDynamicStrokeWidth(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTransformAnchor(string, Func<int,Point>) Method + +Register a dynamic transform anchor property. + +```csharp +public void RegisterDynamicTransformAnchor(string path, System.Func<int,Tizen.UI.Point> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTransformOpacity(string, Func<int,float>) Method + +Register a dynamic transform opacity property. + +```csharp +public void RegisterDynamicTransformOpacity(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTransformPosition(string, Func<int,Point>) Method + +Register a dynamic transform position property. + +```csharp +public void RegisterDynamicTransformPosition(string path, System.Func<int,Tizen.UI.Point> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTransformRotation(string, Func<int,float>) Method + +Register a dynamic transform rotation property. + +```csharp +public void RegisterDynamicTransformRotation(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTransformScale(string, Func<int,Point>) Method + +Register a dynamic transform scale property. + +```csharp +public void RegisterDynamicTransformScale(string path, System.Func<int,Tizen.UI.Point> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTrimEnd(string, Func<int,Point>) Method + +Register a dynamic trim end property. + +```csharp +public void RegisterDynamicTrimEnd(string path, System.Func<int,Tizen.UI.Point> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.RegisterDynamicTrimStart(string, Func<int,float>) Method + +Register a dynamic trim start property. + +```csharp +public void RegisterDynamicTrimStart(string path, System.Func<int,float> valueProvider); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`valueProvider` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## LottieImage.Stop() Method + +Stops the animation. + +```csharp +public override void Stop(); +``` + +Implements Stop() +### Events + + + +## LottieImage.Finished Event + +Event triggered when the animation finishes. + +```csharp +public event EventHandler Finished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageProgress.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageProgress.md new file mode 100644 index 0000000000..b241753a25 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageProgress.md @@ -0,0 +1,57 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LottieImageProgress Class + +A progress using lottie animated image. + +```csharp +public abstract class LottieImageProgress : Tizen.UI.Components.Progress +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Progress 🡒 LottieImageProgress + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageTimeCounter.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageTimeCounter.md new file mode 100644 index 0000000000..dddf2d3e87 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageTimeCounter.md @@ -0,0 +1,119 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## LottieImageTimeCounter Class + +A time counter component using LottieImage. + +```csharp +public class LottieImageTimeCounter : Tizen.UI.Components.TimeCounter +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.TimeCounter 🡒 LottieImageTimeCounter +### Constructors + + + +## LottieImageTimeCounter(int, string) Constructor + +Constructs a new lottie image time counter. + +```csharp +public LottieImageTimeCounter(int totalTimeInMilliseconds, string resourceUrl); +``` +#### Parameters + + + +`totalTimeInMilliseconds` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## LottieImageTimeCounter(string) Constructor + +Constructs a new lottie image time counter. + +```csharp +public LottieImageTimeCounter(string resourceUrl); +``` +#### Parameters + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Properties + + + +## LottieImageTimeCounter.LottieImage Property + +Gets the lottie image handle. + +```csharp +public Tizen.UI.Components.Material.LottieImage LottieImage { get; } +``` + +#### Property Value +[LottieImage](Tizen.UI.Components.Material.LottieImage.md 'Tizen.UI.Components.Material.LottieImage') + + + +## LottieImageTimeCounter.UseReverseFrameIndex Property + +Gets or sets whether to use reverse frame index for lottie to describe remaining time. Default is false. + +```csharp +public bool UseReverseFrameIndex { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialApplication.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialApplication.md new file mode 100644 index 0000000000..2f188f745f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialApplication.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialApplication Class + +Represents an material application. + +```csharp +public class MaterialApplication : Tizen.UI.UIApplication +``` + +Inheritance Tizen.Applications.CoreApplication 🡒 Tizen.UI.UIApplication 🡒 MaterialApplication +### Constructors + + + +## MaterialApplication() Constructor + +Initializes a new instance of the [MaterialApplication](Tizen.UI.Components.Material.MaterialApplication.md 'Tizen.UI.Components.Material.MaterialApplication') class. + +```csharp +public MaterialApplication(); +``` + + + +## MaterialApplication(bool) Constructor + +Initializes a new instance of the [MaterialApplication](Tizen.UI.Components.Material.MaterialApplication.md 'Tizen.UI.Components.Material.MaterialApplication') class. + +```csharp +public MaterialApplication(bool isTransparentWindow); +``` +#### Parameters + + + +`isTransparentWindow` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the window should be transparent. +### Properties + + + +## MaterialApplication.Current Property + +Initializes a new instance of the [MaterialApplication](Tizen.UI.Components.Material.MaterialApplication.md 'Tizen.UI.Components.Material.MaterialApplication') class. + +```csharp +public static Tizen.UI.Components.Material.MaterialApplication Current { get; } +``` + +#### Property Value +[MaterialApplication](Tizen.UI.Components.Material.MaterialApplication.md 'Tizen.UI.Components.Material.MaterialApplication') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialBorder.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialBorder.md new file mode 100644 index 0000000000..6cfa5577c6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialBorder.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialBorder Class + +Represents an material borderline width. + +```csharp +public static class MaterialBorder +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialBorder +### Fields + + + +## MaterialBorder.Lg Field + +Large border line width. + +```csharp +public static readonly float Lg; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialBorder.Md Field + +Medium border line width. + +```csharp +public static readonly float Md; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialBorder.Sm Field + +Small border line width. + +```csharp +public static readonly float Sm; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## MaterialBorder.Get(string) Method + +Gets a border line width by its name. + +```csharp +public static float Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialColor.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialColor.md new file mode 100644 index 0000000000..cbf09d368c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialColor.md @@ -0,0 +1,1313 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialColor Class + +Represents an material resource. + +```csharp +public static class MaterialColor +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialColor +### Fields + + + +## MaterialColor.Background Field + +Background color. + +```csharp +public static readonly Color Background; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.BackgroundApp Field + +Background app color. + +```csharp +public static readonly Color BackgroundApp; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.BackgroundVariant Field + +Background variant color. + +```csharp +public static readonly Color BackgroundVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.BlurLightUltraThin Field + +Blur light ultra thin color. + +```csharp +public static readonly Color BlurLightUltraThin; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.BlurSurface Field + +Blur surface color. + +```csharp +public static readonly Color BlurSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Error Field + +Error color. + +```csharp +public static readonly Color Error; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ErrorContainer Field + +ErrorContainer color. + +```csharp +public static readonly Color ErrorContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Green Field + +Green color. + +```csharp +public static readonly Color Green; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.GreenBright Field + +Green bright color. + +```csharp +public static readonly Color GreenBright; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.InverseOnSurface Field + +InverseOnSurface color. + +```csharp +public static readonly Color InverseOnSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.InverseOnSurfaceContainer Field + +Inverse on surface container color. + +```csharp +public static readonly Color InverseOnSurfaceContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.InversePrimary Field + +InversePrimary color. + +```csharp +public static readonly Color InversePrimary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.InverseSurface Field + +InverseSurface color. + +```csharp +public static readonly Color InverseSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.InverseSurfaceContainer Field + +Inverse surface container color. + +```csharp +public static readonly Color InverseSurfaceContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnBackground Field + +OnBackground color. + +```csharp +public static readonly Color OnBackground; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnError Field + +OnError color. + +```csharp +public static readonly Color OnError; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnErrorContainer Field + +OnErrorContainer color. + +```csharp +public static readonly Color OnErrorContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnPrimary Field + +OnPrimary color. + +```csharp +public static readonly Color OnPrimary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnPrimaryContainer Field + +OnPrimaryContainer color. + +```csharp +public static readonly Color OnPrimaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSecondary Field + +OnSecondary color. + +```csharp +public static readonly Color OnSecondary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSecondaryContainer Field + +OnSecondaryContainer color. + +```csharp +public static readonly Color OnSecondaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurface Field + +OnSurface color. + +```csharp +public static readonly Color OnSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerFixed Field + +On surface container fixed color. + +```csharp +public static readonly Color OnSurfaceContainerFixed; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerFixedInverse Field + +On surface container fixed inverse color. + +```csharp +public static readonly Color OnSurfaceContainerFixedInverse; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerFixedVariant Field + +On surface container fixed variant color. + +```csharp +public static readonly Color OnSurfaceContainerFixedVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerFixedVariantBright Field + +On surface container fixed variant bright color. + +```csharp +public static readonly Color OnSurfaceContainerFixedVariantBright; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerHigher Field + +On surface container higher color. + +```csharp +public static readonly Color OnSurfaceContainerHigher; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerHighest Field + +On surface container highest color. + +```csharp +public static readonly Color OnSurfaceContainerHighest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerLow Field + +On surface container low color. + +```csharp +public static readonly Color OnSurfaceContainerLow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerLowest Field + +On surface container lowest color. + +```csharp +public static readonly Color OnSurfaceContainerLowest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceContainerSemi Field + +On surface container semi color. + +```csharp +public static readonly Color OnSurfaceContainerSemi; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnSurfaceVariant Field + +OnSurfaceVariant color. + +```csharp +public static readonly Color OnSurfaceVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnTertiary Field + +OnTertiary color. + +```csharp +public static readonly Color OnTertiary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OnTertiaryContainer Field + +OnTertiaryContainer color. + +```csharp +public static readonly Color OnTertiaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Orange Field + +Orange color. + +```csharp +public static readonly Color Orange; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OrangeBright Field + +Orange bright color. + +```csharp +public static readonly Color OrangeBright; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Outline Field + +Outline color. + +```csharp +public static readonly Color Outline; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineACC Field + +Outline accessibilty color. + +```csharp +public static readonly Color OutlineACC; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineACCHigh Field + +Outline accessibilty high color. + +```csharp +public static readonly Color OutlineACCHigh; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineACCLow Field + +Outline accessibilty low color. + +```csharp +public static readonly Color OutlineACCLow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineACCTranslucent Field + +Outline accessibilty translucent color. + +```csharp +public static readonly Color OutlineACCTranslucent; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineFixed Field + +Outline fixed color. + +```csharp +public static readonly Color OutlineFixed; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineHigh Field + +Outline high color. + +```csharp +public static readonly Color OutlineHigh; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineHighest Field + +Outline highest color. + +```csharp +public static readonly Color OutlineHighest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineLow Field + +Outline low color. + +```csharp +public static readonly Color OutlineLow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineLowest Field + +Outline lowest color. + +```csharp +public static readonly Color OutlineLowest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.OutlineVariant Field + +OutlineVariant color. + +```csharp +public static readonly Color OutlineVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.PressedOnColor Field + +Pressed on color. + +```csharp +public static readonly Color PressedOnColor; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.PressedOnSurface Field + +Pressed on surface color. + +```csharp +public static readonly Color PressedOnSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.PressedOnSurfaceVariant Field + +Pressed on surface variant color. + +```csharp +public static readonly Color PressedOnSurfaceVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Primary Field + +Primary color. + +```csharp +public static readonly Color Primary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.PrimaryContainer Field + +PrimaryContainer color. + +```csharp +public static readonly Color PrimaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.PrimaryHigh Field + +PrimaryHigh color. + +```csharp +public static readonly Color PrimaryHigh; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Red Field + +Red color. + +```csharp +public static readonly Color Red; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.RedBright Field + +Red bright color. + +```csharp +public static readonly Color RedBright; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Scrim Field + +Scrim color. + +```csharp +public static readonly Color Scrim; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ScrimDefault Field + +Scrim default color. + +```csharp +public static readonly Color ScrimDefault; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ScrimHelpOverlay Field + +Scrim help overlay color. + +```csharp +public static readonly Color ScrimHelpOverlay; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ScrimOnBlurSmallScreen Field + +Scrom on blur small screen color. + +```csharp +public static readonly Color ScrimOnBlurSmallScreen; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Secondary Field + +Secondary color. + +```csharp +public static readonly Color Secondary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SecondaryContainer Field + +SecondaryContainer color. + +```csharp +public static readonly Color SecondaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SelectedOnBackground Field + +Selected on background color. + +```csharp +public static readonly Color SelectedOnBackground; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SelectedOnSurface Field + +Selected on surface color. + +```csharp +public static readonly Color SelectedOnSurface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SelectedOnSurfaceVariant Field + +Selected on surface variant color. + +```csharp +public static readonly Color SelectedOnSurfaceVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Shadow Field + +Shadow color. + +```csharp +public static readonly Color Shadow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ShadowDefault Field + +Shadow default color. + +```csharp +public static readonly Color ShadowDefault; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ShadowVariant Field + +Shadow variant color. + +```csharp +public static readonly Color ShadowVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Surface Field + +Surface color. + +```csharp +public static readonly Color Surface; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceBright Field + +Surface bright color. + +```csharp +public static readonly Color SurfaceBright; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceBrightest Field + +Surface brightest color. + +```csharp +public static readonly Color SurfaceBrightest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainer Field + +Surface container color. + +```csharp +public static readonly Color SurfaceContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerFixed Field + +Surface container fixed color. + +```csharp +public static readonly Color SurfaceContainerFixed; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerFixedTranslucent Field + +Surface container fixed translucent color. + +```csharp +public static readonly Color SurfaceContainerFixedTranslucent; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerFixedVariant Field + +Surface container fixed variant color. + +```csharp +public static readonly Color SurfaceContainerFixedVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerHigh Field + +Surface container high color. + +```csharp +public static readonly Color SurfaceContainerHigh; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerHigher Field + +Surface container higher color. + +```csharp +public static readonly Color SurfaceContainerHigher; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerHigherTranslucent Field + +Surface container higher translucent color. + +```csharp +public static readonly Color SurfaceContainerHigherTranslucent; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerHighest Field + +Surface container highest color. + +```csharp +public static readonly Color SurfaceContainerHighest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerHighestTranslucent Field + +SurfaceContainerHighestTranslucent color. + +```csharp +public static readonly Color SurfaceContainerHighestTranslucent; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerLow Field + +Surface container low color. + +```csharp +public static readonly Color SurfaceContainerLow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerLowest Field + +Surface container lowest color. + +```csharp +public static readonly Color SurfaceContainerLowest; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerSemi Field + +Surface container semi color. + +```csharp +public static readonly Color SurfaceContainerSemi; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerTranslucent Field + +Surface container translucent color. + +```csharp +public static readonly Color SurfaceContainerTranslucent; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerTranslucentLow Field + +Surface container translucent low color. + +```csharp +public static readonly Color SurfaceContainerTranslucentLow; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceContainerTranslucentSemi Field + +Surface container translucent semi color. + +```csharp +public static readonly Color SurfaceContainerTranslucentSemi; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceDim Field + +SurfaceDim color. + +```csharp +public static readonly Color SurfaceDim; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceFixed Field + +Surface fixed color. + +```csharp +public static readonly Color SurfaceFixed; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceFixedVariant Field + +Surface fixed variant color. + +```csharp +public static readonly Color SurfaceFixedVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.SurfaceVariant Field + +Surface variant color. + +```csharp +public static readonly Color SurfaceVariant; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.Tertiary Field + +Tertiary color. + +```csharp +public static readonly Color Tertiary; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.TertiaryContainer Field + +TertiaryContainer color. + +```csharp +public static readonly Color TertiaryContainer; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.TextHighlight Field + +TextHighlight color. + +```csharp +public static readonly Color TextHighlight; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ToneOnTone Field + +Tone on tone color. + +```csharp +public static readonly Color ToneOnTone; +``` + +#### Field Value +Tizen.UI.Color + + + +## MaterialColor.ToneOnToneHigh Field + +Tone on tone high color. + +```csharp +public static readonly Color ToneOnToneHigh; +``` + +#### Field Value +Tizen.UI.Color +### Methods + + + +## MaterialColor.Get(string) Method + +Gets a color by its name. + +```csharp +public static Tizen.UI.Color Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +Tizen.UI.Color + + + +## MaterialColor.Update(IDictionary<string,Color>) Method + +The method to update the color table. + +```csharp +public static void Update(System.Collections.Generic.IDictionary<string,Tizen.UI.Color> table); +``` +#### Parameters + + + +`table` [System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialComponentVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialComponentVariables.md new file mode 100644 index 0000000000..bdba372d5b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialComponentVariables.md @@ -0,0 +1,762 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialComponentVariables Class + +Defines the variables for material components. + +```csharp +public class MaterialComponentVariables : Tizen.UI.Components.UIVariables +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.UIVariables 🡒 MaterialComponentVariables +### Properties + + + +## MaterialComponentVariables.Current Property + +Gets the current singleton instance set. + +```csharp +public static Tizen.UI.Components.Material.MaterialComponentVariables Current { get; } +``` + +#### Property Value +[MaterialComponentVariables](Tizen.UI.Components.Material.MaterialComponentVariables.md 'Tizen.UI.Components.Material.MaterialComponentVariables') +### Methods + + + +## MaterialComponentVariables.CreateActionButton() Method + +Creates the default action button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateActionButton(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreateAlertDialogDefault() Method + +Creates the default alert dialog variables. + +```csharp +public virtual Tizen.UI.Components.Material.AlertDialogVariables CreateAlertDialogDefault(); +``` + +#### Returns +[AlertDialogVariables](Tizen.UI.Components.Material.AlertDialogVariables.md 'Tizen.UI.Components.Material.AlertDialogVariables') + + + +## MaterialComponentVariables.CreateAppBarDefault() Method + +Creates the default app bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.AppBarVariables CreateAppBarDefault(); +``` + +#### Returns +[AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') + + + +## MaterialComponentVariables.CreateAppBarTransparent() Method + +Creates the transparent app bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.AppBarVariables CreateAppBarTransparent(); +``` + +#### Returns +[AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') + + + +## MaterialComponentVariables.CreateBackButton() Method + +Creates the default back button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateBackButton(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreateBottomSheetContainerDefault() Method + +Creates the default bottom sheet container vairables. + +```csharp +public virtual Tizen.UI.Components.Material.BottomSheetContainerVariables CreateBottomSheetContainerDefault(); +``` + +#### Returns +[BottomSheetContainerVariables](Tizen.UI.Components.Material.BottomSheetContainerVariables.md 'Tizen.UI.Components.Material.BottomSheetContainerVariables') + + + +## MaterialComponentVariables.CreateBottomSheetDefault() Method + +Creates the default bottom sheet variables. + +```csharp +public virtual Tizen.UI.Components.Material.BottomSheetVariables CreateBottomSheetDefault(); +``` + +#### Returns +[BottomSheetVariables](Tizen.UI.Components.Material.BottomSheetVariables.md 'Tizen.UI.Components.Material.BottomSheetVariables') + + + +## MaterialComponentVariables.CreateButtonDefault() Method + +Creates the default button variables. + +```csharp +public virtual Tizen.UI.Components.Material.ButtonVariables CreateButtonDefault(); +``` + +#### Returns +[ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') + + + +## MaterialComponentVariables.CreateButtonFlat() Method + +, + Creates the flat button variables. + +```csharp +public virtual Tizen.UI.Components.Material.ButtonVariables CreateButtonFlat(); +``` + +#### Returns +[ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') + + + +## MaterialComponentVariables.CreateCardDefault() Method + +Creates the default card variables. + +```csharp +public virtual Tizen.UI.Components.Material.CardVariables CreateCardDefault(); +``` + +#### Returns +[CardVariables](Tizen.UI.Components.Material.CardVariables.md 'Tizen.UI.Components.Material.CardVariables') + + + +## MaterialComponentVariables.CreateCheckboxDefault() Method + +Creates the default checkbox variables. + +```csharp +public virtual Tizen.UI.Components.Material.CheckboxVariables CreateCheckboxDefault(); +``` + +#### Returns +[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') + + + +## MaterialComponentVariables.CreateCheckboxGhost() Method + +Creates the ghost checkbox variables. + +```csharp +public virtual Tizen.UI.Components.Material.CheckboxVariables CreateCheckboxGhost(); +``` + +#### Returns +[CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') + + + +## MaterialComponentVariables.CreateCircleButtonDefault() Method + +Creates the default circle button variables. + +```csharp +public virtual Tizen.UI.Components.Material.CircleButtonVariables CreateCircleButtonDefault(); +``` + +#### Returns +[CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables') + + + +## MaterialComponentVariables.CreateDialogContainerDefault() Method + +Creates the default dialog container vairables. + +```csharp +public virtual Tizen.UI.Components.Material.DialogContainerVariables CreateDialogContainerDefault(); +``` + +#### Returns +[DialogContainerVariables](Tizen.UI.Components.Material.DialogContainerVariables.md 'Tizen.UI.Components.Material.DialogContainerVariables') + + + +## MaterialComponentVariables.CreateDialogDefault() Method + +Creates the default dialog variables. + +```csharp +public virtual Tizen.UI.Components.Material.DialogVariables CreateDialogDefault(); +``` + +#### Returns +[DialogVariables](Tizen.UI.Components.Material.DialogVariables.md 'Tizen.UI.Components.Material.DialogVariables') + + + +## MaterialComponentVariables.CreateDividerDefault() Method + +Creates the default divider variables. + +```csharp +public virtual Tizen.UI.Components.Material.DividerVariables CreateDividerDefault(); +``` + +#### Returns +[DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables') + + + +## MaterialComponentVariables.CreateDoubleTitleDefault() Method + +Creates the default title variables. + +```csharp +public virtual Tizen.UI.Components.Material.DoubleTitleVariables CreateDoubleTitleDefault(); +``` + +#### Returns +[DoubleTitleVariables](Tizen.UI.Components.Material.DoubleTitleVariables.md 'Tizen.UI.Components.Material.DoubleTitleVariables') + + + +## MaterialComponentVariables.CreateDrawerItemDefault() Method + +Creates the default Drawer item variables. + +```csharp +public virtual Tizen.UI.Components.Material.DrawerItemVariables CreateDrawerItemDefault(); +``` + +#### Returns +[DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables') + + + +## MaterialComponentVariables.CreateDropdownItemCheck() Method + +Creates the default dropdown item variables. + +```csharp +public virtual Tizen.UI.Components.Material.DropdownItemVariables CreateDropdownItemCheck(); +``` + +#### Returns +[DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## MaterialComponentVariables.CreateDropdownItemDefault() Method + +Creates the default dropdown item variables. + +```csharp +public virtual Tizen.UI.Components.Material.DropdownItemVariables CreateDropdownItemDefault(); +``` + +#### Returns +[DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') + + + +## MaterialComponentVariables.CreateDropdownListDefault() Method + +Creates the default dropdown list variables. + +```csharp +public virtual Tizen.UI.Components.Material.DropdownListVariables CreateDropdownListDefault(); +``` + +#### Returns +[DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables') + + + +## MaterialComponentVariables.CreateFloatingActionButton() Method + +Creates the default floating action button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateFloatingActionButton(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreateGoToTopButton() Method + +Creates the default floating action button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateGoToTopButton(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreateIconButtonDefault() Method + +Creates the primary button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateIconButtonDefault(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreateInputEditorDefault() Method + +Creates the default input editor variables. + +```csharp +public virtual Tizen.UI.Components.Material.InputEditorVariables CreateInputEditorDefault(); +``` + +#### Returns +[InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables') + + + +## MaterialComponentVariables.CreateInputFieldDefault() Method + +Creates the default input field variables. + +```csharp +public virtual Tizen.UI.Components.Material.InputFieldVariables CreateInputFieldDefault(); +``` + +#### Returns +[InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables') + + + +## MaterialComponentVariables.CreateLabelDefault() Method + +Creates the default label variables. + +```csharp +public virtual Tizen.UI.Components.Material.LabelVariables CreateLabelDefault(); +``` + +#### Returns +[LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') + + + +## MaterialComponentVariables.CreateLevelBarDefault() Method + +Creates the default level bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.LevelBarVariables CreateLevelBarDefault(); +``` + +#### Returns +[LevelBarVariables](Tizen.UI.Components.Material.LevelBarVariables.md 'Tizen.UI.Components.Material.LevelBarVariables') + + + +## MaterialComponentVariables.CreateModalDrawerDefault() Method + +Creates the default Modal Drawer variables. + +```csharp +public virtual Tizen.UI.Components.Material.ModalDrawerVariables CreateModalDrawerDefault(); +``` + +#### Returns +[ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') + + + +## MaterialComponentVariables.CreateMoreButton() Method + +Creates the default more button variables. + +```csharp +public virtual Tizen.UI.Components.Material.IconButtonVariables CreateMoreButton(); +``` + +#### Returns +[IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') + + + +## MaterialComponentVariables.CreatePageIndicator() Method + +Creates the page indicator variables. + +```csharp +public virtual Tizen.UI.Components.Material.PageIndicatorVariables CreatePageIndicator(); +``` + +#### Returns +[PageIndicatorVariables](Tizen.UI.Components.Material.PageIndicatorVariables.md 'Tizen.UI.Components.Material.PageIndicatorVariables') + + + +## MaterialComponentVariables.CreatePageIndicatorDot() Method + +Creates the page indicator dot variables. + +```csharp +public virtual Tizen.UI.Components.Material.PageIndicatorDotVariables CreatePageIndicatorDot(); +``` + +#### Returns +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## MaterialComponentVariables.CreatePageIndicatorHome() Method + +Creates the page indicator home variables. + +```csharp +public virtual Tizen.UI.Components.Material.PageIndicatorDotVariables CreatePageIndicatorHome(); +``` + +#### Returns +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## MaterialComponentVariables.CreatePageIndicatorPlus() Method + +Creates the page indicator plus variables. + +```csharp +public virtual Tizen.UI.Components.Material.PageIndicatorDotVariables CreatePageIndicatorPlus(); +``` + +#### Returns +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## MaterialComponentVariables.CreatePickerDefault() Method + +Creates the default picker variables. + +```csharp +public virtual Tizen.UI.Components.Material.PickerVariables CreatePickerDefault(); +``` + +#### Returns +[PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables') + + + +## MaterialComponentVariables.CreateProgressBarDefault() Method + +Creates the default progress bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.ProgressBarVariables CreateProgressBarDefault(); +``` + +#### Returns +[ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables') + + + +## MaterialComponentVariables.CreateProgressCircleDefault() Method + +Creates the default progress circle variables. + +```csharp +public virtual Tizen.UI.Components.Material.ProgressCircleVariables CreateProgressCircleDefault(); +``` + +#### Returns +[ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables') + + + +## MaterialComponentVariables.CreateProgressTimerDefault() Method + +Creates the default timer progress variables. + +```csharp +public virtual Tizen.UI.Components.Material.ProgressTimerVariables CreateProgressTimerDefault(); +``` + +#### Returns +[ProgressTimerVariables](Tizen.UI.Components.Material.ProgressTimerVariables.md 'Tizen.UI.Components.Material.ProgressTimerVariables') + + + +## MaterialComponentVariables.CreateRadioButtonDefault() Method + +Creates the default radio button variables. + +```csharp +public virtual Tizen.UI.Components.Material.RadioButtonVariables CreateRadioButtonDefault(); +``` + +#### Returns +[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') + + + +## MaterialComponentVariables.CreateRadioButtonGhost() Method + +Creates the ghost radio button variables. + +```csharp +public virtual Tizen.UI.Components.Material.RadioButtonVariables CreateRadioButtonGhost(); +``` + +#### Returns +[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') + + + +## MaterialComponentVariables.CreateScrollBarDefault() Method + +Creates the default scroll bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.ScrollBarVariables CreateScrollBarDefault(); +``` + +#### Returns +[ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + + + +## MaterialComponentVariables.CreateSliderDefault() Method + +Creates the default slider variables. + +```csharp +public virtual Tizen.UI.Components.Material.SliderVariables CreateSliderDefault(); +``` + +#### Returns +[SliderVariables](Tizen.UI.Components.Material.SliderVariables.md 'Tizen.UI.Components.Material.SliderVariables') + + + +## MaterialComponentVariables.CreateSmartTipDarkGray() Method + +Creates the dark gray smart tip variables. + +```csharp +public virtual Tizen.UI.Components.Material.SmartTipVariables CreateSmartTipDarkGray(); +``` + +#### Returns +[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + + + +## MaterialComponentVariables.CreateSmartTipDefault() Method + +Creates the default smart tip variables. + +```csharp +public virtual Tizen.UI.Components.Material.SmartTipVariables CreateSmartTipDefault(); +``` + +#### Returns +[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + + + +## MaterialComponentVariables.CreateSnackBarDefault() Method + +Creates the default snackbar variables. + +```csharp +public virtual Tizen.UI.Components.Material.SnackBarVariables CreateSnackBarDefault(); +``` + +#### Returns +[SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables') + + + +## MaterialComponentVariables.CreateSpinnerButtonDefault() Method + +Creates the default spinner button variables. + +```csharp +public virtual Tizen.UI.Components.Material.SpinnerButtonVariables CreateSpinnerButtonDefault(); +``` + +#### Returns +[SpinnerButtonVariables](Tizen.UI.Components.Material.SpinnerButtonVariables.md 'Tizen.UI.Components.Material.SpinnerButtonVariables') + + + +## MaterialComponentVariables.CreateStaticDrawerDefault() Method + +Creates the default Static Drawer variables. + +```csharp +public virtual Tizen.UI.Components.Material.StaticDrawerVariables CreateStaticDrawerDefault(); +``` + +#### Returns +[StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables') + + + +## MaterialComponentVariables.CreateSwitchDefault() Method + +Creates the default switch variables. + +```csharp +public virtual Tizen.UI.Components.Material.SwitchVariables CreateSwitchDefault(); +``` + +#### Returns +[SwitchVariables](Tizen.UI.Components.Material.SwitchVariables.md 'Tizen.UI.Components.Material.SwitchVariables') + + + +## MaterialComponentVariables.CreateTabBarBottom() Method + +Creates the default tab bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.TabBarVariables CreateTabBarBottom(); +``` + +#### Returns +[TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + + + +## MaterialComponentVariables.CreateTabBarDefault() Method + +Creates the default tab bar variables. + +```csharp +public virtual Tizen.UI.Components.Material.TabBarVariables CreateTabBarDefault(); +``` + +#### Returns +[TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + + + +## MaterialComponentVariables.CreateTabItemDefault() Method + +Creates the default tab item variables. + +```csharp +public virtual Tizen.UI.Components.Material.TabItemVariables CreateTabItemDefault(); +``` + +#### Returns +[TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables') + + + +## MaterialComponentVariables.CreateTitleDefault() Method + +Creates the default title variables. + +```csharp +public virtual Tizen.UI.Components.Material.TitleVariables CreateTitleDefault(); +``` + +#### Returns +[TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables') + + + +## MaterialComponentVariables.CreateToastDefault() Method + +Creates the default button variables. + +```csharp +public virtual Tizen.UI.Components.Material.ToastVariables CreateToastDefault(); +``` + +#### Returns +[ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialConfig.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialConfig.md new file mode 100644 index 0000000000..12b3edcc75 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialConfig.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialConfig Class + +The configuration of material components. + +```csharp +public class MaterialConfig : Tizen.UI.Components.UIConfig +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.UIConfig 🡒 MaterialConfig +### Constructors + + + +## MaterialConfig() Constructor + +Creates a new instance of UIConfig. + +```csharp +public MaterialConfig(); +``` +### Methods + + + +## MaterialConfig.CreateColorTable() Method + +Creates a color table. + +```csharp +public override System.Collections.Generic.IDictionary<string,Tizen.UI.Color> CreateColorTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') +The color table. + + + +## MaterialConfig.CreateThemeLoader() Method + +Creates a theme loader. + +```csharp +public override Tizen.UI.Components.IThemeLoader CreateThemeLoader(); +``` + +#### Returns +Tizen.UI.Components.IThemeLoader + + + +## MaterialConfig.CreateVariables() Method + +Creates variables for UI components. + +```csharp +public override Tizen.UI.Components.UIVariables CreateVariables(); +``` + +#### Returns +Tizen.UI.Components.UIVariables + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialCorner.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialCorner.md new file mode 100644 index 0000000000..65701dec47 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialCorner.md @@ -0,0 +1,181 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialCorner Class + +Represents an material corner radius. + +```csharp +public static class MaterialCorner +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialCorner +### Fields + + + +## MaterialCorner.Full Field + +Full corner radius + +```csharp +public static readonly CornerRadius Full; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Lg Field + +Large corner radius + +```csharp +public static readonly CornerRadius Lg; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Md Field + +Medium corner radius + +```csharp +public static readonly CornerRadius Md; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Sm Field + +Small corner radius + +```csharp +public static readonly CornerRadius Sm; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Sm2 Field + +Small2 corner radius + +```csharp +public static readonly CornerRadius Sm2; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Xl Field + +Extra large corner radius + +```csharp +public static readonly CornerRadius Xl; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Xs Field + +Extra small corner radius + +```csharp +public static readonly CornerRadius Xs; +``` + +#### Field Value +Tizen.UI.CornerRadius + + + +## MaterialCorner.Xs2 Field + +Extra small2 corner radius + +```csharp +public static readonly CornerRadius Xs2; +``` + +#### Field Value +Tizen.UI.CornerRadius +### Methods + + + +## MaterialCorner.Get(string) Method + +Gets a corner value by its name. + +```csharp +public static Tizen.UI.CornerRadius Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +Tizen.UI.CornerRadius + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFont.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFont.md new file mode 100644 index 0000000000..e2ee602578 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFont.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialFont Class + +Represents an material font family. + +```csharp +public static class MaterialFont +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialFont +### Fields + + + +## MaterialFont.Normal400 Field + +The normal 400 weight font family. + +```csharp +public static readonly string Normal400; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialFont.Normal600 Field + +The normal 600 weight font family. + +```csharp +public static readonly string Normal600; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## MaterialFont.Get(string) Method + +Gets a font famly value by its name. + +```csharp +public static string Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFontSize.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFontSize.md new file mode 100644 index 0000000000..cd2c783073 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFontSize.md @@ -0,0 +1,245 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialFontSize Class + +Represents an material font size. + +```csharp +public static class MaterialFontSize +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialFontSize +### Fields + + + +## MaterialFontSize.Lg Field + +Large font size. + +```csharp +public static readonly float Lg; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Lg2 Field + +2 Large font size. + +```csharp +public static readonly float Lg2; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Lg3 Field + +3 Large font size. + +```csharp +public static readonly float Lg3; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Md Field + +Medium font size. + +```csharp +public static readonly float Md; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Sm Field + +Small font size. + +```csharp +public static readonly float Sm; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Sm2 Field + +2 small font size. + +```csharp +public static readonly float Sm2; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xl Field + +Extra large font size. + +```csharp +public static readonly float Xl; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xl2 Field + +2 extra large font size. + +```csharp +public static readonly float Xl2; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xl3 Field + +3 extra large font size. + +```csharp +public static readonly float Xl3; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xs Field + +Extra small font size. + +```csharp +public static readonly float Xs; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xs2 Field + +2 extra small font size. + +```csharp +public static readonly float Xs2; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xs3 Field + +3 extra small font size. + +```csharp +public static readonly float Xs3; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialFontSize.Xs4 Field + +4 extra small font size. + +```csharp +public static readonly float Xs4; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## MaterialFontSize.Get(string) Method + +Gets a font size by its name. + +```csharp +public static float Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialIcon.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialIcon.md new file mode 100644 index 0000000000..5d6109d552 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialIcon.md @@ -0,0 +1,707 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialIcon Class + +Represents an material icon resources. + +```csharp +public static class MaterialIcon +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialIcon +### Properties + + + +## MaterialIcon.Accessibility Property + +The accessibility icon. + +```csharp +public static string Accessibility { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Add Property + +The add icon. + +```csharp +public static string Add { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowBack Property + +The arrow back icon. + +```csharp +public static string ArrowBack { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowDown Property + +The arrow down icon. + +```csharp +public static string ArrowDown { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowDropDown Property + +The arrow drop down icon. + +```csharp +public static string ArrowDropDown { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowDropUp Property + +The arrow drop up icon. + +```csharp +public static string ArrowDropUp { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowLeft Property + +The arrow left icon. + +```csharp +public static string ArrowLeft { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowRight Property + +The arrow right icon. + +```csharp +public static string ArrowRight { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.ArrowUp Property + +The arrow up icon. + +```csharp +public static string ArrowUp { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Camera Property + +The camera icon. + +```csharp +public static string Camera { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Check Property + +The check icon. + +```csharp +public static string Check { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Checkbox Property + +The checkbox icon. + +```csharp +public static string Checkbox { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.CheckboxBlank Property + +The checkbox blank icon. + +```csharp +public static string CheckboxBlank { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.CheckCircle Property + +The check circle icon. + +```csharp +public static string CheckCircle { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Close Property + +The close icon. + +```csharp +public static string Close { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Copy Property + +The copy icon. + +```csharp +public static string Copy { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.DeleteTrash Property + +The delete trash icon. + +```csharp +public static string DeleteTrash { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.DriveFileMove Property + +The move arrow folder icon. + +```csharp +public static string DriveFileMove { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Edit Property + +The edit icon. + +```csharp +public static string Edit { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Error Property + +The error icon. + +```csharp +public static string Error { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Home Property + +The home icon. + +```csharp +public static string Home { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.IndicatorHome Property + +The indicator home icon. + +```csharp +public static string IndicatorHome { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.IndicatorPlus Property + +The indicator plus icon. + +```csharp +public static string IndicatorPlus { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Info Property + +The info icon. + +```csharp +public static string Info { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.InfoFilled Property + +The info filled icon. + +```csharp +public static string InfoFilled { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Lock Property + +The lock icon. + +```csharp +public static string Lock { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Menu Property + +The navi recent icon. + +```csharp +public static string Menu { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Mic Property + +The mic icon. + +```csharp +public static string Mic { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.MoreHorizontal Property + +The more horizontal icon. + +```csharp +public static string MoreHorizontal { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.MoreVertical Property + +The more vertical icon. + +```csharp +public static string MoreVertical { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Photo Property + +The photo icon. + +```csharp +public static string Photo { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.PhotoFilled Property + +The photo filled icon. + +```csharp +public static string PhotoFilled { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.PlayCircle Property + +The play circle icon. + +```csharp +public static string PlayCircle { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Refresh Property + +The refresh icon. + +```csharp +public static string Refresh { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Remove Property + +The remove icon. + +```csharp +public static string Remove { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Search Property + +The search icon. + +```csharp +public static string Search { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Settings Property + +The settings icon. + +```csharp +public static string Settings { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.SlideShow Property + +The slideshow icon. + +```csharp +public static string SlideShow { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.SquareDot Property + +The square dot icon. + +```csharp +public static string SquareDot { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.SwapVertical Property + +The swap vertical icon. + +```csharp +public static string SwapVertical { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Tag Property + +The tag icon. + +```csharp +public static string Tag { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Timer Property + +The timer icon. + +```csharp +public static string Timer { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.VerticalAlignTop Property + +The vertical align top icon. + +```csharp +public static string VerticalAlignTop { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.VisibilityOff Property + +The visibility off icon. + +```csharp +public static string VisibilityOff { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.VolumeMute Property + +The media volume mute icon. + +```csharp +public static string VolumeMute { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.VolumeUp Property + +The media volume icon. + +```csharp +public static string VolumeUp { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.Wifi Property + +The wifi icon. + +```csharp +public static string Wifi { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.WifiOff Property + +The wifi off icon. + +```csharp +public static string WifiOff { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.WifiOneBar Property + +The wifi one bar icon. + +```csharp +public static string WifiOneBar { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## MaterialIcon.WifiTwoBar Property + +The wifi two bar icon. + +```csharp +public static string WifiTwoBar { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialResourceManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialResourceManager.md new file mode 100644 index 0000000000..ab1b9bfb50 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialResourceManager.md @@ -0,0 +1,78 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialResourceManager Class + +Provides a method to get the path of a resource file. + +```csharp +public static class MaterialResourceManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialResourceManager +### Methods + + + +## MaterialResourceManager.GetCommonPath(string) Method + +Gets the common path of the specified resource. + +```csharp +public static string GetCommonPath(string res); +``` +#### Parameters + + + +`res` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the resource. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The path of the resource. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialSpacing.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialSpacing.md new file mode 100644 index 0000000000..4107c38cf7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialSpacing.md @@ -0,0 +1,388 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialSpacing Class + +Represents an material spacings. + +```csharp +public static class MaterialSpacing +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MaterialSpacing +### Fields + + + +## MaterialSpacing.Lg1000 Field + +Large 1000 spacing. + +```csharp +public static readonly float Lg1000; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Lg600 Field + +Large 600 spacing. + +```csharp +public static readonly float Lg600; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Lg700 Field + +Large 700 spacing. + +```csharp +public static readonly float Lg700; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Lg800 Field + +Large 800 spacing. + +```csharp +public static readonly float Lg800; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Lg900 Field + +Large 900 spacing. + +```csharp +public static readonly float Lg900; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Md100 Field + +Medium 100 spacing. + +```csharp +public static readonly float Md100; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Md200 Field + +Medium 200 spacing. + +```csharp +public static readonly float Md200; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Md300 Field + +Medium 300 spacing. + +```csharp +public static readonly float Md300; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Md400 Field + +Large 400 spacing. + +```csharp +public static readonly float Md400; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Md500 Field + +Large 500 spacing. + +```csharp +public static readonly float Md500; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.None Field + +No spacing. + +```csharp +public static readonly float None; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Sm50 Field + +Small 50 spacing. + +```csharp +public static readonly float Sm50; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Sm60 Field + +Small 60 spacing. + +```csharp +public static readonly float Sm60; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Sm70 Field + +Small 70 spacing. + +```csharp +public static readonly float Sm70; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Sm80 Field + +Small 80 spacing. + +```csharp +public static readonly float Sm80; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Sm90 Field + +Small 90 spacing. + +```csharp +public static readonly float Sm90; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xl1100 Field + +Extra large 1100 spacing. + +```csharp +public static readonly float Xl1100; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xl1200 Field + +Extra large 1200 spacing. + +```csharp +public static readonly float Xl1200; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xl1300 Field + +Extra large 1300 spacing. + +```csharp +public static readonly float Xl1300; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xl1400 Field + +Extra large 1400 spacing. + +```csharp +public static readonly float Xl1400; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xs10 Field + +Extra small 10 spacing. + +```csharp +public static readonly float Xs10; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xs20 Field + +Extra small 20 spacing. + +```csharp +public static readonly float Xs20; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xs30 Field + +Extra small 30 spacing. + +```csharp +public static readonly float Xs30; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MaterialSpacing.Xs40 Field + +Extra small 40 spacing. + +```csharp +public static readonly float Xs40; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## MaterialSpacing.Get(string) Method + +Gets a spacing length by its name. + +```csharp +public static float Get(string tokenName); +``` +#### Parameters + + + +`tokenName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialThemeLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialThemeLoader.md new file mode 100644 index 0000000000..4c1942ac7a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialThemeLoader.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialThemeLoader Class + +The material theme loader. + +```csharp +public class MaterialThemeLoader : Tizen.UI.Components.TizenThemeLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.TizenThemeLoader 🡒 MaterialThemeLoader +### Methods + + + +## MaterialThemeLoader.LoadColorTable() Method + +Load color table for current theme. + +```csharp +public override System.Collections.Generic.IDictionary<string,Tizen.UI.Color> LoadColorTable(); +``` + +Implements LoadColorTable() + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialWidgetApplication.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialWidgetApplication.md new file mode 100644 index 0000000000..65169f98e7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialWidgetApplication.md @@ -0,0 +1,75 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MaterialWidgetApplication Class + +Represents an material widget application. + +```csharp +public class MaterialWidgetApplication : Tizen.UI.Widget.WidgetApplication +``` + +Inheritance Tizen.Applications.CoreApplication 🡒 Tizen.UI.Widget.WidgetApplication 🡒 MaterialWidgetApplication +### Constructors + + + +## MaterialWidgetApplication(Dictionary<Type,string>) Constructor + +The constructor for multi widget class and instance. + +```csharp +public MaterialWidgetApplication(System.Collections.Generic.Dictionary<System.Type,string> widgetTypes); +``` +#### Parameters + + + +`widgetTypes` [System.Collections.Generic.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2')[System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2') + +List of derived widget class type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer.md new file mode 100644 index 0000000000..7b7370ca7f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ModalDrawer Class + +A [ModalDrawer<T>](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>') with default item type of [DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem'). + +```csharp +public class ModalDrawer : Tizen.UI.Components.Material.ModalDrawer<Tizen.UI.Components.Material.DrawerItem> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Tizen.UI.Components.Material.Drawer<](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>')[DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem')[>](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>') 🡒 [Tizen.UI.Components.Material.ModalDrawer<](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>')[DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem')[>](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>') 🡒 ModalDrawer +### Constructors + + + +## ModalDrawer() Constructor + +Construct a new instance. + +```csharp +public ModalDrawer(); +``` + + + +## ModalDrawer(ModalDrawerVariables) Constructor + +Construct a new instance. + +```csharp +public ModalDrawer(Tizen.UI.Components.Material.ModalDrawerVariables variables); +``` +#### Parameters + + + +`variables` [ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') + +The variables to configure the tab bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawerVariables.md new file mode 100644 index 0000000000..ee5eeb38a9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawerVariables.md @@ -0,0 +1,152 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ModalDrawerVariables Class + +Variables used for Drawer. + +```csharp +public class ModalDrawerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ModalDrawerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ModalDrawerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ModalDrawerVariables.BackgroundColor Property + +Color of the background. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ModalDrawerVariables.Default Property + +Default variables for ModalDrawer. + +```csharp +public static Tizen.UI.Components.Material.ModalDrawerVariables Default { get; } +``` + +#### Property Value +[ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') + + + +## ModalDrawerVariables.DrawerColor Property + +Color of the Drawer. + +```csharp +public Tizen.UI.Color DrawerColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ModalDrawerVariables.DrawerCornerRadius Property + +Drawer corner radius. + +```csharp +public Tizen.UI.CornerRadius DrawerCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ModalDrawerVariables.DrawerItemSpacing Property + +Drawer spacing between items. + +```csharp +public float DrawerItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ModalDrawerVariables.DrawerPadding Property + +Drawer padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness DrawerPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ModalDrawerVariables.DrawerRatio Property + +Gets the Width of the Drawer component. + +```csharp +public float DrawerRatio { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer_T_.md new file mode 100644 index 0000000000..8609d2e89d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer_T_.md @@ -0,0 +1,145 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ModalDrawer<T> Class + +Canonical layout container that provides selectable items area in left side and content area in right side. +The items area can be hidden. + +```csharp +public class ModalDrawer<T> : Tizen.UI.Components.Material.Drawer<T> + where T : Tizen.UI.ContentView, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Tizen.UI.Components.Material.Drawer<](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>')[T](Tizen.UI.Components.Material.ModalDrawer_T_.md#Tizen.UI.Components.Material.ModalDrawer_T_.T 'Tizen.UI.Components.Material.ModalDrawer<T>.T')[>](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>') 🡒 ModalDrawer<T> + +Derived +↳ [ModalDrawer](Tizen.UI.Components.Material.ModalDrawer.md 'Tizen.UI.Components.Material.ModalDrawer') +### Constructors + + + +## ModalDrawer() Constructor + +Initializes a new instance of the Drawer class with default settings. + +```csharp +public ModalDrawer(); +``` + + + +## ModalDrawer(ModalDrawerVariables) Constructor + +Initializes a new instance of the Drawer class with specified variables. + +```csharp +public ModalDrawer(Tizen.UI.Components.Material.ModalDrawerVariables variables); +``` +#### Parameters + + + +`variables` [ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') + +The DrawerVariables object containing configuration for the drawer. +### Properties + + + +## ModalDrawer<T>.Content Property + +Gets or sets the content of the Drawer. + +```csharp +public override Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View +### Methods + + + +## ModalDrawer<T>.Close() Method + +Closes the drawer if it is open and is not of the static type. + +```csharp +public void Close(); +``` + + + +## ModalDrawer<T>.Open() Method + +Opens the drawer if it is not already open and is not of the static type. + +```csharp +public void Open(); +``` + + + +## ModalDrawer<T>.Toggle(KeyDeviceClass) Method + +Toggles the state of the drawer between open and closed. + +```csharp +public void Toggle(Tizen.UI.KeyDeviceClass device=Tizen.UI.KeyDeviceClass.None); +``` +#### Parameters + + + +`device` Tizen.UI.KeyDeviceClass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MoreButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MoreButton.md new file mode 100644 index 0000000000..0a5c5fab30 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MoreButton.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## MoreButton Class + +MoreVertical button is a button that pops up a contextual menu within a given navigator when clicked. +If no navigator is specified it will use default navigator. + +```csharp +public class MoreButton : Tizen.UI.Components.Material.IconButton, +Tizen.UI.Components.Material.IAppBarContent +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') 🡒 MoreButton + +Implements [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') +### Constructors + + + +## MoreButton() Constructor + +Constructs a button with icon resource url. + +```csharp +public MoreButton(); +``` + + + +## MoreButton(IconButtonVariables) Constructor + +Constructs a button with icon resource url. + +```csharp +public MoreButton(Tizen.UI.Components.Material.IconButtonVariables variables); +``` +#### Parameters + + + +`variables` [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') +### Properties + + + +## MoreButton.ModalContent Property + +Gets or sets the modal content to be shown when clicked. + +```csharp +public Tizen.UI.Components.IAnchoredModal ModalContent { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IAnchoredModal +### Methods + + + +## MoreButton.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +public void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +Implements [ApplyUnifiedContentColor(Color)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color) 'Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color)') + + + +## MoreButton.OnAttached(AppBar) Method + +Called when the content is attached to AppBar. + +```csharp +public virtual void OnAttached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnAttached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnAttached(Tizen.UI.Components.Material.AppBar)') + + + +## MoreButton.OnDetached(AppBar) Method + +Called when the content is detected from AppBar. + +```csharp +public virtual void OnDetached(Tizen.UI.Components.Material.AppBar appBar); +``` +#### Parameters + + + +`appBar` [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + +Implements [OnDetached(AppBar)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar) 'Tizen.UI.Components.Material.IAppBarContent.OnDetached(Tizen.UI.Components.Material.AppBar)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.NotificationDuration.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.NotificationDuration.md new file mode 100644 index 0000000000..12e6c03f2f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.NotificationDuration.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## NotificationDuration Class + +Notification Duration + +```csharp +public static class NotificationDuration +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 NotificationDuration +### Fields + + + +## NotificationDuration.Indefinite Field + +Indefinite duration for the notification. + +```csharp +public const uint Indefinite = 4294967295; +``` + +#### Field Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## NotificationDuration.Long Field + +Long duration for the notification. + +```csharp +public const uint Long = 2500; +``` + +#### Field Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## NotificationDuration.Short Field + +Short duration for the notification. + +```csharp +public const uint Short = 1500; +``` + +#### Field Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageAdapter.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageAdapter.md new file mode 100644 index 0000000000..25d3a91bf2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageAdapter.md @@ -0,0 +1,137 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageAdapter Class + +A Page adapter who connects pager and indicator. + +```csharp +public class PageAdapter +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PageAdapter +### Properties + + + +## PageAdapter.PageIndicator Property + +Indicator of page. + +```csharp +public Tizen.UI.Components.Material.IPageIndicator PageIndicator { get; set; } +``` + +#### Property Value +[IPageIndicator](Tizen.UI.Components.Material.IPageIndicator.md 'Tizen.UI.Components.Material.IPageIndicator') + + + +## PageAdapter.Pager Property + +Pager. + +```csharp +public Tizen.UI.Components.Material.IPager Pager { get; set; } +``` + +#### Property Value +[IPager](Tizen.UI.Components.Material.IPager.md 'Tizen.UI.Components.Material.IPager') +### Methods + + + +## PageAdapter.AddPage(View, int) Method + +Add page in indicator + +```csharp +public void AddPage(Tizen.UI.View page, int index); +``` +#### Parameters + + + +`page` Tizen.UI.View + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageAdapter.OnPageChanged(int) Method + +Notify page changed. + +```csharp +public virtual void OnPageChanged(int pageIndex); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The page index to be shown. + + + +## PageAdapter.RemovePage(View) Method + +Remove page in indicator + +```csharp +public void RemovePage(Tizen.UI.View page); +``` +#### Parameters + + + +`page` Tizen.UI.View + +The added page. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicator.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicator.md new file mode 100644 index 0000000000..7cb6f7ae55 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicator.md @@ -0,0 +1,215 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageIndicator Class + +A Page indicator component. + +```csharp +public class PageIndicator : Tizen.UI.ContentView, +Tizen.UI.Components.Material.IPageIndicator +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 PageIndicator + +Implements [IPageIndicator](Tizen.UI.Components.Material.IPageIndicator.md 'Tizen.UI.Components.Material.IPageIndicator') +### Constructors + + + +## PageIndicator() Constructor + +Constructs a page indicator. + +```csharp +public PageIndicator(); +``` + + + +## PageIndicator(PageIndicatorVariables) Constructor + +Constructs a page indicator with variables + +```csharp +public PageIndicator(Tizen.UI.Components.Material.PageIndicatorVariables variables); +``` +#### Parameters + + + +`variables` [PageIndicatorVariables](Tizen.UI.Components.Material.PageIndicatorVariables.md 'Tizen.UI.Components.Material.PageIndicatorVariables') +### Properties + + + +## PageIndicator.CurrentPage Property + +Gets sets the current page. + +```csharp +public int CurrentPage { get; set; } +``` + +Implements [CurrentPage](Tizen.UI.Components.Material.IPageIndicator.md#Tizen.UI.Components.Material.IPageIndicator.CurrentPage 'Tizen.UI.Components.Material.IPageIndicator.CurrentPage') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageIndicator.PageAdapter Property + +Adapter who connects pager and indicator. + +```csharp +public Tizen.UI.Components.Material.PageAdapter PageAdapter { get; set; } +``` + +Implements [PageAdapter](Tizen.UI.Components.Material.IPageIndicator.md#Tizen.UI.Components.Material.IPageIndicator.PageAdapter 'Tizen.UI.Components.Material.IPageIndicator.PageAdapter') + +#### Property Value +[PageAdapter](Tizen.UI.Components.Material.PageAdapter.md 'Tizen.UI.Components.Material.PageAdapter') + + + +## PageIndicator.PageCount Property + +Gets sets the page count. + +```csharp +public int PageCount { get; } +``` + +Implements [PageCount](Tizen.UI.Components.Material.IPageIndicator.md#Tizen.UI.Components.Material.IPageIndicator.PageCount 'Tizen.UI.Components.Material.IPageIndicator.PageCount') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageIndicator.PageDotTemplate Property + +View template of page dot. +If view implments ISelectable, Select state will be updated on the view, +when the indexed page are changed. + +```csharp +public Tizen.UI.ViewTemplate PageDotTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## PageIndicator.Spacing Property + +Gets or sets the spacing between the indicator dots. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PageIndicator.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +#### Property Value +Tizen.UI.View +### Methods + + + +## PageIndicator.AddPage(int) Method + +Add page at the end. + +```csharp +public void AddPage(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [AddPage(int)](Tizen.UI.Components.Material.IPageIndicator.md#Tizen.UI.Components.Material.IPageIndicator.AddPage(int) 'Tizen.UI.Components.Material.IPageIndicator.AddPage(int)') + + + +## PageIndicator.RemovePage(int) Method + +Remove page. + +```csharp +public void RemovePage(int pageIndex); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The removing page index. + +Implements [RemovePage(int)](Tizen.UI.Components.Material.IPageIndicator.md#Tizen.UI.Components.Material.IPageIndicator.RemovePage(int) 'Tizen.UI.Components.Material.IPageIndicator.RemovePage(int)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDot.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDot.md new file mode 100644 index 0000000000..44f1c72cb4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDot.md @@ -0,0 +1,83 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageIndicatorDot Class + +A Page indicator dot elements. + +```csharp +public class PageIndicatorDot : Tizen.UI.Components.Selectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 PageIndicatorDot +### Constructors + + + +## PageIndicatorDot() Constructor + +Constructs a page indicator dot. + +```csharp +public PageIndicatorDot(); +``` + + + +## PageIndicatorDot(PageIndicatorDotVariables) Constructor + +Constructs a page indicator dot with variables. + +```csharp +public PageIndicatorDot(Tizen.UI.Components.Material.PageIndicatorDotVariables variables); +``` +#### Parameters + + + +`variables` [PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDotVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDotVariables.md new file mode 100644 index 0000000000..63c95db400 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDotVariables.md @@ -0,0 +1,194 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageIndicatorDotVariables Class + +Variables used for page indicator dot. + +```csharp +public class PageIndicatorDotVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.PageIndicatorDotVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 PageIndicatorDotVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## PageIndicatorDotVariables.Default Property + +Default page indicator dot variables. + +```csharp +public static Tizen.UI.Components.Material.PageIndicatorDotVariables Default { get; } +``` + +#### Property Value +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## PageIndicatorDotVariables.Home Property + +Ghost checkbox variables. + +```csharp +public static Tizen.UI.Components.Material.PageIndicatorDotVariables Home { get; } +``` + +#### Property Value +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## PageIndicatorDotVariables.IconColor Property + +Page indicator dot icon color. + +```csharp +public Tizen.UI.Color IconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## PageIndicatorDotVariables.IconHeight Property + +Page indicator dot icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PageIndicatorDotVariables.IconResourceUrl Property + +Page indicator dot icon resource url. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## PageIndicatorDotVariables.IconWidth Property + +Page indicator dot icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PageIndicatorDotVariables.Padding Property + +Page indicator dot padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## PageIndicatorDotVariables.Plus Property + +Ghost checkbox variables. + +```csharp +public static Tizen.UI.Components.Material.PageIndicatorDotVariables Plus { get; } +``` + +#### Property Value +[PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') + + + +## PageIndicatorDotVariables.SelectedIconColor Property + +Page indicator dot icon selected color. + +```csharp +public Tizen.UI.Color SelectedIconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## PageIndicatorDotVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorVariables.md new file mode 100644 index 0000000000..5e9b1add27 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorVariables.md @@ -0,0 +1,87 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageIndicatorVariables Class + +Variables used for page indicator. + +```csharp +public class PageIndicatorVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.PageIndicatorVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 PageIndicatorVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[PageIndicatorVariables](Tizen.UI.Components.Material.PageIndicatorVariables.md 'Tizen.UI.Components.Material.PageIndicatorVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## PageIndicatorVariables.Default Property + +Default page indicator variables. + +```csharp +public static Tizen.UI.Components.Material.PageIndicatorVariables Default { get; } +``` + +#### Property Value +[PageIndicatorVariables](Tizen.UI.Components.Material.PageIndicatorVariables.md 'Tizen.UI.Components.Material.PageIndicatorVariables') + + + +## PageIndicatorVariables.Spacing Property + +Spacing between the indicator dots. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageScroller.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageScroller.md new file mode 100644 index 0000000000..fefa9c71f3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageScroller.md @@ -0,0 +1,526 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PageScroller Class + +A Page scroller component. + +```csharp +public class PageScroller : Tizen.UI.ContentView, +Tizen.UI.Components.Material.IPager, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 PageScroller + +Implements [IPager](Tizen.UI.Components.Material.IPager.md 'Tizen.UI.Components.Material.IPager'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## PageScroller() Constructor + +Constructs a Page Scroller. + +```csharp +public PageScroller(); +``` +### Properties + + + +## PageScroller.Children Property + +Children of the page scroller. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## PageScroller.CurrentPage Property + +Gets sets the current page. + +```csharp +public int CurrentPage { get; } +``` + +Implements [CurrentPage](Tizen.UI.Components.Material.IPager.md#Tizen.UI.Components.Material.IPager.CurrentPage 'Tizen.UI.Components.Material.IPager.CurrentPage') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageScroller.IsHorizontal Property + +Gets or sets the direction of page scroller is horizontal or not. + +```csharp +public bool IsHorizontal { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## PageScroller.IsScrolling Property + +Gets a value indicating whether the scroll is currently in progress. + +```csharp +public bool IsScrolling { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## PageScroller.Padding Property + +Gets or sets the padding on PageScroller. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## PageScroller.PageAdapter Property + +Adapter who connects pager and indicator. + +```csharp +public Tizen.UI.Components.Material.PageAdapter PageAdapter { get; set; } +``` + +Implements [PageAdapter](Tizen.UI.Components.Material.IPager.md#Tizen.UI.Components.Material.IPager.PageAdapter 'Tizen.UI.Components.Material.IPager.PageAdapter') + +#### Property Value +[PageAdapter](Tizen.UI.Components.Material.PageAdapter.md 'Tizen.UI.Components.Material.PageAdapter') + + + +## PageScroller.PageCount Property + +Gets sets the page count. + +```csharp +public int PageCount { get; } +``` + +Implements [PageCount](Tizen.UI.Components.Material.IPager.md#Tizen.UI.Components.Material.IPager.PageCount 'Tizen.UI.Components.Material.IPager.PageCount') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageScroller.SnapPointsAlignment Property + +Page alignment of scroll. default is Center. +[SnapPointsAlignment](Tizen.UI.Components.Material.PageScroller.md#Tizen.UI.Components.Material.PageScroller.SnapPointsAlignment 'Tizen.UI.Components.Material.PageScroller.SnapPointsAlignment'). + +```csharp +public Tizen.UI.Layouts.SnapPointsAlignment SnapPointsAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.SnapPointsAlignment + + + +## PageScroller.SnapPointType Property + +Specifies the behavior of snap points when scrolling. +default is MandatorySingle + +```csharp +public Tizen.UI.Layouts.SnapPointsType SnapPointType { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.SnapPointsType + + + +## PageScroller.Spacing Property + +Gets or sets the spacing between pages. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PageScroller.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)'), [this[int]](Tizen.UI.Components.Material.IPager.md#Tizen.UI.Components.Material.IPager.this[int] 'Tizen.UI.Components.Material.IPager.this[int]') + +#### Property Value +Tizen.UI.View +### Methods + + + +## PageScroller.Clear() Method + +Clears all children. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## PageScroller.Contains(View) Method + +Whether it contains the specified child. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## PageScroller.CopyTo(View[], int) Method + +Copies the children to an array. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` Tizen.UI.View[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageScroller.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## PageScroller.IndexOf(View) Method + +Gets the index of the specified child. + +```csharp +public int IndexOf(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PageScroller.Insert(int, View) Method + +(Not implemented) Inserts the specified content at the specified index. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`item` Tizen.UI.View + + + +## PageScroller.Remove(View) Method + +Removes the specified view from its parent. + +```csharp +public void Remove(Tizen.UI.View child); +``` +#### Parameters + + + +`child` Tizen.UI.View + +Implements Remove(View)') + + + +## PageScroller.RemoveAt(int) Method + +Removes the content at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') + + + +## PageScroller.ShowPage(int, bool) Method + +Show page in pager. + +```csharp +public System.Threading.Tasks.Task ShowPage(int pageIndex, bool animation); +``` +#### Parameters + + + +`pageIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The page index to be shown. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation. + +Implements [ShowPage(int, bool)](Tizen.UI.Components.Material.IPager.md#Tizen.UI.Components.Material.IPager.ShowPage(int,bool) 'Tizen.UI.Components.Material.IPager.ShowPage(int, bool)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +the visual object. +### Events + + + +## PageScroller.DragFinished Event + +Occurs when the page drag finishes. + +```csharp +public event EventHandler DragFinished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## PageScroller.Dragging Event + +Occurs while page dragging. + +```csharp +public event EventHandler<DragEventArgs> Dragging; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## PageScroller.DragStarted Event + +Occurs when the page drag starts. + +```csharp +public event EventHandler DragStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## PageScroller.ScrollFinished Event + +Occurs when the page scroll finishes. + +```csharp +public event EventHandler ScrollFinished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## PageScroller.Scrolling Event + +Occurs while page scrolling. + +```csharp +public event EventHandler Scrolling; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## PageScroller.ScrollStarted Event + +Occurs when the page scroll starts. + +```csharp +public event EventHandler ScrollStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') +### Explicit Interface Implementations + + + +## PageScroller.System.Collections.Generic.ICollection<Tizen.UI.View>.Add(View) Method + +Adds a child view. + +```csharp +void System.Collections.Generic.ICollection<Tizen.UI.View>.Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Add(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## PageScroller.System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(View) Method + +Removes the specified content from the page scroller. + +```csharp +bool System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Remove(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## PageScroller.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Picker.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Picker.md new file mode 100644 index 0000000000..568bdfd5d6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Picker.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Picker Class + +Represents a picker component that shows a list of values and allows the user to select one. + +```csharp +public class Picker : Tizen.UI.Components.Material.PickerBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [PickerBase](Tizen.UI.Components.Material.PickerBase.md 'Tizen.UI.Components.Material.PickerBase') 🡒 Picker +### Constructors + + + +## Picker(ClosedRange<int>) Constructor + +Initializes a new instance of the Picker class with the specified range and default variables. + +```csharp +public Picker(Tizen.UI.Components.ClosedRange<int> range); +``` +#### Parameters + + + +`range` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + +The range of values that the picker can select. + + + +## Picker(ClosedRange<int>, PickerVariables) Constructor + +Initializes a new instance of the Picker class with the specified range and variables. + +```csharp +public Picker(Tizen.UI.Components.ClosedRange<int> range, Tizen.UI.Components.Material.PickerVariables variables); +``` +#### Parameters + + + +`range` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + +The range of values that the picker can select. + + + +`variables` [PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables') + +The variables that define the picker's styling and behavioral properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerBase.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerBase.md new file mode 100644 index 0000000000..63a87886fb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerBase.md @@ -0,0 +1,142 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PickerBase Class + +The base abstract class for all picker implementations. +Contains common properties and logic for picker components. + +```csharp +public abstract class PickerBase : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 PickerBase + +Derived +↳ [InputPicker](Tizen.UI.Components.Material.InputPicker.md 'Tizen.UI.Components.Material.InputPicker') +↳ [Picker](Tizen.UI.Components.Material.Picker.md 'Tizen.UI.Components.Material.Picker') +### Properties + + + +## PickerBase.DisplayedValues Property + +Gets or sets the displayed values of the picker. + +```csharp +public System.Collections.ObjectModel.ReadOnlyCollection<string> DisplayedValues { get; set; } +``` + +#### Property Value +[System.Collections.ObjectModel.ReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ReadOnlyCollection-1 'System.Collections.ObjectModel.ReadOnlyCollection`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ReadOnlyCollection-1 'System.Collections.ObjectModel.ReadOnlyCollection`1') + + + +## PickerBase.Range Property + +Gets or sets the range of the picker. + +```csharp +public Tizen.UI.Components.ClosedRange<int> Range { get; set; } +``` + +#### Property Value +Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + + + +## PickerBase.Value Property + +Gets or sets the current value of the picker. + +```csharp +public int Value { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## PickerBase.EditModeChanged Event + +Occurs when the picker edit mode changed. + +```csharp +public event EventHandler EditModeChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## PickerBase.InputPanelVisibilityChanged Event + +Occurs when the input panel visibility state changed. + +```csharp +public event EventHandler<bool> InputPanelVisibilityChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## PickerBase.ValueChanged Event + +Occurs when the picker value changed. + +```csharp +public event EventHandler ValueChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerVariables.md new file mode 100644 index 0000000000..72ef731e4c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerVariables.md @@ -0,0 +1,113 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## PickerVariables Class + +Variables used for picker. + +```csharp +public class PickerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.PickerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 PickerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## PickerVariables.CenterItemFontFamily Property + +Picker center item font family. + +```csharp +public string CenterItemFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## PickerVariables.Default Property + +Default picker variables. + +```csharp +public static Tizen.UI.Components.Material.PickerVariables Default { get; } +``` + +#### Property Value +[PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables') + + + +## PickerVariables.ItemFontFamily Property + +Picker item font family. + +```csharp +public string ItemFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## PickerVariables.ItemTextColor Property + +Picker item text color. + +```csharp +public Tizen.UI.Color ItemTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBar.md new file mode 100644 index 0000000000..4f2755fc29 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBar.md @@ -0,0 +1,195 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressBar Class + +A progress component that indicates a specific value from a continuous or discrete range of values in bar shape. + +```csharp +public class ProgressBar : Tizen.UI.Components.Progress +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Progress 🡒 ProgressBar +### Constructors + + + +## ProgressBar() Constructor + +Constructs a new progress bar. + +```csharp +public ProgressBar(); +``` + + + +## ProgressBar(float, float) Constructor + +Constructs a new progress bar. + +```csharp +public ProgressBar(float minimumValue, float maximumValue); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressBar(float, float, ProgressBarVariables) Constructor + +Constructs a new progress bar. + +```csharp +public ProgressBar(float minimumValue, float maximumValue, Tizen.UI.Components.Material.ProgressBarVariables variables); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`variables` [ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables') + + + +## ProgressBar(ProgressBarVariables) Constructor + +Constructs a new progress bar. + +```csharp +public ProgressBar(Tizen.UI.Components.Material.ProgressBarVariables variables); +``` +#### Parameters + + + +`variables` [ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables') +### Properties + + + +## ProgressBar.DividerStepCount Property + +The number of segments to divide the range into to show dividers between them. + +```csharp +public int DividerStepCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +If the value is less than equals to one, the divider would not appears. + + + +## ProgressBar.IsReversed Property + +Determines whether the trail sticks to the start or end of the progress bar. +The default is false, which means the trail sticks to the start of the progress bar. Otherwise, it sticks to the end of the progress bar. + +```csharp +public bool IsReversed { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ProgressBar.TrackColor Property + +The color of the track. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressBar.TrackThickness Property + +The thickness of the track. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressBar.TrailColor Property + +The color of the trail. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBarVariables.md new file mode 100644 index 0000000000..86347b248a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBarVariables.md @@ -0,0 +1,139 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressBarVariables Class + +Variables used for progress bar. + +```csharp +public class ProgressBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ProgressBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ProgressBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ProgressBarVariables.Default Property + +Default variables for progress bar. + +```csharp +public static Tizen.UI.Components.Material.ProgressBarVariables Default { get; } +``` + +#### Property Value +[ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables') + + + +## ProgressBarVariables.DividerColor Property + +Progress bar divider color. + +```csharp +public Tizen.UI.Color DividerColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressBarVariables.Padding Property + +Progress bar padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ProgressBarVariables.TrackColor Property + +Progress bar track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressBarVariables.TrackThickness Property + +Progress bar track thickness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressBarVariables.TrailColor Property + +Progress bar trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircle.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircle.md new file mode 100644 index 0000000000..2cc3a47eb4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircle.md @@ -0,0 +1,168 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressCircle Class + +A progress component that indicates a specific value from a continuous or discrete range of values in circular shape. + +```csharp +public class ProgressCircle : Tizen.UI.Components.Progress +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Progress 🡒 ProgressCircle +### Constructors + + + +## ProgressCircle() Constructor + +Constructs a new progress circle. + +```csharp +public ProgressCircle(); +``` + + + +## ProgressCircle(float, float) Constructor + +Constructs a new progress circle. + +```csharp +public ProgressCircle(float minimumValue, float maximumValue); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressCircle(float, float, ProgressCircleVariables) Constructor + +Constructs a new progress circle. + +```csharp +public ProgressCircle(float minimumValue, float maximumValue, Tizen.UI.Components.Material.ProgressCircleVariables variables); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`variables` [ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables') + + + +## ProgressCircle(ProgressCircleVariables) Constructor + +Constructs a new progress circle. + +```csharp +public ProgressCircle(Tizen.UI.Components.Material.ProgressCircleVariables variables); +``` +#### Parameters + + + +`variables` [ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables') +### Properties + + + +## ProgressCircle.TrackColor Property + +Gets or sets the track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressCircle.TrackThickness Property + +Gets or sets the track thinkness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If the value is less than 1 and greater than 0, it will be treat as percentage for the radius. + + + +## ProgressCircle.TrailColor Property + +Gets or sets the trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircleVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircleVariables.md new file mode 100644 index 0000000000..b1db1f6d11 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircleVariables.md @@ -0,0 +1,168 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressCircleVariables Class + +Variables used for progress circle. + +```csharp +public class ProgressCircleVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ProgressCircleVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ProgressCircleVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ProgressCircleVariables.Default Property + +Default variables for progress circle. + +```csharp +public static Tizen.UI.Components.Material.ProgressCircleVariables Default { get; } +``` + +#### Property Value +[ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables') + + + +## ProgressCircleVariables.DefaultHeight Property + +progress circle default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressCircleVariables.DefaultWidth Property + +progress circle default width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressCircleVariables.IndeterminateImageUrl Property + +progress circle indeterminate resource url. + +```csharp +public string IndeterminateImageUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ProgressCircleVariables.Padding Property + +progress circle padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ProgressCircleVariables.TrackColor Property + +progress circle track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressCircleVariables.TrackThickness Property + +progress circle track thickness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If the value is less than 1 and greater than 0, it will be treat as percentage for the radius. + + + +## ProgressCircleVariables.TrailColor Property + +progress circle trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimer.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimer.md new file mode 100644 index 0000000000..0bf3e54f8f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimer.md @@ -0,0 +1,185 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressTimer Class + +A progress component that specific GUI that can indicate a time value. + +```csharp +public class ProgressTimer : Tizen.UI.Components.TimeCounter +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.TimeCounter 🡒 ProgressTimer +### Constructors + + + +## ProgressTimer() Constructor + +Constructs a new timer progress. + +```csharp +public ProgressTimer(); +``` + + + +## ProgressTimer(int) Constructor + +Constructs a new timer progress. + +```csharp +public ProgressTimer(int totalTimeInMilliseconds); +``` +#### Parameters + + + +`totalTimeInMilliseconds` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ProgressTimer(ProgressTimerVariables) Constructor + +Constructs a new timer progress. + +```csharp +public ProgressTimer(Tizen.UI.Components.Material.ProgressTimerVariables variables); +``` +#### Parameters + + + +`variables` [ProgressTimerVariables](Tizen.UI.Components.Material.ProgressTimerVariables.md 'Tizen.UI.Components.Material.ProgressTimerVariables') +### Properties + + + +## ProgressTimer.IsPaused Property + +Gets or sets whether the timer is paused state. + +```csharp +public bool IsPaused { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ProgressTimer.IsReversed Property + +Determines whether the trail represents elapsed time or remaining time. +The default is false, which means the trail represents elapsed time. + +```csharp +public bool IsReversed { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ProgressTimer.TrackColor Property + +Gets or sets the track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressTimer.TrackThickness Property + +Gets or sets the track thinkness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If the value is less than 1 and greater than 0, it will be treat as percentage for the radius. + + + +## ProgressTimer.TrailColor Property + +Gets or sets the trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + +### Remarks +Once this value is set, the predefined color changes for the warning and paused state will be ignored. +### Events + + + +## ProgressTimer.PausedChanged Event + +Invoked when the warning state of the timer progress changes. + +```csharp +public event EventHandler PausedChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimerVariables.md new file mode 100644 index 0000000000..41442e2df2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimerVariables.md @@ -0,0 +1,165 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ProgressTimerVariables Class + +Variables used for timer progress. + +```csharp +public class ProgressTimerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ProgressTimerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ProgressTimerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ProgressTimerVariables](Tizen.UI.Components.Material.ProgressTimerVariables.md 'Tizen.UI.Components.Material.ProgressTimerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ProgressTimerVariables.Default Property + +Default variables for timer progress. + +```csharp +public static Tizen.UI.Components.Material.ProgressTimerVariables Default { get; } +``` + +#### Property Value +[ProgressTimerVariables](Tizen.UI.Components.Material.ProgressTimerVariables.md 'Tizen.UI.Components.Material.ProgressTimerVariables') + + + +## ProgressTimerVariables.DefaultHeight Property + +timer progress default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressTimerVariables.DefaultWidth Property + +timer progress default width. + +```csharp +public float DefaultWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ProgressTimerVariables.Padding Property + +timer progress padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ProgressTimerVariables.PausedTrailColor Property + +timer progress trail color when paused. + +```csharp +public Tizen.UI.Color PausedTrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressTimerVariables.TrackColor Property + +timer progress track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressTimerVariables.TrailColor Property + +timer progress trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ProgressTimerVariables.WarningTrailColor Property + +timer progress trail color when warning. + +```csharp +public Tizen.UI.Color WarningTrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButton.md new file mode 100644 index 0000000000..e150097f85 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButton.md @@ -0,0 +1,101 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## RadioButton Class + +Radio button is a component that can be selected among the Tizen.UI.Components.SelectionGroup. + +```csharp +public class RadioButton : Tizen.UI.Components.GroupSelectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 RadioButton +### Constructors + + + +## RadioButton() Constructor + +Constructs a new radio button. + +```csharp +public RadioButton(); +``` + + + +## RadioButton(RadioButtonVariables) Constructor + +Constructs a new radio button. + +```csharp +public RadioButton(Tizen.UI.Components.Material.RadioButtonVariables variables); +``` +#### Parameters + + + +`variables` [RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') + +The variables for the radio button. +### Methods + + + +## RadioButton.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButtonVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButtonVariables.md new file mode 100644 index 0000000000..4086a3ab87 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButtonVariables.md @@ -0,0 +1,181 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## RadioButtonVariables Class + +Variables used for radio button. + +```csharp +public class RadioButtonVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.RadioButtonVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 RadioButtonVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## RadioButtonVariables.Default Property + +Default radio button variables. + +```csharp +public static Tizen.UI.Components.Material.RadioButtonVariables Default { get; } +``` + +#### Property Value +[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') + + + +## RadioButtonVariables.Ghost Property + +Ghost radio button variables. + +```csharp +public static Tizen.UI.Components.Material.RadioButtonVariables Ghost { get; } +``` + +#### Property Value +[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') + + + +## RadioButtonVariables.IconColor Property + +Radio button icon color. + +```csharp +public Tizen.UI.Color IconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## RadioButtonVariables.IconGenerator Property + +Radio button icon generator. + +```csharp +public System.Func<Tizen.UI.Components.Material.RadioButtonVariables,Tizen.UI.Components.Material.SelectableLottieImage> IconGenerator { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[SelectableLottieImage](Tizen.UI.Components.Material.SelectableLottieImage.md 'Tizen.UI.Components.Material.SelectableLottieImage')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## RadioButtonVariables.IconHeight Property + +Radio button icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RadioButtonVariables.IconWidth Property + +Radio button icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RadioButtonVariables.Padding Property + +Switch padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## RadioButtonVariables.SelectedIconColor Property + +Radio button icon selected color. + +```csharp +public Tizen.UI.Color SelectedIconColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## RadioButtonVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Scaffold.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Scaffold.md new file mode 100644 index 0000000000..95da2a707b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Scaffold.md @@ -0,0 +1,110 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Scaffold Class + +A scaffold of application. +Application can have a scaffold in a window to layout content properly. + +```csharp +public class Scaffold : Tizen.UI.Components.ScaffoldBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.ScaffoldBase 🡒 Scaffold +### Constructors + + + +## Scaffold() Constructor + +Constructs a new scaffold. + +```csharp +public Scaffold(); +``` +### Properties + + + +## Scaffold.AppBar Property + +Gets or sets the app bar of scaffold. + +```csharp +public Tizen.UI.Components.Material.AppBar AppBar { get; set; } +``` + +#### Property Value +[AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') + + + +## Scaffold.BottomBar Property + +Gets or sets the bottom bar of scaffold. + +```csharp +public Tizen.UI.View BottomBar { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## Scaffold.Content Property + +Content view of scaffold. +This view is the body of scaffold. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBar.md new file mode 100644 index 0000000000..ac2299ec48 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBar.md @@ -0,0 +1,88 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ScrollBar Class + +A class representing a scroll bar that can be used to control the scrolling of a view. + +```csharp +public class ScrollBar : Tizen.UI.Components.ScrollBarBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Components.ScrollBarBase 🡒 ScrollBar + +Derived +↳ [FloatingActionButtonScrollBar](Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md 'Tizen.UI.Components.Material.FloatingActionButtonScrollBar') +### Constructors + + + +## ScrollBar() Constructor + +Initializes a new instance of the [ScrollBar](Tizen.UI.Components.Material.ScrollBar.md 'Tizen.UI.Components.Material.ScrollBar') class. + +```csharp +public ScrollBar(); +``` + + + +## ScrollBar(ScrollBarVariables) Constructor + +Initializes a new instance of the [ScrollBar](Tizen.UI.Components.Material.ScrollBar.md 'Tizen.UI.Components.Material.ScrollBar') class with variables. + +```csharp +public ScrollBar(Tizen.UI.Components.Material.ScrollBarVariables variables); +``` +#### Parameters + + + +`variables` [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + +The variables for the scroll bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBarVariables.md new file mode 100644 index 0000000000..4f901ba357 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBarVariables.md @@ -0,0 +1,139 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ScrollBarVariables Class + +Variables used for scroll bar. + +```csharp +public class ScrollBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ScrollBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ScrollBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ScrollBarVariables.BarColor Property + +Gets or sets the color of the scroll bar. + +```csharp +public Tizen.UI.Color BarColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ScrollBarVariables.BarCornerRadius Property + +Gets or sets the corner of the scroll bar. + +```csharp +public Tizen.UI.CornerRadius BarCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ScrollBarVariables.BarMargin Property + +Gets or sets the margin between the scroll bar and its target view. + +```csharp +public Tizen.UI.Thickness BarMargin { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ScrollBarVariables.BarMinSize Property + +Gets or sets the minimum size of the scroll bar. + +```csharp +public float BarMinSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ScrollBarVariables.BarThickness Property + +Gets or sets the width of the scroll bar. + +```csharp +public float BarThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ScrollBarVariables.Default Property + +Default scroll bar variables. + +```csharp +public static Tizen.UI.Components.Material.ScrollBarVariables Default { get; } +``` + +#### Property Value +[ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollView.md new file mode 100644 index 0000000000..f4c3f5721d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollView.md @@ -0,0 +1,68 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ScrollView Class + +A scrolable view containnig other views that can be scrolled manually (via touch). + +```csharp +public class ScrollView : Tizen.UI.Components.Scrollable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Layouts.Layout 🡒 Tizen.UI.Components.Scrollable 🡒 ScrollView +### Constructors + + + +## ScrollView() Constructor + +Initializes a new instance of the [ScrollView](Tizen.UI.Components.Material.ScrollView.md 'Tizen.UI.Components.Material.ScrollView') class. + +```csharp +public ScrollView(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SelectableLottieImage.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SelectableLottieImage.md new file mode 100644 index 0000000000..7a1b5f89c7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SelectableLottieImage.md @@ -0,0 +1,121 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SelectableLottieImage Class + +A selectable lottie image view that can be selected and deselected with animation. + +```csharp +public class SelectableLottieImage : Tizen.UI.Components.Material.LottieImage +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 [Image](Tizen.UI.Components.Material.Image.md 'Tizen.UI.Components.Material.Image') 🡒 [LottieImage](Tizen.UI.Components.Material.LottieImage.md 'Tizen.UI.Components.Material.LottieImage') 🡒 SelectableLottieImage +### Constructors + + + +## SelectableLottieImage(string, ClosedRange<int>, ClosedRange<int>) Constructor + +Constructs a new selectable lottie image. + +```csharp +public SelectableLottieImage(string resourceUrl, Tizen.UI.Components.ClosedRange<int> selectionFrames, Tizen.UI.Components.ClosedRange<int> deselectionFrames); +``` +#### Parameters + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`selectionFrames` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> + + + +`deselectionFrames` Tizen.UI.Components.ClosedRange<[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')> +### Methods + + + +## SelectableLottieImage.Refresh() Method + +Redraw current frame. + +```csharp +public void Refresh(); +``` + + + +## SelectableLottieImage.RefreshWhenThemeChanged() Method + +Redraw when theme changed + +```csharp +public void RefreshWhenThemeChanged(); +``` + + + +## SelectableLottieImage.SetSelection(bool, bool) Method + +Sets the selection. + +```csharp +public void SetSelection(bool isSelected, bool animate); +``` +#### Parameters + + + +`isSelected` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +`animate` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Slider.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Slider.md new file mode 100644 index 0000000000..d4a29b66f6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Slider.md @@ -0,0 +1,180 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Slider Class + +A slider component that indicates a specific value from a continuous or discrete range of values in bar shape. +It can be used to select a value by moving the trail along the track. + +```csharp +public class Slider : Tizen.UI.Components.InteractiveProgress +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.InteractiveProgress 🡒 Slider +### Constructors + + + +## Slider(float, float) Constructor + +Constructs a new progress bar. + +```csharp +public Slider(float minimumValue, float maximumValue); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Slider(float, float, SliderVariables) Constructor + +Constructs a new progress bar. + +```csharp +public Slider(float minimumValue, float maximumValue, Tizen.UI.Components.Material.SliderVariables variables); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`variables` [SliderVariables](Tizen.UI.Components.Material.SliderVariables.md 'Tizen.UI.Components.Material.SliderVariables') +### Properties + + + +## Slider.AccessibilityValueTextGenerator Property + +Generate accessibility value text with given. + +```csharp +public System.Func<Tizen.UI.Components.Material.Slider,string> AccessibilityValueTextGenerator { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[Slider](Tizen.UI.Components.Material.Slider.md 'Tizen.UI.Components.Material.Slider')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## Slider.KeyStep Property + +The step size for keyboard navigation. + +```csharp +public float KeyStep { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Slider.Padding Property + +Gets or sets the padding of button. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## Slider.TrackColor Property + +The color of the track. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Slider.TrackThickness Property + +The thickness of the track. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Slider.TrailColor Property + +The color of the trail. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SliderVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SliderVariables.md new file mode 100644 index 0000000000..7cab6a2e13 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SliderVariables.md @@ -0,0 +1,165 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SliderVariables Class + +Variables used for slider. + +```csharp +public class SliderVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.SliderVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 SliderVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SliderVariables](Tizen.UI.Components.Material.SliderVariables.md 'Tizen.UI.Components.Material.SliderVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SliderVariables.Default Property + +Default variables for slider. + +```csharp +public static Tizen.UI.Components.Material.SliderVariables Default { get; } +``` + +#### Property Value +[SliderVariables](Tizen.UI.Components.Material.SliderVariables.md 'Tizen.UI.Components.Material.SliderVariables') + + + +## SliderVariables.HandleColor Property + +Slider handle color. + +```csharp +public Tizen.UI.Color HandleColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SliderVariables.HandleHeight Property + +Slider handle height. + +```csharp +public float HandleHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SliderVariables.HandleWidth Property + +Slider handle width. + +```csharp +public float HandleWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SliderVariables.Padding Property + +Slider padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SliderVariables.TrackColor Property + +Slider track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SliderVariables.TrackThickness Property + +Slider track thickness. + +```csharp +public float TrackThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SliderVariables.TrailColor Property + +Slider trail color. + +```csharp +public Tizen.UI.Color TrailColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTip.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTip.md new file mode 100644 index 0000000000..4e19fdf32b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTip.md @@ -0,0 +1,244 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTip Class + +A bubble shaped pop over text. + +```csharp +public class SmartTip : Tizen.UI.Components.Material.SmartTipBase, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [SmartTipBase](Tizen.UI.Components.Material.SmartTipBase.md 'Tizen.UI.Components.Material.SmartTipBase') 🡒 SmartTip + +Implements Tizen.UI.IText +### Constructors + + + +## SmartTip() Constructor + +Constructs a smart tip. + +```csharp +public SmartTip(); +``` + + + +## SmartTip(string) Constructor + +Constructs a smart tip. + +```csharp +public SmartTip(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SmartTip(string, SmartTipVariables) Constructor + +Constructs a smart tip. + +```csharp +public SmartTip(string text, Tizen.UI.Components.Material.SmartTipVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') +### Properties + + + +## SmartTip.ContentPadding Property + +Gets or sets the inner padding for determining the bubble size. + +```csharp +public Tizen.UI.Thickness ContentPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SmartTip.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SmartTip.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTip.FontSizeScale Property + +Gets or sets the scaling value of the font size. + +```csharp +public float FontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTip.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + +## SmartTip.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool IsMultiline { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SmartTip.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SmartTip.Text Property + +Gets or sets the content text. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SmartTip.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## SmartTip.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipArrowPosition.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipArrowPosition.md new file mode 100644 index 0000000000..f14aa72205 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipArrowPosition.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipArrowPosition Enum + +Describes the arrow position of SmartTip + +```csharp +public enum SmartTipArrowPosition +``` +### Fields + + + +`Bottom` 7 + +The arrow points to the bottom center. + + + +`BottomLeft` 6 + +The arrow points to the bottom left. + + + +`BottomRight` 8 + +The arrow points to the bottom right. + + + +`Left` 4 + +The arrow points to the center left. + + + +`None` 0 + +The arrow is not shown. + + + +`Right` 5 + +The arrow points to the center right. + + + +`Top` 2 + +The arrow points to the top center. + + + +`TopLeft` 1 + +The arrow points to the top left. + + + +`TopRight` 3 + +The arrow points to the top right. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipBase.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipBase.md new file mode 100644 index 0000000000..70fd897047 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipBase.md @@ -0,0 +1,389 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipBase Class + +Provide base structure for SmartTips. + +```csharp +public class SmartTipBase : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 SmartTipBase + +Derived +↳ [SmartTip](Tizen.UI.Components.Material.SmartTip.md 'Tizen.UI.Components.Material.SmartTip') +↳ [SmartTipMenu](Tizen.UI.Components.Material.SmartTipMenu.md 'Tizen.UI.Components.Material.SmartTipMenu') +↳ [SmartTipView](Tizen.UI.Components.Material.SmartTipView.md 'Tizen.UI.Components.Material.SmartTipView') +### Constructors + + + +## SmartTipBase() Constructor + +Constructs a smart tip. + +```csharp +public SmartTipBase(); +``` + + + +## SmartTipBase(SmartTipViewVariables) Constructor + +Constructs a smart tip. + +```csharp +public SmartTipBase(Tizen.UI.Components.Material.SmartTipViewVariables variables); +``` +#### Parameters + + + +`variables` [SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') +### Properties + + + +## SmartTipBase.ArrowHeight Property + +Gets or sets the arrow height. + +```csharp +public float ArrowHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTipBase.ArrowPosition Property + +Gets or sets the position of the arrow. + +```csharp +public Tizen.UI.Components.Material.SmartTipArrowPosition ArrowPosition { get; set; } +``` + +#### Property Value +[SmartTipArrowPosition](Tizen.UI.Components.Material.SmartTipArrowPosition.md 'Tizen.UI.Components.Material.SmartTipArrowPosition') + + + +## SmartTipBase.ArrowWidth Property + +Gets or sets the arrow width. + +```csharp +public float ArrowWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTipBase.DismissedCommand Property + +DismissStarted event command. [Dismissed](Tizen.UI.Components.Material.SmartTipBase.md#Tizen.UI.Components.Material.SmartTipBase.Dismissed 'Tizen.UI.Components.Material.SmartTipBase.Dismissed'). + +```csharp +public System.Action<object,System.EventArgs> DismissedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## SmartTipBase.HiddenCommand Property + +Dismissed event command. [Hidden](Tizen.UI.Components.Material.SmartTipBase.md#Tizen.UI.Components.Material.SmartTipBase.Hidden 'Tizen.UI.Components.Material.SmartTipBase.Hidden'). + +```csharp +public System.Action<object,System.EventArgs> HiddenCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## SmartTipBase.ShapeCornerRadius Property + +Gets or sets the bubble corner radius. + +```csharp +public Tizen.UI.CornerRadius ShapeCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## SmartTipBase.ShapeFillColor Property + +Gets or sets the bubble fill color. + +```csharp +public Tizen.UI.Color ShapeFillColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SmartTipBase.ShapeShadows Property + +Gets or sets the bubble shadows. + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> ShapeShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +### Remarks +The shadows will finally sets the under shadow visuals so they can get cleared by SetUnderShadowVisuals or ClearUnderShadowVisuals. + + + +## SmartTipBase.ShapeStrokeColor Property + +Gets or sets the bubble stroke color. + +```csharp +public Tizen.UI.Color ShapeStrokeColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color +### Methods + + + +## SmartTipBase.Dismiss() Method + +Dismiss the modal from the window. + +```csharp +public void Dismiss(); +``` + + + +## SmartTipBase.GetArrowPosition() Method + +Gets the arrow position. + +```csharp +public Tizen.UI.Point GetArrowPosition(); +``` + +#### Returns +Tizen.UI.Point + + + +## SmartTipBase.GetArrowPosition(float, float) Method + +Gets the arrow position with given smart tip size. + +```csharp +public Tizen.UI.Point GetArrowPosition(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +Tizen.UI.Point + + + +## SmartTipBase.Post() Method + +Post as a modal content. + +```csharp +public void Post(); +``` + + + +## SmartTipBase.Post(Point) Method + +Post as a modal content with anchor data to the default window. + +```csharp +public void Post(Tizen.UI.Point anchorPoint); +``` +#### Parameters + + + +`anchorPoint` Tizen.UI.Point + +The anchor point. It should be relative to the window's coordinate system. + + + +## SmartTipBase.Post(View) Method + +Post as a modal content with anchor data to the default window. + +```csharp +public void Post(Tizen.UI.View anchorObject); +``` +#### Parameters + + + +`anchorObject` Tizen.UI.View + +The anchor object. + + + +## SmartTipBase.Post(Window) Method + +Post as a modal content to the given window. If no window is specified, it uses default window. + +```csharp +public void Post(Tizen.UI.Window window); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +## SmartTipBase.Post(Window, Point) Method + +Post as a modal content to the given window. If no window is specified, it uses default window. + +```csharp +public void Post(Tizen.UI.Window window, Tizen.UI.Point anchorPoint); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +`anchorPoint` Tizen.UI.Point + +The anchor point. It should be relative to the window's coordinate system. + + + +## SmartTipBase.Post(Window, View) Method + +Post as a modal content with anchor data. + +```csharp +public void Post(Tizen.UI.Window window, Tizen.UI.View anchorObject); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to post the modal to. + + + +`anchorObject` Tizen.UI.View + +The anchor object. +### Events + + + +## SmartTipBase.Dismissed Event + +Occurred when the dismiss requested. + +```csharp +public event EventHandler Dismissed; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## SmartTipBase.Hidden Event + +Occurred when the smart tip is fully dismissed (animation finished). + +```csharp +public event EventHandler Hidden; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipMenu.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipMenu.md new file mode 100644 index 0000000000..9b6d2e0500 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipMenu.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipMenu Class + +A bubble shaped pop over container with Title and Content area. + +```csharp +public class SmartTipMenu : Tizen.UI.Components.Material.SmartTipBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [SmartTipBase](Tizen.UI.Components.Material.SmartTipBase.md 'Tizen.UI.Components.Material.SmartTipBase') 🡒 SmartTipMenu +### Constructors + + + +## SmartTipMenu() Constructor + +Constructs a smart tip. + +```csharp +public SmartTipMenu(); +``` + + + +## SmartTipMenu(SmartTipViewVariables) Constructor + +Constructs a smart tip. + +```csharp +public SmartTipMenu(Tizen.UI.Components.Material.SmartTipViewVariables variables); +``` +#### Parameters + + + +`variables` [SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') +### Properties + + + +## SmartTipMenu.Content Property + +Gets or sets the content. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## SmartTipMenu.TitleContent Property + +Gets or sets the content. + +```csharp +public Tizen.UI.View TitleContent { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## SmartTipMenu.TitleFillColor Property + +Gets or sets the fill color of title area. + +```csharp +public Tizen.UI.Color TitleFillColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipVariables.md new file mode 100644 index 0000000000..73665f4e6e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipVariables.md @@ -0,0 +1,152 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipVariables Class + +Variables used for smart tip. + +```csharp +public class SmartTipVariables : Tizen.UI.Components.Material.SmartTipViewVariables, +System.IEquatable<Tizen.UI.Components.Material.SmartTipVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 [SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') 🡒 SmartTipVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SmartTipVariables.ContentPadding Property + +Gets or sets padding of content text. + +```csharp +public Tizen.UI.Thickness ContentPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SmartTipVariables.DarkGray Property + +Dark gray smart tip variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipVariables DarkGray { get; } +``` + +#### Property Value +[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + + + +## SmartTipVariables.Default Property + +Default smart tip variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipVariables Default { get; } +``` + +#### Property Value +[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + + + +## SmartTipVariables.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SmartTipVariables.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTipVariables.LightGray Property + +Light gray smart tip variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipVariables LightGray { get; } +``` + +#### Property Value +[SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + + + +## SmartTipVariables.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipView.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipView.md new file mode 100644 index 0000000000..bc4919fb3c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipView.md @@ -0,0 +1,97 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipView Class + +A bubble shaped pop over container. + +```csharp +public class SmartTipView : Tizen.UI.Components.Material.SmartTipBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [SmartTipBase](Tizen.UI.Components.Material.SmartTipBase.md 'Tizen.UI.Components.Material.SmartTipBase') 🡒 SmartTipView +### Constructors + + + +## SmartTipView() Constructor + +Constructs a smart tip. + +```csharp +public SmartTipView(); +``` + + + +## SmartTipView(SmartTipViewVariables) Constructor + +Constructs a smart tip. + +```csharp +public SmartTipView(Tizen.UI.Components.Material.SmartTipViewVariables variables); +``` +#### Parameters + + + +`variables` [SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') +### Properties + + + +## SmartTipView.Content Property + +Gets or sets the content. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipViewVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipViewVariables.md new file mode 100644 index 0000000000..82a097c145 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipViewVariables.md @@ -0,0 +1,194 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SmartTipViewVariables Class + +Variables used for smart tip view. + +```csharp +public class SmartTipViewVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.SmartTipViewVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 SmartTipViewVariables + +Derived +↳ [SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SmartTipViewVariables.DarkGray Property + +Dark gray smart tip view variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipViewVariables DarkGray { get; } +``` + +#### Property Value +[SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') + + + +## SmartTipViewVariables.Default Property + +Default smart tip view variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipViewVariables Default { get; } +``` + +#### Property Value +[SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') + + + +## SmartTipViewVariables.LightGray Property + +Light gray smart tip view variables. + +```csharp +public static Tizen.UI.Components.Material.SmartTipViewVariables LightGray { get; } +``` + +#### Property Value +[SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') + + + +## SmartTipViewVariables.ShapeArrowHeight Property + +Gets or sets the height size of bubble tail. + +```csharp +public float ShapeArrowHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTipViewVariables.ShapeArrowWidth Property + +Gets or sets the width size of bubble tail. + +```csharp +public float ShapeArrowWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SmartTipViewVariables.ShapeCornerRadius Property + +Gets or sets bubble corner radius. + +```csharp +public Tizen.UI.CornerRadius ShapeCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## SmartTipViewVariables.ShapeFillColor Property + +Gets or sets fill color of bubble. + +```csharp +public Tizen.UI.Color ShapeFillColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SmartTipViewVariables.ShapeShadows Property + +Gets or sets the shadows to be placed under the bubble. + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> ShapeShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + +## SmartTipViewVariables.ShapeStrokeColor Property + +Gets or sets bubble stroke color. + +```csharp +public Tizen.UI.Color ShapeStrokeColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SmartTipViewVariables.ShapeStrokeWidth Property + +Gets or sets bubble stroke width. + +```csharp +public float ShapeStrokeWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBar.md new file mode 100644 index 0000000000..7e6efa5f1f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBar.md @@ -0,0 +1,342 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SnackBar Class + +A SnackBar component that displays a message with action button. + +```csharp +public class SnackBar : Tizen.UI.Layouts.Grid, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Layouts.Layout 🡒 Tizen.UI.Layouts.Grid 🡒 SnackBar + +Implements Tizen.UI.IText +### Constructors + + + +## SnackBar() Constructor + +Constructs an empty SnackBar. + +```csharp +public SnackBar(); +``` + + + +## SnackBar(string) Constructor + +Constructs a SnackBar with text. + +```csharp +public SnackBar(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the SnackBar. + + + +## SnackBar(string, uint) Constructor + +Constructs a SnackBar with text and duration. + +```csharp +public SnackBar(string text, uint duration); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the SnackBar. + + + +`duration` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The duration for which the SnackBar is displayed. + + + +## SnackBar(string, uint, SnackBarVariables) Constructor + +Constructs a SnackBar with text, duration and variables. + +```csharp +public SnackBar(string text, uint duration, Tizen.UI.Components.Material.SnackBarVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the SnackBar. + + + +`duration` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The duration for which the SnackBar is displayed. + + + +`variables` [SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables') + +Custom SnackBar variables. + + + +## SnackBar(SnackBarVariables) Constructor + +Constructs an empty SnackBar. + +```csharp +public SnackBar(Tizen.UI.Components.Material.SnackBarVariables variables); +``` +#### Parameters + + + +`variables` [SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables') + +Custom SnackBar variables. +### Properties + + + +## SnackBar.ActionButtonText Property + +Gets or sets the action button text of the SnackBar. + +```csharp +public string ActionButtonText { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SnackBar.ActionButtonTextColor Property + +Gets or sets the action button text color of the SnackBar. + +```csharp +public Tizen.UI.Color ActionButtonTextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SnackBar.Duration Property + +Gets or sets the duration for which the SnackBar is displayed. + +```csharp +public uint Duration { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## SnackBar.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SnackBar.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBar.ItemSpacing Property + +Gets or sets the spacing between text and action button. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBar.Text Property + +Gets or sets the text of the SnackBar. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SnackBar.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color +### Methods + + + +## SnackBar.Dismiss() Method + +Dismisses the SnackBar. + +```csharp +public void Dismiss(); +``` + + + +## SnackBar.Post(Window) Method + +Post the SnackBar. + +```csharp +public void Post(Tizen.UI.Window window=null); +``` +#### Parameters + + + +`window` Tizen.UI.Window +### Events + + + +## SnackBar.ActionButtonClicked Event + +ActionButtonClicked event is raised when the action button is clicked. + +```csharp +public event EventHandler<SnackBarActionEventArgs> ActionButtonClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[SnackBarActionEventArgs](Tizen.UI.Components.Material.SnackBarActionEventArgs.md 'Tizen.UI.Components.Material.SnackBarActionEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## SnackBar.Hidden Event + +Add and remove hidden event handler. + +```csharp +public event EventHandler Hidden; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + +### Remarks +This event is raised when the SnackBar is fully dismissed. + + + +## SnackBar.Shown Event + +Add and remove shown event handler. + +```csharp +public event EventHandler Shown; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + +### Remarks +This event is raised when the SnackBar is fully shown. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarAction.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarAction.md new file mode 100644 index 0000000000..1a9ffe1e87 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarAction.md @@ -0,0 +1,67 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SnackBarAction Enum + +SnackBarAction is used to define the action of snackbar. + +```csharp +public enum SnackBarAction +``` +### Fields + + + +`ConfirmInDefaultMode` 0 + +Confirm in default mode. + + + +`ConfirmInExpandMode` 1 + +Confirm in expand mode. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarActionEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarActionEventArgs.md new file mode 100644 index 0000000000..dc4252af50 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarActionEventArgs.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SnackBarActionEventArgs Class + +EventArgs for SnackBarAction. + +```csharp +public class SnackBarActionEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 SnackBarActionEventArgs +### Constructors + + + +## SnackBarActionEventArgs(SnackBarAction) Constructor + +Constructor of SnackBarActionEventArgs. + +```csharp +public SnackBarActionEventArgs(Tizen.UI.Components.Material.SnackBarAction action); +``` +#### Parameters + + + +`action` [SnackBarAction](Tizen.UI.Components.Material.SnackBarAction.md 'Tizen.UI.Components.Material.SnackBarAction') +### Properties + + + +## SnackBarActionEventArgs.Action Property + +Gets the action. + +```csharp +public Tizen.UI.Components.Material.SnackBarAction Action { get; } +``` + +#### Property Value +[SnackBarAction](Tizen.UI.Components.Material.SnackBarAction.md 'Tizen.UI.Components.Material.SnackBarAction') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarVariables.md new file mode 100644 index 0000000000..417be148fb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarVariables.md @@ -0,0 +1,360 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SnackBarVariables Class + +Variables used for radio button. + +```csharp +public class SnackBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.SnackBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 SnackBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SnackBarVariables.BackgroundColor Property + +Background color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SnackBarVariables.BottomOffset Property + +Bottom offset. + +```csharp +public float BottomOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ButtonBackgroundColor Property + +Action button background color. + +```csharp +public Tizen.UI.Color ButtonBackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SnackBarVariables.ButtonFontColor Property + +Action button font color + +```csharp +public Tizen.UI.Color ButtonFontColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SnackBarVariables.ButtonFontSize Property + +Action button font size + +```csharp +public float ButtonFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ButtonHeight Property + +Action button height. + +```csharp +public float ButtonHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ButtonPadding Property + +Action button padding. + +```csharp +public Tizen.UI.Thickness ButtonPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SnackBarVariables.CornerRadius Property + +Corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## SnackBarVariables.Default Property + +Default SnackBar variables. + +```csharp +public static Tizen.UI.Components.Material.SnackBarVariables Default { get; } +``` + +#### Property Value +[SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables') + + + +## SnackBarVariables.ExpandHeight Property + +Expand height. + +```csharp +public float ExpandHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ExpandItemSpacing Property + +Item spacing between text and action button in expand mode. + +```csharp +public float ExpandItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ExpandPadding Property + +Expand mode padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness ExpandPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SnackBarVariables.InitialHeight Property + +Initial height for SnackBar post animation. + +```csharp +public float InitialHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.InitialWidth Property + +Initial width for SnackBar post animation. + +```csharp +public float InitialWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.ItemSpacing Property + +Item spacing between text and action button. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.MaximumHeight Property + +Maximum height. + +```csharp +public float MaximumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.MaximumWidth Property + +Maximum width. + +```csharp +public float MaximumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.MinimumHeight Property + +Minimum height. + +```csharp +public float MinimumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.MinimumWidth Property + +Minimum width. + +```csharp +public float MinimumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.Padding Property + +Padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SnackBarVariables.TextColor Property + +Text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SnackBarVariables.TextFontSize Property + +Text font size. + +```csharp +public float TextFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SnackBarVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButton.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButton.md new file mode 100644 index 0000000000..035681342e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButton.md @@ -0,0 +1,228 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SpinnerButton Class + +```csharp +public class SpinnerButton : Tizen.UI.Components.Clickable, +Tizen.UI.Components.IFlexibleText, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 SpinnerButton + +Implements Tizen.UI.Components.IFlexibleText, Tizen.UI.IText +### Constructors + + + +## SpinnerButton() Constructor + +Constructs an instance. + +```csharp +public SpinnerButton(); +``` + + + +## SpinnerButton(SpinnerButtonVariables) Constructor + +Constructs an instance. + +```csharp +public SpinnerButton(Tizen.UI.Components.Material.SpinnerButtonVariables variables); +``` +#### Parameters + + + +`variables` [SpinnerButtonVariables](Tizen.UI.Components.Material.SpinnerButtonVariables.md 'Tizen.UI.Components.Material.SpinnerButtonVariables') +### Properties + + + +## SpinnerButton.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + + + +## SpinnerButton.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SpinnerButton.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButton.IconMixColor Property + +Gets or sets the mix color of the icon. + +```csharp +public Tizen.UI.Color IconMixColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SpinnerButton.ItemSpacing Property + +Gets or sets the spacing between icon and text. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButton.ModalContent Property + +Gets or sets the modal content to be shown when clicked. + +```csharp +public Tizen.UI.Components.IAnchoredModal ModalContent { get; set; } +``` + +#### Property Value +Tizen.UI.Components.IAnchoredModal + + + +## SpinnerButton.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SpinnerButton.Text Property + +Gets or sets the text of the tab item. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SpinnerButton.TextColor Property + +Gets or sets the text color of the label. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## SpinnerButton.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow + +#### Property Value +Tizen.UI.TextOverflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButtonVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButtonVariables.md new file mode 100644 index 0000000000..cd51a73aa6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButtonVariables.md @@ -0,0 +1,233 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SpinnerButtonVariables Class + +Variables used for spinner button. + +```csharp +public class SpinnerButtonVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.SpinnerButtonVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 SpinnerButtonVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SpinnerButtonVariables](Tizen.UI.Components.Material.SpinnerButtonVariables.md 'Tizen.UI.Components.Material.SpinnerButtonVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SpinnerButtonVariables.BackgroundColor Property + +Gets or sets the fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SpinnerButtonVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## SpinnerButtonVariables.Default Property + +Default spinner button variables. + +```csharp +public static Tizen.UI.Components.Material.SpinnerButtonVariables Default { get; } +``` + +#### Property Value +[SpinnerButtonVariables](Tizen.UI.Components.Material.SpinnerButtonVariables.md 'Tizen.UI.Components.Material.SpinnerButtonVariables') + + + +## SpinnerButtonVariables.FontFamily Property + +Gets or sets the text font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SpinnerButtonVariables.FontSize Property + +Gets or sets the text font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButtonVariables.IconHeight Property + +Gets or sets the icon height size. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButtonVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SpinnerButtonVariables.IconResourceUrl Property + +Gets or sets the icon resource url. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SpinnerButtonVariables.IconWidth Property + +Gets or sets the icon width size. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButtonVariables.ItemSpacing Property + +Gets or sets the spacing between text and icon. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SpinnerButtonVariables.Padding Property + +Gets or sets the padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SpinnerButtonVariables.TextColor Property + +Gets or sets the text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SpinnerButtonVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer.md new file mode 100644 index 0000000000..c399e423c9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## StaticDrawer Class + +A [StaticDrawer<T>](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>') with default item type of [StaticDrawer](Tizen.UI.Components.Material.StaticDrawer.md 'Tizen.UI.Components.Material.StaticDrawer'). + +```csharp +public class StaticDrawer : Tizen.UI.Components.Material.StaticDrawer<Tizen.UI.Components.Material.DrawerItem> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Tizen.UI.Components.Material.Drawer<](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>')[DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem')[>](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>') 🡒 [Tizen.UI.Components.Material.StaticDrawer<](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>')[DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem')[>](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>') 🡒 StaticDrawer +### Constructors + + + +## StaticDrawer() Constructor + +Construct a new instance. + +```csharp +public StaticDrawer(); +``` + + + +## StaticDrawer(StaticDrawerVariables) Constructor + +Construct a new instance. + +```csharp +public StaticDrawer(Tizen.UI.Components.Material.StaticDrawerVariables variables); +``` +#### Parameters + + + +`variables` [StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables') + +The variables to configure the tab bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawerVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawerVariables.md new file mode 100644 index 0000000000..3d459a7942 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawerVariables.md @@ -0,0 +1,152 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## StaticDrawerVariables Class + +Variables used for Drawer. + +```csharp +public class StaticDrawerVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.StaticDrawerVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 StaticDrawerVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## StaticDrawerVariables.BackgroundColor Property + +Color of the background. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## StaticDrawerVariables.Default Property + +Default variables for StaticDrawer. + +```csharp +public static Tizen.UI.Components.Material.StaticDrawerVariables Default { get; } +``` + +#### Property Value +[StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables') + + + +## StaticDrawerVariables.DrawerColor Property + +Color of the Drawer. + +```csharp +public Tizen.UI.Color DrawerColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## StaticDrawerVariables.DrawerCornerRadius Property + +Drawer corner radius. + +```csharp +public Tizen.UI.CornerRadius DrawerCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## StaticDrawerVariables.DrawerItemSpacing Property + +Drawer spacing between items. + +```csharp +public float DrawerItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## StaticDrawerVariables.DrawerPadding Property + +Drawer padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness DrawerPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## StaticDrawerVariables.DrawerRatio Property + +Gets the Width of the Drawer component. + +```csharp +public float DrawerRatio { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer_T_.md new file mode 100644 index 0000000000..4aaa4f5499 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer_T_.md @@ -0,0 +1,163 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## StaticDrawer<T> Class + +Canonical layout container that provides selectable items area in left side and content area in right side. + +```csharp +public class StaticDrawer<T> : Tizen.UI.Components.Material.Drawer<T> + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Tizen.UI.Components.Material.Drawer<](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>')[T](Tizen.UI.Components.Material.StaticDrawer_T_.md#Tizen.UI.Components.Material.StaticDrawer_T_.T 'Tizen.UI.Components.Material.StaticDrawer<T>.T')[>](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>') 🡒 StaticDrawer<T> + +Derived +↳ [StaticDrawer](Tizen.UI.Components.Material.StaticDrawer.md 'Tizen.UI.Components.Material.StaticDrawer') +### Constructors + + + +## StaticDrawer() Constructor + +Initializes a new instance of the Drawer class with default settings. + +```csharp +public StaticDrawer(); +``` + + + +## StaticDrawer(StaticDrawerVariables) Constructor + +Initializes a new instance of the Drawer class with specified variables. + +```csharp +public StaticDrawer(Tizen.UI.Components.Material.StaticDrawerVariables variables); +``` +#### Parameters + + + +`variables` [StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables') + +The DrawerVariables object containing configuration for the drawer. +### Properties + + + +## StaticDrawer<T>.Content Property + +Gets or sets the content of the Drawer. + +```csharp +public override Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View +### Methods + + + +## StaticDrawer<T>.Measure(float, float) Method + +Measures the size requirements of the view for the given constraints. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +Tizen.UI.Size +The measured size requirements of the view. + + + +## StaticDrawer<T>.SwapContent(View) Method + +Sets a content to be shown with the content swap animation. +If current content is null, it will not show the content swap animation. + +```csharp +public System.Threading.Tasks.Task SwapContent(Tizen.UI.View newContent); +``` +#### Parameters + + + +`newContent` Tizen.UI.View + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + +### Remarks +For the continuation task, please specify [System.Threading.Tasks.TaskScheduler](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.TaskScheduler 'System.Threading.Tasks.TaskScheduler') as the current synchronization context to ensure that the continuation runs on the UI thread. +For example, + +```csharp +staticDrawer.SwapContent(newContent).ContinueWith(finishedCallback, TaskScheduler.FromCurrentSynchronizationContext()); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Switch.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Switch.md new file mode 100644 index 0000000000..67d15061d0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Switch.md @@ -0,0 +1,116 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Switch Class + +Switch is a component that toggle on and off by click event. + +```csharp +public class Switch : Tizen.UI.Components.Selectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Switch +### Constructors + + + +## Switch() Constructor + +Constructs a new switch. + +```csharp +public Switch(); +``` + + + +## Switch(SwitchVariables) Constructor + +Constructs a new switch. + +```csharp +public Switch(Tizen.UI.Components.Material.SwitchVariables variables); +``` +#### Parameters + + + +`variables` [SwitchVariables](Tizen.UI.Components.Material.SwitchVariables.md 'Tizen.UI.Components.Material.SwitchVariables') + +The variables for the switch. +### Methods + + + +## Switch.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + +## Switch.GetTouchEffectTarget() Method + +Get the target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectTarget(); +``` + +Implements GetTouchEffectTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SwitchVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SwitchVariables.md new file mode 100644 index 0000000000..0be41d61a3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SwitchVariables.md @@ -0,0 +1,181 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## SwitchVariables Class + +Variables used for switch. + +```csharp +public class SwitchVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.SwitchVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 SwitchVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[SwitchVariables](Tizen.UI.Components.Material.SwitchVariables.md 'Tizen.UI.Components.Material.SwitchVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## SwitchVariables.Default Property + +Default switch variables. + +```csharp +public static Tizen.UI.Components.Material.SwitchVariables Default { get; } +``` + +#### Property Value +[SwitchVariables](Tizen.UI.Components.Material.SwitchVariables.md 'Tizen.UI.Components.Material.SwitchVariables') + + + +## SwitchVariables.Padding Property + +Switch padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SwitchVariables.ThumbColor Property + +Switch thumb color. + +```csharp +public Tizen.UI.Color ThumbColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SwitchVariables.ThumbPadding Property + +Switch padding between track and thumb. + +```csharp +public Tizen.UI.Thickness ThumbPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## SwitchVariables.TouchEffect Property + +The visual feedback effect for switch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + +## SwitchVariables.TrackColor Property + +Switch track color. + +```csharp +public Tizen.UI.Color TrackColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SwitchVariables.TrackHeight Property + +Switch track height. + +```csharp +public float TrackHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SwitchVariables.TrackSelectedColor Property + +Switch track selected color. + +```csharp +public Tizen.UI.Color TrackSelectedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SwitchVariables.TrackWidth Property + +Switch track width. + +```csharp +public float TrackWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar.md new file mode 100644 index 0000000000..08539c8422 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TabBar Class + +A [TabBar<T>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') with default item type of [TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem'). + +```csharp +public class TabBar : Tizen.UI.Components.Material.TabBar<Tizen.UI.Components.Material.TabItem> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.SelectionGroupBox<[TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem')> 🡒 [Tizen.UI.Components.Material.TabBar<](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>')[TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem')[>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') 🡒 TabBar +### Constructors + + + +## TabBar() Constructor + +Construct a new instance. + +```csharp +public TabBar(); +``` + + + +## TabBar(TabBarVariables) Constructor + +Construct a new instance. + +```csharp +public TabBar(Tizen.UI.Components.Material.TabBarVariables variables); +``` +#### Parameters + + + +`variables` [TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + +The variables to configure the tab bar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBarVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBarVariables.md new file mode 100644 index 0000000000..4230b97a7e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBarVariables.md @@ -0,0 +1,191 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TabBarVariables Class + +Variables used for TabBar. + +```csharp +public class TabBarVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.TabBarVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 TabBarVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## TabBarVariables.BackgroundColor Property + +Gets or sets the fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabBarVariables.BottomBar Property + +BottomBar variables for TabBar. + +```csharp +public static Tizen.UI.Components.Material.TabBarVariables BottomBar { get; } +``` + +#### Property Value +[TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + + + +## TabBarVariables.BottomBorderlineColor Property + +Gets or sets the bottom borderline color. + +```csharp +public Tizen.UI.Color BottomBorderlineColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabBarVariables.BottomBorderlineWidth Property + +Gets or sets the bottom borderline thickness. + +```csharp +public float BottomBorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabBarVariables.Default Property + +Default variables for TabBar. + +```csharp +public static Tizen.UI.Components.Material.TabBarVariables Default { get; } +``` + +#### Property Value +[TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + + + +## TabBarVariables.DefaultHeight Property + +Gets or sets the default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabBarVariables.ItemSpacing Property + +Gets or sets the spacing between tab items. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabBarVariables.Padding Property + +Gets or sets padding. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## TabBarVariables.TopBorderlineColor Property + +Gets or sets the top borderline color. + +```csharp +public Tizen.UI.Color TopBorderlineColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabBarVariables.TopBorderlineWidth Property + +Gets or sets the top borderline thickness. + +```csharp +public float TopBorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar_T_.md new file mode 100644 index 0000000000..5261dab73a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar_T_.md @@ -0,0 +1,110 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TabBar<T> Class + +TabBar provides a horizontal layout to display TabItems. + +```csharp +public class TabBar<T> : Tizen.UI.Components.SelectionGroupBox<T> + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.SelectionGroupBox<[T](Tizen.UI.Components.Material.TabBar_T_.md#Tizen.UI.Components.Material.TabBar_T_.T 'Tizen.UI.Components.Material.TabBar<T>.T')> 🡒 TabBar<T> + +Derived +↳ [BottomBar<T>](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>') +↳ [TabBar](Tizen.UI.Components.Material.TabBar.md 'Tizen.UI.Components.Material.TabBar') +### Constructors + + + +## TabBar() Constructor + +Construct a new instance. + +```csharp +public TabBar(); +``` + + + +## TabBar(TabBarVariables) Constructor + +Construct a new instance. + +```csharp +public TabBar(Tizen.UI.Components.Material.TabBarVariables variables); +``` +#### Parameters + + + +`variables` [TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') + +The variables to configure the tab bar. +### Properties + + + +## TabBar<T>.ItemAlignment Property + +Gets or sets the alignment of the tab items. + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.LayoutAlignment +The alignment of the tab items. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItem.md new file mode 100644 index 0000000000..c9ffb5244a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItem.md @@ -0,0 +1,288 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TabItem Class + +TabItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. + +```csharp +public class TabItem : Tizen.UI.Components.GroupSelectable, +Tizen.UI.Components.IFlexibleText, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Tizen.UI.Components.Pressable 🡒 Tizen.UI.Components.Clickable 🡒 Tizen.UI.Components.Selectable 🡒 Tizen.UI.Components.GroupSelectable 🡒 TabItem + +Implements Tizen.UI.Components.IFlexibleText, Tizen.UI.IText +### Constructors + + + +## TabItem() Constructor + +Constructs an empty button. + +```csharp +public TabItem(); +``` + + + +## TabItem(string) Constructor + +Constructs a tab item with specified text. + +```csharp +public TabItem(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display on the tab item. + + + +## TabItem(string, TabItemVariables) Constructor + +Constructs a tab item with specified text and variables. + +```csharp +public TabItem(string text, Tizen.UI.Components.Material.TabItemVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display on the tab item. + + + +`variables` [TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables') + +Custom variables for the tab item. + + + +## TabItem(TabItemVariables) Constructor + +Constructs an empty tab item with specified variables. + +```csharp +public TabItem(Tizen.UI.Components.Material.TabItemVariables variables); +``` +#### Parameters + + + +`variables` [TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables') + +Custom variables for the tab item. +### Properties + + + +## TabItem.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +Implements AutoFontSize + +#### Property Value +Tizen.UI.AutoFontSize + + + +## TabItem.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TabItem.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize, FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItem.IconMultipliedColor Property + +Gets or sets the mix color of the icon image. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabItem.IconResourceUrl Property + +Gets or sets the resource URL of the icon image. + +```csharp +public string IconResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TabItem.ItemSpacing Property + +Gets or sets the spacing between icon and text. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItem.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TabItem.Text Property + +Gets or sets the text of the tab item. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TabItem.TextColor Property + +Gets or sets the text color of the label. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## TabItem.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements TextOverflow + +#### Property Value +Tizen.UI.TextOverflow +### Methods + + + +## TabItem.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public override Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements GetTouchEffectSecondaryTarget() + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItemVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItemVariables.md new file mode 100644 index 0000000000..e0f0ba49e3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItemVariables.md @@ -0,0 +1,272 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TabItemVariables Class + +Variables used for TabItem. + +```csharp +public class TabItemVariables : Tizen.UI.Components.Variables, +Tizen.UI.Components.IClickableVariables, +System.IEquatable<Tizen.UI.Components.Material.TabItemVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 TabItemVariables + +Implements Tizen.UI.Components.IClickableVariables, [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## TabItemVariables.BackgroundColor Property + +Gets or sets the fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabItemVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## TabItemVariables.Default Property + +Default TabItem variables. + +```csharp +public static Tizen.UI.Components.Material.TabItemVariables Default { get; } +``` + +#### Property Value +[TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables') + + + +## TabItemVariables.DefaultHeight Property + +Gets or sets the default height. + +```csharp +public float DefaultHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItemVariables.FontFamily Property + +Gets or sets the text font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TabItemVariables.FontSize Property + +Gets or sets the text font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItemVariables.IconCornerRadius Property + +TabItem icon corner radius. + +```csharp +public Tizen.UI.CornerRadius IconCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## TabItemVariables.IconHeight Property + +Gets or sets the icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItemVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabItemVariables.IconWidth Property + +Gets or sets the icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItemVariables.ItemSpacing Property + +Gets or sets the item spacing between text and icon. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TabItemVariables.Padding Property + +Gets or sets the padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## TabItemVariables.SelectedFontFamily Property + +Gets or sets the text font family when selected. + +```csharp +public string SelectedFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TabItemVariables.SelectedIconMultipliedColor Property + +Gets or sets the icon mix color when selected. + +```csharp +public Tizen.UI.Color SelectedIconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabItemVariables.TextColor Property + +Gets or sets the text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TabItemVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +public Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +Implements TouchEffect + +#### Property Value +Tizen.UI.Components.UIAttachable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Title.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Title.md new file mode 100644 index 0000000000..66fcd4d276 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Title.md @@ -0,0 +1,124 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Title Class + +The title component. It is a label with some predefined styles. It can be used as a app bar title content. + +```csharp +public class Title : Tizen.UI.Components.Material.Label, +Tizen.UI.Components.ITitle, +Tizen.UI.Components.Material.IAppBarContent +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 [Label](Tizen.UI.Components.Material.Label.md 'Tizen.UI.Components.Material.Label') 🡒 Title + +Implements Tizen.UI.Components.ITitle, [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') +### Constructors + + + +## Title() Constructor + +Constructs a title. + +```csharp +public Title(); +``` + + + +## Title(string) Constructor + +Constructs a title. + +```csharp +public Title(string title); +``` +#### Parameters + + + +`title` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Title(string, TitleVariables) Constructor + +Constructs a title. + +```csharp +public Title(string title, Tizen.UI.Components.Material.TitleVariables variables); +``` +#### Parameters + + + +`title` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`variables` [TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables') +### Methods + + + +## Title.ApplyUnifiedContentColor(Color) Method + +Apply app bar unified content color. + +```csharp +public void ApplyUnifiedContentColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +Implements [ApplyUnifiedContentColor(Color)](Tizen.UI.Components.Material.IAppBarContent.md#Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color) 'Tizen.UI.Components.Material.IAppBarContent.ApplyUnifiedContentColor(Tizen.UI.Color)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TitleVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TitleVariables.md new file mode 100644 index 0000000000..0a095f7182 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TitleVariables.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## TitleVariables Class + +Variables used for title. + +```csharp +public class TitleVariables : Tizen.UI.Components.Material.LabelVariables, +System.IEquatable<Tizen.UI.Components.Material.TitleVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 [LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') 🡒 TitleVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## TitleVariables.Default Property + +Default app bar variables. + +```csharp +public static Tizen.UI.Components.Material.TitleVariables Default { get; } +``` + +#### Property Value +[TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables') + + + +## TitleVariables.Padding Property + +Gets or sets padding of title. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## TitleVariables.TextOverflow Property + +Gets or sets overflow mode of title. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Toast.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Toast.md new file mode 100644 index 0000000000..97ba84e37d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Toast.md @@ -0,0 +1,303 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## Toast Class + +A toast component that displays a message, it automatically dismisses after a specified duration. + +```csharp +public class Toast : Tizen.UI.Layouts.Grid, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Layouts.Layout 🡒 Tizen.UI.Layouts.Grid 🡒 Toast + +Implements Tizen.UI.IText +### Constructors + + + +## Toast() Constructor + +Constructs an empty toast. + +```csharp +public Toast(); +``` + + + +## Toast(string) Constructor + +Constructs a toast with text. + +```csharp +public Toast(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the Toast. + + + +## Toast(string, uint) Constructor + +Constructs a toast with text and duration. + +```csharp +public Toast(string text, uint duration); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the Toast. + + + +`duration` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The duration for which the Toast is displayed. + + + +## Toast(string, uint, ToastVariables) Constructor + +Constructs a toast with text, duration and variables. + +```csharp +public Toast(string text, uint duration, Tizen.UI.Components.Material.ToastVariables variables); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to display in the Toast. + + + +`duration` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The duration for which the Toast is displayed. + + + +`variables` [ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables') + +Custom Toast variables. + + + +## Toast(ToastVariables) Constructor + +Constructs an empty toast. + +```csharp +public Toast(Tizen.UI.Components.Material.ToastVariables variables); +``` +#### Parameters + + + +`variables` [ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables') + +Custom Toast variables. +### Properties + + + +## Toast.Duration Property + +Gets or sets the duration for which the toast is displayed. + +```csharp +public uint Duration { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## Toast.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Toast.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Toast.ItemSpacing Property + +Gets or sets the spacing between icon and text. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Toast.Text Property + +Gets or sets the text of the toast. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Toast.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color +### Methods + + + +## Toast.Dismiss() Method + +Dismisses the toast. + +```csharp +public void Dismiss(); +``` + + + +## Toast.Post(Window) Method + +Post the toast. + +```csharp +public void Post(Tizen.UI.Window window=null); +``` +#### Parameters + + + +`window` Tizen.UI.Window +### Events + + + +## Toast.Hidden Event + +Add and remove hidden event handler. + +```csharp +public event EventHandler Hidden; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + +### Remarks +This event is raised when the toast is fully dismissed. + + + +## Toast.Shown Event + +Add and remove shown event handler. + +```csharp +public event EventHandler Shown; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + +### Remarks +This event is raised when the toast is fully shown. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ToastVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ToastVariables.md new file mode 100644 index 0000000000..72f9d37953 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ToastVariables.md @@ -0,0 +1,269 @@ +### [Tizen.UI.Components.Material](Tizen.UI.Components.Material.md 'Tizen.UI.Components.Material') + +## ToastVariables Class + +Variables used for radio button. + +```csharp +public class ToastVariables : Tizen.UI.Components.Variables, +System.IEquatable<Tizen.UI.Components.Material.ToastVariables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Components.Variables 🡒 ToastVariables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## ToastVariables.BackgroundColor Property + +Gets or sets the fill color. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ToastVariables.BottomOffset Property + +Gets or sets the bottom offset from the window edge. + +```csharp +public float BottomOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.CornerRadius Property + +Gets or sets the corner radius. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ToastVariables.Default Property + +Default radio button variables. + +```csharp +public static Tizen.UI.Components.Material.ToastVariables Default { get; } +``` + +#### Property Value +[ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables') + + + +## ToastVariables.FontFamily Property + +Gets or sets the font family. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ToastVariables.FontSize Property + +Gets or sets the font size. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.IconCornerRadius Property + +Gets or sets the icon corner radius. + +```csharp +public Tizen.UI.CornerRadius IconCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ToastVariables.IconHeight Property + +Gets or sets the icon height. + +```csharp +public float IconHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.IconMultipliedColor Property + +Gets or sets the icon mix color. + +```csharp +public Tizen.UI.Color IconMultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ToastVariables.IconWidth Property + +Gets or sets the icon width. + +```csharp +public float IconWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.ItemSpacing Property + +Gets or sets the item spacing between text and icon. + +```csharp +public float ItemSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.MaximumHeight Property + +Gets or sets the maximum height. + +```csharp +public float MaximumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.MaximumWidth Property + +Gets or sets the maximum width. + +```csharp +public float MaximumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ToastVariables.Padding Property + +Gets or sets the padding. (start, end, top, bottom). + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ToastVariables.TextColor Property + +Gets or sets the text color. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ToastVariables.UnderShadows Property + +Gets or sets the visuals to be placed under [View.Shadow](https://docs.microsoft.com/en-us/dotnet/api/View.Shadow 'View.Shadow'). + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> UnderShadows { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.md b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.md new file mode 100644 index 0000000000..e0e1b07d67 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.md @@ -0,0 +1,194 @@ +## Tizen.UI.Components.Material Namespace + +| Classes | | +| :--- | :--- | +| [ActionButton](Tizen.UI.Components.Material.ActionButton.md 'Tizen.UI.Components.Material.ActionButton') | A button that can be used in an AppBar. | +| [AdapterView](Tizen.UI.Components.Material.AdapterView.md 'Tizen.UI.Components.Material.AdapterView') | A loopable scroll view that displays recycling items in specific layouts with adapter. | +| [AlertDialog](Tizen.UI.Components.Material.AlertDialog.md 'Tizen.UI.Components.Material.AlertDialog') | An alert dialog component containing [Title](Tizen.UI.Components.Material.AlertDialog.md#Tizen.UI.Components.Material.AlertDialog.Title 'Tizen.UI.Components.Material.AlertDialog.Title'), [Message](Tizen.UI.Components.Material.AlertDialog.md#Tizen.UI.Components.Material.AlertDialog.Message 'Tizen.UI.Components.Material.AlertDialog.Message'), and action buttons.
AlertDialog can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. | +| [AlertDialogVariables](Tizen.UI.Components.Material.AlertDialogVariables.md 'Tizen.UI.Components.Material.AlertDialogVariables') | Variables used for alert dialog. | +| [AnimatedImage](Tizen.UI.Components.Material.AnimatedImage.md 'Tizen.UI.Components.Material.AnimatedImage') | AnimatedImage is a control for displaying an animated image resource such as gif, webp and sequential images. | +| [AppBar](Tizen.UI.Components.Material.AppBar.md 'Tizen.UI.Components.Material.AppBar') | The AppBar providing a layout for leading, title, action buttons, and trailing contents. | +| [AppBarVariables](Tizen.UI.Components.Material.AppBarVariables.md 'Tizen.UI.Components.Material.AppBarVariables') | Variables used for app bar. | +| [BackButton](Tizen.UI.Components.Material.BackButton.md 'Tizen.UI.Components.Material.BackButton') | Back button is a button that go back within given navigator when clicked.
If no navigator is specified it will use default navigator. | +| [BottomBar](Tizen.UI.Components.Material.BottomBar.md 'Tizen.UI.Components.Material.BottomBar') | A [BottomBar<T>](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>') with default item type of [TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem'). | +| [BottomBar<T>](Tizen.UI.Components.Material.BottomBar_T_.md 'Tizen.UI.Components.Material.BottomBar<T>') | TabBar provides a horizontal layout to display TabItems. | +| [BottomSheet](Tizen.UI.Components.Material.BottomSheet.md 'Tizen.UI.Components.Material.BottomSheet') | A bottom sheet component containing [Content](Tizen.UI.Components.Material.BottomSheet.md#Tizen.UI.Components.Material.BottomSheet.Content 'Tizen.UI.Components.Material.BottomSheet.Content').
BottomSheet can be set to [ModalContent](Tizen.UI.Components.Material.BottomSheetContainer.md#Tizen.UI.Components.Material.BottomSheetContainer.ModalContent 'Tizen.UI.Components.Material.BottomSheetContainer.ModalContent') to be shown as modal bottom sheet. | +| [BottomSheetContainer](Tizen.UI.Components.Material.BottomSheetContainer.md 'Tizen.UI.Components.Material.BottomSheetContainer') | A container that can show a bottom sheet. It should have a scrim to block the background. It also has animation for showing and hiding bottom sheet.
[BottomSheet](Tizen.UI.Components.Material.BottomSheet.md 'Tizen.UI.Components.Material.BottomSheet') can be set to [ModalContent](Tizen.UI.Components.Material.BottomSheetContainer.md#Tizen.UI.Components.Material.BottomSheetContainer.ModalContent 'Tizen.UI.Components.Material.BottomSheetContainer.ModalContent') to be shown as modal bottom sheet. | +| [BottomSheetContainerVariables](Tizen.UI.Components.Material.BottomSheetContainerVariables.md 'Tizen.UI.Components.Material.BottomSheetContainerVariables') | Variables used for bottom sheet container. | +| [BottomSheetVariables](Tizen.UI.Components.Material.BottomSheetVariables.md 'Tizen.UI.Components.Material.BottomSheetVariables') | Variables used for bottom sheet. | +| [BounceEdgeEffect](Tizen.UI.Components.Material.BounceEdgeEffect.md 'Tizen.UI.Components.Material.BounceEdgeEffect') | Bounce Edge effect. | +| [Button](Tizen.UI.Components.Material.Button.md 'Tizen.UI.Components.Material.Button') | A Tizen.UI.Components.Clickable component containing single text. | +| [ButtonVariables](Tizen.UI.Components.Material.ButtonVariables.md 'Tizen.UI.Components.Material.ButtonVariables') | Variables used for button. | +| [Card](Tizen.UI.Components.Material.Card.md 'Tizen.UI.Components.Material.Card') | A Card component | +| [CardVariables](Tizen.UI.Components.Material.CardVariables.md 'Tizen.UI.Components.Material.CardVariables') | Variables used for switch. | +| [Checkbox](Tizen.UI.Components.Material.Checkbox.md 'Tizen.UI.Components.Material.Checkbox') | Checkbox is a component that toggle on and off by click event. | +| [CheckboxVariables](Tizen.UI.Components.Material.CheckboxVariables.md 'Tizen.UI.Components.Material.CheckboxVariables') | Variables used for checkbox. | +| [CircleButton](Tizen.UI.Components.Material.CircleButton.md 'Tizen.UI.Components.Material.CircleButton') | A Tizen.UI.Components.Clickable component containing single icon.
The main difference from an [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') is that it can have a Tizen.UI.Components.UIState.Progressing like [Button](Tizen.UI.Components.Material.Button.md 'Tizen.UI.Components.Material.Button'). | +| [CircleButtonVariables](Tizen.UI.Components.Material.CircleButtonVariables.md 'Tizen.UI.Components.Material.CircleButtonVariables') | Variables used for circle button. | +| [Dialog](Tizen.UI.Components.Material.Dialog.md 'Tizen.UI.Components.Material.Dialog') | A dialog component containing [HeaderView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.HeaderView 'Tizen.UI.Components.Material.Dialog.HeaderView'), [BodyView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.BodyView 'Tizen.UI.Components.Material.Dialog.BodyView'), and [FooterView](Tizen.UI.Components.Material.Dialog.md#Tizen.UI.Components.Material.Dialog.FooterView 'Tizen.UI.Components.Material.Dialog.FooterView').
Dialog can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. | +| [DialogContainer](Tizen.UI.Components.Material.DialogContainer.md 'Tizen.UI.Components.Material.DialogContainer') | A container that can show a dialog. It should have a scrim to block the background. It also has animation for showing and hiding dialog.
[Dialog](Tizen.UI.Components.Material.Dialog.md 'Tizen.UI.Components.Material.Dialog') and [AlertDialog](Tizen.UI.Components.Material.AlertDialog.md 'Tizen.UI.Components.Material.AlertDialog') can be set to [ModalContent](Tizen.UI.Components.Material.DialogContainer.md#Tizen.UI.Components.Material.DialogContainer.ModalContent 'Tizen.UI.Components.Material.DialogContainer.ModalContent') to be shown as modal dialog. | +| [DialogContainerVariables](Tizen.UI.Components.Material.DialogContainerVariables.md 'Tizen.UI.Components.Material.DialogContainerVariables') | Variables used for dialog container. | +| [DialogVariables](Tizen.UI.Components.Material.DialogVariables.md 'Tizen.UI.Components.Material.DialogVariables') | Variables used for dialog. | +| [Divider](Tizen.UI.Components.Material.Divider.md 'Tizen.UI.Components.Material.Divider') | Represents a divider component with different styles and directions. | +| [DividerVariables](Tizen.UI.Components.Material.DividerVariables.md 'Tizen.UI.Components.Material.DividerVariables') | Variables used for divider. | +| [DoubleTitle](Tizen.UI.Components.Material.DoubleTitle.md 'Tizen.UI.Components.Material.DoubleTitle') | The title component with main title and subtitle. It can be used as a app bar title content. | +| [DoubleTitleVariables](Tizen.UI.Components.Material.DoubleTitleVariables.md 'Tizen.UI.Components.Material.DoubleTitleVariables') | Variables used for double title which has main and sub titles. | +| [Drawer<T>](Tizen.UI.Components.Material.Drawer_T_.md 'Tizen.UI.Components.Material.Drawer<T>') | This component supports both modal and static types of drawers. | +| [DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem') | DrawerItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. | +| [DrawerItemVariables](Tizen.UI.Components.Material.DrawerItemVariables.md 'Tizen.UI.Components.Material.DrawerItemVariables') | Variables used for DrawerItem. | +| [DropdownActionItem](Tizen.UI.Components.Material.DropdownActionItem.md 'Tizen.UI.Components.Material.DropdownActionItem') | It is uesed as an item of DropdownList. It focuses an action to be executed when clicked rather than the expressing selection among the other items. | +| [DropdownCheckItem](Tizen.UI.Components.Material.DropdownCheckItem.md 'Tizen.UI.Components.Material.DropdownCheckItem') | DropdownCheckItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. | +| [DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem') | DropdownListItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. | +| [DropdownItemVariables](Tizen.UI.Components.Material.DropdownItemVariables.md 'Tizen.UI.Components.Material.DropdownItemVariables') | Variables used for DropdownListItem. | +| [DropdownList](Tizen.UI.Components.Material.DropdownList.md 'Tizen.UI.Components.Material.DropdownList') | A [DropdownList<T>](Tizen.UI.Components.Material.DropdownList_T_.md 'Tizen.UI.Components.Material.DropdownList<T>') with default item type of [DropdownItem](Tizen.UI.Components.Material.DropdownItem.md 'Tizen.UI.Components.Material.DropdownItem'). | +| [DropdownList<T>](Tizen.UI.Components.Material.DropdownList_T_.md 'Tizen.UI.Components.Material.DropdownList<T>') | The selectable item container desinged to be posted above the other objects. | +| [DropdownListVariables](Tizen.UI.Components.Material.DropdownListVariables.md 'Tizen.UI.Components.Material.DropdownListVariables') | Variables used for DropdownList. | +| [FloatingActionButtonScrollBar](Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md 'Tizen.UI.Components.Material.FloatingActionButtonScrollBar') | A class representing a scroll bar with a floating icon. | +| [GoToTopScrollBar](Tizen.UI.Components.Material.GoToTopScrollBar.md 'Tizen.UI.Components.Material.GoToTopScrollBar') | A class representing a scroll bar with a Got-o-top icon. | +| [GridView](Tizen.UI.Components.Material.GridView.md 'Tizen.UI.Components.Material.GridView') | A scroll view that displays recycling items in a grid layout.
It supports horizontal and vertical scrolling. The items can be bound to a data source using an item template.
The grid view can be customized with various properties such as span count, prefetch base size, and scroll bar visibility.
The grid view uses a recycler view internally to efficiently manage the display of items.
The grid view can be used to create a variety of layouts such as a photo gallery or a product catalog. | +| [IconButton](Tizen.UI.Components.Material.IconButton.md 'Tizen.UI.Components.Material.IconButton') | A [Button](Tizen.UI.Components.Material.Button.md 'Tizen.UI.Components.Material.Button') containing a single icon. | +| [IconButtonVariables](Tizen.UI.Components.Material.IconButtonVariables.md 'Tizen.UI.Components.Material.IconButtonVariables') | Variables used for icon button. | +| [Image](Tizen.UI.Components.Material.Image.md 'Tizen.UI.Components.Material.Image') | Image is a control for displaying an image resource. | +| [InputEditor](Tizen.UI.Components.Material.InputEditor.md 'Tizen.UI.Components.Material.InputEditor') | A multi-line text input control that supports various text editing features. | +| [InputEditorVariables](Tizen.UI.Components.Material.InputEditorVariables.md 'Tizen.UI.Components.Material.InputEditorVariables') | Variables used for input editor. | +| [InputField](Tizen.UI.Components.Material.InputField.md 'Tizen.UI.Components.Material.InputField') | A single-line text input control that supports various text editing features. | +| [InputFieldVariables](Tizen.UI.Components.Material.InputFieldVariables.md 'Tizen.UI.Components.Material.InputFieldVariables') | Variables used for input field. | +| [InputPicker](Tizen.UI.Components.Material.InputPicker.md 'Tizen.UI.Components.Material.InputPicker') | Represents a picker component that only shows an input field for direct value entry. | +| [InputTextVariables](Tizen.UI.Components.Material.InputTextVariables.md 'Tizen.UI.Components.Material.InputTextVariables') | Variables used for input text. | +| [Label](Tizen.UI.Components.Material.Label.md 'Tizen.UI.Components.Material.Label') | A text control that displays a short to medium length string of text. | +| [LabelVariables](Tizen.UI.Components.Material.LabelVariables.md 'Tizen.UI.Components.Material.LabelVariables') | Variables used for label. | +| [LevelBar](Tizen.UI.Components.Material.LevelBar.md 'Tizen.UI.Components.Material.LevelBar') | A level bar is a discrete slider with a specific GUI.
It can be used to select a value by moving the trail along the track. | +| [LevelBarVariables](Tizen.UI.Components.Material.LevelBarVariables.md 'Tizen.UI.Components.Material.LevelBarVariables') | Variables used for level bar. | +| [ListView](Tizen.UI.Components.Material.ListView.md 'Tizen.UI.Components.Material.ListView') | A scroll view that displays recycling items in a linear layout.
It supports horizontal and vertical scrolling. The items can be bound to a data source using an item template.
The list view can be customized with various properties such as prefetch base size, and scroll bar visibility.
The list view uses a recycler view internally to efficiently manage the display of items. | +| [LoopedAdapterView](Tizen.UI.Components.Material.LoopedAdapterView.md 'Tizen.UI.Components.Material.LoopedAdapterView') | A loopable scroll view that displays recycling items in specific layouts with adapter. | +| [LottieImage](Tizen.UI.Components.Material.LottieImage.md 'Tizen.UI.Components.Material.LottieImage') | LottieImage is a control for displaying Lottie animations. | +| [LottieImageProgress](Tizen.UI.Components.Material.LottieImageProgress.md 'Tizen.UI.Components.Material.LottieImageProgress') | A progress using lottie animated image. | +| [LottieImageTimeCounter](Tizen.UI.Components.Material.LottieImageTimeCounter.md 'Tizen.UI.Components.Material.LottieImageTimeCounter') | A time counter component using LottieImage. | +| [MaterialApplication](Tizen.UI.Components.Material.MaterialApplication.md 'Tizen.UI.Components.Material.MaterialApplication') | Represents an material application. | +| [MaterialBorder](Tizen.UI.Components.Material.MaterialBorder.md 'Tizen.UI.Components.Material.MaterialBorder') | Represents an material borderline width. | +| [MaterialColor](Tizen.UI.Components.Material.MaterialColor.md 'Tizen.UI.Components.Material.MaterialColor') | Represents an material resource. | +| [MaterialComponentVariables](Tizen.UI.Components.Material.MaterialComponentVariables.md 'Tizen.UI.Components.Material.MaterialComponentVariables') | Defines the variables for material components. | +| [MaterialConfig](Tizen.UI.Components.Material.MaterialConfig.md 'Tizen.UI.Components.Material.MaterialConfig') | The configuration of material components. | +| [MaterialCorner](Tizen.UI.Components.Material.MaterialCorner.md 'Tizen.UI.Components.Material.MaterialCorner') | Represents an material corner radius. | +| [MaterialFont](Tizen.UI.Components.Material.MaterialFont.md 'Tizen.UI.Components.Material.MaterialFont') | Represents an material font family. | +| [MaterialFontSize](Tizen.UI.Components.Material.MaterialFontSize.md 'Tizen.UI.Components.Material.MaterialFontSize') | Represents an material font size. | +| [MaterialIcon](Tizen.UI.Components.Material.MaterialIcon.md 'Tizen.UI.Components.Material.MaterialIcon') | Represents an material icon resources. | +| [MaterialResourceManager](Tizen.UI.Components.Material.MaterialResourceManager.md 'Tizen.UI.Components.Material.MaterialResourceManager') | Provides a method to get the path of a resource file. | +| [MaterialSpacing](Tizen.UI.Components.Material.MaterialSpacing.md 'Tizen.UI.Components.Material.MaterialSpacing') | Represents an material spacings. | +| [MaterialThemeLoader](Tizen.UI.Components.Material.MaterialThemeLoader.md 'Tizen.UI.Components.Material.MaterialThemeLoader') | The material theme loader. | +| [MaterialWidgetApplication](Tizen.UI.Components.Material.MaterialWidgetApplication.md 'Tizen.UI.Components.Material.MaterialWidgetApplication') | Represents an material widget application. | +| [ModalDrawer](Tizen.UI.Components.Material.ModalDrawer.md 'Tizen.UI.Components.Material.ModalDrawer') | A [ModalDrawer<T>](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>') with default item type of [DrawerItem](Tizen.UI.Components.Material.DrawerItem.md 'Tizen.UI.Components.Material.DrawerItem'). | +| [ModalDrawer<T>](Tizen.UI.Components.Material.ModalDrawer_T_.md 'Tizen.UI.Components.Material.ModalDrawer<T>') | Canonical layout container that provides selectable items area in left side and content area in right side.
The items area can be hidden. | +| [ModalDrawerVariables](Tizen.UI.Components.Material.ModalDrawerVariables.md 'Tizen.UI.Components.Material.ModalDrawerVariables') | Variables used for Drawer. | +| [MoreButton](Tizen.UI.Components.Material.MoreButton.md 'Tizen.UI.Components.Material.MoreButton') | MoreVertical button is a button that pops up a contextual menu within a given navigator when clicked.
If no navigator is specified it will use default navigator. | +| [NotificationDuration](Tizen.UI.Components.Material.NotificationDuration.md 'Tizen.UI.Components.Material.NotificationDuration') | Notification Duration | +| [PageAdapter](Tizen.UI.Components.Material.PageAdapter.md 'Tizen.UI.Components.Material.PageAdapter') | A Page adapter who connects pager and indicator. | +| [PageIndicator](Tizen.UI.Components.Material.PageIndicator.md 'Tizen.UI.Components.Material.PageIndicator') | A Page indicator component. | +| [PageIndicatorDot](Tizen.UI.Components.Material.PageIndicatorDot.md 'Tizen.UI.Components.Material.PageIndicatorDot') | A Page indicator dot elements. | +| [PageIndicatorDotVariables](Tizen.UI.Components.Material.PageIndicatorDotVariables.md 'Tizen.UI.Components.Material.PageIndicatorDotVariables') | Variables used for page indicator dot. | +| [PageIndicatorVariables](Tizen.UI.Components.Material.PageIndicatorVariables.md 'Tizen.UI.Components.Material.PageIndicatorVariables') | Variables used for page indicator. | +| [PageScroller](Tizen.UI.Components.Material.PageScroller.md 'Tizen.UI.Components.Material.PageScroller') | A Page scroller component. | +| [Picker](Tizen.UI.Components.Material.Picker.md 'Tizen.UI.Components.Material.Picker') | Represents a picker component that shows a list of values and allows the user to select one. | +| [PickerBase](Tizen.UI.Components.Material.PickerBase.md 'Tizen.UI.Components.Material.PickerBase') | The base abstract class for all picker implementations.
Contains common properties and logic for picker components. | +| [PickerVariables](Tizen.UI.Components.Material.PickerVariables.md 'Tizen.UI.Components.Material.PickerVariables') | Variables used for picker. | +| [ProgressBar](Tizen.UI.Components.Material.ProgressBar.md 'Tizen.UI.Components.Material.ProgressBar') | A progress component that indicates a specific value from a continuous or discrete range of values in bar shape. | +| [ProgressBarVariables](Tizen.UI.Components.Material.ProgressBarVariables.md 'Tizen.UI.Components.Material.ProgressBarVariables') | Variables used for progress bar. | +| [ProgressCircle](Tizen.UI.Components.Material.ProgressCircle.md 'Tizen.UI.Components.Material.ProgressCircle') | A progress component that indicates a specific value from a continuous or discrete range of values in circular shape. | +| [ProgressCircleVariables](Tizen.UI.Components.Material.ProgressCircleVariables.md 'Tizen.UI.Components.Material.ProgressCircleVariables') | Variables used for progress circle. | +| [ProgressTimer](Tizen.UI.Components.Material.ProgressTimer.md 'Tizen.UI.Components.Material.ProgressTimer') | A progress component that specific GUI that can indicate a time value. | +| [ProgressTimerVariables](Tizen.UI.Components.Material.ProgressTimerVariables.md 'Tizen.UI.Components.Material.ProgressTimerVariables') | Variables used for timer progress. | +| [RadioButton](Tizen.UI.Components.Material.RadioButton.md 'Tizen.UI.Components.Material.RadioButton') | Radio button is a component that can be selected among the Tizen.UI.Components.SelectionGroup. | +| [RadioButtonVariables](Tizen.UI.Components.Material.RadioButtonVariables.md 'Tizen.UI.Components.Material.RadioButtonVariables') | Variables used for radio button. | +| [Scaffold](Tizen.UI.Components.Material.Scaffold.md 'Tizen.UI.Components.Material.Scaffold') | A scaffold of application.
Application can have a scaffold in a window to layout content properly. | +| [ScrollBar](Tizen.UI.Components.Material.ScrollBar.md 'Tizen.UI.Components.Material.ScrollBar') | A class representing a scroll bar that can be used to control the scrolling of a view. | +| [ScrollBarVariables](Tizen.UI.Components.Material.ScrollBarVariables.md 'Tizen.UI.Components.Material.ScrollBarVariables') | Variables used for scroll bar. | +| [ScrollView](Tizen.UI.Components.Material.ScrollView.md 'Tizen.UI.Components.Material.ScrollView') | A scrolable view containnig other views that can be scrolled manually (via touch). | +| [SelectableLottieImage](Tizen.UI.Components.Material.SelectableLottieImage.md 'Tizen.UI.Components.Material.SelectableLottieImage') | A selectable lottie image view that can be selected and deselected with animation. | +| [Slider](Tizen.UI.Components.Material.Slider.md 'Tizen.UI.Components.Material.Slider') | A slider component that indicates a specific value from a continuous or discrete range of values in bar shape.
It can be used to select a value by moving the trail along the track. | +| [SliderVariables](Tizen.UI.Components.Material.SliderVariables.md 'Tizen.UI.Components.Material.SliderVariables') | Variables used for slider. | +| [SmartTip](Tizen.UI.Components.Material.SmartTip.md 'Tizen.UI.Components.Material.SmartTip') | A bubble shaped pop over text. | +| [SmartTipBase](Tizen.UI.Components.Material.SmartTipBase.md 'Tizen.UI.Components.Material.SmartTipBase') | Provide base structure for SmartTips. | +| [SmartTipMenu](Tizen.UI.Components.Material.SmartTipMenu.md 'Tizen.UI.Components.Material.SmartTipMenu') | A bubble shaped pop over container with Title and Content area. | +| [SmartTipVariables](Tizen.UI.Components.Material.SmartTipVariables.md 'Tizen.UI.Components.Material.SmartTipVariables') | Variables used for smart tip. | +| [SmartTipView](Tizen.UI.Components.Material.SmartTipView.md 'Tizen.UI.Components.Material.SmartTipView') | A bubble shaped pop over container. | +| [SmartTipViewVariables](Tizen.UI.Components.Material.SmartTipViewVariables.md 'Tizen.UI.Components.Material.SmartTipViewVariables') | Variables used for smart tip view. | +| [SnackBar](Tizen.UI.Components.Material.SnackBar.md 'Tizen.UI.Components.Material.SnackBar') | A SnackBar component that displays a message with action button. | +| [SnackBarActionEventArgs](Tizen.UI.Components.Material.SnackBarActionEventArgs.md 'Tizen.UI.Components.Material.SnackBarActionEventArgs') | EventArgs for SnackBarAction. | +| [SnackBarVariables](Tizen.UI.Components.Material.SnackBarVariables.md 'Tizen.UI.Components.Material.SnackBarVariables') | Variables used for radio button. | +| [SpinnerButton](Tizen.UI.Components.Material.SpinnerButton.md 'Tizen.UI.Components.Material.SpinnerButton') | | +| [SpinnerButtonVariables](Tizen.UI.Components.Material.SpinnerButtonVariables.md 'Tizen.UI.Components.Material.SpinnerButtonVariables') | Variables used for spinner button. | +| [StaticDrawer](Tizen.UI.Components.Material.StaticDrawer.md 'Tizen.UI.Components.Material.StaticDrawer') | A [StaticDrawer<T>](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>') with default item type of [StaticDrawer](Tizen.UI.Components.Material.StaticDrawer.md 'Tizen.UI.Components.Material.StaticDrawer'). | +| [StaticDrawer<T>](Tizen.UI.Components.Material.StaticDrawer_T_.md 'Tizen.UI.Components.Material.StaticDrawer<T>') | Canonical layout container that provides selectable items area in left side and content area in right side. | +| [StaticDrawerVariables](Tizen.UI.Components.Material.StaticDrawerVariables.md 'Tizen.UI.Components.Material.StaticDrawerVariables') | Variables used for Drawer. | +| [Switch](Tizen.UI.Components.Material.Switch.md 'Tizen.UI.Components.Material.Switch') | Switch is a component that toggle on and off by click event. | +| [SwitchVariables](Tizen.UI.Components.Material.SwitchVariables.md 'Tizen.UI.Components.Material.SwitchVariables') | Variables used for switch. | +| [TabBar](Tizen.UI.Components.Material.TabBar.md 'Tizen.UI.Components.Material.TabBar') | A [TabBar<T>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') with default item type of [TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem'). | +| [TabBar<T>](Tizen.UI.Components.Material.TabBar_T_.md 'Tizen.UI.Components.Material.TabBar<T>') | TabBar provides a horizontal layout to display TabItems. | +| [TabBarVariables](Tizen.UI.Components.Material.TabBarVariables.md 'Tizen.UI.Components.Material.TabBarVariables') | Variables used for TabBar. | +| [TabItem](Tizen.UI.Components.Material.TabItem.md 'Tizen.UI.Components.Material.TabItem') | TabItem is a component that can be selected among the Tizen.UI.Components.SelectionGroup. | +| [TabItemVariables](Tizen.UI.Components.Material.TabItemVariables.md 'Tizen.UI.Components.Material.TabItemVariables') | Variables used for TabItem. | +| [Title](Tizen.UI.Components.Material.Title.md 'Tizen.UI.Components.Material.Title') | The title component. It is a label with some predefined styles. It can be used as a app bar title content. | +| [TitleVariables](Tizen.UI.Components.Material.TitleVariables.md 'Tizen.UI.Components.Material.TitleVariables') | Variables used for title. | +| [Toast](Tizen.UI.Components.Material.Toast.md 'Tizen.UI.Components.Material.Toast') | A toast component that displays a message, it automatically dismisses after a specified duration. | +| [ToastVariables](Tizen.UI.Components.Material.ToastVariables.md 'Tizen.UI.Components.Material.ToastVariables') | Variables used for radio button. | + +| Interfaces | | +| :--- | :--- | +| [IAppBarContent](Tizen.UI.Components.Material.IAppBarContent.md 'Tizen.UI.Components.Material.IAppBarContent') | Interface for AppBar content. It notify when an object is attached or detached. | +| [IPageIndicator](Tizen.UI.Components.Material.IPageIndicator.md 'Tizen.UI.Components.Material.IPageIndicator') | A Page indicator interface. | +| [IPager](Tizen.UI.Components.Material.IPager.md 'Tizen.UI.Components.Material.IPager') | A Pager interface. | + +| Enums | | +| :--- | :--- | +| [DividerDirection](Tizen.UI.Components.Material.DividerDirection.md 'Tizen.UI.Components.Material.DividerDirection') | Represents the direction of the divider. | +| [DividerStyle](Tizen.UI.Components.Material.DividerStyle.md 'Tizen.UI.Components.Material.DividerStyle') | Represents the style of the divider. | +| [DynamicType](Tizen.UI.Components.Material.DynamicType.md 'Tizen.UI.Components.Material.DynamicType') | Vector Property | +| [SmartTipArrowPosition](Tizen.UI.Components.Material.SmartTipArrowPosition.md 'Tizen.UI.Components.Material.SmartTipArrowPosition') | Describes the arrow position of SmartTip | +| [SnackBarAction](Tizen.UI.Components.Material.SnackBarAction.md 'Tizen.UI.Components.Material.SnackBarAction') | SnackBarAction is used to define the action of snackbar. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedImageVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedImageVisualMap.md new file mode 100644 index 0000000000..70340a9d92 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedImageVisualMap.md @@ -0,0 +1,160 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## AnimatedImageVisualMap Class + +AnimatedImageVisualMap is a class that represents a property map for the animated image visual. + +```csharp +public class AnimatedImageVisualMap : Tizen.UI.Internal.ImageVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Internal.ImageVisualMap 🡒 AnimatedImageVisualMap +### Properties + + + +## AnimatedImageVisualMap.CacheSize Property + +Defines the cache size for loading images in the sequential image animation. +number of images to keep cached ahead during playback. + +```csharp +public int CacheSize { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +cacheSize should be >= batchSize. If it isn't, then the cache will automatically be changed to batchSize. +because of the defaults, it is expected that the application developer tune the batch and cache sizes to their particular use case. + + + +## AnimatedImageVisualMap.FrameSpeedFactor Property + +Specifies a speed factor for the animated image frame. + +```csharp +public float FrameSpeedFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The speed factor is a multiplier of the normal velocity of the animation. Values between [0,1] will +slow down the animation and values above one will speed up the animation. +The range of this value is clamped between [0.01f ~ 100.0f]. + + + +## AnimatedImageVisualMap.PreloadingBatchSize Property + +Defines the batch size for pre-loading images in the sequential image animation. +number of images to pre-load before starting to play. + +```csharp +public int PreloadingBatchSize { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## AnimatedImageVisualMap.RepeatCount Property + +Gets or sets whether the animation should loop. + +```csharp +public int RepeatCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## AnimatedImageVisualMap.RepeatMode Property + +Gets or sets the mode of animation repetition. + +```csharp +public Tizen.UI.AnimationRepeatMode RepeatMode { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationRepeatMode + + + +## AnimatedImageVisualMap.StopBehavior Property + +Gets or sets the behavior of the animation when it stops. + +```csharp +public Tizen.UI.AnimationStopBehavior StopBehavior { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationStopBehavior + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedLayout.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedLayout.md new file mode 100644 index 0000000000..0e0d53983e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedLayout.md @@ -0,0 +1,112 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## AnimatedLayout Class + +Provides animated layout functionalities + +```csharp +public static class AnimatedLayout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AnimatedLayout +### Methods + + + +## AnimatedLayout.ApplyAnimation<T>(this T, int, AlphaFunction) Method + +Applies an animation to child position and size changes when the layout is updated. + +```csharp +public static T ApplyAnimation<T>(this T layout, int duration=150, Tizen.UI.AlphaFunction alphaFunction=null) + where T : Tizen.UI.Layouts.Layout; +``` +#### Type parameters + + + +`T` + +The type of the layout. +#### Parameters + + + +`layout` [T](Tizen.UI.Components.AnimatedLayout.md#Tizen.UI.Components.AnimatedLayout.ApplyAnimation_T_(thisT,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Components.AnimatedLayout.ApplyAnimation<T>(this T, int, Tizen.UI.AlphaFunction).T') + +The layout to animate. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation in milliseconds. + + + +`alphaFunction` Tizen.UI.AlphaFunction + +The alpha function applied to the animation. Can be null. + +#### Returns +[T](Tizen.UI.Components.AnimatedLayout.md#Tizen.UI.Components.AnimatedLayout.ApplyAnimation_T_(thisT,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Components.AnimatedLayout.ApplyAnimation<T>(this T, int, Tizen.UI.AlphaFunction).T') +The layout with animation applied. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.AnimationExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.AnimationExtensions.md new file mode 100644 index 0000000000..5a62d51b06 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.AnimationExtensions.md @@ -0,0 +1,471 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## AnimationExtensions Class + +Provides extension methods for UIAnimation + +```csharp +public static class AnimationExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AnimationExtensions +### Methods + + + +## AnimationExtensions.AbortAnimation(this View, string) Method + +Aborts the animation with the specified handle. + +```csharp +public static bool AbortAnimation(this Tizen.UI.View self, string handle); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to abort the animation on. + + + +`handle` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The handle of the animation to abort. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animation was aborted, false otherwise. + + + +## AnimationExtensions.Animate(this View, string, Action<float>, float, float, uint, uint, Easing, Action<float,bool>, Func<bool>) Method + +Animates a property of the view using the specified callback. + +```csharp +public static void Animate(this Tizen.UI.View self, string name, System.Action<float> callback, float start, float end, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<float,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to animate. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the animation. + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the animation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the animation. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## AnimationExtensions.Animate(this View, string, Action<float>, uint, uint, Easing, Action<float,bool>, Func<bool>) Method + +Animates a property of the view using the specified callback. + +```csharp +public static void Animate(this Tizen.UI.View self, string name, System.Action<float> callback, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<float,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to animate. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the animation. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## AnimationExtensions.Animate(this View, string, UIAnimation, uint, uint, Easing, Action<float,bool>, Func<bool>) Method + +Animates a property of the view using the specified animation. + +```csharp +public static void Animate(this Tizen.UI.View self, string name, Tizen.UI.Components.Animations.UIAnimation animation, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<float,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to animate. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The animation to use. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## AnimationExtensions.Animate<T>(this View, string, Func<float,T>, Action<T>, uint, uint, Easing, Action<T,bool>, Func<bool>) Method + +Animates a property of the view using the specified transform and callback. + +```csharp +public static void Animate<T>(this Tizen.UI.View self, string name, System.Func<float,T> transform, System.Action<T> callback, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<T,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Type parameters + + + +`T` + +The type of the property to animate. +#### Parameters + + + +`self` Tizen.UI.View + +The view to animate. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`transform` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[T](Tizen.UI.Components.Animations.AnimationExtensions.md#Tizen.UI.Components.Animations.AnimationExtensions.Animate_T_(thisTizen.UI.View,string,System.Func_float,T_,System.Action_T_,uint,uint,Tizen.UI.Components.Animations.Easing,System.Action_T,bool_,System.Func_bool_).T 'Tizen.UI.Components.Animations.AnimationExtensions.Animate<T>(this Tizen.UI.View, string, System.Func<float,T>, System.Action<T>, uint, uint, Tizen.UI.Components.Animations.Easing, System.Action<T,bool>, System.Func<bool>).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The transform function to apply during the animation. + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[T](Tizen.UI.Components.Animations.AnimationExtensions.md#Tizen.UI.Components.Animations.AnimationExtensions.Animate_T_(thisTizen.UI.View,string,System.Func_float,T_,System.Action_T_,uint,uint,Tizen.UI.Components.Animations.Easing,System.Action_T,bool_,System.Func_bool_).T 'Tizen.UI.Components.Animations.AnimationExtensions.Animate<T>(this Tizen.UI.View, string, System.Func<float,T>, System.Action<T>, uint, uint, Tizen.UI.Components.Animations.Easing, System.Action<T,bool>, System.Func<bool>).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the animation. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.Components.Animations.AnimationExtensions.md#Tizen.UI.Components.Animations.AnimationExtensions.Animate_T_(thisTizen.UI.View,string,System.Func_float,T_,System.Action_T_,uint,uint,Tizen.UI.Components.Animations.Easing,System.Action_T,bool_,System.Func_bool_).T 'Tizen.UI.Components.Animations.AnimationExtensions.Animate<T>(this Tizen.UI.View, string, System.Func<float,T>, System.Action<T>, uint, uint, Tizen.UI.Components.Animations.Easing, System.Action<T,bool>, System.Func<bool>).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## AnimationExtensions.AnimateKinetic(this View, string, Func<float,float,bool>, float, float, Action) Method + +Animates a property of the view using a kinetic motion. + +```csharp +public static void AnimateKinetic(this Tizen.UI.View self, string name, System.Func<float,float,bool> callback, float velocity, float drag, System.Action finished=null); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to animate. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`callback` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +The callback to invoke during the kinetic motion. + + + +`velocity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The initial velocity of the kinetic motion. + + + +`drag` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The drag coefficient of the kinetic motion. + + + +`finished` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The callback to invoke when the kinetic motion is finished. + + + +## AnimationExtensions.AnimationIsRunning(this View, string) Method + +Determines if an animation with the specified handle is running. + +```csharp +public static bool AnimationIsRunning(this Tizen.UI.View self, string handle); +``` +#### Parameters + + + +`self` Tizen.UI.View + +The view to check for running animations on. + + + +`handle` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The handle of the animation to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animation is running, false otherwise. + + + +## AnimationExtensions.Interpolate(float, float, float, bool) Method + +Interpolates between two values. + +```csharp +public static System.Func<float,float> Interpolate(float start, float end=1f, float reverseVal=0f, bool reverse=false); +``` +#### Parameters + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the interpolation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the interpolation. Defaults to 1.0f. + + + +`reverseVal` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to use when reversing the interpolation. + + + +`reverse` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, the interpolation will go from the end value to the start value. + +#### Returns +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') +A function that interpolates between two values based on a given progress value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Bezier.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Bezier.md new file mode 100644 index 0000000000..348be6a8c6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Bezier.md @@ -0,0 +1,93 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## Bezier Class + +Represents a cubic Bezier easing function. + +```csharp +public class Bezier : Tizen.UI.Components.Animations.Easing +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') 🡒 Bezier +### Constructors + + + +## Bezier(Point, Point) Constructor + +Initializes a new instance of the Bezier class with the specified control points. + +```csharp +public Bezier(Tizen.UI.Point p1, Tizen.UI.Point p2); +``` +#### Parameters + + + +`p1` Tizen.UI.View.VisibilityChanged + +The first control point. + + + +`p2` Tizen.UI.Point + +The second control point. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Easing.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Easing.md new file mode 100644 index 0000000000..1b618f8579 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Easing.md @@ -0,0 +1,304 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## Easing Class + +Represents an easing function used for animations. + +```csharp +public class Easing +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Easing + +Derived +↳ [Bezier](Tizen.UI.Components.Animations.Bezier.md 'Tizen.UI.Components.Animations.Bezier') +### Constructors + + + +## Easing(Func<float,float>) Constructor + +Initializes a new instance of the Easing class with the specified easing function. + +```csharp +public Easing(System.Func<float,float> easingFunc); +``` +#### Parameters + + + +`easingFunc` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The easing function to use. +### Fields + + + +## Easing.Bounce Field + +Represents an easing function that creates a bouncing effect. + +```csharp +public static readonly Easing Bounce; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseIn Field + +Represents an easing function that eases in using a cubic curve. + +```csharp +public static readonly Easing EaseIn; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseInOut Field + +Represents an easing function that eases in and out using a cubic curve. + +```csharp +public static readonly Easing EaseInOut; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseInOutSine Field + +Represents an easing function that eases in and out using a sine curve. + +```csharp +public static readonly Easing EaseInOutSine; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseInSine Field + +Represents an easing function that eases in using a sine curve. + +```csharp +public static readonly Easing EaseInSine; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseInSquare Field + +Represents an easing function that eases in using a square curve. + +```csharp +public static readonly Easing EaseInSquare; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseOut Field + +Represents an easing function that eases out using a cubic curve. + +```csharp +public static readonly Easing EaseOut; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseOutBack Field + +Represents an easing function that eases out using a back curve. + +```csharp +public static readonly Easing EaseOutBack; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseOutSine Field + +Represents an easing function that eases out using a sine curve. + +```csharp +public static readonly Easing EaseOutSine; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.EaseOutSquare Field + +Represents an easing function that eases out using a square curve. + +```csharp +public static readonly Easing EaseOutSquare; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.Linear Field + +Represents a linear easing function. + +```csharp +public static readonly Easing Linear; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.LinearReverse Field + +Represents a linear easing function that reverses the progress. + +```csharp +public static readonly Easing LinearReverse; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + + + +## Easing.Sin Field + +Represents an easing function that creates a sinusoidal motion. + +```csharp +public static readonly Easing Sin; +``` + +#### Field Value +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') +### Methods + + + +## Easing.Ease(float) Method + +Applies the easing function to the specified value. + +```csharp +public float Ease(float v); +``` +#### Parameters + + + +`v` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to apply the easing function to. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The result of applying the easing function to the specified value. +### Operators + + + +## Easing.implicit operator Easing(Func<float,float>) Operator + +Implicitly converts a Func{float, float} to an Easing object. + +```csharp +public static Tizen.UI.Components.Animations.Easing implicit operator Easing(System.Func<float,float> func); +``` +#### Parameters + + + +`func` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The Func{float, float} to convert. + +#### Returns +[Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') +The resulting Easing object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationExtensions.md new file mode 100644 index 0000000000..cdda8d8e98 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationExtensions.md @@ -0,0 +1,2179 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## TypedAnimationExtensions Class + +Provides extension methods for typed animation. + +```csharp +public static class TypedAnimationExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TypedAnimationExtensions +### Methods + + + +## TypedAnimationExtensions.Animate<T>(this Animation, T) Method + +Prepare to animate a given target view. This returns a bridge providing various animatable properties for the target view. + +```csharp +public static Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> Animate<T>(this Tizen.UI.Animation animation, T targetView) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the target view. +#### Parameters + + + +`animation` Tizen.UI.Animation + +The animation. + + + +`targetView` [T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.Animate_T_(thisTizen.UI.Animation,T).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.Animate<T>(this Tizen.UI.Animation, T).T') + +The target view to be animated. + +#### Returns +[Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.Animate_T_(thisTizen.UI.Animation,T).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.Animate<T>(this Tizen.UI.Animation, T).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') +The bridge providing various animatable properties for the target view. + + + +## TypedAnimationExtensions.BackgroundColorBy<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate background color by relative mount. + +```csharp +public static Tizen.UI.Animation BackgroundColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BackgroundColorBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BackgroundColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Color + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BackgroundColorTo<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate background color to destination value. + +```csharp +public static Tizen.UI.Animation BackgroundColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BackgroundColorTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BackgroundColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Color + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowBlurRadiusBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate box shadow's blur radius by relative mount. + +```csharp +public static Tizen.UI.Animation BoxShadowBlurRadiusBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowBlurRadiusBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowBlurRadiusBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowBlurRadiusTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate box shadow's blur radius to destination value. + +```csharp +public static Tizen.UI.Animation BoxShadowBlurRadiusTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowBlurRadiusTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowBlurRadiusTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowOffsetBy<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate box shadow's offset by relative mount. + +```csharp +public static Tizen.UI.Animation BoxShadowOffsetBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float x, float y, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOffsetBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOffsetBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative x value. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative y value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowOffsetTo<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate box shadow's offset to destination value. + +```csharp +public static Tizen.UI.Animation BoxShadowOffsetTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float x, float y, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOffsetTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOffsetTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination x value. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination y value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowOpacityBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate box shadow's opacity by relative mount. + +```csharp +public static Tizen.UI.Animation BoxShadowOpacityBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOpacityBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOpacityBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.BoxShadowOpacityTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate box shadow's opacity to destination value. + +```csharp +public static Tizen.UI.Animation BoxShadowOpacityTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOpacityTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.BoxShadowOpacityTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ColorBy<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate color by relative mount. + +```csharp +public static Tizen.UI.Animation ColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ColorBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Color + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ColorTo<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate color to destination value. + +```csharp +public static Tizen.UI.Animation ColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ColorTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Color + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.CornerRadiusBy<T>(this TypedAnimationTargetBridge<T>, CornerRadius, int, AlphaFunction, int) Method + +Animate corner radius by relative mount. + +```csharp +public static Tizen.UI.Animation CornerRadiusBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.CornerRadius relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerRadiusBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.CornerRadius,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerRadiusBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.CornerRadius, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.CornerRadius + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.CornerRadiusTo<T>(this TypedAnimationTargetBridge<T>, CornerRadius, int, AlphaFunction, int) Method + +Animate corner radius to destination value. + +```csharp +public static Tizen.UI.Animation CornerRadiusTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.CornerRadius destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerRadiusTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.CornerRadius,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerRadiusTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.CornerRadius, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.CornerRadius + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.CornerSquarenessBy<T>(this TypedAnimationTargetBridge<T>, CornerRadius, int, AlphaFunction, int) Method + +Animate corner squareness by relative mount. + +```csharp +public static Tizen.UI.Animation CornerSquarenessBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.CornerRadius relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerSquarenessBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.CornerRadius,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerSquarenessBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.CornerRadius, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.CornerRadius + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.CornerSquarenessTo<T>(this TypedAnimationTargetBridge<T>, CornerRadius, int, AlphaFunction, int) Method + +Animate corner squareness to destination value. + +```csharp +public static Tizen.UI.Animation CornerSquarenessTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.CornerRadius destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerSquarenessTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.CornerRadius,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.CornerSquarenessTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.CornerRadius, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.CornerRadius + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.HeightBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate size-height by relative mount. + +```csharp +public static Tizen.UI.Animation HeightBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.HeightBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.HeightBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.HeightTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate size-height to destination value. + +```csharp +public static Tizen.UI.Animation HeightTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.HeightTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.HeightTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.OpacityBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate opacity by relative mount. + +```csharp +public static Tizen.UI.Animation OpacityBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.OpacityBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.OpacityBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.OpacityTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate opacity to destination value. + +```csharp +public static Tizen.UI.Animation OpacityTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.OpacityTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.OpacityTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionBy<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate position-x by relative mount. + +```csharp +public static Tizen.UI.Animation PositionBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeX, float relativeY, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative X value. + + + +`relativeY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative Y value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionBy<T>(this TypedAnimationTargetBridge<T>, Point, int, AlphaFunction, int) Method + +Animate position-x by relative mount. + +```csharp +public static Tizen.UI.Animation PositionBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Point relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Point,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Point, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Point + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionTo<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate position to destination value. + +```csharp +public static Tizen.UI.Animation PositionTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationX, float destinationY, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination X value. + + + +`destinationY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination X value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionTo<T>(this TypedAnimationTargetBridge<T>, Point, int, AlphaFunction, int) Method + +Animate position to destination value. + +```csharp +public static Tizen.UI.Animation PositionTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Point destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Point,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Point, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Point + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionXBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate position-x by relative mount. + +```csharp +public static Tizen.UI.Animation PositionXBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionXBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionXBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionXTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate position-x to destination value. + +```csharp +public static Tizen.UI.Animation PositionXTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionXTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionXTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionYBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate position-y by relative mount. + +```csharp +public static Tizen.UI.Animation PositionYBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionYBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionYBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.PositionYTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate position-y to destination value. + +```csharp +public static Tizen.UI.Animation PositionYTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionYTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.PositionYTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleBy<T>(this TypedAnimationTargetBridge<T>, Size, int, AlphaFunction, int) Method + +Animate scale by relative mount. + +```csharp +public static Tizen.UI.Animation ScaleBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Size relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Size,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Size, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Size + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleTo<T>(this TypedAnimationTargetBridge<T>, Size, int, AlphaFunction, int) Method + +Animate scale to destination value. + +```csharp +public static Tizen.UI.Animation ScaleTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Size destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Size,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Size, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Size + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleXBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate scale-x by relative mount. + +```csharp +public static Tizen.UI.Animation ScaleXBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleXBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleXBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleXTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate scale-x to destination value. + +```csharp +public static Tizen.UI.Animation ScaleXTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleXTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleXTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleYBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate scale-y by relative mount. + +```csharp +public static Tizen.UI.Animation ScaleYBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleYBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleYBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.ScaleYTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate scale-y to destination value. + +```csharp +public static Tizen.UI.Animation ScaleYTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleYTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.ScaleYTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.SizeBy<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate size-width by relative mount. + +```csharp +public static Tizen.UI.Animation SizeBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeX, float relativeY, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative X value. + + + +`relativeY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative Y value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.SizeBy<T>(this TypedAnimationTargetBridge<T>, Size, int, AlphaFunction, int) Method + +Animate size-width by relative mount. + +```csharp +public static Tizen.UI.Animation SizeBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Size relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Size,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Size, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Size + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.SizeTo<T>(this TypedAnimationTargetBridge<T>, float, float, int, AlphaFunction, int) Method + +Animate size-width to destination value. + +```csharp +public static Tizen.UI.Animation SizeTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationX, float destinationY, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination X value. + + + +`destinationY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination Y value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.SizeTo<T>(this TypedAnimationTargetBridge<T>, Size, int, AlphaFunction, int) Method + +Animate size-width to destination value. + +```csharp +public static Tizen.UI.Animation SizeTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Size destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Size,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.SizeTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Size, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Size + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.TextColorBy<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate text color by relative mount. + +```csharp +public static Tizen.UI.Animation TextColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View, Tizen.UI.IText; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.TextColorBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.TextColorBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` Tizen.UI.Color + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.TextColorTo<T>(this TypedAnimationTargetBridge<T>, Color, int, AlphaFunction, int) Method + +Animate text color to destination value. + +```csharp +public static Tizen.UI.Animation TextColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, Tizen.UI.Color destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View, Tizen.UI.IText; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.TextColorTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,Tizen.UI.Color,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.TextColorTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, Tizen.UI.Color, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` Tizen.UI.Color + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.WidthBy<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate size-width by relative mount. + +```csharp +public static Tizen.UI.Animation WidthBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float relativeValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.WidthBy_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.WidthBy<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`relativeValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + +## TypedAnimationExtensions.WidthTo<T>(this TypedAnimationTargetBridge<T>, float, int, AlphaFunction, int) Method + +Animate size-width to destination value. + +```csharp +public static Tizen.UI.Animation WidthTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T> target, float destinationValue, int duration, Tizen.UI.AlphaFunction alpha=null, int delay=0) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`target` [Tizen.UI.Components.Animations.TypedAnimationTargetBridge<](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>')[T](Tizen.UI.Components.Animations.TypedAnimationExtensions.md#Tizen.UI.Components.Animations.TypedAnimationExtensions.WidthTo_T_(thisTizen.UI.Components.Animations.TypedAnimationTargetBridge_T_,float,int,Tizen.UI.AlphaFunction,int).T 'Tizen.UI.Components.Animations.TypedAnimationExtensions.WidthTo<T>(this Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>, float, int, Tizen.UI.AlphaFunction, int).T')[>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') + +The extension target. + + + +`destinationValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The destination value. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation duration in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function for the animation. + + + +`delay` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The animation delay in milliseconds. + +#### Returns +Tizen.UI.Animation +The typed animation instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md new file mode 100644 index 0000000000..29b28f78c8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md @@ -0,0 +1,130 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## TypedAnimationTargetBridge<T> Struct + +A bridge between a typed animation and extensions. +It provides animation instance and target view to extension method. + +```csharp +public readonly struct TypedAnimationTargetBridge<T> + where T : Tizen.UI.View +``` +#### Type parameters + + + +`T` +### Properties + + + +## TypedAnimationTargetBridge<T>.TargetView Property + +The target view of the animation. + +```csharp +public T TargetView { get; set; } +``` + +#### Property Value +[T](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md#Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.T 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>.T') + +## TypedAnimationTargetBridge<T> Struct + +A bridge between a typed animation and extensions. +It provides animation instance and target view to extension method. + +```csharp +public readonly struct TypedAnimationTargetBridge<T> + where T : Tizen.UI.View +``` +#### Type parameters + + + +`T` +### Properties + + + +## TypedAnimationTargetBridge<T>.TargetView Property + +The target view of the animation. + +```csharp +public T TargetView { get; set; } +``` + +#### Property Value +[T](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md#Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.T 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>.T') + + + +## TypedAnimationTargetBridge<T>.TypedAnimation Property + +The typed animation instance. + +```csharp +public Tizen.UI.Animation TypedAnimation { get; set; } +``` + +#### Property Value +Tizen.UI.Animation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.UIAnimation.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.UIAnimation.md new file mode 100644 index 0000000000..c1de579d26 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.UIAnimation.md @@ -0,0 +1,376 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## UIAnimation Class + +Represents an animation that can be composed of multiple sub-animations. + +```csharp +public class UIAnimation : +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIAnimation + +Implements [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## UIAnimation() Constructor + +Initializes a new instance of the UIAnimation class. + +```csharp +public UIAnimation(); +``` + + + +## UIAnimation(Action<float>, float, float, Easing, Action) Constructor + +Initializes a new instance of the UIAnimation class with the specified callback and range. + +```csharp +public UIAnimation(System.Action<float> callback, float start=0f, float end=1f, Tizen.UI.Components.Animations.Easing easing=null, System.Action finished=null); +``` +#### Parameters + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the animation. + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the animation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the animation. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The callback to invoke when the animation is finished. +### Methods + + + +## UIAnimation.Abort(View, string) Method + +Aborts the UIAnimation of the specified view with the specified parameters. + +```csharp +public void Abort(Tizen.UI.View owner, string name); +``` +#### Parameters + + + +`owner` Tizen.UI.View + +The view to abort the animation. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the animated property. + + + +## UIAnimation.Add(float, float, UIAnimation) Method + +Adds a sub-animation to the UIAnimation with the specified range. + +```csharp +public void Add(float beginAt, float finishAt, Tizen.UI.Components.Animations.UIAnimation animation); +``` +#### Parameters + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to add. + + + +## UIAnimation.Commit(View, string, uint, uint, Easing, Action<float,bool>, Func<bool>) Method + +Commits the UIAnimation to the specified view with the specified parameters. + +```csharp +public void Commit(Tizen.UI.View owner, string name, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<float,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Parameters + + + +`owner` Tizen.UI.View + +The view to commit the animation to. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## UIAnimation.GetCallback() Method + +Gets the callback for the UIAnimation. + +```csharp +public System.Action<float> GetCallback(); +``` + +#### Returns +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') +The callback for the UIAnimation. + + + +## UIAnimation.GetEnumerator() Method + +Returns an enumerator that iterates through the sub-animations of the UIAnimation. + +```csharp +public System.Collections.IEnumerator GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.IEnumerator](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerator 'System.Collections.IEnumerator') +The enumerator that iterates through the sub-animations. + + + +## UIAnimation.Insert(float, float, UIAnimation) Method + +Inserts a sub-animation into the UIAnimation with the specified range. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation Insert(float beginAt, float finishAt, Tizen.UI.Components.Animations.UIAnimation animation); +``` +#### Parameters + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to insert. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + +## UIAnimation.WithConcurrent(Action<float>, float, float, Easing, float, float) Method + +Adds a concurrent sub-animation to the UIAnimation with the specified parameters. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation WithConcurrent(System.Action<float> callback, float start=0f, float end=1f, Tizen.UI.Components.Animations.Easing easing=null, float beginAt=0f, float finishAt=1f); +``` +#### Parameters + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the sub-animation. + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the sub-animation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the sub-animation. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the sub-animation. + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + +## UIAnimation.WithConcurrent(UIAnimation, float, float) Method + +Adds a concurrent sub-animation to the UIAnimation with the specified range. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation WithConcurrent(Tizen.UI.Components.Animations.UIAnimation animation, float beginAt=0f, float finishAt=1f); +``` +#### Parameters + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to add. + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.md new file mode 100644 index 0000000000..4f7b96c314 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.md @@ -0,0 +1,73 @@ + +## Tizen.UI.Components.Animations Namespace + +| Classes | | +| :--- | :--- | +| [AnimationExtensions](Tizen.UI.Components.Animations.AnimationExtensions.md 'Tizen.UI.Components.Animations.AnimationExtensions') | Provides extension methods for UIAnimation | +| [Bezier](Tizen.UI.Components.Animations.Bezier.md 'Tizen.UI.Components.Animations.Bezier') | Represents a cubic Bezier easing function. | +| [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') | Represents an easing function used for animations. | +| [TypedAnimationExtensions](Tizen.UI.Components.Animations.TypedAnimationExtensions.md 'Tizen.UI.Components.Animations.TypedAnimationExtensions') | Provides extension methods for typed animation. | +| [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') | Represents an animation that can be composed of multiple sub-animations. | + +| Structs | | +| :--- | :--- | +| [TypedAnimationTargetBridge<T>](Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md 'Tizen.UI.Components.Animations.TypedAnimationTargetBridge<T>') | A bridge between a typed animation and extensions.
It provides animation instance and target view to extension method. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickKeyType.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickKeyType.md new file mode 100644 index 0000000000..1d6115e0f6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickKeyType.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClickKeyType Enum + +The type of click key. + +```csharp +public enum ClickKeyType +``` +### Fields + + + +`None` 0 + +Key input does not affect the click. + + + +`Press` 1 + +The key press down triggers the click. + + + +`Release` 2 + +The key release triggers the click. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Clickable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Clickable.md new file mode 100644 index 0000000000..50fbb73079 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Clickable.md @@ -0,0 +1,377 @@ +### [Tizen.UI.Components.Animations](Tizen.UI.Components.Animations.md 'Tizen.UI.Components.Animations') + +## UIAnimation Class + +Represents an animation that can be composed of multiple sub-animations. + +```csharp +public class UIAnimation : +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIAnimation + +Implements [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## UIAnimation() Constructor + +Initializes a new instance of the UIAnimation class. + +```csharp +public UIAnimation(); +``` + + + +## UIAnimation(Action<float>, float, float, Easing, Action) Constructor + +Initializes a new instance of the UIAnimation class with the specified callback and range. + +```csharp +public UIAnimation(System.Action<float> callback, float start=0f, float end=1f, Tizen.UI.Components.Animations.Easing easing=null, System.Action finished=null); +``` +#### Parameters + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the animation. + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the animation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the animation. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The callback to invoke when the animation is finished. +### Methods + + + +## UIAnimation.Abort(View, string) Method + +Aborts the UIAnimation of the specified view with the specified parameters. + +```csharp +public void Abort(Tizen.UI.View owner, string name); +``` +#### Parameters + + + +`owner` Tizen.UI.View + +The view to abort the animation. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the animated property. + + + +## UIAnimation.Add(float, float, UIAnimation) Method + +Adds a sub-animation to the UIAnimation with the specified range. + +```csharp +public void Add(float beginAt, float finishAt, Tizen.UI.Components.Animations.UIAnimation animation); +``` +#### Parameters + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to add. + + + +## UIAnimation.Commit(View, string, uint, uint, Easing, Action<float,bool>, Func<bool>) Method + +Commits the UIAnimation to the specified view with the specified parameters. + +```csharp +public void Commit(Tizen.UI.View owner, string name, uint rate=16u, uint length=250u, Tizen.UI.Components.Animations.Easing easing=null, System.Action<float,bool> finished=null, System.Func<bool> repeat=null); +``` +#### Parameters + + + +`owner` Tizen.UI.View + +The view to commit the animation to. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property to animate. + + + +`rate` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The rate of the animation in milliseconds. + + + +`length` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The length of the animation in milliseconds. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the animation. + + + +`finished` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The callback to invoke when the animation is finished. + + + +`repeat` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The callback to invoke to determine if the animation should repeat. + + + +## UIAnimation.GetCallback() Method + +Gets the callback for the UIAnimation. + +```csharp +public System.Action<float> GetCallback(); +``` + +#### Returns +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') +The callback for the UIAnimation. + + + +## UIAnimation.GetEnumerator() Method + +Returns an enumerator that iterates through the sub-animations of the UIAnimation. + +```csharp +public System.Collections.IEnumerator GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.IEnumerator](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerator 'System.Collections.IEnumerator') +The enumerator that iterates through the sub-animations. + + + +## UIAnimation.Insert(float, float, UIAnimation) Method + +Inserts a sub-animation into the UIAnimation with the specified range. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation Insert(float beginAt, float finishAt, Tizen.UI.Components.Animations.UIAnimation animation); +``` +#### Parameters + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to insert. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + +## UIAnimation.WithConcurrent(Action<float>, float, float, Easing, float, float) Method + +Adds a concurrent sub-animation to the UIAnimation with the specified parameters. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation WithConcurrent(System.Action<float> callback, float start=0f, float end=1f, Tizen.UI.Components.Animations.Easing easing=null, float beginAt=0f, float finishAt=1f); +``` +#### Parameters + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback to invoke during the sub-animation. + + + +`start` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The start value of the sub-animation. + + + +`end` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The end value of the sub-animation. + + + +`easing` [Easing](Tizen.UI.Components.Animations.Easing.md 'Tizen.UI.Components.Animations.Easing') + +The easing function to use for the sub-animation. + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + +## UIAnimation.WithConcurrent(UIAnimation, float, float) Method + +Adds a concurrent sub-animation to the UIAnimation with the specified range. + +```csharp +public Tizen.UI.Components.Animations.UIAnimation WithConcurrent(Tizen.UI.Components.Animations.UIAnimation animation, float beginAt=0f, float finishAt=1f); +``` +#### Parameters + + + +`animation` [UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') + +The sub-animation to add. + + + +`beginAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The beginning progress value of the sub-animation. + + + +`finishAt` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The ending progress value of the sub-animation. + +#### Returns +[UIAnimation](Tizen.UI.Components.Animations.UIAnimation.md 'Tizen.UI.Components.Animations.UIAnimation') +The UIAnimation object for method chaining. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableBox.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableBox.md new file mode 100644 index 0000000000..f2d1ac350f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableBox.md @@ -0,0 +1,313 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClickableBox Class + +Clickable component with . +It provides [Clicked](Tizen.UI.Components.Clickable.md#Tizen.UI.Components.Clickable.Clicked 'Tizen.UI.Components.Clickable.Clicked') event. + +```csharp +public abstract class ClickableBox : Tizen.UI.Components.Clickable, +Tizen.UI.Components.ILayoutBox, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 ClickableBox + +Derived +↳ [ClickableGrid](Tizen.UI.Components.ClickableGrid.md 'Tizen.UI.Components.ClickableGrid') +↳ [ClickableHStack](Tizen.UI.Components.ClickableHStack.md 'Tizen.UI.Components.ClickableHStack') +↳ [ClickableVStack](Tizen.UI.Components.ClickableVStack.md 'Tizen.UI.Components.ClickableVStack') + +Implements [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## ClickableBox.Children Property + +Children of the layout box. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +Implements [Children](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Children 'Tizen.UI.Components.ILayoutBox.Children') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ClickableBox.Count Property + +Gets the number of elements contained in the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ClickableBox.IsReadOnly Property + +Gets a value indicating whether the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ClickableBox.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public abstract Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## ClickableBox.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +Tizen.UI.View +### Methods + + + +## ClickableBox.Clear() Method + +Clears all children. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## ClickableBox.Contains(View) Method + +Whether it contains the specified child. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ClickableBox.CopyTo(View[], int) Method + +Copies the children to an array. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` Tizen.UI.View[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ClickableBox.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## ClickableBox.Insert(int, View) Method + +(Not implemented) Inserts the specified content at the specified index. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`item` Tizen.UI.View + + + +## ClickableBox.RemoveAt(int) Method + +Removes the content at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## ClickableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Add(View) Method + +Adds a child view. + +```csharp +void System.Collections.Generic.ICollection<Tizen.UI.View>.Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Add(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## ClickableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(View) Method + +Removes the specified content from the layout box. + +```csharp +bool System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Remove(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## ClickableBox.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableGrid.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableGrid.md new file mode 100644 index 0000000000..fbf88e43a0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableGrid.md @@ -0,0 +1,149 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClickableGrid Class + +Clickable view with grid layout. + +```csharp +public class ClickableGrid : Tizen.UI.Components.ClickableBox +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [ClickableBox](Tizen.UI.Components.ClickableBox.md 'Tizen.UI.Components.ClickableBox') 🡒 ClickableGrid +### Constructors + + + +## ClickableGrid() Constructor + +Constructs a new instance of a ClickableGrid. + +```csharp +public ClickableGrid(); +``` +### Properties + + + +## ClickableGrid.ColumnDefinitions Property + +Provides the interface for the bound property that gets or sets the collection of ColumnDefinitions objects that control the heights of each column. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Layouts.GridColumnDefinition> ColumnDefinitions { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.Layouts.GridColumnDefinition[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ClickableGrid.ColumnSpacing Property + +Gets or sets the amount of space between columns in the Grid. + +```csharp +public float ColumnSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ClickableGrid.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public override Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## ClickableGrid.RowDefinitions Property + +Provides the interface for the bound property that gets or sets the collection of RowDefinition objects that control the heights of each row. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Layouts.GridRowDefinition> RowDefinitions { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.Layouts.GridRowDefinition[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ClickableGrid.RowSpacing Property + +Gets or sets the amount of space between rows in the Grid. + +```csharp +public float RowSpacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableHStack.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableHStack.md new file mode 100644 index 0000000000..3f0e51d41a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableHStack.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClickableHStack Class + +Clickable view with horizontal stacking layout. + +```csharp +public class ClickableHStack : Tizen.UI.Components.ClickableBox +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [ClickableBox](Tizen.UI.Components.ClickableBox.md 'Tizen.UI.Components.ClickableBox') 🡒 ClickableHStack +### Constructors + + + +## ClickableHStack() Constructor + +Constructs a new instance of a ClickableHStack. + +```csharp +public ClickableHStack(); +``` +### Properties + + + +## ClickableHStack.ItemAlignment Property + +Gets or sets the alignment for children + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.LayoutAlignment + + + +## ClickableHStack.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public override Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## ClickableHStack.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableVStack.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableVStack.md new file mode 100644 index 0000000000..ac9eade603 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableVStack.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClickableVStack Class + +Clickable view with vertical stacking layout. + +```csharp +public class ClickableVStack : Tizen.UI.Components.ClickableBox +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [ClickableBox](Tizen.UI.Components.ClickableBox.md 'Tizen.UI.Components.ClickableBox') 🡒 ClickableVStack +### Constructors + + + +## ClickableVStack() Constructor + +Constructs a new instance of a ClickableVStack. + +```csharp +public ClickableVStack(); +``` +### Properties + + + +## ClickableVStack.ItemAlignment Property + +Gets or sets the alignment for children + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.LayoutAlignment + + + +## ClickableVStack.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public override Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## ClickableVStack.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClosedRange_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClosedRange_T_.md new file mode 100644 index 0000000000..dbb8b9ea11 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClosedRange_T_.md @@ -0,0 +1,186 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ClosedRange<T> Struct + +A range that is inclusive of both ends. + +```csharp +public struct ClosedRange<T> + where T : System.IComparable<T> +``` +#### Type parameters + + + +`T` +### Constructors + + + +## ClosedRange(T, T) Constructor + +Construct a closed range with the given start and end values. + +```csharp +public ClosedRange(T startValue, T endValue); +``` +#### Parameters + + + +`startValue` [T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') + +The start value of the range. + + + +`endValue` [T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') + +The end value of the range. + +#### Exceptions + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when the start value is greater than or equal to the end value. +### Properties + + + +## ClosedRange<T>.EndValue Property + +The end value of the range. + +```csharp +public readonly T EndValue { get; } +``` + +#### Property Value +[T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') + + + +## ClosedRange<T>.StartValue Property + +The start value of the range. + +```csharp +public readonly T StartValue { get; } +``` + +#### Property Value +[T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') +### Methods + + + +## ClosedRange<T>.Clamp(T) Method + +Enusres it fits in the range. + +```csharp +public readonly T Clamp(T value); +``` +#### Parameters + + + +`value` [T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') + +The value to be clamped. + +#### Returns +[T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') +The clamped value. + + + +## ClosedRange<T>.Contains(T) Method + +Determine whether the given value is within this range. + +```csharp +public readonly bool Contains(T value); +``` +#### Parameters + + + +`value` [T](Tizen.UI.Components.ClosedRange_T_.md#Tizen.UI.Components.ClosedRange_T_.T 'Tizen.UI.Components.ClosedRange<T>.T') + +The value to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the value is within the range, false otherwise. + + + +## ClosedRange<T>.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DestroyUtility.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DestroyUtility.md new file mode 100644 index 0000000000..e5dabb13bb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DestroyUtility.md @@ -0,0 +1,133 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## DestroyUtility Class + +Provides extension methods for disposables. + +```csharp +public static class DestroyUtility +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DestroyUtility +### Methods + + + +## DestroyUtility.Destroy<T>(IEnumerable<T>) Method + +Dispose all items in disposable list and make reference null. + +```csharp +public static void Destroy<T>(ref System.Collections.Generic.IEnumerable<T> enumerable) + where T : class, System.IDisposable; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`enumerable` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.DestroyUtility.md#Tizen.UI.Components.DestroyUtility.Destroy_T_(System.Collections.Generic.IEnumerable_T_).T 'Tizen.UI.Components.DestroyUtility.Destroy<T>(System.Collections.Generic.IEnumerable<T>).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + +## DestroyUtility.Destroy<T>(T) Method + +Dispose a disposable and make reference null. + +```csharp +public static void Destroy<T>(ref T disposable) + where T : class, System.IDisposable; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`disposable` [T](Tizen.UI.Components.DestroyUtility.md#Tizen.UI.Components.DestroyUtility.Destroy_T_(T).T 'Tizen.UI.Components.DestroyUtility.Destroy<T>(T).T') + + + +## DestroyUtility.Destroy<T>(this IEnumerable<T>) Method + +Dispose all items in disposable list. + +```csharp +public static void Destroy<T>(this System.Collections.Generic.IEnumerable<T> enumerable) + where T : class, System.IDisposable; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`enumerable` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.DestroyUtility.md#Tizen.UI.Components.DestroyUtility.Destroy_T_(thisSystem.Collections.Generic.IEnumerable_T_).T 'Tizen.UI.Components.DestroyUtility.Destroy<T>(this System.Collections.Generic.IEnumerable<T>).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontFamilyLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontFamilyLoader.md new file mode 100644 index 0000000000..9b33845e6a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontFamilyLoader.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## DummyFontFamilyLoader Class + +Implements a dummy font family loader. + +```csharp +public class DummyFontFamilyLoader : +Tizen.UI.Components.IFontFamilyLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DummyFontFamilyLoader + +Implements [IFontFamilyLoader](Tizen.UI.Components.IFontFamilyLoader.md 'Tizen.UI.Components.IFontFamilyLoader') +### Properties + + + +## DummyFontFamilyLoader.FontFamily Property + +Gets the current font family. + +```csharp +public string FontFamily { get; set; } +``` + +Implements [FontFamily](Tizen.UI.Components.IFontFamilyLoader.md#Tizen.UI.Components.IFontFamilyLoader.FontFamily 'Tizen.UI.Components.IFontFamilyLoader.FontFamily') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DummyFontFamilyLoader.Instance Property + +Gets a singleton instance of the DummyFontFamilyLoader. + +```csharp +public static Tizen.UI.Components.DummyFontFamilyLoader Instance { get; } +``` + +#### Property Value +[DummyFontFamilyLoader](Tizen.UI.Components.DummyFontFamilyLoader.md 'Tizen.UI.Components.DummyFontFamilyLoader') +### Events + + + +## DummyFontFamilyLoader.FontFamilyChanged Event + +Occurs when the font family is changed. + +```csharp +public event EventHandler FontFamilyChanged; +``` + +Implements [FontFamilyChanged](Tizen.UI.Components.IFontFamilyLoader.md#Tizen.UI.Components.IFontFamilyLoader.FontFamilyChanged 'Tizen.UI.Components.IFontFamilyLoader.FontFamilyChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontScaleLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontScaleLoader.md new file mode 100644 index 0000000000..66c70bbe8f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontScaleLoader.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## DummyFontScaleLoader Class + +Implements a dummy font scale loader. + +```csharp +public class DummyFontScaleLoader : +Tizen.UI.Components.IFontScaleLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DummyFontScaleLoader + +Implements [IFontScaleLoader](Tizen.UI.Components.IFontScaleLoader.md 'Tizen.UI.Components.IFontScaleLoader') +### Properties + + + +## DummyFontScaleLoader.FontScale Property + +Gets the current font scale. + +```csharp +public float FontScale { get; set; } +``` + +Implements [FontScale](Tizen.UI.Components.IFontScaleLoader.md#Tizen.UI.Components.IFontScaleLoader.FontScale 'Tizen.UI.Components.IFontScaleLoader.FontScale') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DummyFontScaleLoader.Instance Property + +Gets a singleton instance of the DummyFontScaleLoader. + +```csharp +public static Tizen.UI.Components.DummyFontScaleLoader Instance { get; } +``` + +#### Property Value +[DummyFontScaleLoader](Tizen.UI.Components.DummyFontScaleLoader.md 'Tizen.UI.Components.DummyFontScaleLoader') +### Events + + + +## DummyFontScaleLoader.FontScaleChanged Event + +Occurs when the font scale is changed. + +```csharp +public event EventHandler FontScaleChanged; +``` + +Implements [FontScaleChanged](Tizen.UI.Components.IFontScaleLoader.md#Tizen.UI.Components.IFontScaleLoader.FontScaleChanged 'Tizen.UI.Components.IFontScaleLoader.FontScaleChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyThemeLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyThemeLoader.md new file mode 100644 index 0000000000..a5638304aa --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyThemeLoader.md @@ -0,0 +1,199 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## DummyThemeLoader Class + +Implements a dummy font scale loader. + +```csharp +public class DummyThemeLoader : +Tizen.UI.Components.IThemeLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DummyThemeLoader + +Implements [IThemeLoader](Tizen.UI.Components.IThemeLoader.md 'Tizen.UI.Components.IThemeLoader') +### Constructors + + + +## DummyThemeLoader(string[]) Constructor + +Creates a new instance of DummyThemeLoader with the specified theme resource directories. + +```csharp +public DummyThemeLoader(params string[] themeResourceDirectories); +``` +#### Parameters + + + +`themeResourceDirectories` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +### Properties + + + +## DummyThemeLoader.CurrentResourcePath Property + +Gets the current resource path. + +```csharp +public string CurrentResourcePath { get; set; } +``` + +Implements [CurrentResourcePath](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.CurrentResourcePath 'Tizen.UI.Components.IThemeLoader.CurrentResourcePath') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DummyThemeLoader.CurrentThemeId Property + +Gets the current theme id. + +```csharp +public string CurrentThemeId { get; } +``` + +Implements [CurrentThemeId](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.CurrentThemeId 'Tizen.UI.Components.IThemeLoader.CurrentThemeId') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## DummyThemeLoader.Instance Property + +Gets a singleton instance of the DummyThemeLoader. + +```csharp +public static Tizen.UI.Components.DummyThemeLoader Instance { get; } +``` + +#### Property Value +[DummyThemeLoader](Tizen.UI.Components.DummyThemeLoader.md 'Tizen.UI.Components.DummyThemeLoader') +### Methods + + + +## DummyThemeLoader.LoadColorTable() Method + +Load color table for current theme. + +```csharp +public System.Collections.Generic.IDictionary<string,Tizen.UI.Color> LoadColorTable(); +``` + +Implements [LoadColorTable()](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.LoadColorTable() 'Tizen.UI.Components.IThemeLoader.LoadColorTable()') + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## DummyThemeLoader.NextTheme() Method + +Change theme to next one. + +```csharp +public void NextTheme(); +``` + + + +## DummyThemeLoader.ResetTheme() Method + +Resets to the default theme. + +```csharp +public void ResetTheme(); +``` + + + +## DummyThemeLoader.SwitchTheme(int) Method + +Change theme with specified index. + +```csharp +public void SwitchTheme(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## DummyThemeLoader.ThemeChanged Event + +Occurs when the theme is changed. + +```csharp +public event EventHandler ThemeChanged; +``` + +Implements [ThemeChanged](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.ThemeChanged 'Tizen.UI.Components.IThemeLoader.ThemeChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeDirection.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeDirection.md new file mode 100644 index 0000000000..129777ee86 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeDirection.md @@ -0,0 +1,92 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## EdgeDirection Enum + +The direction of edge. + +```csharp +public enum EdgeDirection +``` +### Fields + + + +`Bottom` 3 + +Bottom edge side of the virtical scroll. + + + +`End` 1 + +End, right-edge side of the horizontal scroll. + + + +`Start` 0 + +Start, left-edge side of the horizontal scroll. + + + +`Top` 2 + +Top edge side of the virtical scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeState.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeState.md new file mode 100644 index 0000000000..a186883cbc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeState.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## EdgeState Enum + +The State of edge effect. + +```csharp +public enum EdgeState +``` +### Fields + + + +`Absorb` 2 + +Edge effect on absorbing. + + + +`Idle` 0 + +Idle state. + + + +`Pull` 1 + +Edge effect pulling over. + + + +`PullDecay` 4 + +Edge effect is on pulled and not yet recede back. + + + +`Recede` 3 + +Edge effect recede back. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.FloatingOrigin.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.FloatingOrigin.md new file mode 100644 index 0000000000..eccb002dd7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.FloatingOrigin.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## FloatingOrigin Enum + +The position where the floating target is placed. + +```csharp +public enum FloatingOrigin +``` +### Fields + + + +`BottomCenter` 1 + +Positions the target relative to the bottom center of the container. + + + +`BottomEnd` 2 + +Positions the target relative to the bottom end of the container. + + + +`BottomStart` 0 + +Positions the target relative to the bottom start of the container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectable.md new file mode 100644 index 0000000000..5cf942d78f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectable.md @@ -0,0 +1,134 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## GroupSelectable Class + +Group selectable component is a component that can be selected among the [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup'). + +```csharp +public class GroupSelectable : Tizen.UI.Components.Selectable, +Tizen.UI.Components.IGroupSelectable, +Tizen.UI.Components.ISelectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') 🡒 GroupSelectable + +Derived +↳ [GroupSelectableBox](Tizen.UI.Components.GroupSelectableBox.md 'Tizen.UI.Components.GroupSelectableBox') + +Implements [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable'), [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') +### Constructors + + + +## GroupSelectable() Constructor + +Constructs a new group selectable. + +```csharp +public GroupSelectable(); +``` +### Properties + + + +## GroupSelectable.Group Property + +The group of selectable. + +```csharp +public Tizen.UI.Components.SelectionGroup Group { get; } +``` + +Implements [Group](Tizen.UI.Components.IGroupSelectable.md#Tizen.UI.Components.IGroupSelectable.Group 'Tizen.UI.Components.IGroupSelectable.Group') + +#### Property Value +[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') + + + +## GroupSelectable.GroupName Property + +The name of [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup'). + +```csharp +public string GroupName { get; set; } +``` + +Implements [GroupName](Tizen.UI.Components.IGroupSelectable.md#Tizen.UI.Components.IGroupSelectable.GroupName 'Tizen.UI.Components.IGroupSelectable.GroupName') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## GroupSelectable.IsGrouped Property + +Boolean value indicating whether the group selectable is grouped. + +```csharp +public bool IsGrouped { get; } +``` + +Implements [IsGrouped](Tizen.UI.Components.IGroupSelectable.md#Tizen.UI.Components.IGroupSelectable.IsGrouped 'Tizen.UI.Components.IGroupSelectable.IsGrouped') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectableBox.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectableBox.md new file mode 100644 index 0000000000..9d234c8dec --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectableBox.md @@ -0,0 +1,307 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## GroupSelectableBox Class + +Selectable component with a content. + +```csharp +public abstract class GroupSelectableBox : Tizen.UI.Components.GroupSelectable, +Tizen.UI.Components.ILayoutBox, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') 🡒 [GroupSelectable](Tizen.UI.Components.GroupSelectable.md 'Tizen.UI.Components.GroupSelectable') 🡒 GroupSelectableBox + +Implements [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## GroupSelectableBox.Children Property + +Children of the layout box. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +Implements [Children](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Children 'Tizen.UI.Components.ILayoutBox.Children') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## GroupSelectableBox.Count Property + +Gets the number of elements contained in the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupSelectableBox.IsReadOnly Property + +Gets a value indicating whether the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupSelectableBox.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public abstract Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## GroupSelectableBox.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +Tizen.UI.View +### Methods + + + +## GroupSelectableBox.Clear() Method + +Clears all children. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## GroupSelectableBox.Contains(View) Method + +Whether it contains the specified child. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupSelectableBox.CopyTo(View[], int) Method + +Copies the children to an array. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` Tizen.UI.View[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupSelectableBox.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## GroupSelectableBox.Insert(int, View) Method + +(Not implemented) Inserts the specified content at the specified index. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`item` Tizen.UI.View + + + +## GroupSelectableBox.RemoveAt(int) Method + +Removes the content at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## GroupSelectableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Add(View) Method + +Adds a child view. + +```csharp +void System.Collections.Generic.ICollection<Tizen.UI.View>.Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Add(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## GroupSelectableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(View) Method + +Removes the specified content from the layout box. + +```csharp +bool System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Remove(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## GroupSelectableBox.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectionChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectionChangedEventArgs.md new file mode 100644 index 0000000000..7efc84ce0e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectionChangedEventArgs.md @@ -0,0 +1,120 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## GroupSelectionChangedEventArgs Class + +The event arguments for the GroupSelectionChangedEventArgs event. + +```csharp +public class GroupSelectionChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 GroupSelectionChangedEventArgs +### Constructors + + + +## GroupSelectionChangedEventArgs(IGroupSelectable, IGroupSelectable) Constructor + +GroupSelectionChangedEventArgs constructor. + +```csharp +public GroupSelectionChangedEventArgs(Tizen.UI.Components.IGroupSelectable previous, Tizen.UI.Components.IGroupSelectable current); +``` +#### Parameters + + + +`previous` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The old selected child. + + + +`current` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The new selected child. +### Properties + + + +## GroupSelectionChangedEventArgs.Current Property + +Gets or sets the new selected child. + +```csharp +public Tizen.UI.Components.IGroupSelectable Current { get; } +``` + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + + + +## GroupSelectionChangedEventArgs.Previous Property + +Gets or sets the old selected child. + +```csharp +public Tizen.UI.Components.IGroupSelectable Previous { get; } +``` + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnchoredModal.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnchoredModal.md new file mode 100644 index 0000000000..1995d627d4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnchoredModal.md @@ -0,0 +1,116 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IAnchoredModal Interface + +A modal content to be poped up from the anchor object. + +```csharp +public interface IAnchoredModal +``` +### Properties + + + +## IAnchoredModal.ModalPivot Property + +Gets the modal pivot. + +```csharp +Tizen.UI.Components.ModalPivot ModalPivot { get; } +``` + +#### Property Value +[ModalPivot](Tizen.UI.Components.ModalPivot.md 'Tizen.UI.Components.ModalPivot') +### Methods + + + +## IAnchoredModal.Post(Window, Rect) Method + +Post as a modal to the given window with anchor data. + +```csharp +void Post(Tizen.UI.Window window, Tizen.UI.Rect anchorBounds); +``` +#### Parameters + + + +`window` Tizen.UI.Window + + + +`anchorBounds` Tizen.UI.Rect +### Events + + + +## IAnchoredModal.Dismissed Event + +Occurred when the dismissed. + +```csharp +event EventHandler Dismissed; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnimatedImage.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnimatedImage.md new file mode 100644 index 0000000000..0c7bfc6f2f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnimatedImage.md @@ -0,0 +1,138 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IAnimatedImage Interface + +Interface for animated image. + +```csharp +public interface IAnimatedImage +``` +### Properties + + + +## IAnimatedImage.IsLooping Property + +Gets or sets whether the animation should loop. + +```csharp +bool IsLooping { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IAnimatedImage.RepeatCount Property + +Gets or sets the number of times the animation should repeat. + +```csharp +int RepeatCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## IAnimatedImage.StopBehavior Property + +Gets or sets the behavior of the animation when it stops. + +```csharp +Tizen.UI.AnimationStopBehavior StopBehavior { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationStopBehavior +### Methods + + + +## IAnimatedImage.Pause() Method + +Pauses the animation. + +```csharp +void Pause(); +``` + + + +## IAnimatedImage.Play() Method + +Plays the animation. + +```csharp +void Play(); +``` + + + +## IAnimatedImage.Stop() Method + +Stops the animation. + +```csharp +void Stop(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickable.md new file mode 100644 index 0000000000..be401ac614 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickable.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IClickable Interface + +Clickable element interface. + +```csharp +public interface IClickable +``` + +Derived +↳ [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') +### Properties + + + +## IClickable.ClickedCommand Property + +Clicked command. see [Clicked](Tizen.UI.Components.IClickable.md#Tizen.UI.Components.IClickable.Clicked 'Tizen.UI.Components.IClickable.Clicked'). + +```csharp +System.Action<object,Tizen.UI.Components.InputEventArgs> ClickedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') +### Events + + + +## IClickable.Clicked Event + +Clicked event is raised when the element is clicked. + +```csharp +event EventHandler<InputEventArgs> Clicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickableVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickableVariables.md new file mode 100644 index 0000000000..27ac72b880 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickableVariables.md @@ -0,0 +1,81 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IClickableVariables Interface + +Variables used for clickable. + +```csharp +public interface IClickableVariables +``` +### Properties + + + +## IClickableVariables.TouchEffect Property + +The visual effect on touch. + +```csharp +Tizen.UI.Components.UIAttachable TouchEffect { get; set; } +``` + +#### Property Value +[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IColorProvider.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IColorProvider.md new file mode 100644 index 0000000000..e0abc6009d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IColorProvider.md @@ -0,0 +1,95 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IColorProvider Interface + +Interface for providing color. + +```csharp +public interface IColorProvider +``` +### Properties + + + +## IColorProvider.DominantColor Property + +Gets a color of the object. + +```csharp +Tizen.UI.Color DominantColor { get; } +``` + +#### Property Value +Tizen.UI.Color +### Events + + + +## IColorProvider.DominantColorChanged Event + +Invoked when the dominant color is changed. + +```csharp +event EventHandler DominantColorChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDecoratableText.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDecoratableText.md new file mode 100644 index 0000000000..bcffe162f7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDecoratableText.md @@ -0,0 +1,121 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IDecoratableText Interface + +An interface to express decoratable text. + +```csharp +public interface IDecoratableText +``` +### Properties + + + +## IDecoratableText.Outline Property + +The outline of the text. + +```csharp +System.Nullable<Tizen.UI.Outline> Outline { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Outline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## IDecoratableText.Strikethrough Property + +The strikethrough of the text. + +```csharp +System.Nullable<Tizen.UI.Strikethrough> Strikethrough { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Strikethrough[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## IDecoratableText.TextShadow Property + +The drop shadow of the text. + +```csharp +System.Nullable<Tizen.UI.TextShadow> TextShadow { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.TextShadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## IDecoratableText.Underline Property + +The underline of the text. + +```csharp +System.Nullable<Tizen.UI.Underline> Underline { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDoubleTitle.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDoubleTitle.md new file mode 100644 index 0000000000..ec94a5ae1c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDoubleTitle.md @@ -0,0 +1,84 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IDoubleTitle Interface + +Interface describes a double title. + +```csharp +public interface IDoubleTitle : +Tizen.UI.Components.ITitle +``` + +Implements [ITitle](Tizen.UI.Components.ITitle.md 'Tizen.UI.Components.ITitle') +### Properties + + + +## IDoubleTitle.Subtitle Property + +Gets or sets a subtitle text. + +```csharp +string Subtitle { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IEdgeEffect.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IEdgeEffect.md new file mode 100644 index 0000000000..eba2bc2d84 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IEdgeEffect.md @@ -0,0 +1,187 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IEdgeEffect Interface + +Edge effect for over scroll in scrollable view. +when the scrollable view reach the end edge of scroll, +pulling over the view process the Egde effect. + +```csharp +public interface IEdgeEffect +``` +### Properties + + + +## IEdgeEffect.EdgeDirection Property + +The direction of edge. [EdgeDirection](Tizen.UI.Components.IEdgeEffect.md#Tizen.UI.Components.IEdgeEffect.EdgeDirection 'Tizen.UI.Components.IEdgeEffect.EdgeDirection'). + +```csharp +Tizen.UI.Components.EdgeDirection EdgeDirection { get; set; } +``` + +#### Property Value +[EdgeDirection](Tizen.UI.Components.EdgeDirection.md 'Tizen.UI.Components.EdgeDirection') + + + +## IEdgeEffect.MaxDistance Property + +The Maximum distance of touch pull over the parent view. + +```csharp +float MaxDistance { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IEdgeEffect.SourceView Property + +The source view who will reflect the edge effect. + +```csharp +Tizen.UI.View SourceView { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## IEdgeEffect.State Property + +The state of edge effect. [EdgeState](Tizen.UI.Components.EdgeState.md 'Tizen.UI.Components.EdgeState'). + +```csharp +Tizen.UI.Components.EdgeState State { get; } +``` + +#### Property Value +[EdgeState](Tizen.UI.Components.EdgeState.md 'Tizen.UI.Components.EdgeState') +### Methods + + + +## IEdgeEffect.Finish() Method + +Finish edge effect immediately. + +```csharp +void Finish(); +``` + + + +## IEdgeEffect.OnAbsorb(float) Method + +Call when the effect absorbs an impact at the given velocity. + +```csharp +void OnAbsorb(float velocity); +``` +#### Parameters + + + +`velocity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The velocity to absorb. + + + +## IEdgeEffect.OnPull(float, float) Method + +A view should call this when content is pulled over form the edge. + +```csharp +float OnPull(float deltaDistance, float displacement=0.5f); +``` +#### Parameters + + + +`deltaDistance` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Change in distance since the last call. Values may be 0 to 1.f or negative values. + + + +`displacement` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The displacement from the side of the point initiating the pull. value may be from 0 to 1. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The amount of deltaDistance that was consumed. + + + +## IEdgeEffect.OnRelease() Method + +Call when the object is released after being pulled. + +```csharp +void OnRelease(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFlexibleText.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFlexibleText.md new file mode 100644 index 0000000000..31e9b50ea8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFlexibleText.md @@ -0,0 +1,108 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IFlexibleText Interface + +An interface to express flexible text. + +```csharp +public interface IFlexibleText +``` +### Properties + + + +## IFlexibleText.AutoFontSize Property + +Gets or sets the auto font size. + +```csharp +Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +#### Property Value +Tizen.UI.AutoFontSize + + + +## IFlexibleText.FontSize Property + +Gets or sets the font size of the text. + +```csharp +float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IFlexibleText.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontFamilyLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontFamilyLoader.md new file mode 100644 index 0000000000..915082b8cf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontFamilyLoader.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IFontFamilyLoader Interface + +Interface for loading system font family. + +```csharp +public interface IFontFamilyLoader +``` + +Derived +↳ [DummyFontFamilyLoader](Tizen.UI.Components.DummyFontFamilyLoader.md 'Tizen.UI.Components.DummyFontFamilyLoader') +↳ [TizenFontFamilyLoader](Tizen.UI.Components.TizenFontFamilyLoader.md 'Tizen.UI.Components.TizenFontFamilyLoader') +### Properties + + + +## IFontFamilyLoader.FontFamily Property + +Gets the current font family. + +```csharp +string FontFamily { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Events + + + +## IFontFamilyLoader.FontFamilyChanged Event + +Occurs when the font family is changed. + +```csharp +event EventHandler FontFamilyChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontScaleLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontScaleLoader.md new file mode 100644 index 0000000000..26d948836e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontScaleLoader.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IFontScaleLoader Interface + +Interface for loading system font scale. + +```csharp +public interface IFontScaleLoader +``` + +Derived +↳ [DummyFontScaleLoader](Tizen.UI.Components.DummyFontScaleLoader.md 'Tizen.UI.Components.DummyFontScaleLoader') +### Properties + + + +## IFontScaleLoader.FontScale Property + +Gets the current font scale. + +```csharp +float FontScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Events + + + +## IFontScaleLoader.FontScaleChanged Event + +Occurs when the font scale is changed. + +```csharp +event EventHandler FontScaleChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IGroupSelectable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IGroupSelectable.md new file mode 100644 index 0000000000..52236c559b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IGroupSelectable.md @@ -0,0 +1,127 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IGroupSelectable Interface + +Represents group selectable element. +[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') can control the selection of group selectable. + +```csharp +public interface IGroupSelectable : +Tizen.UI.Components.ISelectable +``` + +Derived +↳ [GroupSelectable](Tizen.UI.Components.GroupSelectable.md 'Tizen.UI.Components.GroupSelectable') + +Implements [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') +### Properties + + + +## IGroupSelectable.Group Property + +The group of selectable. + +```csharp +Tizen.UI.Components.SelectionGroup Group { get; } +``` + +#### Property Value +[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') + + + +## IGroupSelectable.GroupName Property + +The name of [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup'). + +```csharp +string GroupName { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IGroupSelectable.IsGrouped Property + +Boolean value indicating whether the group selectable is grouped. + +```csharp +bool IsGrouped { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IGroupSelectable.Name Property + +Name of group selectable. + +```csharp +string Name { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IImage.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IImage.md new file mode 100644 index 0000000000..5fc3611282 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IImage.md @@ -0,0 +1,187 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IImage Interface + +Interface for image. + +```csharp +public interface IImage +``` +### Properties + + + +## IImage.AlphaMaskUrl Property + +Gets or sets the URL of the alpha mask image to apply to the image. + +```csharp +string AlphaMaskUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IImage.CropToMask Property + +Gets or sets whether the image should be cropped to its mask. + +```csharp +bool CropToMask { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IImage.FittingMode Property + +Gets or sets the fitting mode used to scale the image to fit the control. + +```csharp +Tizen.UI.ImageLoaderFittingMode FittingMode { get; set; } +``` + +#### Property Value +Tizen.UI.ImageLoaderFittingMode + + + +## IImage.LoadingStatus Property + +Gets the loading status of the image. + +```csharp +Tizen.UI.ImageLoadingStatus LoadingStatus { get; } +``` + +#### Property Value +Tizen.UI.ImageLoadingStatus + + + +## IImage.MultipliedColor Property + +Gets or sets the color of the view, which is multiplied by the image view's alpha value. + +```csharp +Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## IImage.ResourceUrl Property + +Gets or sets the URL of the image to display. + +```csharp +string ResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IImage.SynchronousLoading Property + +Gets or sets whether the image should be loaded synchronously. + +```csharp +bool SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## IImage.Reload() Method + +Reloads the image. + +```csharp +void Reload(); +``` +### Events + + + +## IImage.ResourceReady Event + +An event for ResourceReady signal which can be used to subscribe or unsubscribe the event handler.
+This signal is emitted after all resources required by a control are loaded and ready.
+Most resources are only loaded when the control is placed on the stage.
+ +```csharp +event EventHandler ResourceReady; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ILayoutBox.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ILayoutBox.md new file mode 100644 index 0000000000..f80a4ebb0a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ILayoutBox.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ILayoutBox Interface + +The interface implemeting a view has a specific layout. + +```csharp +public interface ILayoutBox +``` + +Derived +↳ [ClickableBox](Tizen.UI.Components.ClickableBox.md 'Tizen.UI.Components.ClickableBox') +↳ [GroupSelectableBox](Tizen.UI.Components.GroupSelectableBox.md 'Tizen.UI.Components.GroupSelectableBox') +↳ [PressableBox](Tizen.UI.Components.PressableBox.md 'Tizen.UI.Components.PressableBox') +↳ [SelectableBox](Tizen.UI.Components.SelectableBox.md 'Tizen.UI.Components.SelectableBox') +↳ [SelectionGroupBox<T>](Tizen.UI.Components.SelectionGroupBox_T_.md 'Tizen.UI.Components.SelectionGroupBox<T>') +### Properties + + + +## ILayoutBox.Children Property + +Children of the layout box. + +```csharp +System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ILayoutBox.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +Tizen.UI.Thickness Padding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IModalContainer.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IModalContainer.md new file mode 100644 index 0000000000..38e633487a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IModalContainer.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IModalContainer Interface + +A container that can show a modal content. It should have a scrim to block the background. + +```csharp +public interface IModalContainer +``` +### Properties + + + +## IModalContainer.ModalContent Property + +A modal content to be shown in this container. + +```csharp +Tizen.UI.View ModalContent { get; set; } +``` + +#### Property Value +Tizen.UI.View +UIView to be shown or hidden as modal content + + + +## IModalContainer.Scrim Property + +A scrim to block the background when the modal content is shown. + +```csharp +Tizen.UI.View Scrim { get; set; } +``` + +#### Property Value +Tizen.UI.View +UIView with dimmed background color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigateBackHandler.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigateBackHandler.md new file mode 100644 index 0000000000..e071d936b0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigateBackHandler.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## INavigateBackHandler Interface + +The INavigateBackHandler interface defines methods to handle navigating back. + +```csharp +public interface INavigateBackHandler +``` + +Derived +↳ [Navigator](Tizen.UI.Components.Navigator.md 'Tizen.UI.Components.Navigator') +### Methods + + + +## INavigateBackHandler.HandleNavigateBack() Method + +Handles navigating back. +If navigating back is not consumed, then the Navigation object of this object will handle navigating back instead. + +```csharp +bool HandleNavigateBack(); +``` + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if navigating back is consumed. False otherwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigation.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigation.md new file mode 100644 index 0000000000..3f38a2e09c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigation.md @@ -0,0 +1,314 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## INavigation Interface + +The INavigation interface defines methods to navigate views with the stack data structure. + +```csharp +public interface INavigation +``` + +Derived +↳ [Navigator](Tizen.UI.Components.Navigator.md 'Tizen.UI.Components.Navigator') +### Properties + + + +## INavigation.ModalStack Property + +Gets the list of views pushed onto the modal stack. + +```csharp +System.Collections.Generic.IReadOnlyList<Tizen.UI.View> ModalStack { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## INavigation.NavigationStack Property + +Gets the list of views pushed onto the navigation stack. + +```csharp +System.Collections.Generic.IReadOnlyList<Tizen.UI.View> NavigationStack { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') +### Methods + + + +## INavigation.InsertBefore(View, View) Method + +Inserts a view to the navigation stack right before the given view `before`. + +```csharp +void InsertBefore(Tizen.UI.View view, Tizen.UI.View before); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be inserted to the navigation stack right before the given view `before`. + + + +`before` Tizen.UI.View + +The view existing in the navigation stack and will be the next view of the inserted view. + + + +## INavigation.NavigateBack() Method + +Navigate back to the previous view. + +```csharp +bool NavigateBack(); +``` + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the navigation back was handled, otherwise false. + + + +## INavigation.PopAsync() Method + +Pops the top view off the navigation stack. + +```csharp +System.Threading.Tasks.Task<Tizen.UI.View> PopAsync(); +``` + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The view popped off the navigation stack. + + + +## INavigation.PopAsync(bool) Method + +Pops the top view off the navigation stack with or without the transition animation. + +```csharp +System.Threading.Tasks.Task<Tizen.UI.View> PopAsync(bool animated); +``` +#### Parameters + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The view popped off the navigation stack. + + + +## INavigation.PopModalAsync() Method + +Pops the top modal view such as dialog off the modal stack. + +```csharp +System.Threading.Tasks.Task<Tizen.UI.View> PopModalAsync(); +``` + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The modal view popped off the modal stack. + + + +## INavigation.PopModalAsync(bool) Method + +Pops the top modal view such as dialog off the modal stack with or without the transition animation. + +```csharp +System.Threading.Tasks.Task<Tizen.UI.View> PopModalAsync(bool animated); +``` +#### Parameters + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The modal view popped off the modal stack. + + + +## INavigation.PushAsync(View) Method + +Pushes a view onto the navigation stack. + +```csharp +System.Threading.Tasks.Task PushAsync(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the navigation stack. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## INavigation.PushAsync(View, bool) Method + +Pushes a view onto the navigation stack with or without the transition animation. + +```csharp +System.Threading.Tasks.Task PushAsync(Tizen.UI.View view, bool animated); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the navigation stack. + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## INavigation.PushModalAsync(View) Method + +Pushes a modal view such as dialog onto the modal stack. + +```csharp +System.Threading.Tasks.Task PushModalAsync(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the modal stack. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## INavigation.PushModalAsync(View, bool) Method + +Pushes a modal view such as dialog onto the modal stack with or without the transition animation. + +```csharp +System.Threading.Tasks.Task PushModalAsync(Tizen.UI.View view, bool animated); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the modal stack. + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## INavigation.Remove(View) Method + +Removes the specified view from the navigation stack or modal stack. + +```csharp +void Remove(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be removed from the navigation stack or modal stack. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimation.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimation.md new file mode 100644 index 0000000000..642feee2bf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimation.md @@ -0,0 +1,135 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## INavigationAnimation Interface + +The INavigationAnimation interface defines functions called for the transition animation during navigation. + +```csharp +public interface INavigationAnimation +``` + +Derived +↳ [Navigator](Tizen.UI.Components.Navigator.md 'Tizen.UI.Components.Navigator') +### Properties + + + +## INavigationAnimation.PopAnimation Property + +Function called for transition animation of navigation pop. + +```csharp +System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopAnimation { get; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the view to be popped. The fist View will be removed from the navigation stack. + + + +## INavigationAnimation.PopModalAnimation Property + +Function called for transition animation of modal pop. + +```csharp +System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopModalAnimation { get; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the modal view to be popped. The fist View will be removed from the modal stack. + + + +## INavigationAnimation.PushAnimation Property + +Function called for transition animation of navigation push. + +```csharp +System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushAnimation { get; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the view to be pushed. The fist View will be the top view. + + + +## INavigationAnimation.PushModalAnimation Property + +Function called for transition animation of modal push. + +```csharp +System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushModalAnimation { get; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + +### Remarks +The first View of Func is the modal view to be pushed. The fist View will be the top view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimationController.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimationController.md new file mode 100644 index 0000000000..05fd89f1d2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimationController.md @@ -0,0 +1,91 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## INavigationAnimationController Interface + +The INavigationAnimationController interface defines interfaces for navigation animation. + +```csharp +public interface INavigationAnimationController +``` +### Methods + + + +## INavigationAnimationController.PlayAsync() Method + +Plays navigation animation. + +```csharp +System.Threading.Tasks.Task PlayAsync(); +``` + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## INavigationAnimationController.Stop() Method + +Stops navigation animation. + +```csharp +void Stop(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationTransition.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationTransition.md new file mode 100644 index 0000000000..5ca682113d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationTransition.md @@ -0,0 +1,142 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## INavigationTransition Interface + +The INavigationTransition interface defines methods to notice the changes of the navigation transition such as appearing or disappearing. + +```csharp +public interface INavigationTransition +``` + +Derived +↳ [Navigator](Tizen.UI.Components.Navigator.md 'Tizen.UI.Components.Navigator') +### Methods + + + +## INavigationTransition.DidAppear(bool) Method + +Called right after appearing by navigation transition. + +```csharp +void DidAppear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + + + +## INavigationTransition.DidDisappear(bool) Method + +Called right after disappearing by navigation transition. + +```csharp +void DidDisappear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + +### Remarks +A view disappeared by pop navigation can be disposed if the view is not used anymore. + + + +## INavigationTransition.WillAppear(bool) Method + +Called right before appearing by navigation transition. + +```csharp +void WillAppear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + + + +## INavigationTransition.WillDisappear(bool) Method + +Called right before disappearing by navigation transition. + +```csharp +void WillDisappear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPressable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPressable.md new file mode 100644 index 0000000000..23d2b51130 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPressable.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IPressable Interface + +Represents pressable element. +All derived class of Tizen.UI.View that implements this interface can have [Pressed](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Pressed 'Tizen.UI.Components.UIState.Pressed') state when [IsPressed](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.IsPressed 'Tizen.UI.Components.IPressable.IsPressed') is true. + +```csharp +public interface IPressable +``` + +Derived +↳ [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') +### Properties + + + +## IPressable.IsPressed Property + +Indicates whether it is pressed or not. + +```csharp +bool IsPressed { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Events + + + +## IPressable.PressedChanged Event + +The event that is called when the value of [IsPressed](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.IsPressed 'Tizen.UI.Components.IPressable.IsPressed') changes. + +```csharp +event EventHandler<InputEventArgs> PressedChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPropertySetter_TValue_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPropertySetter_TValue_.md new file mode 100644 index 0000000000..cc75784021 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPropertySetter_TValue_.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IPropertySetter<TValue> Interface + +The interface for property setter. + +```csharp +public interface IPropertySetter<TValue> +``` +#### Type parameters + + + +`TValue` + +Derived +↳ [PropertySetter<TView,TValue>](Tizen.UI.Components.PropertySetter_TView,TValue_.md 'Tizen.UI.Components.PropertySetter<TView,TValue>') +### Properties + + + +## IPropertySetter<TValue>.Name Property + +The name of the property. + +```csharp +string Name { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## IPropertySetter<TValue>.Invoke(object, TValue) Method + +Invokes property setter. + +```csharp +void Invoke(object target, TValue value); +``` +#### Parameters + + + +`target` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + + + +`value` [TValue](Tizen.UI.Components.IPropertySetter_TValue_.md#Tizen.UI.Components.IPropertySetter_TValue_.TValue 'Tizen.UI.Components.IPropertySetter<TValue>.TValue') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectable.md new file mode 100644 index 0000000000..8fc45b68ac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectable.md @@ -0,0 +1,131 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ISelectable Interface + +Represents selectable element. +All derived class of Tizen.UI.View that implements this interface can have [Selected](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Selected 'Tizen.UI.Components.UIState.Selected') state when [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') is true. + +```csharp +public interface ISelectable +``` + +Derived +↳ [GroupSelectable](Tizen.UI.Components.GroupSelectable.md 'Tizen.UI.Components.GroupSelectable') +↳ [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') +↳ [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') +### Properties + + + +## ISelectable.IsSelectable Property + +Indicates whether it is selectable or not. + +```csharp +bool IsSelectable { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ISelectable.IsSelected Property + +Indicates whether it is selected or not. + +```csharp +bool IsSelected { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## ISelectable.Toggle(KeyDeviceClass) Method + +Toggle the selection state of the component. + +```csharp +void Toggle(Tizen.UI.KeyDeviceClass device); +``` +#### Parameters + + + +`device` Tizen.UI.KeyDeviceClass +### Events + + + +## ISelectable.SelectedChanged Event + +The event that is called when the value of [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') changes. + +```csharp +event EventHandler<InputEventArgs> SelectedChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectionGroup.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectionGroup.md new file mode 100644 index 0000000000..96159ad269 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectionGroup.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ISelectionGroup Interface + +Interface for a group of [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable'). + +```csharp +public interface ISelectionGroup +``` + +Derived +↳ [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') +↳ [SelectionGroupBox<T>](Tizen.UI.Components.SelectionGroupBox_T_.md 'Tizen.UI.Components.SelectionGroupBox<T>') +### Properties + + + +## ISelectionGroup.Selected Property + +The selected child in the group. + +```csharp +Tizen.UI.Components.IGroupSelectable Selected { get; } +``` + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') +### Events + + + +## ISelectionGroup.SelectionChanged Event + +Occures when the selected item is changed. + +```csharp +event EventHandler<GroupSelectionChangedEventArgs> SelectionChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IThemeLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IThemeLoader.md new file mode 100644 index 0000000000..905b185431 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IThemeLoader.md @@ -0,0 +1,126 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IThemeLoader Interface + +Interface for loading system theme. + +```csharp +public interface IThemeLoader +``` + +Derived +↳ [DummyThemeLoader](Tizen.UI.Components.DummyThemeLoader.md 'Tizen.UI.Components.DummyThemeLoader') +↳ [TizenThemeLoader](Tizen.UI.Components.TizenThemeLoader.md 'Tizen.UI.Components.TizenThemeLoader') +### Properties + + + +## IThemeLoader.CurrentResourcePath Property + +Gets the current resource path. + +```csharp +string CurrentResourcePath { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IThemeLoader.CurrentThemeId Property + +Gets the current theme id. + +```csharp +string CurrentThemeId { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## IThemeLoader.LoadColorTable() Method + +Load color table for current theme. + +```csharp +System.Collections.Generic.IDictionary<string,Tizen.UI.Color> LoadColorTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') +### Events + + + +## IThemeLoader.ThemeChanged Event + +Occurs when the theme is changed. + +```csharp +event EventHandler ThemeChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITitle.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITitle.md new file mode 100644 index 0000000000..7d6cd90f4b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITitle.md @@ -0,0 +1,84 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ITitle Interface + +Interface describes a title. + +```csharp +public interface ITitle +``` + +Derived +↳ [IDoubleTitle](Tizen.UI.Components.IDoubleTitle.md 'Tizen.UI.Components.IDoubleTitle') +### Properties + + + +## ITitle.Title Property + +Gets or sets a title text. + +```csharp +string Title { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITouchEffectTarget.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITouchEffectTarget.md new file mode 100644 index 0000000000..8ca5f56685 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITouchEffectTarget.md @@ -0,0 +1,97 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ITouchEffectTarget Interface + +Interface for touch effect target. + +```csharp +public interface ITouchEffectTarget +``` + +Derived +↳ [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') +### Methods + + + +## ITouchEffectTarget.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +#### Returns +Tizen.UI.View + + + +## ITouchEffectTarget.GetTouchEffectTarget() Method + +Get the target view to apply feedback. + +```csharp +Tizen.UI.View GetTouchEffectTarget(); +``` + +#### Returns +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IconPlacement.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IconPlacement.md new file mode 100644 index 0000000000..32dd3e1e40 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IconPlacement.md @@ -0,0 +1,80 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## IconPlacement Enum + +Specifieds the placement of the icon relative to other content. + +```csharp +public enum IconPlacement +``` +### Fields + + + +`Leading` 0 + +The icon appears before the content. + + + +`Trailing` 1 + +The icon appears after the content. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEditorImpl.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEditorImpl.md new file mode 100644 index 0000000000..cc066e3c66 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEditorImpl.md @@ -0,0 +1,129 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InputEditorImpl Class + +Wrapper class of DALi text editor. + +```csharp +public class InputEditorImpl : Tizen.UI.Components.InputTextBaseImpl +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [TextBaseImpl](Tizen.UI.Components.TextBaseImpl.md 'Tizen.UI.Components.TextBaseImpl') 🡒 [InputTextBaseImpl](Tizen.UI.Components.InputTextBaseImpl.md 'Tizen.UI.Components.InputTextBaseImpl') 🡒 InputEditorImpl +### Properties + + + +## InputEditorImpl.IsAbsoluteLineHeight Property + +Gets or sets the line height policy. This value will determine how the line height is calculated. +If the value is false, the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is false with value 1.0f. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEditorImpl.LineBreakMode Property + +Gets or sets the line break mode of the text. + +```csharp +public Tizen.UI.LineBreakMode LineBreakMode { get; set; } +``` + +#### Property Value +Tizen.UI.LineBreakMode + + + +## InputEditorImpl.LineCount Property + +Gets the number of lines of text. + +```csharp +public int LineCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputEditorImpl.LineHeight Property + +Gets or sets the minimum line height. If the value is smaller than the natural line height, the natural line height will be used instead. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +This property is treated differently by the [LineHeightPolicy](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy 'LineHeightPolicy'). If the value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative'), the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative') with value 1.0f. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEventArgs.md new file mode 100644 index 0000000000..250085b117 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEventArgs.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InputEventArgs Class + +Event arguments for component input event. + +```csharp +public class InputEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 InputEventArgs +### Constructors + + + +## InputEventArgs(KeyDeviceClass) Constructor + +Initializes a new instance of the [InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs') class with the specified input device. + +```csharp +public InputEventArgs(Tizen.UI.KeyDeviceClass device); +``` +#### Parameters + + + +`device` Tizen.UI.KeyDeviceClass + +The input device. +### Properties + + + +## InputEventArgs.Handled Property + +Gets or sets a value indicating whether the input event has been handled. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputEventArgs.InputDevice Property + +Gets the input device + +```csharp +public Tizen.UI.KeyDeviceClass InputDevice { get; set; } +``` + +#### Property Value +Tizen.UI.KeyDeviceClass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputFieldImpl.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputFieldImpl.md new file mode 100644 index 0000000000..ba0293ca04 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputFieldImpl.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InputFieldImpl Class + +Wrapper class of DALi text field. + +```csharp +public class InputFieldImpl : Tizen.UI.Components.InputTextBaseImpl +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [TextBaseImpl](Tizen.UI.Components.TextBaseImpl.md 'Tizen.UI.Components.TextBaseImpl') 🡒 [InputTextBaseImpl](Tizen.UI.Components.InputTextBaseImpl.md 'Tizen.UI.Components.InputTextBaseImpl') 🡒 InputFieldImpl +### Properties + + + +## InputFieldImpl.PasswordMode Property + +Gets or sets the password mode. + +```csharp +public Tizen.UI.HiddenInputMode PasswordMode { get; set; } +``` + +#### Property Value +Tizen.UI.HiddenInputModeH + + + +## InputFieldImpl.ShowPlaceholderOnFocus Property + +Whether to keep showing the placeholder when the field is focused. + +```csharp +public bool ShowPlaceholderOnFocus { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputTextBaseImpl.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputTextBaseImpl.md new file mode 100644 index 0000000000..baa3b10f6f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputTextBaseImpl.md @@ -0,0 +1,626 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InputTextBaseImpl Class + +Basic DALi input text object wrapper. + +```csharp +public abstract class InputTextBaseImpl : Tizen.UI.Components.TextBaseImpl +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [TextBaseImpl](Tizen.UI.Components.TextBaseImpl.md 'Tizen.UI.Components.TextBaseImpl') 🡒 InputTextBaseImpl + +Derived +↳ [InputEditorImpl](Tizen.UI.Components.InputEditorImpl.md 'Tizen.UI.Components.InputEditorImpl') +↳ [InputFieldImpl](Tizen.UI.Components.InputFieldImpl.md 'Tizen.UI.Components.InputFieldImpl') +### Constructors + + + +## InputTextBaseImpl() Constructor + +Constructs a new instance. + +```csharp +public InputTextBaseImpl(); +``` +### Properties + + + +## InputTextBaseImpl.CursorPosition Property + +Gets or sets the cursor position. + +```csharp +public int CursorPosition { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputTextBaseImpl.InputColor Property + +Gets or sets the input color for the text will be added to the input area from now on. + +```csharp +public Tizen.UI.Color InputColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputTextBaseImpl.InputFontFamily Property + +Gets or sets the input font family for the text will be added to the input area from now on. + +```csharp +public string InputFontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputTextBaseImpl.InputFontSize Property + +Gets or sets the input font size for the text will be added to the input area from now on. + +```csharp +public float InputFontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputTextBaseImpl.InputFontSlant Property + +Gets or sets the input font style weight such as Tizen.UI.FontSlant.Italic for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontSlant InputFontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## InputTextBaseImpl.InputFontWeight Property + +Gets or sets the input font style weight such as Tizen.UI.FontWeight.Bold for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWeight InputFontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## InputTextBaseImpl.InputFontWidth Property + +Gets or sets the input font style width such as Tizen.UI.FontWidth.Condensed for the text will be added to the input area from now on.. + +```csharp +public Tizen.UI.FontWidth InputFontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## InputTextBaseImpl.InputMethodContext Property + +Gets the input method context. + +```csharp +public Tizen.UI.InputMethodContext InputMethodContext { get; } +``` + +#### Property Value +Tizen.UI.InputMethodContext + + + +## InputTextBaseImpl.IsEditable Property + +Gets or sets whether the text can be edited. + +```csharp +public bool IsEditable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputTextBaseImpl.MaximumLength Property + +Gets or sets the maximum length of the text. + +```csharp +public int MaximumLength { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputTextBaseImpl.Placeholder Property + +Gets or sets the placeholder text. + +```csharp +public string Placeholder { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputTextBaseImpl.PlaceholderColor Property + +Gets or sets the placeholder text color. + +```csharp +public Tizen.UI.Color PlaceholderColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## InputTextBaseImpl.SelectedText Property + +Gets the currently selected text. + +```csharp +public string SelectedText { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputTextBaseImpl.SelectedTextIndex Property + +Gets the index range of the currently selected text. + +```csharp +public Tizen.UI.Components.ClosedRange<int> SelectedTextIndex { get; } +``` + +#### Property Value +[Tizen.UI.Components.ClosedRange<](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>') + + + +## InputTextBaseImpl.SelectionEnabled Property + +Gets or sets whether the text selection is enabled. + +```csharp +public bool SelectionEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## InputTextBaseImpl.ClearSelection() Method + +Clears the current selection. + +```csharp +public void ClearSelection(); +``` + + + +## InputTextBaseImpl.EnableGrabHandle(bool) Method + +Enable the grab handle. + +```csharp +public void EnableGrabHandle(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputTextBaseImpl.EnableGrabHandlePopup(bool) Method + +Enable the grab handle popup. + +```csharp +public void EnableGrabHandlePopup(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputTextBaseImpl.SelectText(int, int) Method + +Selects the text within the specified index range. + +```csharp +public void SelectText(int startIndex, int endIndex); +``` +#### Parameters + + + +`startIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The start index of the selection. + + + +`endIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The end index of the selection. + + + +## InputTextBaseImpl.SelectWholeText() Method + +Selects the whole text. + +```csharp +public void SelectWholeText(); +``` + + + +## InputTextBaseImpl.SetCursorBlink(float, float) Method + +Enables cursor blink. + +```csharp +public void SetCursorBlink(float interval, float duration); +``` +#### Parameters + + + +`interval` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The interval between blinks. + + + +`duration` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The duration of each blink. + + + +## InputTextBaseImpl.SetCursorColor(Color) Method + +Sets the cursor color. + +```csharp +public void SetCursorColor(Tizen.UI.Color value); +``` +#### Parameters + + + +`value` Tizen.UI.Color + + + +## InputTextBaseImpl.SetCursorWidth(int) Method + +Sets the cursor width. + +```csharp +public void SetCursorWidth(int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the cursor. + + + +## InputTextBaseImpl.SetInputMethodActionButtonTitle(ActionButtonTitle) Method + +Sets the input method's action button title. + +```csharp +public void SetInputMethodActionButtonTitle(Tizen.UI.ActionButtonTitle actionButtonTitle); +``` +#### Parameters + + + +`actionButtonTitle` Tizen.UI.ActionButtonTitle + +The title of the action button. + + + +## InputTextBaseImpl.SetInputMethodCapitalMode(AutoCapital) Method + +Sets the input method's capital mode. + +```csharp +public void SetInputMethodCapitalMode(Tizen.UI.AutoCapital capitalMode); +``` +#### Parameters + + + +`capitalMode` Tizen.UI.AutoCapital + +The capital mode of the input method. + + + +## InputTextBaseImpl.SetInputMethodPanelType(PanelLayout) Method + +Sets the input method's panel layout. + +```csharp +public void SetInputMethodPanelType(Tizen.UI.PanelLayout panelLayout); +``` +#### Parameters + + + +`panelLayout` Tizen.UI.PanelLayout + +The panel layout of the input method. + + + +## InputTextBaseImpl.SetSecondaryCursorColor(Color) Method + +Sets the secondary cursor color. + +```csharp +public void SetSecondaryCursorColor(Tizen.UI.Color value); +``` +#### Parameters + + + +`value` Tizen.UI.Color + + + +## InputTextBaseImpl.SetSelectionColor(Color) Method + +Sets the selection area color. + +```csharp +public void SetSelectionColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + + + +## InputTextBaseImpl.SetSelectionHandleImage(string, string) Method + +Sets the selection handle images. + +```csharp +public void SetSelectionHandleImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputTextBaseImpl.SetSelectionHandlePressedImage(string, string) Method + +Sets the pressed selection handle images. + +```csharp +public void SetSelectionHandlePressedImage(string leftResourceUrl, string rightResourceUrl); +``` +#### Parameters + + + +`leftResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the left handle. + + + +`rightResourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The Url of the image for the right handle. + + + +## InputTextBaseImpl.UnsetCursorBlink() Method + +Disables the cursor blink. + +```csharp +public void UnsetCursorBlink(); +``` +### Events + + + +## InputTextBaseImpl.CursorMoved Event + +Occurs when the cursor moved. + +```csharp +public event EventHandler CursorMoved; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputTextBaseImpl.MaximumLengthReached Event + +Occurs when the text has reached to the specified maximum length. + +```csharp +public event EventHandler MaximumLengthReached; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputTextBaseImpl.SelectionChanged Event + +Occurs when the seledction changed. + +```csharp +public event EventHandler SelectionChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputTextBaseImpl.SelectionCleared Event + +Occurs when the selection is cleared. + +```csharp +public event EventHandler SelectionCleared; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputTextBaseImpl.SelectionStarted Event + +Occurs when the selection is started. + +```csharp +public event EventHandler SelectionStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputTextBaseImpl.TextChanged Event + +Occurs when the text is changed. + +```csharp +public event EventHandler TextChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractionType.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractionType.md new file mode 100644 index 0000000000..ceb6702040 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractionType.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InteractionType Enum + +The interaction type of view. + +```csharp +public enum InteractionType +``` +### Fields + + + +`Clicked` 64 + +Clicked interaction. +Note that it can be applied only to the Clickable objects. + + + +`Focused` 16 + +Focus gained interaction. + + + +`KeyPress` 4 + +Key press interaction. + + + +`KeyRelease` 8 + +Key release interaction. + + + +`None` 0 + +No interaction. + + + +`TouchPress` 1 + +Touch press interaction. + + + +`TouchRelease` 2 + +Touch release interaction. + + + +`Unfocused` 32 + +Focus lost interaction. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgress.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgress.md new file mode 100644 index 0000000000..bdd92e105a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgress.md @@ -0,0 +1,258 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InteractiveProgress Class + +A interactive progress component that indicates a specific value from a continuous or discrete range of values. + +```csharp +public class InteractiveProgress : Tizen.UI.Components.Pressable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 InteractiveProgress +### Constructors + + + +## InteractiveProgress(float, float) Constructor + +Constructs a new interactive progress. + +```csharp +public InteractiveProgress(float minimumValue, float maximumValue); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Properties + + + +## InteractiveProgress.IgnoreTap Property + +Whether to ignore tap or not. Default is false. +If true, the tap will not change the value. + +```csharp +public bool IgnoreTap { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InteractiveProgress.IgnoreTouchDown Property + +Whether to ignore touch down or not for selecting a value. Default is true. +If false, the touch down will change the value immediately using the touch down position. + +```csharp +public bool IgnoreTouchDown { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InteractiveProgress.Range Property + +The range of values. + +```csharp +public Tizen.UI.Components.ClosedRange<float> Range { get; set; } +``` + +#### Property Value +[Tizen.UI.Components.ClosedRange<](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>') + +#### Exceptions + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when the maximum is less than or equal to the minimum. + +### Remarks +The [Value](Tizen.UI.Components.InteractiveProgress.md#Tizen.UI.Components.InteractiveProgress.Value 'Tizen.UI.Components.InteractiveProgress.Value') will be coerced to the range when the range changes. + + + +## InteractiveProgress.UseRelativeTouchPoint Property + +Whether to use relative touch point. Default is false. +If true, the value will be calculated based on the diff value between the last touch point and the current touch point. + +```csharp +public bool UseRelativeTouchPoint { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InteractiveProgress.Value Property + +The current value. + +```csharp +public float Value { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The [Value](Tizen.UI.Components.InteractiveProgress.md#Tizen.UI.Components.InteractiveProgress.Value 'Tizen.UI.Components.InteractiveProgress.Value') will be coerced to the range. + + + +## InteractiveProgress.ValueChanging Property + +Whether the vale is changing due to user interactions such as dragging. + +```csharp +public bool ValueChanging { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InteractiveProgress.ValueStepCount Property + +The number of segments to divide the range into. + +```csharp +public int ValueStepCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +If the value is less than equals to zero, the progress will be continuous. Otherwise, the progress will be discrete and the value will be snapped to the nearest step. +### Methods + + + +## InteractiveProgress.GetValueInStep(int) Method + +Calculate the value with step index. + +```csharp +public float GetValueInStep(int stepIndex); +``` +#### Parameters + + + +`stepIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Events + + + +## InteractiveProgress.ValueChanged Event + +An event triggered when the value of the slider changes. + +```csharp +public event EventHandler<InputEventArgs> ValueChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InteractiveProgress.ValueChangeFinished Event + +An event triggered when the value of the slider stops changing by interactions such as dragging. + +```csharp +public event EventHandler<InputEventArgs> ValueChangeFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InteractiveProgress.ValueChangeStarted Event + +An event triggered when the value of the slider starts to change due to user interactions such as dragging. + +```csharp +public event EventHandler<InputEventArgs> ValueChangeStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgressHelper.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgressHelper.md new file mode 100644 index 0000000000..3b42782698 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgressHelper.md @@ -0,0 +1,183 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## InteractiveProgressHelper Class + +A helper class of interactive progress providing value converting methods. + +```csharp +public static class InteractiveProgressHelper +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 InteractiveProgressHelper +### Methods + + + +## InteractiveProgressHelper.HorizontalLengthToRatio(float, float, float, Rect) Method + +Calulates the ratio after adding given length to the track length in horizontal slider. + +```csharp +public static float HorizontalLengthToRatio(float currentRatio, float deltaX, float width, Tizen.UI.Rect targetBounds); +``` +#### Parameters + + + +`currentRatio` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`deltaX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`targetBounds` Tizen.UI.Rect + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InteractiveProgressHelper.HorizontalPointToRatio(float, float, Rect) Method + +Calulates the ratio of the point to the track length in horizontal slider. + +```csharp +public static float HorizontalPointToRatio(float x, float width, Tizen.UI.Rect targetBounds); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`targetBounds` Tizen.UI.Rect + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InteractiveProgressHelper.VerticalLengthToRatio(float, float, float, Rect) Method + +Calulates the ratio after adding given length to the track length in vertical slider. + +```csharp +public static float VerticalLengthToRatio(float currentRatio, float deltaY, float height, Tizen.UI.Rect targetBounds); +``` +#### Parameters + + + +`currentRatio` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`deltaY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`targetBounds` Tizen.UI.Rect + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InteractiveProgressHelper.VerticalPointToRatio(float, float, Rect) Method + +Calulates the ratio of the point to the track length in vertical slider. + +```csharp +public static float VerticalPointToRatio(float y, float height, Tizen.UI.Rect targetBounds); +``` +#### Parameters + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`targetBounds` Tizen.UI.Rect + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.JsonParser.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.JsonParser.md new file mode 100644 index 0000000000..6d30b51833 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.JsonParser.md @@ -0,0 +1,88 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## JsonParser Class + +JsonParser is a helper class to parse JSON file. + +```csharp +public static class JsonParser +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 JsonParser +### Methods + + + +## JsonParser.ParseUIColor(string) Method + +Parse the JSON file and return the dictionary of Color. + +```csharp +public static System.Collections.Generic.IDictionary<string,Tizen.UI.Color> ParseUIColor(string jsonFilePath); +``` +#### Parameters + + + +`jsonFilePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LabelImpl.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LabelImpl.md new file mode 100644 index 0000000000..5873a6011e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LabelImpl.md @@ -0,0 +1,313 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## LabelImpl Class + +Wrapper class of DALi text label. +Note that this creates a native instance that can be accessed through [Handle](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.Handle 'Tizen.UI.Components.TextBaseImpl.Handle') which you should release manually using [ReleaseNativeHandle](https://docs.microsoft.com/en-us/dotnet/api/ReleaseNativeHandle 'ReleaseNativeHandle'). + +```csharp +public class LabelImpl : Tizen.UI.Components.TextBaseImpl, +Tizen.UI.ITextFormatting +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [TextBaseImpl](Tizen.UI.Components.TextBaseImpl.md 'Tizen.UI.Components.TextBaseImpl') 🡒 LabelImpl + +Implements Tizen.UI.ITextFormatting +### Constructors + + + +## LabelImpl() Constructor + +Construct a new instance. + +```csharp +public LabelImpl(); +``` +### Properties + + + +## LabelImpl.AdjustedFontSize Property + +Gets the adjusted font size after fitting the text by [AutoFontSize](Tizen.UI.Components.LabelImpl.md#Tizen.UI.Components.LabelImpl.AutoFontSize 'Tizen.UI.Components.LabelImpl.AutoFontSize'). + +```csharp +public float AdjustedFontSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LabelImpl.AnchorClickedColor Property + +Gets or sets the color of the anchor text when it is clicked in markup. + +```csharp +public Tizen.UI.Color AnchorClickedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## LabelImpl.AnchorColor Property + +Gets or sets the color of the anchor text in markup. + +```csharp +public Tizen.UI.Color AnchorColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## LabelImpl.AutoFontSize Property + +Gets or sets the auto font size options to fit text in the boundary of label. + +```csharp +public Tizen.UI.AutoFontSize AutoFontSize { get; set; } +``` + +#### Property Value +Tizen.UI.AutoFontSize + +### Remarks +The [FontSize](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.FontSize 'Tizen.UI.Components.TextBaseImpl.FontSize') value will be ignored if this is not [AutoFontSize.None](https://docs.microsoft.com/en-us/dotnet/api/AutoFontSize.None 'AutoFontSize.None'). + + + +## LabelImpl.IsAbsoluteLineHeight Property + +Gets or sets the line height policy. This value will determine how the line height is calculated. +If the value is false, the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is false with value 1.0f. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LabelImpl.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool IsMultiline { get; set; } +``` + +Implements IsMultiline + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LabelImpl.IsTextCutout Property + +Gets or sets whether to enable cutout of the text. + +```csharp +public bool IsTextCutout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LabelImpl.LineBreakMode Property + +Gets or sets the line break mode of the text. + +```csharp +public Tizen.UI.LineBreakMode LineBreakMode { get; set; } +``` + +#### Property Value +Tizen.UI.LineBreakMode + + + +## LabelImpl.LineHeight Property + +Gets or sets the minimum line height. If the value is smaller than the natural line height, the natural line height will be used instead. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +This property is treated differently by the [LineHeightPolicy](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy 'LineHeightPolicy'). If the value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative'), the line height will be calculated as a percentage of the natural line height. Otherwise, it will be calculated as an absolute value. +Default value is [LineHeightPolicy.Relative](https://docs.microsoft.com/en-us/dotnet/api/LineHeightPolicy.Relative 'LineHeightPolicy.Relative') with value 1.0f. +### Methods + + + +## LabelImpl.GetLineCount(float) Method + +Gets the number of lines of text within given width. + +```csharp +public int GetLineCount(float width); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LabelImpl.SetMarqueeGap(float) Method + +Sets the gap before marquee wraps. + +```csharp +public void SetMarqueeGap(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The gap. + + + +## LabelImpl.SetMarqueeLoopCount(int) Method + +Sets the number of complete loops for marquee. + +```csharp +public void SetMarqueeLoopCount(int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of loops. + + + +## LabelImpl.SetMarqueeLoopDelay(float) Method + +Sets the amount of time to delay the starting time of marquee and further loops. + +```csharp +public void SetMarqueeLoopDelay(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The delay time in seconds. + + + +## LabelImpl.SetMarqueeSpeed(int) Method + +Sets the speed of scrolling in pixels per second. + +```csharp +public void SetMarqueeSpeed(int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## LabelImpl.FontSizeAdjusted Event + +Occurs when the font size is adjusted automatically. + +```csharp +public event EventHandler FontSizeAdjusted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LocalizationExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LocalizationExtensions.md new file mode 100644 index 0000000000..1256a2299f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LocalizationExtensions.md @@ -0,0 +1,276 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## LocalizationExtensions Class + +Provides extension methods for the localization. + +```csharp +public static class LocalizationExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LocalizationExtensions +### Methods + + + +## LocalizationExtensions.BindLocalizedAccessibilityDescription<TView>(this TView, string, ResourceManager) Method + +Binds the localized accessibility description of the given [TView](https://docs.microsoft.com/en-us/dotnet/api/TView 'TView') to the specified key. + +```csharp +public static TView BindLocalizedAccessibilityDescription<TView>(this TView view, string key, System.Resources.ResourceManager resourceManager=null) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityDescription_TView_(thisTView,string,System.Resources.ResourceManager).TView 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityDescription<TView>(this TView, string, System.Resources.ResourceManager).TView') + +The view to bind. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized accessibility description. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized accessibility description. + +#### Returns +[TView](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityDescription_TView_(thisTView,string,System.Resources.ResourceManager).TView 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityDescription<TView>(this TView, string, System.Resources.ResourceManager).TView') +The view itself. + + + +## LocalizationExtensions.BindLocalizedAccessibilityName<TView>(this TView, string, ResourceManager) Method + +Binds the localized accessibility name of the given [TView](https://docs.microsoft.com/en-us/dotnet/api/TView 'TView') to the specified key. + +```csharp +public static TView BindLocalizedAccessibilityName<TView>(this TView view, string key, System.Resources.ResourceManager resourceManager=null) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityName_TView_(thisTView,string,System.Resources.ResourceManager).TView 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityName<TView>(this TView, string, System.Resources.ResourceManager).TView') + +The view to bind. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized accessibility name. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized accessibility name. + +#### Returns +[TView](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityName_TView_(thisTView,string,System.Resources.ResourceManager).TView 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedAccessibilityName<TView>(this TView, string, System.Resources.ResourceManager).TView') +The view itself. + + + +## LocalizationExtensions.BindLocalizedPlaceholderText<TText>(this TText, string, ResourceManager) Method + +Binds the localized placeholder text of the given Tizen.UI.ITextEditable to the specified key. + +```csharp +public static TText BindLocalizedPlaceholderText<TText>(this TText view, string key, System.Resources.ResourceManager resourceManager=null) + where TText : class, Tizen.UI.ITextEditable; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedPlaceholderText_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedPlaceholderText<TText>(this TText, string, System.Resources.ResourceManager).TText') + +The text view to bind. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized text. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized text. + +#### Returns +[TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedPlaceholderText_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedPlaceholderText<TText>(this TText, string, System.Resources.ResourceManager).TText') +The text view itself. + + + +## LocalizationExtensions.BindLocalizedSubtitle<TText>(this TText, string, ResourceManager) Method + +Binds the localized subtitle text of the given [IDoubleTitle](Tizen.UI.Components.IDoubleTitle.md 'Tizen.UI.Components.IDoubleTitle') to the specified key. + +```csharp +public static TText BindLocalizedSubtitle<TText>(this TText view, string key, System.Resources.ResourceManager resourceManager=null) + where TText : class, Tizen.UI.Components.IDoubleTitle; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedSubtitle_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedSubtitle<TText>(this TText, string, System.Resources.ResourceManager).TText') + +The text view to bind. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized text. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized text. + +#### Returns +[TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedSubtitle_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedSubtitle<TText>(this TText, string, System.Resources.ResourceManager).TText') +The text view itself. + + + +## LocalizationExtensions.BindLocalizedTitle<TText>(this TText, string, ResourceManager) Method + +Binds the localized title text of the given [ITitle](Tizen.UI.Components.ITitle.md 'Tizen.UI.Components.ITitle') to the specified key. + +```csharp +public static TText BindLocalizedTitle<TText>(this TText view, string key, System.Resources.ResourceManager resourceManager=null) + where TText : class, Tizen.UI.Components.ITitle; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedTitle_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedTitle<TText>(this TText, string, System.Resources.ResourceManager).TText') + +The text view to bind. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized text. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized text. + +#### Returns +[TText](Tizen.UI.Components.LocalizationExtensions.md#Tizen.UI.Components.LocalizationExtensions.BindLocalizedTitle_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.Components.LocalizationExtensions.BindLocalizedTitle<TText>(this TText, string, System.Resources.ResourceManager).TText') +The text view itself. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LottieImageVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LottieImageVisualMap.md new file mode 100644 index 0000000000..4eb249edcd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LottieImageVisualMap.md @@ -0,0 +1,70 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## LottieImageVisualMap Class + +LottieImageVisualMap is a class that represents a property map for the lottie image visual. + +```csharp +public class LottieImageVisualMap : Tizen.UI.Internal.ImageVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Internal.ImageVisualMap 🡒 LottieImageVisualMap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ModalPivot.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ModalPivot.md new file mode 100644 index 0000000000..b92be0940c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ModalPivot.md @@ -0,0 +1,116 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ModalPivot Enum + +Enumeration for the pivot type of modal. + +```csharp +public enum ModalPivot +``` +### Fields + + + +`Bottom` 2 + +Bottom pivot. + + + +`BottomEnd` 10 + +Bottom end pivot. + + + +`BottomStart` 6 + +Bottom start pivot. + + + +`End` 8 + +End pivot. + + + +`Start` 4 + +Start pivot. + + + +`Top` 1 + +Top pivot. + + + +`TopEnd` 9 + +Top end pivot. + + + +`TopStart` 5 + +Top start pivot. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Navigator.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Navigator.md new file mode 100644 index 0000000000..7b2a2757e5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Navigator.md @@ -0,0 +1,615 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Navigator Class + +Navigator is a container class that supports view navigation with the stack data structure. +Navigator manages two types of stacks, navigation stack and modal stack. +The modal stack contains modal views such as dialog. +The navigation stack contains the rest of the views. +The views in the modal stack are above the views in the navigation stack. +Views pushed by the modal methods such as [PushModalAsync(View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View) 'Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View)') are pushed onto the modal stack as modal views. + +```csharp +public class Navigator : Tizen.UI.ContentView, +Tizen.UI.Components.INavigation, +Tizen.UI.Components.INavigationAnimation, +Tizen.UI.Components.INavigateBackHandler, +Tizen.UI.Components.INavigationTransition +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Navigator + +Implements [INavigation](Tizen.UI.Components.INavigation.md 'Tizen.UI.Components.INavigation'), [INavigationAnimation](Tizen.UI.Components.INavigationAnimation.md 'Tizen.UI.Components.INavigationAnimation'), [INavigateBackHandler](Tizen.UI.Components.INavigateBackHandler.md 'Tizen.UI.Components.INavigateBackHandler'), [INavigationTransition](Tizen.UI.Components.INavigationTransition.md 'Tizen.UI.Components.INavigationTransition') +### Constructors + + + +## Navigator() Constructor + +Constructor for the Navigator class. + +```csharp +public Navigator(); +``` +### Properties + + + +## Navigator.CurrentView Property + +Gets the top view from the navigation stack and the modal stack. + +```csharp +public Tizen.UI.View CurrentView { get; } +``` + +#### Property Value +Tizen.UI.View + + + +## Navigator.ModalStack Property + +Gets the list of views pushed onto the modal stack. +[PushModalAsync(View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View) 'Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View)') pushes a view onto the modal stack. +[PopModalAsync()](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PopModalAsync() 'Tizen.UI.Components.Navigator.PopModalAsync()') pops a view off the modal stack. + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.View> ModalStack { get; } +``` + +Implements [ModalStack](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.ModalStack 'Tizen.UI.Components.INavigation.ModalStack') + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Navigator.NavigationStack Property + +Gets the list of views pushed onto the navigation stack. +[PushAsync(View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PushAsync(Tizen.UI.View) 'Tizen.UI.Components.Navigator.PushAsync(Tizen.UI.View)') pushes a view onto the navigation stack. +[InsertBefore(View, View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.InsertBefore(Tizen.UI.View,Tizen.UI.View) 'Tizen.UI.Components.Navigator.InsertBefore(Tizen.UI.View, Tizen.UI.View)') inserts a view to the navigation stack. +[PopAsync()](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PopAsync() 'Tizen.UI.Components.Navigator.PopAsync()') pops a view off the navigation stack. +[Remove(View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.Remove(Tizen.UI.View) 'Tizen.UI.Components.Navigator.Remove(Tizen.UI.View)') removes a view from the navigation stack. + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.View> NavigationStack { get; } +``` + +Implements [NavigationStack](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.NavigationStack 'Tizen.UI.Components.INavigation.NavigationStack') + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Navigator.PopAnimation Property + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopAnimation { get; } +``` + +Implements [PopAnimation](Tizen.UI.Components.INavigationAnimation.md#Tizen.UI.Components.INavigationAnimation.PopAnimation 'Tizen.UI.Components.INavigationAnimation.PopAnimation') + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + + + +## Navigator.PopModalAnimation Property + +Function called for transition animation when INavigation.PopModalAsync is called. +If a view implements this function, Navigator calls the view's function instead of the default transition animation for modal pop. +Function's first parameter View is the view which will appear on the screen. +Function's second parameter View is the view which will disappear on the screen. +Function's return value is the navigation animation controller which supports PlayAsync and Stop. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PopModalAnimation { get; } +``` + +Implements [PopModalAnimation](Tizen.UI.Components.INavigationAnimation.md#Tizen.UI.Components.INavigationAnimation.PopModalAnimation 'Tizen.UI.Components.INavigationAnimation.PopModalAnimation') + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + + + +## Navigator.PushAnimation Property + +Function called for transition animation when INavigation.PushAsync is called. +If a view implements this function, Navigator calls the view's function instead of the default transition animation for navigation push. +Function's first parameter View is the view which will appear on the screen. +Function's second parameter View is the view which will disappear on the screen. +Function's return value is the navigation animation controller which supports PlayAsync and Stop. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushAnimation { get; } +``` + +Implements [PushAnimation](Tizen.UI.Components.INavigationAnimation.md#Tizen.UI.Components.INavigationAnimation.PushAnimation 'Tizen.UI.Components.INavigationAnimation.PushAnimation') + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') + + + +## Navigator.PushModalAnimation Property + +Function called for transition animation when INavigation.PushModalAsync is called. +If a view implements this function, Navigator calls the view's function instead of the default transition animation for modal push. +Function's first parameter View is the view which will appear on the screen. +Function's second parameter View is the view which will disappear on the screen. +Function's return value is the navigation animation controller which supports PlayAsync and Stop. + +```csharp +public System.Func<Tizen.UI.View,Tizen.UI.View,Tizen.UI.Components.INavigationAnimationController> PushModalAnimation { get; } +``` + +Implements [PushModalAnimation](Tizen.UI.Components.INavigationAnimation.md#Tizen.UI.Components.INavigationAnimation.PushModalAnimation 'Tizen.UI.Components.INavigationAnimation.PushModalAnimation') + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') +### Methods + + + +## Navigator.DidAppear(bool) Method + +Called right after appearing by navigation transition. + +```csharp +public virtual void DidAppear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + +Implements [DidAppear(bool)](Tizen.UI.Components.INavigationTransition.md#Tizen.UI.Components.INavigationTransition.DidAppear(bool) 'Tizen.UI.Components.INavigationTransition.DidAppear(bool)') + + + +## Navigator.DidDisappear(bool) Method + +Called right after disappearing by navigation transition. + +```csharp +public virtual void DidDisappear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + +Implements [DidDisappear(bool)](Tizen.UI.Components.INavigationTransition.md#Tizen.UI.Components.INavigationTransition.DidDisappear(bool) 'Tizen.UI.Components.INavigationTransition.DidDisappear(bool)') + +### Remarks +A view disappeared by pop navigation can be disposed if the view is not used anymore. + + + +## Navigator.InsertBefore(View, View) Method + +Inserts a view to the navigation stack right before the given view `before`. + +```csharp +public void InsertBefore(Tizen.UI.View view, Tizen.UI.View before); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be inserted to the navigation stack right before the given view `before`. + + + +`before` Tizen.UI.View + +The view existing in the navigation stack and will be the next view of the inserted view. + +Implements [InsertBefore(View, View)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.InsertBefore(Tizen.UI.View,Tizen.UI.View) 'Tizen.UI.Components.INavigation.InsertBefore(Tizen.UI.View, Tizen.UI.View)') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `view` is null. + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `before` is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown if `before` does not exist in the navigation stack. + + + +## Navigator.NavigateBack() Method + +Navigate back to the previous view. + +```csharp +public bool NavigateBack(); +``` + +Implements [NavigateBack()](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.NavigateBack() 'Tizen.UI.Components.INavigation.NavigateBack()') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the navigation back was handled, otherwise false. + + + +## Navigator.PopAsync() Method + +Pops the top view off the navigation stack. +After this method is finished, the previous top view in the navigation stack becomes visible. + +```csharp +public System.Threading.Tasks.Task<Tizen.UI.View> PopAsync(); +``` + +Implements [PopAsync()](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PopAsync() 'Tizen.UI.Components.INavigation.PopAsync()') + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The view popped off the navigation stack. + +#### Exceptions + +[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException') +Thrown if there is no view in the navigation stack. + + + +## Navigator.PopAsync(bool) Method + +Pops the top view off the navigation stack with or without the transition animation. +After this method is finished, the previous top view in the navigation stack becomes visible. + +```csharp +public System.Threading.Tasks.Task<Tizen.UI.View> PopAsync(bool animated); +``` +#### Parameters + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +Implements [PopAsync(bool)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PopAsync(bool) 'Tizen.UI.Components.INavigation.PopAsync(bool)') + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The view popped off the navigation stack. + +#### Exceptions + +[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException') +Thrown if there is no view in the navigation stack. + + + +## Navigator.PopModalAsync() Method + +Pops the top modal view such as dialog off the modal stack. + +```csharp +public System.Threading.Tasks.Task<Tizen.UI.View> PopModalAsync(); +``` + +Implements [PopModalAsync()](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PopModalAsync() 'Tizen.UI.Components.INavigation.PopModalAsync()') + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The modal view popped off the modal stack. + +#### Exceptions + +[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException') +Thrown if there is no view in the modal stack. + + + +## Navigator.PopModalAsync(bool) Method + +Pops the top modal view such as dialog off the modal stack with or without the transition animation. + +```csharp +public System.Threading.Tasks.Task<Tizen.UI.View> PopModalAsync(bool animated); +``` +#### Parameters + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +Implements [PopModalAsync(bool)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PopModalAsync(bool) 'Tizen.UI.Components.INavigation.PopModalAsync(bool)') + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +The modal view popped off the modal stack. + +#### Exceptions + +[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException') +Thrown if there is no view in the modal stack. + + + +## Navigator.PushAsync(View) Method + +Pushes a view onto the navigation stack. +After this method is finished, the previous top view in the navigation stack becomes invisible. +If the view exists in the navigation stack already, then it is not pushed. + +```csharp +public System.Threading.Tasks.Task PushAsync(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the navigation stack. + +Implements [PushAsync(View)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PushAsync(Tizen.UI.View) 'Tizen.UI.Components.INavigation.PushAsync(Tizen.UI.View)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `view` is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown if `view` already exists in the navigation stack. + + + +## Navigator.PushAsync(View, bool) Method + +Pushes a view onto the navigation stack with or without the transition animation. +After this method is finished, the previous top view in the navigation stack becomes invisible. +If the view exists in the navigation stack already, then it is not pushed. + +```csharp +public System.Threading.Tasks.Task PushAsync(Tizen.UI.View view, bool animated); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the navigation stack. + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +Implements [PushAsync(View, bool)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PushAsync(Tizen.UI.View,bool) 'Tizen.UI.Components.INavigation.PushAsync(Tizen.UI.View, bool)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `view` is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown if `view` already exists in the modal stack. + + + +## Navigator.PushModalAsync(View) Method + +Pushes a modal view such as dialog onto the modal stack. +If the view exists in the modal stack already, then it is not pushed. + +```csharp +public System.Threading.Tasks.Task PushModalAsync(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the modal stack. + +Implements [PushModalAsync(View)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PushModalAsync(Tizen.UI.View) 'Tizen.UI.Components.INavigation.PushModalAsync(Tizen.UI.View)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `view` is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown if `view` already exists in the modal stack. + + + +## Navigator.PushModalAsync(View, bool) Method + +Pushes a modal view such as dialog onto the modal stack with or without the transition animation. +If the view exists in the modal stack already, then it is not pushed. + +```csharp +public System.Threading.Tasks.Task PushModalAsync(Tizen.UI.View view, bool animated); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be pushed onto the modal stack. + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to play the transition animation during navigation. + +Implements [PushModalAsync(View, bool)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.PushModalAsync(Tizen.UI.View,bool) 'Tizen.UI.Components.INavigation.PushModalAsync(Tizen.UI.View, bool)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if `view` is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown if `view` already exists in the navigation stack. + + + +## Navigator.Remove(View) Method + +Removes the specified view from the navigation stack or modal stack. + +```csharp +public void Remove(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to be removed from the navigation stack or modal stack. + +Implements [Remove(View)](Tizen.UI.Components.INavigation.md#Tizen.UI.Components.INavigation.Remove(Tizen.UI.View) 'Tizen.UI.Components.INavigation.Remove(Tizen.UI.View)'), Remove(View)') + + + +## Navigator.WillAppear(bool) Method + +Called right before appearing by navigation transition. + +```csharp +public virtual void WillAppear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + +Implements [WillAppear(bool)](Tizen.UI.Components.INavigationTransition.md#Tizen.UI.Components.INavigationTransition.WillAppear(bool) 'Tizen.UI.Components.INavigationTransition.WillAppear(bool)') + + + +## Navigator.WillDisappear(bool) Method + +Called right before disappearing by navigation transition. + +```csharp +public virtual void WillDisappear(bool byPopNavigation); +``` +#### Parameters + + + +`byPopNavigation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, it is called by pop navigation. + +Implements [WillDisappear(bool)](Tizen.UI.Components.INavigationTransition.md#Tizen.UI.Components.INavigationTransition.WillDisappear(bool) 'Tizen.UI.Components.INavigationTransition.WillDisappear(bool)') +### Explicit Interface Implementations + + + +## Navigator.Tizen.UI.Components.INavigateBackHandler.HandleNavigateBack() Method + +Handles navigating back. +If navigating back is not consumed, then the Navigation object of this object will handle navigating back instead. + +```csharp +bool Tizen.UI.Components.INavigateBackHandler.HandleNavigateBack(); +``` + +Implements [HandleNavigateBack()](Tizen.UI.Components.INavigateBackHandler.md#Tizen.UI.Components.INavigateBackHandler.HandleNavigateBack() 'Tizen.UI.Components.INavigateBackHandler.HandleNavigateBack()') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OffScreenRenderingMode.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OffScreenRenderingMode.md new file mode 100644 index 0000000000..9fb50b85b4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OffScreenRenderingMode.md @@ -0,0 +1,92 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## OffScreenRenderingMode Enum + +Enumeration for the mode of offscreen rendering. + +```csharp +public enum OffScreenRenderingMode +``` +### Fields + + + +`Auto` 3 + +Controlled by framework. + + + +`None` 0 + +No offscreen rendering. + + + +`RefreshAlways` 2 + +Draw offscreen every frame. + + + +`RefreshOnce` 1 + +Draw offscreen only once. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OverScrollMode.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OverScrollMode.md new file mode 100644 index 0000000000..0aa033c104 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OverScrollMode.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## OverScrollMode Enum + +Mode of action over scroll after edge reached. + +```csharp +public enum OverScrollMode +``` +### Fields + + + +`Always` 1 + +Always over scroll at the edge. + + + +`ContentScrolls` 2 + +Over scroll when content can scrollable. + + + +`Never` 0 + +Never over scroll at the edge. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Palette.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Palette.md new file mode 100644 index 0000000000..59bbc5d86d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Palette.md @@ -0,0 +1,311 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Palette Class + +A class that extracts prominent colors from an image. + +This is a helper class to extract colors from a Tizen.UI.PixelBuffer +It can generate a number of selected color swatches based on the image. + +```csharp +public class Palette +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Palette +### Properties + + + +## Palette.DarkMuted Property + +Gets a dark muted swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch DarkMuted { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.DarkVibrant Property + +Gets a dark vibrant swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch DarkVibrant { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.Dominant Property + +Gets the dominant swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch Dominant { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.LightMuted Property + +Gets a light muted swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch LightMuted { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.LightVibrant Property + +Gets a light vibrant swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch LightVibrant { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.Muted Property + +Gets a muted swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch Muted { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') + + + +## Palette.Swatches Property + +Gets all of the swatches (colors) extracted from the image. + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Components.Swatch> Swatches { get; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + +## Palette.Vibrant Property + +Gets a vibrant swatch from the image. + +```csharp +public Tizen.UI.Components.Swatch Vibrant { get; } +``` + +#### Property Value +[Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') +### Methods + + + +## Palette.Generate(PixelBuffer) Method + +Synchronously generates a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') from the given Tizen.UI.PixelBuffer. + +```csharp +public static Tizen.UI.Components.Palette Generate(Tizen.UI.PixelBuffer buffer); +``` +#### Parameters + + + +`buffer` Tizen.UI.PixelBuffer + +The Tizen.UI.PixelBuffer to generate the palette from. + +#### Returns +[Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') +The generated [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette'). + + + +## Palette.Generate(PixelBuffer, float, float, float, float) Method + +Synchronously generates a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') from a specific region of the given Tizen.UI.PixelBuffer. + +```csharp +public static Tizen.UI.Components.Palette Generate(Tizen.UI.PixelBuffer buffer, float regionX, float regionY, float regionWidth, float regionHeight); +``` +#### Parameters + + + +`buffer` Tizen.UI.PixelBuffer + +The Tizen.UI.PixelBuffer to generate the palette from. + + + +`regionX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the top-left corner of the region. + + + +`regionY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the top-left corner of the region. + + + +`regionWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the region. + + + +`regionHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the region. + +#### Returns +[Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') +The generated [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette'). + + + +## Palette.GenerateAsync(PixelBuffer) Method + +Asynchronously generates a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') from the given Tizen.UI.PixelBuffer. + +```csharp +public static System.Threading.Tasks.Task<Tizen.UI.Components.Palette> GenerateAsync(Tizen.UI.PixelBuffer buffer); +``` +#### Parameters + + + +`buffer` Tizen.UI.PixelBuffer + +The Tizen.UI.PixelBuffer to generate the palette from. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +A task that represents the asynchronous generation operation. The task result contains the generated [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette'). + + + +## Palette.GenerateAsync(PixelBuffer, float, float, float, float) Method + +Asynchronously generates a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') from the given Tizen.UI.PixelBuffer. + +```csharp +public static System.Threading.Tasks.Task<Tizen.UI.Components.Palette> GenerateAsync(Tizen.UI.PixelBuffer buffer, float regionX, float regionY, float regionWidth, float regionHeight); +``` +#### Parameters + + + +`buffer` Tizen.UI.PixelBuffer + +The Tizen.UI.PixelBuffer to generate the palette from. + + + +`regionX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the top-left corner of the region. + + + +`regionY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the top-left corner of the region. + + + +`regionWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the region. + + + +`regionHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the region. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +A task that represents the asynchronous generation operation. The task result contains the generated [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette'). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Pressable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Pressable.md new file mode 100644 index 0000000000..be8e32b45b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Pressable.md @@ -0,0 +1,167 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Pressable Class + +Pressable is a base class for components that can be pressed. +It provides [PressedChanged](Tizen.UI.Components.Pressable.md#Tizen.UI.Components.Pressable.PressedChanged 'Tizen.UI.Components.Pressable.PressedChanged') event. + +```csharp +public class Pressable : Tizen.UI.ContentView, +Tizen.UI.Components.IPressable, +Tizen.UI.Components.ITouchEffectTarget +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Pressable + +Derived +↳ [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') +↳ [InteractiveProgress](Tizen.UI.Components.InteractiveProgress.md 'Tizen.UI.Components.InteractiveProgress') +↳ [PressableBox](Tizen.UI.Components.PressableBox.md 'Tizen.UI.Components.PressableBox') + +Implements [IPressable](Tizen.UI.Components.IPressable.md 'Tizen.UI.Components.IPressable'), [ITouchEffectTarget](Tizen.UI.Components.ITouchEffectTarget.md 'Tizen.UI.Components.ITouchEffectTarget') +### Constructors + + + +## Pressable() Constructor + +Create an instance of Component. + +```csharp +public Pressable(); +``` +### Properties + + + +## Pressable.IsPressed Property + +The boolean flag for pressed state. + +```csharp +public bool IsPressed { get; set; } +``` + +Implements [IsPressed](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.IsPressed 'Tizen.UI.Components.IPressable.IsPressed') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Pressable.PressedChangedCommand Property + +PressedChanged command. see [PressedChanged](Tizen.UI.Components.Pressable.md#Tizen.UI.Components.Pressable.PressedChanged 'Tizen.UI.Components.Pressable.PressedChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.InputEventArgs> PressedChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') +### Methods + + + +## Pressable.GetTouchEffectSecondaryTarget() Method + +Get the secondary target view to apply feedback. + +```csharp +public virtual Tizen.UI.View GetTouchEffectSecondaryTarget(); +``` + +Implements [GetTouchEffectSecondaryTarget()](Tizen.UI.Components.ITouchEffectTarget.md#Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectSecondaryTarget() 'Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectSecondaryTarget()') + +#### Returns +Tizen.UI.View + + + +## Pressable.GetTouchEffectTarget() Method + +Get the target view to apply feedback. + +```csharp +public virtual Tizen.UI.View GetTouchEffectTarget(); +``` + +Implements [GetTouchEffectTarget()](Tizen.UI.Components.ITouchEffectTarget.md#Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectTarget() 'Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectTarget()') + +#### Returns +Tizen.UI.View +### Events + + + +## Pressable.PressedChanged Event + +The event that is called when the value of [IsPressed](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.IsPressed 'Tizen.UI.Components.IPressable.IsPressed') changes. + +```csharp +public event EventHandler<InputEventArgs> PressedChanged; +``` + +Implements [PressedChanged](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.PressedChanged 'Tizen.UI.Components.IPressable.PressedChanged') + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PressableBox.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PressableBox.md new file mode 100644 index 0000000000..e85ae69183 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PressableBox.md @@ -0,0 +1,307 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## PressableBox Class + +Pressable component with a content. + +```csharp +public abstract class PressableBox : Tizen.UI.Components.Pressable, +Tizen.UI.Components.ILayoutBox, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 PressableBox + +Implements [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## PressableBox.Children Property + +Children of the layout box. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +Implements [Children](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Children 'Tizen.UI.Components.ILayoutBox.Children') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## PressableBox.Count Property + +Gets the number of elements contained in the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PressableBox.IsReadOnly Property + +Gets a value indicating whether the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## PressableBox.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public abstract Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## PressableBox.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +Tizen.UI.View +### Methods + + + +## PressableBox.Clear() Method + +Clears all children. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## PressableBox.Contains(View) Method + +Whether it contains the specified child. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## PressableBox.CopyTo(View[], int) Method + +Copies the children to an array. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` Tizen.UI.View[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PressableBox.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## PressableBox.Insert(int, View) Method + +(Not implemented) Inserts the specified content at the specified index. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`item` Tizen.UI.View + + + +## PressableBox.RemoveAt(int) Method + +Removes the content at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## PressableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Add(View) Method + +Adds a child view. + +```csharp +void System.Collections.Generic.ICollection<Tizen.UI.View>.Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Add(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## PressableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(View) Method + +Removes the specified content from the layout box. + +```csharp +bool System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Remove(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## PressableBox.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Progress.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Progress.md new file mode 100644 index 0000000000..0244ec29b7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Progress.md @@ -0,0 +1,171 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Progress Class + +A progress component that indicates a specific value from a continuous or discrete range of values. + +```csharp +public class Progress : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 Progress +### Constructors + + + +## Progress(float, float) Constructor + +Constructs a new progress. + +```csharp +public Progress(float minimumValue, float maximumValue); +``` +#### Parameters + + + +`minimumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`maximumValue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Properties + + + +## Progress.IsDeterminate Property + +Indicates whether the progress bar shows determinate or indeterminate state. Default is true. + +```csharp +public bool IsDeterminate { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Progress.Range Property + +The range of values. + +```csharp +public Tizen.UI.Components.ClosedRange<float> Range { get; set; } +``` + +#### Property Value +[Tizen.UI.Components.ClosedRange<](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>') + +#### Exceptions + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when the maximum is less than or equal to the minimum. + +### Remarks +The [Value](Tizen.UI.Components.Progress.md#Tizen.UI.Components.Progress.Value 'Tizen.UI.Components.Progress.Value') will be coerced to the range when the range changes. + + + +## Progress.Value Property + +The current value. + +```csharp +public float Value { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The [Value](Tizen.UI.Components.Progress.md#Tizen.UI.Components.Progress.Value 'Tizen.UI.Components.Progress.Value') will be coerced to the range. + + + +## Progress.ValueStepCount Property + +The number of segments to divide the range into. + +```csharp +public int ValueStepCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +If the value is less than equals to zero, the progress will be continuous. Otherwise, the progress will be discrete and the value will be snapped to the nearest step. +### Events + + + +## Progress.ValueChanged Event + +An event triggered when the value of the slider changes. + +```csharp +public event EventHandler ValueChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PropertySetter_TView,TValue_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PropertySetter_TView,TValue_.md new file mode 100644 index 0000000000..644b1ee281 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PropertySetter_TView,TValue_.md @@ -0,0 +1,121 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## PropertySetter<TView,TValue> Class + +Describes a property setter. + +```csharp +public class PropertySetter<TView,TValue> : +Tizen.UI.Components.IPropertySetter<TValue> +``` +#### Type parameters + + + +`TView` + + + +`TValue` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PropertySetter<TView,TValue> + +Implements [Tizen.UI.Components.IPropertySetter<](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>')[TValue](Tizen.UI.Components.PropertySetter_TView,TValue_.md#Tizen.UI.Components.PropertySetter_TView,TValue_.TValue 'Tizen.UI.Components.PropertySetter<TView,TValue>.TValue')[>](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>') +### Constructors + + + +## PropertySetter(string, Action<TView,TValue>) Constructor + +Creates an instance of the PropertySetter class. + +```csharp +public PropertySetter(string name, System.Action<TView,TValue> setter); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.PropertySetter_TView,TValue_.md#Tizen.UI.Components.PropertySetter_TView,TValue_.TView 'Tizen.UI.Components.PropertySetter<TView,TValue>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TValue](Tizen.UI.Components.PropertySetter_TView,TValue_.md#Tizen.UI.Components.PropertySetter_TView,TValue_.TValue 'Tizen.UI.Components.PropertySetter<TView,TValue>.TValue')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The action to set the property. +### Properties + + + +## PropertySetter<TView,TValue>.Name Property + +The name of the property. + +```csharp +public string Name { get; } +``` + +Implements [Name](Tizen.UI.Components.IPropertySetter_TValue_.md#Tizen.UI.Components.IPropertySetter_TValue_.Name 'Tizen.UI.Components.IPropertySetter<TValue>.Name') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.RecoilEffect.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.RecoilEffect.md new file mode 100644 index 0000000000..ab02ef48ac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.RecoilEffect.md @@ -0,0 +1,264 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## RecoilEffect Class + +Recoil visaul feedback that makes view dimmed and scaled. + +```csharp +public class RecoilEffect : Tizen.UI.Components.UIAttachable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') 🡒 RecoilEffect + +### Remarks +It will make overlay dim to target view or to [GetTouchEffectTarget()](Tizen.UI.Components.ITouchEffectTarget.md#Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectTarget() 'Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectTarget()') if the target implemented it. +You can change scaling target by implementing [GetTouchEffectSecondaryTarget()](Tizen.UI.Components.ITouchEffectTarget.md#Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectSecondaryTarget() 'Tizen.UI.Components.ITouchEffectTarget.GetTouchEffectSecondaryTarget()') to target view. +### Constructors + + + +## RecoilEffect() Constructor + +Default constructor. Sets default values for the feedback. + +```csharp +public RecoilEffect(); +``` +### Fields + + + +## RecoilEffect.Basic Field + +Basic recoil feedback with default values. Use this if you don't need to customize the feedback. +This follows the target view's corner shape. + +```csharp +public static readonly RecoilEffect Basic; +``` + +#### Field Value +[RecoilEffect](Tizen.UI.Components.RecoilEffect.md 'Tizen.UI.Components.RecoilEffect') + + + +## RecoilEffect.Circle Field + +Circular shape of recoil feedback with default values. + +```csharp +public static readonly RecoilEffect Circle; +``` + +#### Field Value +[RecoilEffect](Tizen.UI.Components.RecoilEffect.md 'Tizen.UI.Components.RecoilEffect') + + + +## RecoilEffect.List Field + +Recoil feedback for list items. + +```csharp +public static readonly RecoilEffect List; +``` + +#### Field Value +[RecoilEffect](Tizen.UI.Components.RecoilEffect.md 'Tizen.UI.Components.RecoilEffect') +### Properties + + + +## RecoilEffect.CornerRadius Property + +The corner radius value for the overlay used when [InheritCornerRadius](Tizen.UI.Components.RecoilEffect.md#Tizen.UI.Components.RecoilEffect.InheritCornerRadius 'Tizen.UI.Components.RecoilEffect.InheritCornerRadius') is false. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## RecoilEffect.InheritCornerRadius Property + +Determines whether the recoil overlay's corner radius should inherit the value from its target. +The default is true. + +```csharp +public bool InheritCornerRadius { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecoilEffect.OffsetFactorX Property + +The offset length from the original length of the target box in x direction. +The destination scale value will be calculated by adding this value to the original size of the target box. +scale = (targetWidth + OffsetFactorX) / targetWidth * ScaleFactorX. + +```csharp +public float OffsetFactorX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecoilEffect.OverlayColor Property + +```csharp +public Tizen.UI.Color OverlayColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## RecoilEffect.OverlayPadding Property + +The scale factor in vertical used when scaling overlay view. + +```csharp +public Tizen.UI.Thickness OverlayPadding { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## RecoilEffect.OverlayScaleFactorX Property + +The scale factor in horizontal used when scaling overlay view. + +```csharp +public float OverlayScaleFactorX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecoilEffect.OverlayScaleFactorY Property + +The scale factor in vertical used when scaling overlay view. + +```csharp +public float OverlayScaleFactorY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecoilEffect.ScaleFactorX Property + +The scale factor used when calculating the destination scale value in x direction. +scale = (targetWidth + Offset) / targetWidth * ScaleFactorX. + +```csharp +public float ScaleFactorX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## RecoilEffect.OnAttached(View) Method + +Called when this object is attached to the view. + +```csharp +public override void OnAttached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +## RecoilEffect.OnDetached(View) Method + +Called when this object is detached from the view. + +```csharp +public override void OnDetached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.Adapter.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.Adapter.md new file mode 100644 index 0000000000..eca8be72a6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.Adapter.md @@ -0,0 +1,292 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## Adapter Class + +Adapter provide a binding from an app-specific data set to views that +are displayed within a [RecyclerView](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.RecyclerView 'Tizen.UI.Components.Recycler.Adapter.RecyclerView'). + +```csharp +public abstract class Adapter : +System.Collections.Specialized.INotifyCollectionChanged +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Adapter + +Derived +↳ [ItemTemplateAdapter](Tizen.UI.Components.Recycler.ItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.ItemTemplateAdapter') + +Implements [System.Collections.Specialized.INotifyCollectionChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.INotifyCollectionChanged 'System.Collections.Specialized.INotifyCollectionChanged') +### Properties + + + +## Adapter.ItemCount Property + +The count of items in the data source. + +```csharp +public abstract int ItemCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Adapter.RecyclerView Property + +The recyclerView for adapter. + +```csharp +public Tizen.UI.Components.Recycler.RecyclerView RecyclerView { get; set; } +``` + +#### Property Value +[RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Methods + + + +## Adapter.BindViewHolder(ViewHolder, int) Method + +Called by RecyclerView to display the data at the specified position. +This method should update the contents of the [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +to reflect the item at the given position + +```csharp +public void BindViewHolder(Tizen.UI.Components.Recycler.ViewHolder holder, int position); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The view holder to bind. + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of data. + + + +## Adapter.CreateViewHolder(int) Method + +Called when RecyclerView needs a new [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') of the given type to represent an item. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder CreateViewHolder(int viewType); +``` +#### Parameters + + + +`viewType` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The type of the view. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + +## Adapter.GetItemOnPosition(int) Method + +Get item object from position. + +```csharp +public abstract object GetItemOnPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +The item object. + + + +## Adapter.GetItemViewType(int) Method + +Get the type of View that will be created by [OnCreateViewHolder(int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int) 'Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int)') for the specified item. + +```csharp +public virtual int GetItemViewType(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item within the adapter's data set + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Adapter.GetViewPosition(View) Method + +Get the position for the view. + +```csharp +public virtual int GetViewPosition(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to get the position. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Adapter.IsSticky(int) Method + +Called when RecyclerView need to determine whether the item is sticky or not. +If it returns true, the item will be sticked. Otherwise, it will not be sticked. + +```csharp +public virtual bool IsSticky(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of data. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Adapter.OnBindViewHolder(ViewHolder, int) Method + +Called when [BindViewHolder(ViewHolder, int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.BindViewHolder(Tizen.UI.Components.Recycler.ViewHolder,int) 'Tizen.UI.Components.Recycler.Adapter.BindViewHolder(Tizen.UI.Components.Recycler.ViewHolder, int)') binds [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder'). +Derivated class must implement this method to bind viewholder. + +```csharp +public abstract void OnBindViewHolder(Tizen.UI.Components.Recycler.ViewHolder holder, int position); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The view holder to bind. + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of data. + + + +## Adapter.OnCreateViewHolder(int) Method + +Called when [CreateViewHolder(int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.CreateViewHolder(int) 'Tizen.UI.Components.Recycler.Adapter.CreateViewHolder(int)') creates [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder'). +Derivated class must implement this method to create viewholder. + +```csharp +public abstract Tizen.UI.Components.Recycler.ViewHolder OnCreateViewHolder(int viewType); +``` +#### Parameters + + + +`viewType` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The type of the view. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +### Events + + + +## Adapter.CollectionChanged Event + +The event that invoked when the collection changes. + +```csharp +public event NotifyCollectionChangedEventHandler CollectionChanged; +``` + +Implements [CollectionChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged 'System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged') + +#### Event Type +[System.Collections.Specialized.NotifyCollectionChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.NotifyCollectionChangedEventHandler 'System.Collections.Specialized.NotifyCollectionChangedEventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md new file mode 100644 index 0000000000..126c6b462d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md @@ -0,0 +1,120 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## AnimationFinishedEventArgs Class + +Event arguments for when an animation completes. + +```csharp +public class AnimationFinishedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AnimationFinishedEventArgs +### Constructors + + + +## AnimationFinishedEventArgs(ViewHolder, AnimationType) Constructor + +Constructor. + +```csharp +public AnimationFinishedEventArgs(Tizen.UI.Components.Recycler.ViewHolder viewHolder, Tizen.UI.Components.Recycler.AnimationType animationType); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder + + + +`animationType` [AnimationType](Tizen.UI.Components.Recycler.AnimationType.md 'Tizen.UI.Components.Recycler.AnimationType') + +Types of animations +### Properties + + + +## AnimationFinishedEventArgs.AnimationType Property + +The type of animation that was performed. + +```csharp +public Tizen.UI.Components.Recycler.AnimationType AnimationType { get; } +``` + +#### Property Value +[AnimationType](Tizen.UI.Components.Recycler.AnimationType.md 'Tizen.UI.Components.Recycler.AnimationType') + + + +## AnimationFinishedEventArgs.ViewHolder Property + +The view holder that the animation was performed on. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder ViewHolder { get; } +``` + +#### Property Value +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationType.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationType.md new file mode 100644 index 0000000000..776df03aed --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationType.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## AnimationType Enum + +Types of animations. + +```csharp +public enum AnimationType +``` +### Fields + + + +`Add` 0 + +Add animation. + + + +`Change` 3 + +Change animation. + + + +`Move` 2 + +Move animation. + + + +`Remove` 1 + +Remove animation. + + + +`Reset` 4 + +Reset animation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.DefaultItemAnimator.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.DefaultItemAnimator.md new file mode 100644 index 0000000000..7866b59b8a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.DefaultItemAnimator.md @@ -0,0 +1,317 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## DefaultItemAnimator Class + +Default implementation of IItemAnimator. + +```csharp +public class DefaultItemAnimator : +Tizen.UI.Components.Recycler.IItemAnimator +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DefaultItemAnimator + +Implements [IItemAnimator](Tizen.UI.Components.Recycler.IItemAnimator.md 'Tizen.UI.Components.Recycler.IItemAnimator') +### Properties + + + +## DefaultItemAnimator.RecyclerView Property + +The RecyclerView instance that owns this ItemAnimator. Required for recycling views. + +```csharp +public Tizen.UI.Components.Recycler.RecyclerView RecyclerView { get; set; } +``` + +Implements [RecyclerView](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.RecyclerView 'Tizen.UI.Components.Recycler.IItemAnimator.RecyclerView') + +#### Property Value +[RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Methods + + + +## DefaultItemAnimator.AnimateAdd(ViewHolder) Method + +Called when a ViewHolder is about to be added. + +```csharp +public bool AnimateAdd(Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being added. + +Implements [AnimateAdd(ViewHolder)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.AnimateAdd(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IItemAnimator.AnimateAdd(Tizen.UI.Components.Recycler.ViewHolder)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## DefaultItemAnimator.AnimateChange(ViewHolder, ViewHolder, float, float, float, float) Method + +Called when a ViewHolder is about to be changed (e.g., content updated, size changed). + +```csharp +public bool AnimateChange(Tizen.UI.Components.Recycler.ViewHolder oldHolder, Tizen.UI.Components.Recycler.ViewHolder newHolder, float fromX, float fromY, float toX, float toY); +``` +#### Parameters + + + +`oldHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder before the change. + + + +`newHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder after the change (can be the same as oldHolder). + + + +`fromX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start X position. + + + +`fromY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start Y position. + + + +`toX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End X position. + + + +`toY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End Y position. + +Implements [AnimateChange(ViewHolder, ViewHolder, float, float, float, float)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.AnimateChange(Tizen.UI.Components.Recycler.ViewHolder,Tizen.UI.Components.Recycler.ViewHolder,float,float,float,float) 'Tizen.UI.Components.Recycler.IItemAnimator.AnimateChange(Tizen.UI.Components.Recycler.ViewHolder, Tizen.UI.Components.Recycler.ViewHolder, float, float, float, float)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## DefaultItemAnimator.AnimateMove(ViewHolder, float, float, float, float) Method + +Called when a ViewHolder is about to be moved. + +```csharp +public bool AnimateMove(Tizen.UI.Components.Recycler.ViewHolder holder, float fromX, float fromY, float toX, float toY); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being moved. + + + +`fromX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start X position. + + + +`fromY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start Y position. + + + +`toX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End X position. + + + +`toY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End Y position. + +Implements [AnimateMove(ViewHolder, float, float, float, float)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.AnimateMove(Tizen.UI.Components.Recycler.ViewHolder,float,float,float,float) 'Tizen.UI.Components.Recycler.IItemAnimator.AnimateMove(Tizen.UI.Components.Recycler.ViewHolder, float, float, float, float)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## DefaultItemAnimator.AnimateRemove(ViewHolder) Method + +Called when a ViewHolder is about to be removed. + +```csharp +public bool AnimateRemove(Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being removed. + +Implements [AnimateRemove(ViewHolder)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.AnimateRemove(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IItemAnimator.AnimateRemove(Tizen.UI.Components.Recycler.ViewHolder)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## DefaultItemAnimator.EndAnimation(ViewHolder) Method + +Ends the animation for a specific ViewHolder. + +```csharp +public void EndAnimation(Tizen.UI.Components.Recycler.ViewHolder item); +``` +#### Parameters + + + +`item` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder whose animation should be ended. + +Implements [EndAnimation(ViewHolder)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.EndAnimation(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IItemAnimator.EndAnimation(Tizen.UI.Components.Recycler.ViewHolder)') + + + +## DefaultItemAnimator.EndAnimations() Method + +Ends all current animations. + +```csharp +public void EndAnimations(); +``` + +Implements [EndAnimations()](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.EndAnimations() 'Tizen.UI.Components.Recycler.IItemAnimator.EndAnimations()') + + + +## DefaultItemAnimator.IsRunning(ViewHolder) Method + +Checks if any animation is running for a specific ViewHolder. + +```csharp +public bool IsRunning(Tizen.UI.Components.Recycler.ViewHolder item); +``` +#### Parameters + + + +`item` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder to check. + +Implements [IsRunning(ViewHolder)](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.IsRunning(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IItemAnimator.IsRunning(Tizen.UI.Components.Recycler.ViewHolder)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if an animation is active for the item, false otherwise. + + + +## DefaultItemAnimator.RunPendingAnimations() Method + +Runs all pending animations. + +```csharp +public void RunPendingAnimations(); +``` + +Implements [RunPendingAnimations()](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.RunPendingAnimations() 'Tizen.UI.Components.Recycler.IItemAnimator.RunPendingAnimations()') +### Events + + + +## DefaultItemAnimator.AnimationFinished Event + +Event raised when an animation has finished. Useful for cleaning up resources. + +```csharp +public event EventHandler<AnimationFinishedEventArgs> AnimationFinished; +``` + +Implements [AnimationFinished](Tizen.UI.Components.Recycler.IItemAnimator.md#Tizen.UI.Components.Recycler.IItemAnimator.AnimationFinished 'Tizen.UI.Components.Recycler.IItemAnimator.AnimationFinished') + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[AnimationFinishedEventArgs](Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md 'Tizen.UI.Components.Recycler.AnimationFinishedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md new file mode 100644 index 0000000000..cd6913c779 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ExclusiveSelectionModelGroup<T> Class + +An abstract class for the observable group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). +The group can only have one selected children exclusively. + +```csharp +public abstract class ExclusiveSelectionModelGroup<T> : System.Collections.ObjectModel.ObservableCollection<T> + where T : Tizen.UI.Components.Recycler.ISelectableModel +``` +#### Type parameters + + + +`T` + +The child object who implements ISelectableModel + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Collections.ObjectModel.Collection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1')[T](Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1') 🡒 [System.Collections.ObjectModel.ObservableCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1')[T](Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1') 🡒 ExclusiveSelectionModelGroup<T> +### Properties + + + +## ExclusiveSelectionModelGroup<T>.IsSelectable Property + +Boolean value for whether this group is selectable or not. +The value only propagates to the children when it set. +so even though, all children are selectable, group selectable still can be false. +default value is true. + +```csharp +public bool IsSelectable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ExclusiveSelectionModelGroup<T>.Selected Property + +The selected child. +When the selected child changed, previous selected child will be deselected. + +```csharp +public T Selected { get; set; } +``` + +#### Property Value +[T](Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup<T>.T') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GridLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GridLayoutManager.md new file mode 100644 index 0000000000..0c3a59130a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GridLayoutManager.md @@ -0,0 +1,488 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## GridLayoutManager Class + +Grid layout manager for grid view. + +```csharp +public class GridLayoutManager : Tizen.UI.Components.Recycler.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Components.Recycler.LayoutManager.md 'Tizen.UI.Components.Recycler.LayoutManager') 🡒 GridLayoutManager +### Constructors + + + +## GridLayoutManager(uint) Constructor + +Creates an instance of GridLayoutManager. + +```csharp +public GridLayoutManager(uint spanCount=1u); +``` +#### Parameters + + + +`spanCount` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The number of columns or rows in the grid. +### Properties + + + +## GridLayoutManager.CanScrollHorizontally Property + +Check if the recycler view can scroll horizontally. + +```csharp +public override bool CanScrollHorizontally { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLayoutManager.CanScrollVertically Property + +Check if the recycler view can scroll vertically. + +```csharp +public override bool CanScrollVertically { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLayoutManager.IsHorizontal Property + +Gets or sets whether this layout manager arranges items horizontally or vertically. + +```csharp +public bool IsHorizontal { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLayoutManager.ItemAnimator Property + +Gets or sets the ItemAnimator for this LayoutManager. + +```csharp +public Tizen.UI.Components.Recycler.IItemAnimator ItemAnimator { get; set; } +``` + +#### Property Value +[IItemAnimator](Tizen.UI.Components.Recycler.IItemAnimator.md 'Tizen.UI.Components.Recycler.IItemAnimator') + + + +## GridLayoutManager.LayoutViewPort Property + +The view port area where the item is placed + +```csharp +public override Tizen.UI.Rect LayoutViewPort { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## GridLayoutManager.SpanCount Property + +Gets or sets the number of columns or rows in the grid. + +```csharp +public virtual uint SpanCount { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') +### Methods + + + +## GridLayoutManager.ComputeHorizontalScrollExtent(int, int) Method + +Compute the horizontal scroll extent. + +```csharp +public override int ComputeHorizontalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll extent. + + + +## GridLayoutManager.ComputeHorizontalScrollOffset(int, int) Method + +Compute the horizontal scroll offset. + +```csharp +public override int ComputeHorizontalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll offset. + + + +## GridLayoutManager.ComputeHorizontalScrollRange(int, int) Method + +Compute the horizontal scroll range. + +```csharp +public override int ComputeHorizontalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll range. + + + +## GridLayoutManager.ComputeVerticalScrollExtent(int, int) Method + +Compute the vertical scroll extent. + +```csharp +public override int ComputeVerticalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll extent. + + + +## GridLayoutManager.ComputeVerticalScrollOffset(int, int) Method + +Compute the vertical scroll offset. + +```csharp +public override int ComputeVerticalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll offset. + + + +## GridLayoutManager.ComputeVerticalScrollRange(int, int) Method + +Compute the vertical scroll range. + +```csharp +public override int ComputeVerticalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll range. + + + +## GridLayoutManager.Fill(int, int) Method + +Fill the requested space with views. This method will try to fill the requested space with as many views as possible. +It will stop when either all available views have been laid out or when there are no more views to recycle. +The amount of space that was actually filled will be returned. + +```csharp +public virtual int Fill(int requested, int position=-1); +``` +#### Parameters + + + +`requested` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The Requested space + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The filled space + + + +## GridLayoutManager.Initialize() Method + +Initialize the layout manager. This method is called when the layout manager is attached to the recycler view or data source is changed. + +```csharp +public override void Initialize(); +``` + + + +## GridLayoutManager.LayoutPosition(int) Method + +Resets all created items and places the item in the specified position on the top left + +```csharp +public override void LayoutPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the view item to layout. + + + +## GridLayoutManager.MeasureUpdate(View) Method + +Measure the size of the view item. + +```csharp +public override Tizen.UI.Size MeasureUpdate(Tizen.UI.View itemView); +``` +#### Parameters + + + +`itemView` Tizen.UI.View + +The view item to measure. + +#### Returns +Tizen.UI.Size +The measured size of the view item. + + + +## GridLayoutManager.OnChildrenChanged(NotifyCollectionChangedEventArgs) Method + +Called when change the chlidren of the recycler view. + +```csharp +public override void OnChildrenChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs e); +``` +#### Parameters + + + +`e` [System.Collections.Specialized.NotifyCollectionChangedEventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.NotifyCollectionChangedEventArgs 'System.Collections.Specialized.NotifyCollectionChangedEventArgs') + +Collection changed + + + +## GridLayoutManager.OnLayoutChildren() Method + +Called when layout the children of the recycler view. + +```csharp +public override void OnLayoutChildren(); +``` + + + +## GridLayoutManager.RecycleOutOfSightView() Method + +Recycle the out of sight view items. This method will remove all the views that are not visible anymore from the recycler view. +These views will be recycled and can be reused by the adapter. +This method should be called whenever the view port has changed. For example after scrolling or resizing the recycler view. + +```csharp +public override void RecycleOutOfSightView(); +``` + + + +## GridLayoutManager.ScrollHorizontallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public override int ScrollHorizontallyBy(int dx); +``` +#### Parameters + + + +`dx` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + +## GridLayoutManager.ScrollVerticallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public override int ScrollVerticallyBy(int dy); +``` +#### Parameters + + + +`dy` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupInfo.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupInfo.md new file mode 100644 index 0000000000..a11425da63 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupInfo.md @@ -0,0 +1,187 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## GroupInfo Class + +The information data of the groups. + +```csharp +public class GroupInfo +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GroupInfo +### Properties + + + +## GroupInfo.Bottom Property + +The bottom position of the group. + +```csharp +public float Bottom { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## GroupInfo.Count Property + +The item count in the group. + +```csharp +public int Count { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupInfo.End Property + +The end index of the items in the group. + +```csharp +public int End { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupInfo.Left Property + +The left position of the group. + +```csharp +public float Left { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## GroupInfo.NeedLayout Property + +The flag to check if the group needs layout. + +```csharp +public bool NeedLayout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupInfo.Position Property + +The group index position. + +```csharp +public int Position { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupInfo.Right Property + +The right position of the group. + +```csharp +public float Right { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## GroupInfo.Start Property + +The start index of the items in the group. + +```csharp +public int Start { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupInfo.Top Property + +The top position of the group. + +```csharp +public float Top { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemSource.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemSource.md new file mode 100644 index 0000000000..5c904ba82d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemSource.md @@ -0,0 +1,578 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## GroupItemSource Class + +The class that provides the grouped data source for adapter. + +```csharp +public class GroupItemSource : +System.Collections.IList, +System.Collections.ICollection, +System.Collections.IEnumerable, +System.Collections.Specialized.INotifyCollectionChanged +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GroupItemSource + +Implements [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'), [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable'), [System.Collections.Specialized.INotifyCollectionChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.INotifyCollectionChanged 'System.Collections.Specialized.INotifyCollectionChanged') +### Constructors + + + +## GroupItemSource(IEnumerable) Constructor + +Initialize with enumerable source. + +```csharp +public GroupItemSource(System.Collections.IEnumerable source); +``` +#### Parameters + + + +`source` [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## GroupItemSource.Count Property + +Get the number of items in the source. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection.Count 'System.Collections.ICollection.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupItemSource.GroupCount Property + +Get the number of groups in the source. + +```csharp +public int GroupCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupItemSource.HasGroupFooter Property + +Get or set whether group has footer or not. + +```csharp +public bool HasGroupFooter { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemSource.HasGroupHeader Property + +Get or set whether group has header or not. + +```csharp +public bool HasGroupHeader { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemSource.IsFixedSize Property + +Gets a value indicating whether the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') has a fixed size. + +```csharp +public bool IsFixedSize { get; } +``` + +Implements [IsFixedSize](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.IsFixedSize 'System.Collections.IList.IsFixedSize') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemSource.IsReadOnly Property + +Gets a value indicating whether the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.IsReadOnly 'System.Collections.IList.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemSource.IsSynchronized Property + +Gets a value indicating whether access to the [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection') is synchronized (thread safe). + +```csharp +public bool IsSynchronized { get; } +``` + +Implements [IsSynchronized](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection.IsSynchronized 'System.Collections.ICollection.IsSynchronized') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemSource.SyncRoot Property + +Gets an object that can be used to synchronize access to the [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection'). + +```csharp +public object SyncRoot { get; } +``` + +Implements [SyncRoot](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection.SyncRoot 'System.Collections.ICollection.SyncRoot') + +#### Property Value +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + + + +## GroupItemSource.this[int] Property + +Get the item by index. Set is not allowed. + +```csharp +public object this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Item#System_Collections_IList_Item_System_Int32_ 'System.Collections.IList.Item(System.Int32)') + +#### Property Value +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +### Methods + + + +## GroupItemSource.Add(object) Method + +Adds an item to the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +```csharp +public int Add(object value); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to add to the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +Implements [Add(object)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Add#System_Collections_IList_Add_System_Object_ 'System.Collections.IList.Add(System.Object)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + +#### Exceptions + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + -or- + The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') has a fixed size. + + + +## GroupItemSource.Clear() Method + +Removes all items from the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Clear 'System.Collections.IList.Clear') + +#### Exceptions + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + + + +## GroupItemSource.Contains(object) Method + +Determines whether the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') contains a specific value. + +```csharp +public bool Contains(object value); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to locate in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +Implements [Contains(object)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Contains#System_Collections_IList_Contains_System_Object_ 'System.Collections.IList.Contains(System.Object)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') is found in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'); otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## GroupItemSource.CopyTo(Array, int) Method + +Copies the elements of the [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection') to an [System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array'), starting at a particular [System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') index. + +```csharp +public void CopyTo(System.Array array, int index); +``` +#### Parameters + + + +`array` [System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The one-dimensional [System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') that is the destination of the elements copied from [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection'). The [System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') must have zero-based indexing. + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The zero-based index in [array](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).array 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).array') at which copying begins. + +Implements [CopyTo(Array, int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection.CopyTo#System_Collections_ICollection_CopyTo_System_Array,System_Int32_ 'System.Collections.ICollection.CopyTo(System.Array,System.Int32)') + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[array](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).array 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).array') is [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null'). + +[System.ArgumentOutOfRangeException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentOutOfRangeException 'System.ArgumentOutOfRangeException') +[index](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).index 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).index') is less than zero. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +[array](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).array 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).array') is multidimensional. +-or- +The number of elements in the source [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection') is greater than the available space from [index](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).index 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).index') to the end of the destination [array](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).array 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).array'). +-or- +The type of the source [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection') cannot be cast automatically to the type of the destination [array](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array,int).array 'Tizen.UI.Components.Recycler.GroupItemSource.CopyTo(System.Array, int).array'). + + + +## GroupItemSource.GetAbsoluteIndex(int, int) Method + +Get absolute index in groups + +```csharp +public int GetAbsoluteIndex(int group, int ingroup); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Index of group + + + +`ingroup` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Index of item in group + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +Index that converted to absolute position + + + +## GroupItemSource.GetChildrenCount(int) Method + +Get children count of group. It does not include header and footer. + +```csharp +public int GetChildrenCount(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of group + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The children count in the group. + + + +## GroupItemSource.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +public System.Collections.IEnumerator GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.IEnumerator](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerator 'System.Collections.IEnumerator') +An [System.Collections.IEnumerator](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerator 'System.Collections.IEnumerator') object that can be used to iterate through the collection. + + + +## GroupItemSource.GetGroupAndIndex(int) Method + +Get group and index + +```csharp +public (int group,int inGroup) GetGroupAndIndex(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +a global index + +#### Returns +[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple') +index of group , index in group + +### Remarks +-1 means header, -2 means footer + + + +## GroupItemSource.GetGroupItem(int) Method + +Get the item from group. + +```csharp +public object GetGroupItem(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of group. + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +The data item object of group. + + + +## GroupItemSource.IndexOf(object) Method + +Determines the index of a specific item in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +```csharp +public int IndexOf(object value); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to locate in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +Implements [IndexOf(object)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.IndexOf#System_Collections_IList_IndexOf_System_Object_ 'System.Collections.IList.IndexOf(System.Object)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of [value](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.IndexOf(object).value 'Tizen.UI.Components.Recycler.GroupItemSource.IndexOf(object).value') if found in the list; otherwise, -1. + + + +## GroupItemSource.Insert(int, object) Method + +Inserts an item to the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') at the specified index. + +```csharp +public void Insert(int index, object value); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The zero-based index at which [value](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.Insert(int,object).value 'Tizen.UI.Components.Recycler.GroupItemSource.Insert(int, object).value') should be inserted. + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to insert into the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +Implements [Insert(int, object)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Insert#System_Collections_IList_Insert_System_Int32,System_Object_ 'System.Collections.IList.Insert(System.Int32,System.Object)') + +#### Exceptions + +[System.ArgumentOutOfRangeException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentOutOfRangeException 'System.ArgumentOutOfRangeException') +[index](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.Insert(int,object).index 'Tizen.UI.Components.Recycler.GroupItemSource.Insert(int, object).index') is not a valid index in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + -or- + The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') has a fixed size. + +[System.NullReferenceException](https://docs.microsoft.com/en-us/dotnet/api/System.NullReferenceException 'System.NullReferenceException') +[value](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.Insert(int,object).value 'Tizen.UI.Components.Recycler.GroupItemSource.Insert(int, object).value') is null reference in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + + + +## GroupItemSource.Remove(object) Method + +Removes the first occurrence of a specific object from the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +```csharp +public void Remove(object value); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to remove from the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +Implements [Remove(object)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.Remove#System_Collections_IList_Remove_System_Object_ 'System.Collections.IList.Remove(System.Object)') + +#### Exceptions + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + -or- + The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') has a fixed size. + + + +## GroupItemSource.RemoveAt(int) Method + +Removes the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') item at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The zero-based index of the item to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList.RemoveAt#System_Collections_IList_RemoveAt_System_Int32_ 'System.Collections.IList.RemoveAt(System.Int32)') + +#### Exceptions + +[System.ArgumentOutOfRangeException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentOutOfRangeException 'System.ArgumentOutOfRangeException') +[index](Tizen.UI.Components.Recycler.GroupItemSource.md#Tizen.UI.Components.Recycler.GroupItemSource.RemoveAt(int).index 'Tizen.UI.Components.Recycler.GroupItemSource.RemoveAt(int).index') is not a valid index in the [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'). + +[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException') +The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') is read-only. + -or- + The [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList') has a fixed size. +### Events + + + +## GroupItemSource.CollectionChanged Event + +Event when collection changed. + +```csharp +public event NotifyCollectionChangedEventHandler CollectionChanged; +``` + +Implements [CollectionChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged 'System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged') + +#### Event Type +[System.Collections.Specialized.NotifyCollectionChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.NotifyCollectionChangedEventHandler 'System.Collections.Specialized.NotifyCollectionChangedEventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md new file mode 100644 index 0000000000..f4da046088 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md @@ -0,0 +1,367 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## GroupItemTemplateAdapter Class + +The apdater using ViewTemplate for creates items and groups. + +```csharp +public class GroupItemTemplateAdapter : Tizen.UI.Components.Recycler.ItemTemplateAdapter, +Tizen.UI.Components.Recycler.IGroupedAdapter +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Adapter](Tizen.UI.Components.Recycler.Adapter.md 'Tizen.UI.Components.Recycler.Adapter') 🡒 [ItemTemplateAdapter](Tizen.UI.Components.Recycler.ItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.ItemTemplateAdapter') 🡒 GroupItemTemplateAdapter + +Implements [IGroupedAdapter](Tizen.UI.Components.Recycler.IGroupedAdapter.md 'Tizen.UI.Components.Recycler.IGroupedAdapter') +### Constructors + + + +## GroupItemTemplateAdapter() Constructor + +Constructor for GroupItemTemplateAdapter. + +```csharp +public GroupItemTemplateAdapter(); +``` +### Properties + + + +## GroupItemTemplateAdapter.GroupBodyTemplate Property + +Template for the group body. + +```csharp +public Tizen.UI.ViewTemplate GroupBodyTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## GroupItemTemplateAdapter.GroupCount Property + +The count of groups. + +```csharp +public int GroupCount { get; } +``` + +Implements [GroupCount](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.GroupCount 'Tizen.UI.Components.Recycler.IGroupedAdapter.GroupCount') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupItemTemplateAdapter.GroupFooterTemplate Property + +Template for the group footer. + +```csharp +public Tizen.UI.ViewTemplate GroupFooterTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## GroupItemTemplateAdapter.GroupHeaderTemplate Property + +Template for the group header. + +```csharp +public Tizen.UI.ViewTemplate GroupHeaderTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## GroupItemTemplateAdapter.HasGroupBody Property + +Boolean flag to indicate whether the group has body or not. +If it is true, the group will have a body view. Otherwise, the group will only have children views. Default value is false. + +```csharp +public bool HasGroupBody { get; } +``` + +Implements [HasGroupBody](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.HasGroupBody 'Tizen.UI.Components.Recycler.IGroupedAdapter.HasGroupBody') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemTemplateAdapter.IsStickyHeader Property + +Boolean flag to determine whether the header is sticky or not. Default is false. + +```csharp +public bool IsStickyHeader { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## GroupItemTemplateAdapter.BindBodyHolder(ViewHolder, int) Method + +Bind the group's body view holder. + +```csharp +public virtual void BindBodyHolder(Tizen.UI.Components.Recycler.ViewHolder holder, int group); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +View holder for group body. + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + +Implements [BindBodyHolder(ViewHolder, int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.BindBodyHolder(Tizen.UI.Components.Recycler.ViewHolder,int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.BindBodyHolder(Tizen.UI.Components.Recycler.ViewHolder, int)') + + + +## GroupItemTemplateAdapter.CreateBody(int) Method + +Create the group's body view holder. + +```csharp +public virtual Tizen.UI.Components.Recycler.ViewHolder CreateBody(int type); +``` +#### Parameters + + + +`type` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The type of group body. + +Implements [CreateBody(int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.CreateBody(int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.CreateBody(int)') + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +View holder for group body. + + + +## GroupItemTemplateAdapter.GetBodyType(int) Method + +Get the group body's type. + +```csharp +public virtual int GetBodyType(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + +Implements [GetBodyType(int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.GetBodyType(int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.GetBodyType(int)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +Body type. + + + +## GroupItemTemplateAdapter.GetChildrenCount(int) Method + +Get the child items count of the group. + +```csharp +public virtual int GetChildrenCount(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + +Implements [GetChildrenCount(int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.GetChildrenCount(int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.GetChildrenCount(int)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The count of group children. + + + +## GroupItemTemplateAdapter.GetGroupAndIndex(int) Method + +Get the group index and item index in the group. + +```csharp +public virtual (int groupIndex,int inGroupIndex) GetGroupAndIndex(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +Implements [GetGroupAndIndex(int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.GetGroupAndIndex(int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.GetGroupAndIndex(int)') + +#### Returns +[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple') +Group index and item's index in the group. + + + +## GroupItemTemplateAdapter.GetGroupItem(int) Method + +Get the group item. + +```csharp +public virtual object GetGroupItem(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Group index. + +Implements [GetGroupItem(int)](Tizen.UI.Components.Recycler.IGroupedAdapter.md#Tizen.UI.Components.Recycler.IGroupedAdapter.GetGroupItem(int) 'Tizen.UI.Components.Recycler.IGroupedAdapter.GetGroupItem(int)') + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +Group item object. + + + +## GroupItemTemplateAdapter.GetItemViewType(int) Method + +Get the type of View that will be created by [OnCreateViewHolder(int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int) 'Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int)') for the specified item. + +```csharp +public override int GetItemViewType(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item within the adapter's data set + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GroupItemTemplateAdapter.IsSticky(int) Method + +Called when RecyclerView need to determine whether the item is sticky or not. +If it returns true, the item will be sticked. Otherwise, it will not be sticked. + +```csharp +public override bool IsSticky(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of data. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GroupItemTemplateAdapter.SetItemsSource(IEnumerable) Method + +Set the items source. + +```csharp +public override void SetItemsSource(System.Collections.IEnumerable items); +``` +#### Parameters + + + +`items` [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') + +Enumerable source. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderExtensions.md new file mode 100644 index 0000000000..876589b618 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderExtensions.md @@ -0,0 +1,161 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## HolderExtensions Class + +View holder extension method. + +```csharp +public static class HolderExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 HolderExtensions +### Methods + + + +## HolderExtensions.GroupInfo(this View) Method + +Get group info. + +```csharp +public static Tizen.UI.Components.Recycler.GroupInfo GroupInfo(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +#### Returns +[GroupInfo](Tizen.UI.Components.Recycler.GroupInfo.md 'Tizen.UI.Components.Recycler.GroupInfo') + + + +## HolderExtensions.Holder(this View) Method + +Get ViewHolder. + +```csharp +public static Tizen.UI.Components.Recycler.ViewHolder Holder(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + +## HolderExtensions.Holder(this View, ViewHolder) Method + +Set ViewHolder. + +```csharp +public static void Holder(this Tizen.UI.View view, Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + +## HolderExtensions.HolderInfo(this View) Method + +Get holder info. + +```csharp +public static Tizen.UI.Components.Recycler.HolderInfo HolderInfo(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +#### Returns +[HolderInfo](Tizen.UI.Components.Recycler.HolderInfo.md 'Tizen.UI.Components.Recycler.HolderInfo') + + + +## HolderExtensions.HolderPosition(this View) Method + +Get holder position. + +```csharp +public static int HolderPosition(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderInfo.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderInfo.md new file mode 100644 index 0000000000..d1e2912869 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderInfo.md @@ -0,0 +1,83 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## HolderInfo Class + +The information data of the view holder. + +```csharp +public class HolderInfo +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 HolderInfo +### Properties + + + +## HolderInfo.Holder Property + +The view holder. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder Holder { get; set; } +``` + +#### Property Value +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IChildSeizable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IChildSeizable.md new file mode 100644 index 0000000000..3b55a6d863 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IChildSeizable.md @@ -0,0 +1,164 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IChildSeizable Interface + +Interface that Layouter child can be seized and un-handled by layouter or recycled. +This interface will be used on [ItemTouchHelper](Tizen.UI.Components.Recycler.ItemTouchHelper.md 'Tizen.UI.Components.Recycler.ItemTouchHelper'). + +```csharp +public interface IChildSeizable +``` + +Derived +↳ [LinearLayoutManager](Tizen.UI.Components.Recycler.LinearLayoutManager.md 'Tizen.UI.Components.Recycler.LinearLayoutManager') +### Methods + + + +## IChildSeizable.GetSeized(int) Method + +Get seized item view holder. + +```csharp +Tizen.UI.Components.Recycler.ViewHolder GetSeized(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +seized view holder. + + + +## IChildSeizable.GetSeizedCount() Method + +Get the count of seized item. + +```csharp +int GetSeizedCount(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +seized item count. + + + +## IChildSeizable.IsSeized(int) Method + +Check whether this item is seized or not. + +```csharp +bool IsSeized(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if position item is seized. + + + +## IChildSeizable.ReleaseChild(ViewHolder) Method + +Release the view holder. +view holder is released from user, will be re-layout, recycled from now on. + +```csharp +void ReleaseChild(Tizen.UI.Components.Recycler.ViewHolder viewHolder); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewholer to be released. + + + +## IChildSeizable.SeizeChild(ViewHolder) Method + +Seize the view holder. +view holder is seized by user, will not be re-layout, recycled until it is released. + +```csharp +void SeizeChild(Tizen.UI.Components.Recycler.ViewHolder viewHolder); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewholer to be seized. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IDividerProvider.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IDividerProvider.md new file mode 100644 index 0000000000..ad0a79c9db --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IDividerProvider.md @@ -0,0 +1,92 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IDividerProvider Interface + +The interface for a divider adapter. It is used to provide data for the RecyclerView. + +```csharp +public interface IDividerProvider +``` + +Derived +↳ [ItemTemplateAdapter](Tizen.UI.Components.Recycler.ItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.ItemTemplateAdapter') +### Methods + + + +## IDividerProvider.IsDividerPosition(int) Method + +Check the position is divider position or not. + +```csharp +bool IsDividerPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the position is divider position, otherwise false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md new file mode 100644 index 0000000000..d1e034f590 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IGridRelativeSizeHelper Interface + +Interface for [GridView](https://docs.microsoft.com/en-us/dotnet/api/GridView 'GridView') sizing item by aspect ratio. + +```csharp +public interface IGridRelativeSizeHelper : +Tizen.UI.Components.Recycler.IItemDecoration +``` + +Implements [IItemDecoration](Tizen.UI.Components.Recycler.IItemDecoration.md 'Tizen.UI.Components.Recycler.IItemDecoration') +### Methods + + + +## IGridRelativeSizeHelper.GetAspectRatio(View, int, RecyclerView) Method + +Gets the aspect ratio of the item at the given position. The length of item on scroll-cross-axis will be determined by span size, +but if scroll-axis also want to be determined by span size, use aspect ratio. +By default, ratio is 0, measured size will be the length of item on scroll-axis. + +```csharp +float GetAspectRatio(Tizen.UI.View view, int position, Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index poisition of item. + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The aspect ratio of item. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridSpanHelper.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridSpanHelper.md new file mode 100644 index 0000000000..5d1ceb7e13 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridSpanHelper.md @@ -0,0 +1,121 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IGridSpanHelper Interface + +[GridView](https://docs.microsoft.com/en-us/dotnet/api/GridView 'GridView') span helper interface. It provides additional information about item's span. + +```csharp +public interface IGridSpanHelper : +Tizen.UI.Components.Recycler.IItemDecoration +``` + +Implements [IItemDecoration](Tizen.UI.Components.Recycler.IItemDecoration.md 'Tizen.UI.Components.Recycler.IItemDecoration') +### Methods + + + +## IGridSpanHelper.GetSpanIndex(int, RecyclerView) Method + +Gets the span index of the item at the given position. The span index indicates which span of the grid the item is placed in. +By default, items are placed starting from the leftmost span. Implement this method to customize the span index of items. + +```csharp +int GetSpanIndex(int position, Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The span index. if value is negative, index will be default value. + + + +## IGridSpanHelper.GetSpanSize(int, RecyclerView) Method + +Gets the span size of the item at the given position. The span size determines how many spans of the grid the item will occupy. +By default, each item occupies one span. Implement this method to customize the span size of items. + +```csharp +uint GetSpanSize(int position, Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index poisition of item. + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +#### Returns +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') +The span size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedAdapter.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedAdapter.md new file mode 100644 index 0000000000..411c436a9c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedAdapter.md @@ -0,0 +1,227 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IGroupedAdapter Interface + +The interface for a grouped adapter. It is used to provide data for the RecyclerView. + +```csharp +public interface IGroupedAdapter +``` + +Derived +↳ [GroupItemTemplateAdapter](Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.GroupItemTemplateAdapter') +### Properties + + + +## IGroupedAdapter.GroupCount Property + +The count of groups. + +```csharp +int GroupCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## IGroupedAdapter.HasGroupBody Property + +Boolean flag to indicate whether the group has body or not. +If it is true, the group will have a body view. Otherwise, the group will only have children views. Default value is false. + +```csharp +bool HasGroupBody { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## IGroupedAdapter.BindBodyHolder(ViewHolder, int) Method + +Bind the group's body view holder. + +```csharp +void BindBodyHolder(Tizen.UI.Components.Recycler.ViewHolder holder, int group); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +View holder for group body. + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + + + +## IGroupedAdapter.CreateBody(int) Method + +Create the group's body view holder. + +```csharp +Tizen.UI.Components.Recycler.ViewHolder CreateBody(int type); +``` +#### Parameters + + + +`type` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The type of group body. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +View holder for group body. + + + +## IGroupedAdapter.GetBodyType(int) Method + +Get the group body's type. + +```csharp +int GetBodyType(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +Body type. + + + +## IGroupedAdapter.GetChildrenCount(int) Method + +Get the child items count of the group. + +```csharp +int GetChildrenCount(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The group index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The count of group children. + + + +## IGroupedAdapter.GetGroupAndIndex(int) Method + +Get the group index and item index in the group. + +```csharp +(int groupIndex,int inGroupIndex) GetGroupAndIndex(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +#### Returns +[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple') +Group index and item's index in the group. + + + +## IGroupedAdapter.GetGroupItem(int) Method + +Get the group item. + +```csharp +object GetGroupItem(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Group index. + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +Group item object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedItem.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedItem.md new file mode 100644 index 0000000000..26ae1cff4c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedItem.md @@ -0,0 +1,113 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IGroupedItem Interface + +Interface for grouped item. +This interface is not mendatory to implement, but if you want to update the item's by the group position, you can use this interface. + +```csharp +public interface IGroupedItem +``` +### Properties + + + +## IGroupedItem.IsFirstOfGroup Property + +Boolean flag that indicates whether this item is first of group or not. + +```csharp +bool IsFirstOfGroup { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IGroupedItem.IsLastOfGroup Property + +Boolean flag that indicates whether this item is last of group or not. + +```csharp +bool IsLastOfGroup { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## IGroupedItem.UpdateByPosition(int) Method + +Update the item by the group position. + +```csharp +void UpdateByPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemAnimator.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemAnimator.md new file mode 100644 index 0000000000..5b971bfaf2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemAnimator.md @@ -0,0 +1,295 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IItemAnimator Interface + +An interface to animate changes to the views in a RecyclerView. + +```csharp +public interface IItemAnimator +``` + +Derived +↳ [DefaultItemAnimator](Tizen.UI.Components.Recycler.DefaultItemAnimator.md 'Tizen.UI.Components.Recycler.DefaultItemAnimator') +### Properties + + + +## IItemAnimator.RecyclerView Property + +Sets the RecyclerView this animator is attached to. + +```csharp +Tizen.UI.Components.Recycler.RecyclerView RecyclerView { get; set; } +``` + +#### Property Value +[RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Methods + + + +## IItemAnimator.AnimateAdd(ViewHolder) Method + +Called when a ViewHolder is about to be added. + +```csharp +bool AnimateAdd(Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being added. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## IItemAnimator.AnimateChange(ViewHolder, ViewHolder, float, float, float, float) Method + +Called when a ViewHolder is about to be changed (e.g., content updated, size changed). + +```csharp +bool AnimateChange(Tizen.UI.Components.Recycler.ViewHolder oldHolder, Tizen.UI.Components.Recycler.ViewHolder newHolder, float fromX, float fromY, float toX, float toY); +``` +#### Parameters + + + +`oldHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder before the change. + + + +`newHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder after the change (can be the same as oldHolder). + + + +`fromX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start X position. + + + +`fromY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start Y position. + + + +`toX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End X position. + + + +`toY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End Y position. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## IItemAnimator.AnimateMove(ViewHolder, float, float, float, float) Method + +Called when a ViewHolder is about to be moved. + +```csharp +bool AnimateMove(Tizen.UI.Components.Recycler.ViewHolder holder, float fromX, float fromY, float toX, float toY); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being moved. + + + +`fromX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start X position. + + + +`fromY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Start Y position. + + + +`toX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End X position. + + + +`toY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +End Y position. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## IItemAnimator.AnimateRemove(ViewHolder) Method + +Called when a ViewHolder is about to be removed. + +```csharp +bool AnimateRemove(Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for the item being removed. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the animator is ready to animate this change, false otherwise. + + + +## IItemAnimator.EndAnimation(ViewHolder) Method + +Ends the animation for a specific ViewHolder. + +```csharp +void EndAnimation(Tizen.UI.Components.Recycler.ViewHolder item); +``` +#### Parameters + + + +`item` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder whose animation should be ended. + + + +## IItemAnimator.EndAnimations() Method + +Ends all current animations. + +```csharp +void EndAnimations(); +``` + + + +## IItemAnimator.IsRunning(ViewHolder) Method + +Checks if any animation is running for a specific ViewHolder. + +```csharp +bool IsRunning(Tizen.UI.Components.Recycler.ViewHolder item); +``` +#### Parameters + + + +`item` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if an animation is active for the item, false otherwise. + + + +## IItemAnimator.RunPendingAnimations() Method + +Runs all pending animations. + +```csharp +void RunPendingAnimations(); +``` +### Events + + + +## IItemAnimator.AnimationFinished Event + +Listener for animation finished. + +```csharp +event EventHandler<AnimationFinishedEventArgs> AnimationFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[AnimationFinishedEventArgs](Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md 'Tizen.UI.Components.Recycler.AnimationFinishedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemDecoration.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemDecoration.md new file mode 100644 index 0000000000..2a75677206 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemDecoration.md @@ -0,0 +1,107 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## IItemDecoration Interface + +Interface for item decoration. It provides additional information about item's position + +```csharp +public interface IItemDecoration +``` + +Derived +↳ [IGridRelativeSizeHelper](Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md 'Tizen.UI.Components.Recycler.IGridRelativeSizeHelper') +↳ [IGridSpanHelper](Tizen.UI.Components.Recycler.IGridSpanHelper.md 'Tizen.UI.Components.Recycler.IGridSpanHelper') +↳ [ItemTouchHelper](Tizen.UI.Components.Recycler.ItemTouchHelper.md 'Tizen.UI.Components.Recycler.ItemTouchHelper') +### Methods + + + +## IItemDecoration.GetItemOffsets(View, int, RecyclerView) Method + +Get item offsets. The method to get the item offsets. It is called when the item view is laid out. + +```csharp +Tizen.UI.Thickness GetItemOffsets(Tizen.UI.View view, int position, Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to retrieve the offset from. + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The recyclerView + +#### Returns +Tizen.UI.Thickness +The extra drawing space for the item view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectableModel.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectableModel.md new file mode 100644 index 0000000000..a24c52f99a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectableModel.md @@ -0,0 +1,101 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ISelectableModel Interface + +Interface for model which provides data selectable. + +```csharp +public interface ISelectableModel : +System.ComponentModel.INotifyPropertyChanged +``` + +Derived +↳ [SelectableModel](Tizen.UI.Components.Recycler.SelectableModel.md 'Tizen.UI.Components.Recycler.SelectableModel') +↳ [SelectionModelGroup<T>](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>') + +Implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') +### Properties + + + +## ISelectableModel.IsSelectable Property + +Boolean value whether this model can be selectable or not. + +```csharp +bool IsSelectable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ISelectableModel.IsSelected Property + +Boolean value whether this model is selected or not. + +```csharp +bool IsSelected { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup.md new file mode 100644 index 0000000000..f5a7fb1dc4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup.md @@ -0,0 +1,91 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ISelectionModelGroup Interface + +An interface for the group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). +The group can have multiple selected children. + +```csharp +public interface ISelectionModelGroup : +System.Collections.IList, +System.Collections.ICollection, +System.Collections.IEnumerable +``` + +Derived +↳ [ISelectionModelGroup<T>](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>') +↳ [SelectionModelGroup<T>](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>') + +Implements [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'), [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## ISelectionModelGroup.SelectedCount Property + +The count of the selected children. + +```csharp +int SelectedCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md new file mode 100644 index 0000000000..816f7fd096 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ISelectionModelGroup<T> Interface + +An generic interface for the group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). +The group can have multiple selected children. + +```csharp +public interface ISelectionModelGroup<T> : +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable, +Tizen.UI.Components.Recycler.ISelectionModelGroup, +System.Collections.IList, +System.Collections.ICollection + where T : Tizen.UI.Components.Recycler.ISelectableModel +``` +#### Type parameters + + + +`T` + +The child object who implements ISelectableModel + +Derived +↳ [SelectionModelGroup<T>](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>') + +Implements [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable'), [ISelectionModelGroup](Tizen.UI.Components.Recycler.ISelectionModelGroup.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup'), [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'), [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection') +### Properties + + + +## ISelectionModelGroup<T>.SelectedChildren Property + +The read only list of selected children. + +```csharp +System.Collections.Generic.IReadOnlyCollection<T> SelectedChildren { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[T](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTemplateAdapter.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTemplateAdapter.md new file mode 100644 index 0000000000..f52b857eb8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTemplateAdapter.md @@ -0,0 +1,302 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ItemTemplateAdapter Class + +The apdater using ViewTemplate for creates items. + +```csharp +public class ItemTemplateAdapter : Tizen.UI.Components.Recycler.Adapter, +Tizen.UI.Components.Recycler.IDividerProvider +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Adapter](Tizen.UI.Components.Recycler.Adapter.md 'Tizen.UI.Components.Recycler.Adapter') 🡒 ItemTemplateAdapter + +Derived +↳ [GroupItemTemplateAdapter](Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.GroupItemTemplateAdapter') + +Implements [IDividerProvider](Tizen.UI.Components.Recycler.IDividerProvider.md 'Tizen.UI.Components.Recycler.IDividerProvider') +### Constructors + + + +## ItemTemplateAdapter() Constructor + +Constructor for ItemTemplateAdapter. + +```csharp +public ItemTemplateAdapter(); +``` +### Properties + + + +## ItemTemplateAdapter.DividerTemplate Property + +The template for creating divider views. It can be ViewTemplate or ViewTemplateSelector. + +```csharp +public Tizen.UI.ViewTemplate DividerTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## ItemTemplateAdapter.HasDivider Property + +The flag that indicates whether the adapter has a divider or not. + +```csharp +public bool HasDivider { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ItemTemplateAdapter.ItemCount Property + +The count of items. + +```csharp +public override int ItemCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ItemTemplateAdapter.ItemsSource Property + +The enumerable data source of items. +Use INotifyCollectionChanged to observe the changes of collection. + +```csharp +public System.Collections.IEnumerable ItemsSource { get; set; } +``` + +#### Property Value +[System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') + + + +## ItemTemplateAdapter.ItemTemplate Property + +The template for creating item views. It can be ViewTemplate or ViewTemplateSelector. + +```csharp +public Tizen.UI.ViewTemplate ItemTemplate { get; set; } +``` + +#### Property Value +Tizen.UI.ViewTemplate +### Methods + + + +## ItemTemplateAdapter.GetItemOnPosition(int) Method + +Get item object from position. + +```csharp +public override object GetItemOnPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +The item object. + + + +## ItemTemplateAdapter.GetItemViewType(int) Method + +Get the type of View that will be created by [OnCreateViewHolder(int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int) 'Tizen.UI.Components.Recycler.Adapter.OnCreateViewHolder(int)') for the specified item. + +```csharp +public override int GetItemViewType(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item within the adapter's data set + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ItemTemplateAdapter.GetSourceIndexFromPosition(int) Method + +Get the index of source from position. If there is no divider, it returns the same value. If there is divider, it returns the index without divider. + +```csharp +public int GetSourceIndexFromPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The original source index. + + + +## ItemTemplateAdapter.IsDividerPosition(int) Method + +Check the position is divider position or not. + +```csharp +public virtual bool IsDividerPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index position of item. + +Implements [IsDividerPosition(int)](Tizen.UI.Components.Recycler.IDividerProvider.md#Tizen.UI.Components.Recycler.IDividerProvider.IsDividerPosition(int) 'Tizen.UI.Components.Recycler.IDividerProvider.IsDividerPosition(int)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the position is divider position, otherwise false. + + + +## ItemTemplateAdapter.OnBindViewHolder(ViewHolder, int) Method + +Called when [BindViewHolder(ViewHolder, int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.BindViewHolder(Tizen.UI.Components.Recycler.ViewHolder,int) 'Tizen.UI.Components.Recycler.Adapter.BindViewHolder(Tizen.UI.Components.Recycler.ViewHolder, int)') binds [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder'). +Derivated class must implement this method to bind viewholder. + +```csharp +public override void OnBindViewHolder(Tizen.UI.Components.Recycler.ViewHolder holder, int position); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The view holder to bind. + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of data. + + + +## ItemTemplateAdapter.OnCreateViewHolder(int) Method + +Called when [CreateViewHolder(int)](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.CreateViewHolder(int) 'Tizen.UI.Components.Recycler.Adapter.CreateViewHolder(int)') creates [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder'). +Derivated class must implement this method to create viewholder. + +```csharp +public override Tizen.UI.Components.Recycler.ViewHolder OnCreateViewHolder(int viewType); +``` +#### Parameters + + + +`viewType` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The type of the view. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + +## ItemTemplateAdapter.SetItemsSource(IEnumerable) Method + +Set the items source. + +```csharp +public virtual void SetItemsSource(System.Collections.IEnumerable items); +``` +#### Parameters + + + +`items` [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') + +Enumerable source. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelper.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelper.md new file mode 100644 index 0000000000..9006f57a56 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelper.md @@ -0,0 +1,173 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ItemTouchHelper Class + +Item touch helper for [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView'). +This is a utility class to add touch action support to [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView').. +It works with a [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView'). and a [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback'). class, which configures what type of interactions +are enabled and also receives events when user performs these actions. +Depending on which functionality you support, you should override methods in [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback'). + +```csharp +public class ItemTouchHelper : +Tizen.UI.Components.Recycler.IItemDecoration +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ItemTouchHelper + +Implements [IItemDecoration](Tizen.UI.Components.Recycler.IItemDecoration.md 'Tizen.UI.Components.Recycler.IItemDecoration') +### Constructors + + + +## ItemTouchHelper(ItemTouchHelperCallback) Constructor + +Creates an ItemTouchHelper that will work with the given [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback'). + +```csharp +public ItemTouchHelper(Tizen.UI.Components.Recycler.ItemTouchHelperCallback callback); +``` +#### Parameters + + + +`callback` [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback') +### Methods + + + +## ItemTouchHelper.AttachToRecyclerView(RecyclerView) Method + +Attach the touch helper to RecyclerView. + +```csharp +public void AttachToRecyclerView(Tizen.UI.Components.Recycler.RecyclerView view); +``` +#### Parameters + + + +`view` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The recycler view. + + + +## ItemTouchHelper.DetachToRecyclerView() Method + +Detach the touch helper to RecyclerView. + +```csharp +public void DetachToRecyclerView(); +``` + + + +## ItemTouchHelper.GetItemOffsets(View, int, RecyclerView) Method + +Get item offsets. The method to get the item offsets. It is called when the item view is laid out. + +```csharp +public Tizen.UI.Thickness GetItemOffsets(Tizen.UI.View view, int position, Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to retrieve the offset from. + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The recyclerView + +Implements [GetItemOffsets(View, int, RecyclerView)](Tizen.UI.Components.Recycler.IItemDecoration.md#Tizen.UI.Components.Recycler.IItemDecoration.GetItemOffsets(Tizen.UI.View,int,Tizen.UI.Components.Recycler.RecyclerView) 'Tizen.UI.Components.Recycler.IItemDecoration.GetItemOffsets(Tizen.UI.View, int, Tizen.UI.Components.Recycler.RecyclerView)') + +#### Returns +Tizen.UI.Thickness +The extra drawing space for the item view. + + + +## ItemTouchHelper.StartDrag(ViewHolder) Method + +Let the Viewholder start the drag action by force. + +```csharp +public void StartDrag(Tizen.UI.Components.Recycler.ViewHolder viewHolder); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The view holder for drag. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md new file mode 100644 index 0000000000..a78f6cdade --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md @@ -0,0 +1,428 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ItemTouchHelperCallback Class + +This class is the contract between ItemTouchHelper and your application. It lets you control +which touch behaviors are enabled per each ViewHolder and also receive callbacks when user performs these actions. +o control which actions user can take on each view, you should override +[GetMovementPolicy(RecyclerView, ViewHolder)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView,Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView, Tizen.UI.Components.Recycler.ViewHolder)') and return appropriate set of direction flags. + +```csharp +public abstract class ItemTouchHelperCallback +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ItemTouchHelperCallback + +Derived +↳ [LinearSwapCallback](Tizen.UI.Components.Recycler.LinearSwapCallback.md 'Tizen.UI.Components.Recycler.LinearSwapCallback') +### Properties + + + +## ItemTouchHelperCallback.BoundingBoxMargin Property + +When finding views under a dragged view, by default, ItemTouchHelper searches for views That overlap with the dragged View. +By set this value, you can extend or shrink the search box. default is 0. + +```csharp +public float BoundingBoxMargin { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ItemTouchHelperCallback.IsLongpressDragEnabled Property + +whether ItemTouchHelper should start a drag and drop operation if an item is long pressed. +default is true. + +```csharp +public bool IsLongpressDragEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## ItemTouchHelperCallback.CanDropOver(RecyclerView, ViewHolder, ViewHolder) Method + +Return true if the current ViewHolder can be dropped over the the target ViewHolder. +This method is used when selecting drop target for the dragged View. +After Views are eliminated either via bounds check or via this method, +resulting set of views will be passed to [ChooseDropTarget(ViewHolder, List<ViewHolder>, Point)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.ChooseDropTarget(Tizen.UI.Components.Recycler.ViewHolder,System.Collections.Generic.List_Tizen.UI.Components.Recycler.ViewHolder_,Tizen.UI.Point) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.ChooseDropTarget(Tizen.UI.Components.Recycler.ViewHolder, System.Collections.Generic.List<Tizen.UI.Components.Recycler.ViewHolder>, Tizen.UI.Point)'). +Default implementation returns true. + +```csharp +public virtual bool CanDropOver(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder current, Tizen.UI.Components.Recycler.ViewHolder target); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView to which ItemTouchHelper is attached to. + + + +`current` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder that user is dragging. + + + +`target` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder which is below the dragged ViewHolder. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ItemTouchHelperCallback.ChooseDropTarget(ViewHolder, List<ViewHolder>, Point) Method + +Called by ItemTouchHelper to select a drop target from the list of ViewHolders that +are under the dragged View. +Default implementation filters the View with which dragged item have changed position in the drag direction. +For instance, if the view is dragged UP, it compares the top of the two views before and after drag started. +If that value is different, the target view passes the filter. +Among these Views which pass the test, the one closest to the dragged view is chosen. + +```csharp +public virtual Tizen.UI.Components.Recycler.ViewHolder ChooseDropTarget(Tizen.UI.Components.Recycler.ViewHolder selected, System.Collections.Generic.List<Tizen.UI.Components.Recycler.ViewHolder> dropTargets, Tizen.UI.Point currentPosition); +``` +#### Parameters + + + +`selected` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder being dragged by the user. + + + +`dropTargets` [System.Collections.Generic.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System.Collections.Generic.List`1')[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System.Collections.Generic.List`1') + +The list of ViewHolder that are under the dragged View and candidate as a drop. + + + +`currentPosition` Tizen.UI.Point + +The updated position value of the dragged View + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + + + +## ItemTouchHelperCallback.GetMovementPolicy(RecyclerView, ViewHolder) Method + +Should return a composite policy which defines the enabled move directions in each state. + +```csharp +public abstract int GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder viewholder); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView to which ItemTouchHelper is attached. + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for which the movement information is necessary. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ItemTouchHelperCallback.GetSMoveThreshold(ViewHolder) Method + +Returns the fraction that the user should move the View to be considered as it is dragged. +After a view is moved this portion, ItemTouchHelper starts checking for Views below it for a possible drop. +Default is 0.25f. + +```csharp +public virtual float GetSMoveThreshold(Tizen.UI.Components.Recycler.ViewHolder viewholder); +``` +#### Parameters + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The new ViewHolder for get threshold. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ItemTouchHelperCallback.HasDragPolicy(RecyclerView, ViewHolder) Method + +Gets whether this viewholder has drag policy on direction or not. + +```csharp +public bool HasDragPolicy(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder viewholder); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView instance to which ItemTouchHelper is attached to. + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewholer to check drag policy. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ItemTouchHelperCallback.InterpolateOutOfBoundsScroll(RecyclerView, float, float, float, long) Method + +Called by the ItemTouchHelper when user is dragging a view out of bounds. +You can override this method to decide how much RecyclerView should scroll in response to this action. +Default implementation calculates a value based on the amount of View out of bounds and the time it spent there. +The longer user keeps the View out of bounds, the faster the list will scroll. +Similarly, the larger portion of the View is out of bounds, the faster the RecyclerView will scroll. + +```csharp +public virtual float InterpolateOutOfBoundsScroll(Tizen.UI.Components.Recycler.RecyclerView recyclerView, float viewSize, float viewSizeOutOfBounds, float totalSize, long msSinceStartScroll); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView instance to which ItemTouchHelper is attached to. + + + +`viewSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The total size of the View in scroll direction, excluding item decorations. + + + +`viewSizeOutOfBounds` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The total size of the View that is out of bounds. + + + +`totalSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The total size of RecyclerView in the scroll direction. + + + +`msSinceStartScroll` [System.Int64](https://docs.microsoft.com/en-us/dotnet/api/System.Int64 'System.Int64') + +The time passed since View is kept out of bounds. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ItemTouchHelperCallback.MakePolicy(TouchActionState, TouchDirection) Method + +Shifts the given direction flags to the offset of the given action state. + +```csharp +public static int MakePolicy(Tizen.UI.Components.Recycler.TouchActionState actionState, Tizen.UI.Components.Recycler.TouchDirection directions); +``` +#### Parameters + + + +`actionState` [TouchActionState](Tizen.UI.Components.Recycler.TouchActionState.md 'Tizen.UI.Components.Recycler.TouchActionState') + +The action state you want to get policy in. + + + +`directions` [TouchDirection](Tizen.UI.Components.Recycler.TouchDirection.md 'Tizen.UI.Components.Recycler.TouchDirection') + +The direction policy. Can be composed [TouchDirection](Tizen.UI.Components.Recycler.TouchDirection.md 'Tizen.UI.Components.Recycler.TouchDirection') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ItemTouchHelperCallback.OnMove(RecyclerView, ViewHolder, ViewHolder) Method + +Called when ItemTouchHelper wants to move the dragged item from its old position to the new position. +If this method returns true, ItemTouchHelper assumes viewholer has been moved to the adapter position of target ViewHolder. + +```csharp +public abstract bool OnMove(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder viewholder, Tizen.UI.Components.Recycler.ViewHolder target); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView to which ItemTouchHelper is attached to. + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder which is being dragged by the user. + + + +`target` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder over which the currently active item is being dragged. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ItemTouchHelperCallback.OnMoved(RecyclerView, ViewHolder, int, ViewHolder, int, Point) Method + +Called when [OnMove(RecyclerView, ViewHolder, ViewHolder)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView,Tizen.UI.Components.Recycler.ViewHolder,Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView, Tizen.UI.Components.Recycler.ViewHolder, Tizen.UI.Components.Recycler.ViewHolder)') returns true. + +```csharp +public virtual void OnMoved(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder viewholder, int fromPos, Tizen.UI.Components.Recycler.ViewHolder target, int toPos, Tizen.UI.Point currentPosition); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView controlled by the ItemTouchHelper. + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder under user's control. + + + +`fromPos` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The previous adapter position of the dragged item (before it wasmoved). + + + +`target` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder on which the currently active item has been dropped. + + + +`toPos` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The new adapter position of the dragged item. + + + +`currentPosition` Tizen.UI.Point + +The updated point value of the dragged View after drag translations are applied. + + + +## ItemTouchHelperCallback.OnSelectedChanged(ViewHolder, TouchActionState) Method + +```csharp +public void OnSelectedChanged(Tizen.UI.Components.Recycler.ViewHolder viewholder, Tizen.UI.Components.Recycler.TouchActionState actionState); +``` +#### Parameters + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The new ViewHolder that is being selected. Might be null if it is cleared. + + + +`actionState` [TouchActionState](Tizen.UI.Components.Recycler.TouchActionState.md 'Tizen.UI.Components.Recycler.TouchActionState') + +The touch action state on view holder. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LayoutManager.md new file mode 100644 index 0000000000..20fcb1096e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LayoutManager.md @@ -0,0 +1,420 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## LayoutManager Class + +The base class for layout managers. A layout manager is responsible for positioning and sizing the child views in a recycler view. + +```csharp +public abstract class LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LayoutManager + +Derived +↳ [GridLayoutManager](Tizen.UI.Components.Recycler.GridLayoutManager.md 'Tizen.UI.Components.Recycler.GridLayoutManager') +↳ [LinearLayoutManager](Tizen.UI.Components.Recycler.LinearLayoutManager.md 'Tizen.UI.Components.Recycler.LinearLayoutManager') +### Properties + + + +## LayoutManager.CanScrollHorizontally Property + +Check if the recycler view can scroll horizontally. + +```csharp +public virtual bool CanScrollHorizontally { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LayoutManager.CanScrollVertically Property + +Check if the recycler view can scroll vertically. + +```csharp +public virtual bool CanScrollVertically { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LayoutManager.LayoutViewPort Property + +The view port area where the item is placed + +```csharp +public virtual Tizen.UI.Rect LayoutViewPort { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## LayoutManager.RecyclerView Property + +The recycler view that uses this layout manager. +This property is set by the recycler view when the layout manager is attached to it. It should not be set manually. + +```csharp +public Tizen.UI.Components.Recycler.RecyclerView RecyclerView { get; set; } +``` + +#### Property Value +[RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Methods + + + +## LayoutManager.ComputeHorizontalScrollExtent(int, int) Method + +Compute the horizontal scroll extent. + +```csharp +public abstract int ComputeHorizontalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll extent. + + + +## LayoutManager.ComputeHorizontalScrollOffset(int, int) Method + +Compute the horizontal scroll offset. + +```csharp +public abstract int ComputeHorizontalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll offset. + + + +## LayoutManager.ComputeHorizontalScrollRange(int, int) Method + +Compute the horizontal scroll range. + +```csharp +public abstract int ComputeHorizontalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll range. + + + +## LayoutManager.ComputeVerticalScrollExtent(int, int) Method + +Compute the vertical scroll extent. + +```csharp +public abstract int ComputeVerticalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll extent. + + + +## LayoutManager.ComputeVerticalScrollOffset(int, int) Method + +Compute the vertical scroll offset. + +```csharp +public abstract int ComputeVerticalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll offset. + + + +## LayoutManager.ComputeVerticalScrollRange(int, int) Method + +Compute the vertical scroll range. + +```csharp +public abstract int ComputeVerticalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll range. + + + +## LayoutManager.Initialize() Method + +Initialize the layout manager. This method is called when the layout manager is attached to the recycler view or data source is changed. + +```csharp +public abstract void Initialize(); +``` + + + +## LayoutManager.LayoutPosition(int) Method + +Resets all created items and places the item in the specified position on the top left + +```csharp +public abstract void LayoutPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the view item to layout. + + + +## LayoutManager.MeasureUpdate(View) Method + +Measure the size of the view item. + +```csharp +public abstract Tizen.UI.Size MeasureUpdate(Tizen.UI.View itemView); +``` +#### Parameters + + + +`itemView` Tizen.UI.View + +The view item to measure. + +#### Returns +Tizen.UI.Size +The measured size of the view item. + + + +## LayoutManager.OnChildrenChanged(NotifyCollectionChangedEventArgs) Method + +Called when change the chlidren of the recycler view. + +```csharp +public abstract void OnChildrenChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs e); +``` +#### Parameters + + + +`e` [System.Collections.Specialized.NotifyCollectionChangedEventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.NotifyCollectionChangedEventArgs 'System.Collections.Specialized.NotifyCollectionChangedEventArgs') + +Collection changed + + + +## LayoutManager.OnLayoutChildren() Method + +Called when layout the children of the recycler view. + +```csharp +public abstract void OnLayoutChildren(); +``` + + + +## LayoutManager.RecycleOutOfSightView() Method + +Recycle the out of sight view items. This method will remove all the views that are not visible anymore from the recycler view. +These views will be recycled and can be reused by the adapter. +This method should be called whenever the view port has changed. For example after scrolling or resizing the recycler view. + +```csharp +public abstract void RecycleOutOfSightView(); +``` + + + +## LayoutManager.ScrollHorizontallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public abstract int ScrollHorizontallyBy(int dx); +``` +#### Parameters + + + +`dx` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + +## LayoutManager.ScrollVerticallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public abstract int ScrollVerticallyBy(int dy); +``` +#### Parameters + + + +`dy` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearLayoutManager.md new file mode 100644 index 0000000000..db449f7ddb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearLayoutManager.md @@ -0,0 +1,573 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## LinearLayoutManager Class + +A linear layout manager that arranges items in a single row or column. + +```csharp +public class LinearLayoutManager : Tizen.UI.Components.Recycler.LayoutManager, +Tizen.UI.Components.Recycler.IChildSeizable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Components.Recycler.LayoutManager.md 'Tizen.UI.Components.Recycler.LayoutManager') 🡒 LinearLayoutManager + +Implements [IChildSeizable](Tizen.UI.Components.Recycler.IChildSeizable.md 'Tizen.UI.Components.Recycler.IChildSeizable') +### Constructors + + + +## LinearLayoutManager() Constructor + +Creates a new instance of a LinearLayoutManager. + +```csharp +public LinearLayoutManager(); +``` +### Properties + + + +## LinearLayoutManager.CanScrollHorizontally Property + +Check if the recycler view can scroll horizontally. + +```csharp +public override bool CanScrollHorizontally { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LinearLayoutManager.CanScrollVertically Property + +Check if the recycler view can scroll vertically. + +```csharp +public override bool CanScrollVertically { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LinearLayoutManager.IsHorizontal Property + +Specifies whether the layout should be horizontal or vertical. + +```csharp +public bool IsHorizontal { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LinearLayoutManager.ItemAnimator Property + +Gets or sets the ItemAnimator for this LayoutManager. + +```csharp +public Tizen.UI.Components.Recycler.IItemAnimator ItemAnimator { get; set; } +``` + +#### Property Value +[IItemAnimator](Tizen.UI.Components.Recycler.IItemAnimator.md 'Tizen.UI.Components.Recycler.IItemAnimator') + + + +## LinearLayoutManager.LayoutViewPort Property + +The view port area where the item is placed + +```csharp +public override Tizen.UI.Rect LayoutViewPort { get; set; } +``` + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## LinearLayoutManager.ComputeHorizontalScrollExtent(int, int) Method + +Compute the horizontal scroll extent. + +```csharp +public override int ComputeHorizontalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll extent. + + + +## LinearLayoutManager.ComputeHorizontalScrollOffset(int, int) Method + +Compute the horizontal scroll offset. + +```csharp +public override int ComputeHorizontalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll offset. + + + +## LinearLayoutManager.ComputeHorizontalScrollRange(int, int) Method + +Compute the horizontal scroll range. + +```csharp +public override int ComputeHorizontalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The horizontal scroll range. + + + +## LinearLayoutManager.ComputeVerticalScrollExtent(int, int) Method + +Compute the vertical scroll extent. + +```csharp +public override int ComputeVerticalScrollExtent(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll extent. + + + +## LinearLayoutManager.ComputeVerticalScrollOffset(int, int) Method + +Compute the vertical scroll offset. + +```csharp +public override int ComputeVerticalScrollOffset(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll offset. + + + +## LinearLayoutManager.ComputeVerticalScrollRange(int, int) Method + +Compute the vertical scroll range. + +```csharp +public override int ComputeVerticalScrollRange(int first, int last); +``` +#### Parameters + + + +`first` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The first realized item index. + + + +`last` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The last realized item index. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The vertical scroll range. + + + +## LinearLayoutManager.Fill(int, int) Method + +Fill the requested space with views.This method will try to fill the requested space with as many views as possible. +It will stop when either all available views have been laid out or when there are no more views to recycle. +The amount of space that was actually filled will be returned. + +```csharp +public virtual int Fill(int requested, int position=-1); +``` +#### Parameters + + + +`requested` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The Requested space + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The filled space + + + +## LinearLayoutManager.GetSeized(int) Method + +Get seized item view holder. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder GetSeized(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position. + +Implements [GetSeized(int)](Tizen.UI.Components.Recycler.IChildSeizable.md#Tizen.UI.Components.Recycler.IChildSeizable.GetSeized(int) 'Tizen.UI.Components.Recycler.IChildSeizable.GetSeized(int)') + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +seized view holder. + + + +## LinearLayoutManager.GetSeizedCount() Method + +Get the count of seized item. + +```csharp +public int GetSeizedCount(); +``` + +Implements [GetSeizedCount()](Tizen.UI.Components.Recycler.IChildSeizable.md#Tizen.UI.Components.Recycler.IChildSeizable.GetSeizedCount() 'Tizen.UI.Components.Recycler.IChildSeizable.GetSeizedCount()') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +seized item count. + + + +## LinearLayoutManager.Initialize() Method + +Initialize the layout manager. This method is called when the layout manager is attached to the recycler view or data source is changed. + +```csharp +public override void Initialize(); +``` + + + +## LinearLayoutManager.IsSeized(int) Method + +Check whether this item is seized or not. + +```csharp +public bool IsSeized(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The item position. + +Implements [IsSeized(int)](Tizen.UI.Components.Recycler.IChildSeizable.md#Tizen.UI.Components.Recycler.IChildSeizable.IsSeized(int) 'Tizen.UI.Components.Recycler.IChildSeizable.IsSeized(int)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if position item is seized. + + + +## LinearLayoutManager.LayoutPosition(int) Method + +Resets all created items and places the item in the specified position on the top left + +```csharp +public override void LayoutPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the view item to layout. + + + +## LinearLayoutManager.MeasureUpdate(View) Method + +Measure the size of the view item. + +```csharp +public override Tizen.UI.Size MeasureUpdate(Tizen.UI.View itemView); +``` +#### Parameters + + + +`itemView` Tizen.UI.View + +The view item to measure. + +#### Returns +Tizen.UI.Size +The measured size of the view item. + + + +## LinearLayoutManager.OnChildrenChanged(NotifyCollectionChangedEventArgs) Method + +Called when change the chlidren of the recycler view. + +```csharp +public override void OnChildrenChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs e); +``` +#### Parameters + + + +`e` [System.Collections.Specialized.NotifyCollectionChangedEventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Specialized.NotifyCollectionChangedEventArgs 'System.Collections.Specialized.NotifyCollectionChangedEventArgs') + +Collection changed + + + +## LinearLayoutManager.OnLayoutChildren() Method + +Called when layout the children of the recycler view. + +```csharp +public override void OnLayoutChildren(); +``` + + + +## LinearLayoutManager.RecycleOutOfSightView() Method + +Recycle the out of sight view items. This method will remove all the views that are not visible anymore from the recycler view. +These views will be recycled and can be reused by the adapter. +This method should be called whenever the view port has changed. For example after scrolling or resizing the recycler view. + +```csharp +public override void RecycleOutOfSightView(); +``` + + + +## LinearLayoutManager.ReleaseChild(ViewHolder) Method + +Release the view holder. +view holder is released from user, will be re-layout, recycled from now on. + +```csharp +public void ReleaseChild(Tizen.UI.Components.Recycler.ViewHolder viewHolder); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewholer to be released. + +Implements [ReleaseChild(ViewHolder)](Tizen.UI.Components.Recycler.IChildSeizable.md#Tizen.UI.Components.Recycler.IChildSeizable.ReleaseChild(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IChildSeizable.ReleaseChild(Tizen.UI.Components.Recycler.ViewHolder)') + + + +## LinearLayoutManager.ScrollHorizontallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public override int ScrollHorizontallyBy(int dx); +``` +#### Parameters + + + +`dx` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + +## LinearLayoutManager.ScrollVerticallyBy(int) Method + +Layouts items to fill the requested direction. + +```csharp +public override int ScrollVerticallyBy(int dy); +``` +#### Parameters + + + +`dy` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The amount of pixels to scroll by. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +layouted size + + + +## LinearLayoutManager.SeizeChild(ViewHolder) Method + +Seize the view holder. +view holder is seized by user, will not be re-layout, recycled until it is released. + +```csharp +public void SeizeChild(Tizen.UI.Components.Recycler.ViewHolder viewHolder); +``` +#### Parameters + + + +`viewHolder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewholer to be seized. + +Implements [SeizeChild(ViewHolder)](Tizen.UI.Components.Recycler.IChildSeizable.md#Tizen.UI.Components.Recycler.IChildSeizable.SeizeChild(Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.IChildSeizable.SeizeChild(Tizen.UI.Components.Recycler.ViewHolder)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearSwapCallback.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearSwapCallback.md new file mode 100644 index 0000000000..e97d464e8c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearSwapCallback.md @@ -0,0 +1,97 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## LinearSwapCallback Class + +The simple abstract calss of [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback') for swap actions. +You have to override [OnMove(RecyclerView, ViewHolder, ViewHolder)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView,Tizen.UI.Components.Recycler.ViewHolder,Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView, Tizen.UI.Components.Recycler.ViewHolder, Tizen.UI.Components.Recycler.ViewHolder)') methods. + +```csharp +public abstract class LinearSwapCallback : Tizen.UI.Components.Recycler.ItemTouchHelperCallback +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback') 🡒 LinearSwapCallback +### Methods + + + +## LinearSwapCallback.GetMovementPolicy(RecyclerView, ViewHolder) Method + +Should return a composite policy which defines the enabled move directions in each state. + +```csharp +public override int GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView recyclerView, Tizen.UI.Components.Recycler.ViewHolder viewholder); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') + +The RecyclerView to which ItemTouchHelper is attached. + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder for which the movement information is necessary. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecycleScroller.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecycleScroller.md new file mode 100644 index 0000000000..bb1f2c8dee --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecycleScroller.md @@ -0,0 +1,387 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## RecycleScroller Class + +RecyclerView Scroller class. It handles the scrolling behavior of the RecyclerView. + +```csharp +public class RecycleScroller : Tizen.UI.ViewGroup +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 RecycleScroller +### Constructors + + + +## RecycleScroller(RecyclerView) Constructor + +Constructor of RecycleScroller. It initializes the properties and adds the scroller to the RecyclerView. + +```csharp +public RecycleScroller(Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Properties + + + +## RecycleScroller.CurrentViewPort Property + +The current view port area of the scroller. It represents the current scroll position and size of the RecyclerView. + +```csharp +public Tizen.UI.Rect CurrentViewPort { get; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## RecycleScroller.IsScrollAnimationStarted Property + +Indicates whether the scroll animation is started or not. If it is started, the RecyclerView is scrolling. + +```csharp +public bool IsScrollAnimationStarted { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecycleScroller.RecycleBody Property + +Child bodies with recycling in the scroller. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> RecycleBody { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## RecycleScroller.ScrollX Property + +Get the scroll x position of the scroller. + +```csharp +public float ScrollX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecycleScroller.ScrollY Property + +Get the scroll y position of the scroller. + +```csharp +public float ScrollY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecycleScroller.ViewPort Property + +The view port area of the scroller. It represents the scroll position and size of the RecyclerView. + +```csharp +public Tizen.UI.Rect ViewPort { get; } +``` + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## RecycleScroller.AddBody(View) Method + +Add the body view to the scroller. + +```csharp +public void AddBody(Tizen.UI.View child); +``` +#### Parameters + + + +`child` Tizen.UI.View + +The child body view to add. + + + +## RecycleScroller.AdjustChildPosition(float, float, Func<View,bool>) Method + +Add the child view in specific conditions. + +```csharp +public void AdjustChildPosition(float dx, float dy, System.Func<Tizen.UI.View,bool> condition); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal distance to adjust. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical distance to adjust. + + + +`condition` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.View[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The condition to adjust the child view. + + + +## RecycleScroller.AdjustScrollPosition(float, float) Method + +Adjust the scroll position by the specified distance. It moves the scroller and all its children by the specified distance. + +```csharp +public void AdjustScrollPosition(float dx, float dy); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal distance to adjust. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical distance to adjust. + + + +## RecycleScroller.Initialize() Method + +Initialize the scroller position. + +```csharp +public void Initialize(); +``` + + + +## RecycleScroller.MoveBy(float, float) Method + +Move the scroller by the specified distance. + +```csharp +public void MoveBy(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal distance to move. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical distance to move. + + + +## RecycleScroller.RemoveBody(View) Method + +Remove the body view from the scroller. + +```csharp +public void RemoveBody(Tizen.UI.View child); +``` +#### Parameters + + + +`child` Tizen.UI.View + +The child body view to remove. + + + +## RecycleScroller.ScrollBy(float, float, int, AlphaFunction) Method + +Scroll the scroller by the specified distance with animation. + +```csharp +public System.Threading.Tasks.Task ScrollBy(float x, float y, int duration=0, Tizen.UI.AlphaFunction alpha=null); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal distance to scroll. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical distance to scroll. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function of the animation. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task representing the asynchronous operation. + + + +## RecycleScroller.ScrollStop() Method + +Stop the scroll animation. + +```csharp +public void ScrollStop(); +``` +### Events + + + +## RecycleScroller.ScrollAnimationCanceled Event + +Event for scroll animation canceled. Invoked when the scroll animation cancels. + +```csharp +public event EventHandler ScrollAnimationCanceled; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## RecycleScroller.ScrollAnimationFinished Event + +Event for scroll animation finished. Invoked when the scroll animation finishs. + +```csharp +public event EventHandler ScrollAnimationFinished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## RecycleScroller.ScrollAnimationStarted Event + +Event for scroll animation started. Invoked when the scroll animation starts. + +```csharp +public event EventHandler ScrollAnimationStarted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## RecycleScroller.Scrolling Event + +Event for scrolling. Invoked when scrolling happens. + +```csharp +public event EventHandler<ScrollEventArgs> Scrolling; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecyclerView.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecyclerView.md new file mode 100644 index 0000000000..becd6717ce --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecyclerView.md @@ -0,0 +1,743 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## RecyclerView Class + +RecyclerView class. +It provides a flexible view for displaying large data sets that can be scrolled very efficiently by maintaining a limited number of views. +This class also supports smooth scrolling and animations. The RecyclerView works with a LayoutManager to position the items and Adapter to create them. +RecyclerView also has built-in support for animations. + +```csharp +public class RecyclerView : Tizen.UI.ViewGroup, +Tizen.UI.IDescendantFocusObserver, +Tizen.UI.IScrollable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 RecyclerView + +Implements Tizen.UI.IDescendantFocusObserver, Tizen.UI.IScrollable +### Constructors + + + +## RecyclerView() Constructor + +Constructor of RecyclerView. + +```csharp +public RecyclerView(); +``` +### Properties + + + +## RecyclerView.Adapter Property + +The adapter of RecyclerView. It is used to provide the data and create the views for the RecyclerView. + +```csharp +public Tizen.UI.Components.Recycler.Adapter Adapter { get; set; } +``` + +#### Property Value +[Adapter](Tizen.UI.Components.Recycler.Adapter.md 'Tizen.UI.Components.Recycler.Adapter') + + + +## RecyclerView.HasSticky Property + +Indicates whether the RecyclerView has a sticky item or not. If it has, the sticky item will be displayed at the top or left of the RecyclerView. + +```csharp +public bool HasSticky { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecyclerView.HorizontalEdgeEffect Property + +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') of horizontal scroll direction. + edge effect will be come when scroll over the edge of horizontal direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect HorizontalEdgeEffect { get; set; } +``` + +#### Property Value +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') + + + +## RecyclerView.InnerScroller Property + +The inner scroller of RecyclerView. It is used to handle the scrolling behavior of the RecyclerView. + +```csharp +public Tizen.UI.Components.Recycler.RecycleScroller InnerScroller { get; } +``` + +#### Property Value +[RecycleScroller](Tizen.UI.Components.Recycler.RecycleScroller.md 'Tizen.UI.Components.Recycler.RecycleScroller') + + + +## RecyclerView.InnerStickArea Property + +The inner sticky area of RecyclerView. It is used to manage the sticky items in the RecyclerView. + +```csharp +public Tizen.UI.Components.Recycler.StickyArea InnerStickArea { get; } +``` + +#### Property Value +[StickyArea](Tizen.UI.Components.Recycler.StickyArea.md 'Tizen.UI.Components.Recycler.StickyArea') + + + +## RecyclerView.IsScrolledToEnd Property + +Gets a value indicating whether the scrollable content has reached the end position. + +```csharp +public bool IsScrolledToEnd { get; } +``` + +Implements IsScrolledToEnd + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecyclerView.IsScrolledToStart Property + +Gets a value indicating whether the scrollable content has been scrolled to the start position. + +```csharp +public bool IsScrolledToStart { get; } +``` + +Implements IsScrolledToStart + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecyclerView.IsScrolling Property + +Gets a value indicating whether the scroll is currently in progress. + +```csharp +public bool IsScrolling { get; set; } +``` + +Implements IsScrolling + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecyclerView.ItemDecorations Property + +The list of decoration helper for items. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Components.Recycler.IItemDecoration> ItemDecorations { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[IItemDecoration](Tizen.UI.Components.Recycler.IItemDecoration.md 'Tizen.UI.Components.Recycler.IItemDecoration')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## RecyclerView.LastViewPort Property + +The last view port of RecyclerView. It represents the previous scroll area of the RecyclerView. + +```csharp +public Tizen.UI.Rect LastViewPort { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## RecyclerView.LayoutManager Property + +The layout manager of RecyclerView. It is used to define the layout strategy for the items in the RecyclerView. + +```csharp +public Tizen.UI.Components.Recycler.LayoutManager LayoutManager { get; set; } +``` + +#### Property Value +[LayoutManager](Tizen.UI.Components.Recycler.LayoutManager.md 'Tizen.UI.Components.Recycler.LayoutManager') + + + +## RecyclerView.OverScrollMode Property + +Set over scroll mode as type of [OverScrollMode](Tizen.UI.Components.Recycler.RecyclerView.md#Tizen.UI.Components.Recycler.RecyclerView.OverScrollMode 'Tizen.UI.Components.Recycler.RecyclerView.OverScrollMode'). +Default mode is [ContentScrolls](Tizen.UI.Components.OverScrollMode.md#Tizen.UI.Components.OverScrollMode.ContentScrolls 'Tizen.UI.Components.OverScrollMode.ContentScrolls'). + +```csharp +public Tizen.UI.Components.OverScrollMode OverScrollMode { get; set; } +``` + +#### Property Value +[OverScrollMode](Tizen.UI.Components.OverScrollMode.md 'Tizen.UI.Components.OverScrollMode') + + + +## RecyclerView.PrefetchBaseSize Property + +The prefetch base size of RecyclerView. It determines the size of the area that will be preloaded before and after the current view port. + +```csharp +public float PrefetchBaseSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RecyclerView.RecycledPoolSize Property + +Set maximum size of recylcing view holder pool. +The pool size is applied for each view type. + +```csharp +public int RecycledPoolSize { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## RecyclerView.ScrollDirection Property + +Gets or sets the direction of the scroll. + +```csharp +public Tizen.UI.ScrollDirection ScrollDirection { get; } +``` + +#### Property Value +Tizen.UI.ScrollDirection + + + +## RecyclerView.ScrollPosition Property + +Gets the current scroll position. + +```csharp +public Tizen.UI.Point ScrollPosition { get; } +``` + +#### Property Value +Tizen.UI.Point + + + +## RecyclerView.StickyCandidateVisible Property + +Indicates whether the sticky candidate item is visible or not. If it is visible, the sticky candidate item will be displayed in the RecyclerView. + +```csharp +public bool StickyCandidateVisible { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## RecyclerView.VerticalEdgeEffect Property + +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') of vertical scroll direction. + edge effect will be come when scroll over the edge of vertical direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect VerticalEdgeEffect { get; set; } +``` + +#### Property Value +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') + + + +## RecyclerView.ViewPort Property + +The view port of RecyclerView. It represents the scroll area of the RecyclerView. + +```csharp +public Tizen.UI.Rect ViewPort { get; } +``` + +Implements ViewPort + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## RecyclerView.ClearRecycledViewPool() Method + +Clear all recycled view holders from the recycled pool. + +```csharp +public void ClearRecycledViewPool(); +``` + + + +## RecyclerView.FirstCompletelyVisibleItemPosition() Method + +Get the position of first completely visible items in the recyclerView. + +```csharp +public int FirstCompletelyVisibleItemPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the first completely visible item. + + + +## RecyclerView.FirstRealizedPosition() Method + +Get the position of first realized items in the recyclerView. + +```csharp +public int FirstRealizedPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the first realized item. + + + +## RecyclerView.FirstVisibleItemPosition() Method + +Get the position of first visible items in the recyclerView. + +```csharp +public int FirstVisibleItemPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the first visible item. + + + +## RecyclerView.GetBodyForGroup(int) Method + +Get the body ViewHolder for the specified group. If the body is not realized, it creates a new one. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder GetBodyForGroup(int group); +``` +#### Parameters + + + +`group` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the group within the adapter's data set + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +A ViewHolder of body that displays the data at the specified position. + + + +## RecyclerView.GetItemViewType(int) Method + +Get the type of View for the specified item. + +```csharp +public int GetItemViewType(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item within the adapter's data set + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## RecyclerView.GetRealized(int) Method + +Get the realized view of the specified position. If the view is not realized, it returns null. + +```csharp +public Tizen.UI.View GetRealized(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item to get the view. + +#### Returns +Tizen.UI.View +The realized view of the specified position. + + + +## RecyclerView.GetViewHolderForPosition(int) Method + +Get the ViewHolder for the specified position. If the view is not realized, it creates a new one. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder GetViewHolderForPosition(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item within the adapter's data set + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +A ViewHolder that displays the data at the specified position. + + + +## RecyclerView.LastCompletelyVisibleItemPosition() Method + +Get the position of last completely visible items in the recyclerView. + +```csharp +public int LastCompletelyVisibleItemPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the last completely visible item. + + + +## RecyclerView.LastRealizedPosition() Method + +Get the position of last realized items in the recyclerView. + +```csharp +public int LastRealizedPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the last realized item. + + + +## RecyclerView.LastVisibleItemPosition() Method + +Get the position of last visible items in the recyclerView. + +```csharp +public int LastVisibleItemPosition(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The position of the last visible item. + + + +## RecyclerView.Measure(float, float) Method + +Measures the view based on the available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +Tizen.UI.Size +The measured size of the view. + + + +## RecyclerView.RecycleViewHolder(ViewHolder) Method + +Recycles the specified ViewHolder. +It removes the view from the RecyclerView and hides it. Then, it puts the ViewHolder back into the recycled pool. + +```csharp +public void RecycleViewHolder(Tizen.UI.Components.Recycler.ViewHolder viewholder); +``` +#### Parameters + + + +`viewholder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The viewHolder to recycle. + + + +## RecyclerView.ScrollBy(float, float, bool) Method + +Scrolls the RecyclerView to the specified position with the given offset. + +```csharp +public System.Threading.Tasks.Task ScrollBy(float x, float y, bool animation=true); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x distance to scroll. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x distance to scroll. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether the scrolling should be animated or not. + +Implements ScrollBy(float, float, bool)') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task representing the asynchronous operation. + + + +## RecyclerView.ScrollTo(int, ScrollToPosition, bool) Method + +Scrolls the RecyclerView to show the index position item in specified position with animation. + +```csharp +public System.Threading.Tasks.Task ScrollTo(int position, Tizen.UI.ScrollToPosition scrollToPosition=Tizen.UI.ScrollToPosition.MakeVisible, bool animation=true); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position of the item to be shown. + + + +`scrollToPosition` Tizen.UI.ScrollToPosition + +The position to scroll to. It can be Start, Center, or End. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether the scrolling should be animated or not. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task representing the asynchronous operation. +### Events + + + +## RecyclerView.DragFinished Event + +Event for drag ended. Invoked when dragging ends. + +```csharp +public event EventHandler<DragEventArgs> DragFinished; +``` + +Implements DragFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.Dragging Event + +Event for dragging. Invoked when dragging happens. + +```csharp +public event EventHandler<DragEventArgs> Dragging; +``` + +Implements Dragging + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.DragStarted Event + +Event for drag started. Invoked when dragging starts. + +```csharp +public event EventHandler<DragEventArgs> DragStarted; +``` + +Implements DragStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.ScrollCanceled Event + +Event for scroll canceled. Invoked when scrolling canceled. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollCanceled; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.ScrollFinished Event + +Event for scroll finished. Invoked when scrolling finishs. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollFinished; +``` + +Implements ScrollFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.Scrolling Event + +Event for scrolling. Invoked when scrolling happens. + +```csharp +public event EventHandler<ScrollEventArgs> Scrolling; +``` + +Implements Scrolling + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## RecyclerView.ScrollStarted Event + +Event for scroll started. Invoked when scrolling starts. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollStarted; +``` + +Implements ScrollStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectableModel.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectableModel.md new file mode 100644 index 0000000000..bf28dc4346 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectableModel.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## SelectableModel Class + +An abstract selectable data model which implements [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). + +```csharp +public abstract class SelectableModel : Tizen.UI.Components.Recycler.ViewModel, +Tizen.UI.Components.Recycler.ISelectableModel, +System.ComponentModel.INotifyPropertyChanged +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [ViewModel](Tizen.UI.Components.Recycler.ViewModel.md 'Tizen.UI.Components.Recycler.ViewModel') 🡒 SelectableModel + +Implements [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'), [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') +### Constructors + + + +## SelectableModel() Constructor + +SelectableModel constructor. initalize the property value. + +```csharp +public SelectableModel(); +``` +### Properties + + + +## SelectableModel.IsSelectable Property + +Boolean value whether this model can be selectable or not. + +```csharp +public bool IsSelectable { get; set; } +``` + +Implements [IsSelectable](Tizen.UI.Components.Recycler.ISelectableModel.md#Tizen.UI.Components.Recycler.ISelectableModel.IsSelectable 'Tizen.UI.Components.Recycler.ISelectableModel.IsSelectable') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectableModel.IsSelected Property + +Boolean value whether this model is selected or not. + +```csharp +public bool IsSelected { get; set; } +``` + +Implements [IsSelected](Tizen.UI.Components.Recycler.ISelectableModel.md#Tizen.UI.Components.Recycler.ISelectableModel.IsSelected 'Tizen.UI.Components.Recycler.ISelectableModel.IsSelected') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md new file mode 100644 index 0000000000..6c6c7b77b2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md @@ -0,0 +1,158 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## SelectionModelGroup<T> Class + +An abstract class for the observable group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). +The group can have multiple selected children. + +```csharp +public abstract class SelectionModelGroup<T> : System.Collections.ObjectModel.ObservableCollection<T>, +Tizen.UI.Components.Recycler.ISelectionModelGroup<T>, +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable, +Tizen.UI.Components.Recycler.ISelectionModelGroup, +System.Collections.IList, +System.Collections.ICollection, +Tizen.UI.Components.Recycler.ISelectableModel, +System.ComponentModel.INotifyPropertyChanged + where T : Tizen.UI.Components.Recycler.ISelectableModel +``` +#### Type parameters + + + +`T` + +The child object who implements ISelectableModel + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Collections.ObjectModel.Collection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1') 🡒 [System.Collections.ObjectModel.ObservableCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1') 🡒 SelectionModelGroup<T> + +Implements [Tizen.UI.Components.Recycler.ISelectionModelGroup<](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable'), [ISelectionModelGroup](Tizen.UI.Components.Recycler.ISelectionModelGroup.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup'), [System.Collections.IList](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IList 'System.Collections.IList'), [System.Collections.ICollection](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ICollection 'System.Collections.ICollection'), [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'), [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') +### Properties + + + +## SelectionModelGroup<T>.IsSelectable Property + +Boolean value for whether this group is selectable or not. +The value only propagates to the children when it set. +so even though, all children are selectable, group selectable still can be false. +default value is true; + +```csharp +public bool IsSelectable { get; set; } +``` + +Implements [IsSelectable](Tizen.UI.Components.Recycler.ISelectableModel.md#Tizen.UI.Components.Recycler.ISelectableModel.IsSelectable 'Tizen.UI.Components.Recycler.ISelectableModel.IsSelectable') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionModelGroup<T>.IsSelected Property + +Boolean value for whether this group is selected or not. +All children will be propagated value when it set. +If all children are selected, the value will be true. + +```csharp +public bool IsSelected { get; set; } +``` + +Implements [IsSelected](Tizen.UI.Components.Recycler.ISelectableModel.md#Tizen.UI.Components.Recycler.ISelectableModel.IsSelected 'Tizen.UI.Components.Recycler.ISelectableModel.IsSelected') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionModelGroup<T>.SelectedChildren Property + +The read only list of selected children. + +```csharp +public System.Collections.Generic.IReadOnlyCollection<T> SelectedChildren { get; } +``` + +Implements [SelectedChildren](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.SelectedChildren 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>.SelectedChildren') + +#### Property Value +[System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[T](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md#Tizen.UI.Components.Recycler.SelectionModelGroup_T_.T 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') + + + +## SelectionModelGroup<T>.SelectedCount Property + +The count of the selected children. +If the groups are nested tree, it will return the count of selected leaf node. +To get the selected children count in nested group, please use SelectedChildren.Count. + +```csharp +public int SelectedCount { get; } +``` + +Implements [SelectedCount](Tizen.UI.Components.Recycler.ISelectionModelGroup.md#Tizen.UI.Components.Recycler.ISelectionModelGroup.SelectedCount 'Tizen.UI.Components.Recycler.ISelectionModelGroup.SelectedCount') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.StickyArea.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.StickyArea.md new file mode 100644 index 0000000000..baffbbaf99 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.StickyArea.md @@ -0,0 +1,166 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## StickyArea Class + +Sticky area of RecyclerView. + +```csharp +public class StickyArea : Tizen.UI.ViewGroup +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 StickyArea +### Constructors + + + +## StickyArea(RecyclerView) Constructor + +Constructor of StickyArea. + +```csharp +public StickyArea(Tizen.UI.Components.Recycler.RecyclerView recyclerView); +``` +#### Parameters + + + +`recyclerView` [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') +### Methods + + + +## StickyArea.Add(ViewHolder) Method + +Add the sticky item to the sticky area. + +```csharp +public void Add(Tizen.UI.Components.Recycler.ViewHolder holder); +``` +#### Parameters + + + +`holder` [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') + +The ViewHolder of the item to add. + + + +## StickyArea.CreatePrecedingStickyView(int) Method + +Create the preceding sticky view for the specified position. If there is no preceding sticky view, it returns null. + +```csharp +public Tizen.UI.Components.Recycler.ViewHolder CreatePrecedingStickyView(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position to create the preceding sticky view. + +#### Returns +[ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') +The preceding sticky view for the specified position. + + + +## StickyArea.Has(int) Method + +Check if the position is in the sticky area. If it is, the item will be displayed as a sticky item. + +```csharp +public bool Has(int position); +``` +#### Parameters + + + +`position` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the position is in the sticky area, otherwise false. + + + +## StickyArea.Initialize() Method + +Initialize the sticky area. It clears all the sticky items and resets the sticky area. + +```csharp +public void Initialize(); +``` + + + +## StickyArea.Sync() Method + +Sync the sticky area with the RecyclerView. It updates the sticky items based on the current scroll position. + +```csharp +public void Sync(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchActionState.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchActionState.md new file mode 100644 index 0000000000..95168ce06c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchActionState.md @@ -0,0 +1,83 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## TouchActionState Enum + +Touch Action State. +This enum indicate what action is on ItemTouchHelper. + +```csharp +public enum TouchActionState +``` +### Fields + + + +`Drag` 1 + +A selected view is currently being dragged. + + + +`Idle` 0 + +Idle State. +At this state, either there is no related motion event by the user +or latest motion events have not yet triggered. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchDirection.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchDirection.md new file mode 100644 index 0000000000..6fc8391d24 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchDirection.md @@ -0,0 +1,104 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## TouchDirection Enum + +The direction of Touch. + +```csharp +public enum TouchDirection +``` +### Fields + + + +`Down` 2 + +Down direction. + + + +`Horizontal` 12 + +The horizontal direction with left and right. + + + +`Left` 4 + +Left direction. + + + +`Right` 8 + +Right direction. + + + +`Up` 1 + +Up direction. + + + +`Vertical` 3 + +The vertical direction with up and down. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewHolder.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewHolder.md new file mode 100644 index 0000000000..6235e5b245 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewHolder.md @@ -0,0 +1,227 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ViewHolder Class + +ViewHolder is a class that holds the view of an item. + +```csharp +public class ViewHolder +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewHolder +### Properties + + + +## ViewHolder.BindingContext Property + +The binding context of view. + +```csharp +public object BindingContext { get; set; } +``` + +#### Property Value +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + + + +## ViewHolder.BoundsModifier Property + +The bounds modifier of the item view. This value is used to modify the size and position of the item view. + +```csharp +public Tizen.UI.Thickness BoundsModifier { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ViewHolder.Frame Property + +The frame of the item view. + +```csharp +public Tizen.UI.Rect Frame { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## ViewHolder.IsDivider Property + +The flag indicating whether the view holder is divider or not. + +```csharp +public bool IsDivider { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ViewHolder.IsRecycled Property + +The flag indicating whether the view holder has been recycled or not. + +```csharp +public bool IsRecycled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ViewHolder.IsSeized Property + +The flag indicating whether the view holder is seized or not. + +```csharp +public bool IsSeized { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ViewHolder.ItemHeight Property + +The total height of the item view. + +```csharp +public float ItemHeight { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ViewHolder.ItemSpanSize Property + +The span size of the item view. This value is used to determine how many cells the item view occupies in a grid layout. + +```csharp +public uint ItemSpanSize { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## ViewHolder.ItemView Property + +The view of the item. + +```csharp +public Tizen.UI.View ItemView { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## ViewHolder.ItemViewType Property + +The type of the item view. This value is used to determine which layout to use for the item. + +```csharp +public int ItemViewType { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ViewHolder.ItemWidth Property + +The total width of the item view. + +```csharp +public float ItemWidth { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ViewHolder.Position Property + +The position of the item in the adapter. + +```csharp +public int Position { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModel.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModel.md new file mode 100644 index 0000000000..6d1f834036 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModel.md @@ -0,0 +1,75 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ViewModel Class + +View model which implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') with helper methods. + +```csharp +public abstract class ViewModel : +System.ComponentModel.INotifyPropertyChanged +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewModel + +Derived +↳ [SelectableModel](Tizen.UI.Components.Recycler.SelectableModel.md 'Tizen.UI.Components.Recycler.SelectableModel') + +Implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModelGroup_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModelGroup_T_.md new file mode 100644 index 0000000000..16eb4de2f2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModelGroup_T_.md @@ -0,0 +1,75 @@ +### [Tizen.UI.Components.Recycler](Tizen.UI.Components.Recycler.md 'Tizen.UI.Components.Recycler') + +## ViewModelGroup<T> Class + +View model group for [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') with helper methods. + +```csharp +public abstract class ViewModelGroup<T> : System.Collections.ObjectModel.ObservableCollection<T> + where T : System.ComponentModel.INotifyPropertyChanged +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Collections.ObjectModel.Collection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1')[T](Tizen.UI.Components.Recycler.ViewModelGroup_T_.md#Tizen.UI.Components.Recycler.ViewModelGroup_T_.T 'Tizen.UI.Components.Recycler.ViewModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.Collection-1 'System.Collections.ObjectModel.Collection`1') 🡒 [System.Collections.ObjectModel.ObservableCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1')[T](Tizen.UI.Components.Recycler.ViewModelGroup_T_.md#Tizen.UI.Components.Recycler.ViewModelGroup_T_.T 'Tizen.UI.Components.Recycler.ViewModelGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.ObjectModel.ObservableCollection-1 'System.Collections.ObjectModel.ObservableCollection`1') 🡒 ViewModelGroup<T> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.md new file mode 100644 index 0000000000..42072a5e4b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.md @@ -0,0 +1,108 @@ + +## Tizen.UI.Components.Recycler Namespace + +| Classes | | +| :--- | :--- | +| [Adapter](Tizen.UI.Components.Recycler.Adapter.md 'Tizen.UI.Components.Recycler.Adapter') | Adapter provide a binding from an app-specific data set to views that
are displayed within a [RecyclerView](Tizen.UI.Components.Recycler.Adapter.md#Tizen.UI.Components.Recycler.Adapter.RecyclerView 'Tizen.UI.Components.Recycler.Adapter.RecyclerView'). | +| [AnimationFinishedEventArgs](Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md 'Tizen.UI.Components.Recycler.AnimationFinishedEventArgs') | Event arguments for when an animation completes. | +| [DefaultItemAnimator](Tizen.UI.Components.Recycler.DefaultItemAnimator.md 'Tizen.UI.Components.Recycler.DefaultItemAnimator') | Default implementation of IItemAnimator. | +| [ExclusiveSelectionModelGroup<T>](Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup<T>') | An abstract class for the observable group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel').
The group can only have one selected children exclusively. | +| [GridLayoutManager](Tizen.UI.Components.Recycler.GridLayoutManager.md 'Tizen.UI.Components.Recycler.GridLayoutManager') | Grid layout manager for grid view. | +| [GroupInfo](Tizen.UI.Components.Recycler.GroupInfo.md 'Tizen.UI.Components.Recycler.GroupInfo') | The information data of the groups. | +| [GroupItemSource](Tizen.UI.Components.Recycler.GroupItemSource.md 'Tizen.UI.Components.Recycler.GroupItemSource') | The class that provides the grouped data source for adapter. | +| [GroupItemTemplateAdapter](Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.GroupItemTemplateAdapter') | The apdater using ViewTemplate for creates items and groups. | +| [HolderExtensions](Tizen.UI.Components.Recycler.HolderExtensions.md 'Tizen.UI.Components.Recycler.HolderExtensions') | View holder extension method. | +| [HolderInfo](Tizen.UI.Components.Recycler.HolderInfo.md 'Tizen.UI.Components.Recycler.HolderInfo') | The information data of the view holder. | +| [ItemTemplateAdapter](Tizen.UI.Components.Recycler.ItemTemplateAdapter.md 'Tizen.UI.Components.Recycler.ItemTemplateAdapter') | The apdater using ViewTemplate for creates items. | +| [ItemTouchHelper](Tizen.UI.Components.Recycler.ItemTouchHelper.md 'Tizen.UI.Components.Recycler.ItemTouchHelper') | Item touch helper for [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView').
This is a utility class to add touch action support to [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView')..
It works with a [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView'). and a [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback'). class, which configures what type of interactions
are enabled and also receives events when user performs these actions.
Depending on which functionality you support, you should override methods in [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback'). | +| [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback') | This class is the contract between ItemTouchHelper and your application. It lets you control
which touch behaviors are enabled per each ViewHolder and also receive callbacks when user performs these actions.
o control which actions user can take on each view, you should override
[GetMovementPolicy(RecyclerView, ViewHolder)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView,Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.GetMovementPolicy(Tizen.UI.Components.Recycler.RecyclerView, Tizen.UI.Components.Recycler.ViewHolder)') and return appropriate set of direction flags. | +| [LayoutManager](Tizen.UI.Components.Recycler.LayoutManager.md 'Tizen.UI.Components.Recycler.LayoutManager') | The base class for layout managers. A layout manager is responsible for positioning and sizing the child views in a recycler view. | +| [LinearLayoutManager](Tizen.UI.Components.Recycler.LinearLayoutManager.md 'Tizen.UI.Components.Recycler.LinearLayoutManager') | A linear layout manager that arranges items in a single row or column. | +| [LinearSwapCallback](Tizen.UI.Components.Recycler.LinearSwapCallback.md 'Tizen.UI.Components.Recycler.LinearSwapCallback') | The simple abstract calss of [ItemTouchHelperCallback](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback') for swap actions.
You have to override [OnMove(RecyclerView, ViewHolder, ViewHolder)](Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md#Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView,Tizen.UI.Components.Recycler.ViewHolder,Tizen.UI.Components.Recycler.ViewHolder) 'Tizen.UI.Components.Recycler.ItemTouchHelperCallback.OnMove(Tizen.UI.Components.Recycler.RecyclerView, Tizen.UI.Components.Recycler.ViewHolder, Tizen.UI.Components.Recycler.ViewHolder)') methods. | +| [RecyclerView](Tizen.UI.Components.Recycler.RecyclerView.md 'Tizen.UI.Components.Recycler.RecyclerView') | RecyclerView class.
It provides a flexible view for displaying large data sets that can be scrolled very efficiently by maintaining a limited number of views.
This class also supports smooth scrolling and animations. The RecyclerView works with a LayoutManager to position the items and Adapter to create them.
RecyclerView also has built-in support for animations. | +| [RecycleScroller](Tizen.UI.Components.Recycler.RecycleScroller.md 'Tizen.UI.Components.Recycler.RecycleScroller') | RecyclerView Scroller class. It handles the scrolling behavior of the RecyclerView. | +| [SelectableModel](Tizen.UI.Components.Recycler.SelectableModel.md 'Tizen.UI.Components.Recycler.SelectableModel') | An abstract selectable data model which implements [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel'). | +| [SelectionModelGroup<T>](Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.SelectionModelGroup<T>') | An abstract class for the observable group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel').
The group can have multiple selected children. | +| [StickyArea](Tizen.UI.Components.Recycler.StickyArea.md 'Tizen.UI.Components.Recycler.StickyArea') | Sticky area of RecyclerView. | +| [ViewHolder](Tizen.UI.Components.Recycler.ViewHolder.md 'Tizen.UI.Components.Recycler.ViewHolder') | ViewHolder is a class that holds the view of an item. | +| [ViewModel](Tizen.UI.Components.Recycler.ViewModel.md 'Tizen.UI.Components.Recycler.ViewModel') | View model which implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') with helper methods. | +| [ViewModelGroup<T>](Tizen.UI.Components.Recycler.ViewModelGroup_T_.md 'Tizen.UI.Components.Recycler.ViewModelGroup<T>') | View model group for [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') with helper methods. | + +| Interfaces | | +| :--- | :--- | +| [IChildSeizable](Tizen.UI.Components.Recycler.IChildSeizable.md 'Tizen.UI.Components.Recycler.IChildSeizable') | Interface that Layouter child can be seized and un-handled by layouter or recycled.
This interface will be used on [ItemTouchHelper](Tizen.UI.Components.Recycler.ItemTouchHelper.md 'Tizen.UI.Components.Recycler.ItemTouchHelper'). | +| [IDividerProvider](Tizen.UI.Components.Recycler.IDividerProvider.md 'Tizen.UI.Components.Recycler.IDividerProvider') | The interface for a divider adapter. It is used to provide data for the RecyclerView. | +| [IGridRelativeSizeHelper](Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md 'Tizen.UI.Components.Recycler.IGridRelativeSizeHelper') | Interface for [GridView](https://docs.microsoft.com/en-us/dotnet/api/GridView 'GridView') sizing item by aspect ratio. | +| [IGridSpanHelper](Tizen.UI.Components.Recycler.IGridSpanHelper.md 'Tizen.UI.Components.Recycler.IGridSpanHelper') | [GridView](https://docs.microsoft.com/en-us/dotnet/api/GridView 'GridView') span helper interface. It provides additional information about item's span. | +| [IGroupedAdapter](Tizen.UI.Components.Recycler.IGroupedAdapter.md 'Tizen.UI.Components.Recycler.IGroupedAdapter') | The interface for a grouped adapter. It is used to provide data for the RecyclerView. | +| [IGroupedItem](Tizen.UI.Components.Recycler.IGroupedItem.md 'Tizen.UI.Components.Recycler.IGroupedItem') | Interface for grouped item.
This interface is not mendatory to implement, but if you want to update the item's by the group position, you can use this interface. | +| [IItemAnimator](Tizen.UI.Components.Recycler.IItemAnimator.md 'Tizen.UI.Components.Recycler.IItemAnimator') | An interface to animate changes to the views in a RecyclerView. | +| [IItemDecoration](Tizen.UI.Components.Recycler.IItemDecoration.md 'Tizen.UI.Components.Recycler.IItemDecoration') | Interface for item decoration. It provides additional information about item's position | +| [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel') | Interface for model which provides data selectable. | +| [ISelectionModelGroup](Tizen.UI.Components.Recycler.ISelectionModelGroup.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup') | An interface for the group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel').
The group can have multiple selected children. | +| [ISelectionModelGroup<T>](Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md 'Tizen.UI.Components.Recycler.ISelectionModelGroup<T>') | An generic interface for the group collection of [ISelectableModel](Tizen.UI.Components.Recycler.ISelectableModel.md 'Tizen.UI.Components.Recycler.ISelectableModel').
The group can have multiple selected children. | + +| Enums | | +| :--- | :--- | +| [AnimationType](Tizen.UI.Components.Recycler.AnimationType.md 'Tizen.UI.Components.Recycler.AnimationType') | Types of animations. | +| [TouchActionState](Tizen.UI.Components.Recycler.TouchActionState.md 'Tizen.UI.Components.Recycler.TouchActionState') | Touch Action State.
This enum indicate what action is on ItemTouchHelper. | +| [TouchDirection](Tizen.UI.Components.Recycler.TouchDirection.md 'Tizen.UI.Components.Recycler.TouchDirection') | The direction of Touch. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScaffoldBase.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScaffoldBase.md new file mode 100644 index 0000000000..3507fa3425 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScaffoldBase.md @@ -0,0 +1,202 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ScaffoldBase Class + +A base class of scaffold which need to be root view of application. +Application can have a scaffold in a window to layout content properly +with some spefical UI layout and behavior. + +```csharp +public abstract class ScaffoldBase : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 ScaffoldBase +### Constructors + + + +## ScaffoldBase() Constructor + +Constructs an empty Scaffoldbase. + +```csharp +public ScaffoldBase(); +``` +### Properties + + + +## ScaffoldBase.FloatingActionButton Property + +Gets or sets a floating action button. +This button will be placed at the bottom right corner of the scaffold above the content. + +```csharp +public Tizen.UI.View FloatingActionButton { get; set; } +``` + +#### Property Value +Tizen.UI.View + +### Remarks +There are predefined contents such as [FloatingActionButton](Tizen.UI.Components.ScaffoldBase.md#Tizen.UI.Components.ScaffoldBase.FloatingActionButton 'Tizen.UI.Components.ScaffoldBase.FloatingActionButton'). + + + +## ScaffoldBase.FloatingOffset Property + +The relative offset of the floating action button from the bottom edge of the scaffold. + +```csharp +public Tizen.UI.Point FloatingOffset { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## ScaffoldBase.FloatingOrigin Property + +Gets or sets a origin type of floating action button regarding positioning. +This may change position and pivot properties of the floating action button. + +```csharp +public Tizen.UI.Components.FloatingOrigin FloatingOrigin { get; set; } +``` + +#### Property Value +[FloatingOrigin](Tizen.UI.Components.FloatingOrigin.md 'Tizen.UI.Components.FloatingOrigin') + + + +## ScaffoldBase.HasIndicatorArea Property + +Boolean flag whether system indicator area is included or not. +If it is true, indicator height will be placed on the scaffold. + +```csharp +public bool HasIndicatorArea { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ScaffoldBase.HasNavigationBarArea Property + +Boolean flag whether system navigation bar area is included or not. +If it is true, navigation bar height will be placed on the scaffold. + +```csharp +public bool HasNavigationBarArea { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ScaffoldBase.IndicatorAreaColor Property + +Gets or sets the color of indicator area. +If this property is set, the color of indicator area will be set to this color regardless of other properties. +If this property is set to `Color.Default` the color of indicator area will be set to the color provided from the [IndicatorAreaColorProvider](Tizen.UI.Components.ScaffoldBase.md#Tizen.UI.Components.ScaffoldBase.IndicatorAreaColorProvider 'Tizen.UI.Components.ScaffoldBase.IndicatorAreaColorProvider'). +If [IndicatorAreaColorProvider](Tizen.UI.Components.ScaffoldBase.md#Tizen.UI.Components.ScaffoldBase.IndicatorAreaColorProvider 'Tizen.UI.Components.ScaffoldBase.IndicatorAreaColorProvider') not set, the color of indicator area will be transparent. + +```csharp +public Tizen.UI.Color IndicatorAreaColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ScaffoldBase.IndicatorAreaColorProvider Property + +Gets or sets a color provider to the scaffold. + +```csharp +public Tizen.UI.Components.IColorProvider IndicatorAreaColorProvider { get; set; } +``` + +#### Property Value +[IColorProvider](Tizen.UI.Components.IColorProvider.md 'Tizen.UI.Components.IColorProvider') +### Methods + + + +## ScaffoldBase.SetExtraFloatingOffsetY(float) Method + +Sets an additional vertical offset for floating components. +Adjusts the Y position of the scaffold's floating action button by applying the specified offset. + +```csharp +public void SetExtraFloatingOffsetY(float extra); +``` +#### Parameters + + + +`extra` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollBarBase.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollBarBase.md new file mode 100644 index 0000000000..4ac35de9e3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollBarBase.md @@ -0,0 +1,287 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ScrollBarBase Class + +A base class representing a scroll bar that can be used to control the scrolling of a view. + +```csharp +public class ScrollBarBase : Tizen.UI.ViewGroup, +Tizen.UI.IScrollBar, +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 ScrollBarBase + +Implements Tizen.UI.IScrollBar, [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## ScrollBarBase() Constructor + +Initializes a new instance of the Tizen.UI.Layouts.ScrollBar class. + +```csharp +public ScrollBarBase(); +``` +### Properties + + + +## ScrollBarBase.BarColor Property + +Gets or sets the color of the scroll bar. + +```csharp +public Tizen.UI.Color BarColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## ScrollBarBase.BarCornerRadius Property + +Gets or sets the corner of the scroll bar. + +```csharp +public Tizen.UI.CornerRadius BarCornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + +## ScrollBarBase.BarMargin Property + +Gets or sets the margin between the scroll bar and its target view. + +```csharp +public Tizen.UI.Thickness BarMargin { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## ScrollBarBase.BarMinSize Property + +Gets or sets the minimum size of the scroll bar. + +```csharp +public float BarMinSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ScrollBarBase.BarShadow Property + +Gets or sets the shadow of scroll bar. + +```csharp +public Tizen.UI.Shadow BarShadow { get; set; } +``` + +#### Property Value +Tizen.UI.Shadow + + + +## ScrollBarBase.BarThickness Property + +Gets or sets the thickness of the scroll bar. + +```csharp +public float BarThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ScrollBarBase.HorizontalScrollBarVisibility Property + +Gets or sets the visibility of the horizontal scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility HorizontalScrollBarVisibility { get; set; } +``` + +Implements HorizontalScrollBarVisibility + +#### Property Value +Tizen.UI.ScrollBarVisibility + + + +## ScrollBarBase.ScrollPosition Property + +Gets or sets the current scroll position of the target view. + +```csharp +public Tizen.UI.Point ScrollPosition { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## ScrollBarBase.Target Property + +Gets the target view of the scroll bar. + +```csharp +public Tizen.UI.View Target { get; } +``` + +Implements Target + +#### Property Value +Tizen.UI.View + + + +## ScrollBarBase.VerticalScrollBarVisibility Property + +Gets or sets the visibility of the vertical scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility VerticalScrollBarVisibility { get; set; } +``` + +Implements VerticalScrollBarVisibility + +#### Property Value +Tizen.UI.ScrollBarVisibility +### Methods + + + +## ScrollBarBase.UpdateBarSize(Size, Size) Method + +Updates the size of the scroll bar based on the current scroll area and view port size. + +```csharp +public virtual void UpdateBarSize(Tizen.UI.Size scrollArea, Tizen.UI.Size viewportSize); +``` +#### Parameters + + + +`scrollArea` Tizen.UI.Size + +The size of the scrollable area. + + + +`viewportSize` Tizen.UI.Size + +The size of the view port. + +Implements UpdateBarSize(Size, Size)') + + + +## ScrollBarBase.UpdateScrollPosition(Point) Method + +Updates the scroll position of the target view. + +```csharp +public virtual void UpdateScrollPosition(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` Tizen.UI.Point + +The new scroll position. + +Implements UpdateScrollPosition(Point)') +### Explicit Interface Implementations + + + +## ScrollBarBase.Tizen.UI.IScrollBar.OnAttachedToScrollable(IScrollable) Method + +Call when Tizen.UI.IScrollable is attached to the ScrollBar. + +```csharp +void Tizen.UI.IScrollBar.OnAttachedToScrollable(Tizen.UI.IScrollable scrollable); +``` +#### Parameters + + + +`scrollable` Tizen.UI.IScrollable + +The scrollable. + +Implements OnAttachedToScrollable(IScrollable)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Scrollable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Scrollable.md new file mode 100644 index 0000000000..56c8105cfb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Scrollable.md @@ -0,0 +1,568 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Scrollable Class + +A scrollable view that can be scrolled. + +```csharp +public class Scrollable : Tizen.UI.Layouts.Layout, +Tizen.UI.IDescendantFocusObserver, +Tizen.UI.IScrollable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Tizen.UI.Layouts.Layout 🡒 Scrollable + +Implements Tizen.UI.IDescendantFocusObserver, Tizen.UI.IScrollable +### Constructors + + + +## Scrollable() Constructor + +Initializes a new instance of the [Scrollable](Tizen.UI.Components.Scrollable.md 'Tizen.UI.Components.Scrollable') class. + +```csharp +public Scrollable(); +``` +### Properties + + + +## Scrollable.CanScrollHorizontally Property + +Check whether scroller can scroll horizontally or not. + +```csharp +public bool CanScrollHorizontally { get; } +``` + +Implements CanScrollHorizontally + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.CanScrollVertically Property + +Check whether scroller can scroll Vertically or not. + +```csharp +public bool CanScrollVertically { get; } +``` + +Implements CanScrollVertically + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.Content Property + +Gets or sets the content of the scroll view. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## Scrollable.HorizontalEdgeEffect Property + +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') of horizontal scroll direction. + edge effect will be come when scroll over the edge of horizontal direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect HorizontalEdgeEffect { get; set; } +``` + +#### Property Value +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') + + + +## Scrollable.HorizontalScrollBarVisibility Property + +Gets or sets the visibility of the horizontal scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility HorizontalScrollBarVisibility { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollBarVisibility + + + +## Scrollable.IsScrolledToEnd Property + +Gets a value indicating whether the scrollable content has reached the end position. + +```csharp +public bool IsScrolledToEnd { get; } +``` + +Implements IsScrolledToEnd + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.IsScrolledToStart Property + +Gets a value indicating whether the scrollable content has been scrolled to the start position. + +```csharp +public bool IsScrolledToStart { get; } +``` + +Implements IsScrolledToStart + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.IsScrolling Property + +Gets a value indicating whether the scroll is currently in progress. + +```csharp +public bool IsScrolling { get; set; } +``` + +Implements IsScrolling + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.OverScrollMode Property + +Set over scroll mode as type of [OverScrollMode](Tizen.UI.Components.Scrollable.md#Tizen.UI.Components.Scrollable.OverScrollMode 'Tizen.UI.Components.Scrollable.OverScrollMode'). +Default mode is [ContentScrolls](Tizen.UI.Components.OverScrollMode.md#Tizen.UI.Components.OverScrollMode.ContentScrolls 'Tizen.UI.Components.OverScrollMode.ContentScrolls'). + +```csharp +public Tizen.UI.Components.OverScrollMode OverScrollMode { get; set; } +``` + +#### Property Value +[OverScrollMode](Tizen.UI.Components.OverScrollMode.md 'Tizen.UI.Components.OverScrollMode') + + + +## Scrollable.ScrollableHeight Property + +Gets or sets the height of the scrollable content. + +```csharp +public float ScrollableHeight { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Scrollable.ScrollableWidth Property + +Gets or sets the width of the scrollable content. + +```csharp +public float ScrollableWidth { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Scrollable.ScrollBar Property + +Gets or sets the scroll bar. + +```csharp +public Tizen.UI.IScrollBar ScrollBar { get; set; } +``` + +#### Property Value +Tizen.UI.IScrollBar + + + +## Scrollable.ScrollDirection Property + +Gets or sets the direction of the scroll. + +```csharp +public Tizen.UI.ScrollDirection ScrollDirection { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollDirection + + + +## Scrollable.ScrollingDestinationHandler Property + +The ScrollingDestinationHandler property sets or gets a function that handles the scrolling destination calculation. + +```csharp +public System.Func<Tizen.UI.Point,Tizen.UI.Point> ScrollingDestinationHandler { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## Scrollable.ScrollPosition Property + +Gets the current scroll position. + +```csharp +public Tizen.UI.Point ScrollPosition { get; } +``` + +#### Property Value +Tizen.UI.Point + + + +## Scrollable.ScrollSize Property + +Gets or sets the size of the scrollable content. + +```csharp +public Tizen.UI.Size ScrollSize { get; set; } +``` + +#### Property Value +Tizen.UI.Size + + + +## Scrollable.VerticalEdgeEffect Property + +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') of vertical scroll direction. + edge effect will be come when scroll over the edge of vertical direction. + +```csharp +public Tizen.UI.Components.IEdgeEffect VerticalEdgeEffect { get; set; } +``` + +#### Property Value +[IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') + + + +## Scrollable.VerticalScrollBarVisibility Property + +Gets or sets the visibility of the vertical scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility VerticalScrollBarVisibility { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollBarVisibility + + + +## Scrollable.ViewPort Property + +Gets the scroll bounds of the Scrollable content. + +```csharp +public Tizen.UI.Rect ViewPort { get; } +``` + +Implements ViewPort + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## Scrollable.IsScrollableOnDirection(ScrollDirection) Method + +Whether is scrollable on horizontal direction. + +```csharp +public bool IsScrollableOnDirection(Tizen.UI.ScrollDirection direction); +``` +#### Parameters + + + +`direction` Tizen.UI.ScrollDirection + +scroll direction. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Scrollable.ScrollTo(float, bool) Method + +Scrolls the content to the specified position. + +```csharp +public System.Threading.Tasks.Task ScrollTo(float position, bool animation); +``` +#### Parameters + + + +`position` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The position to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## Scrollable.ScrollTo(Point, bool) Method + +Scrolls the content to the specified position. + +```csharp +public System.Threading.Tasks.Task ScrollTo(Tizen.UI.Point position, bool animation); +``` +#### Parameters + + + +`position` Tizen.UI.Point + +The position to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## Scrollable.ScrollTo(View, bool, ScrollToPosition) Method + +Scrolls the content to the specified child view. + +```csharp +public System.Threading.Tasks.Task ScrollTo(Tizen.UI.View child, bool animation, Tizen.UI.ScrollToPosition scrollToPosition); +``` +#### Parameters + + + +`child` Tizen.UI.View + +The child view to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + + + +`scrollToPosition` Tizen.UI.ScrollToPosition + +The position to which the child view will be scrolled. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## Scrollable.UpdateLayout(Rect) Method + +Updates the layout with the specified bounds. + +```csharp +public override Tizen.UI.Size UpdateLayout(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds to update the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after updating. +### Events + + + +## Scrollable.DragFinished Event + +Event handler for when the dragging of the Scrollable finished. + +```csharp +public event EventHandler<DragEventArgs> DragFinished; +``` + +Implements DragFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Scrollable.Dragging Event + +Event handler for the Dragging event. + +```csharp +public event EventHandler<DragEventArgs> Dragging; +``` + +Implements Dragging + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Scrollable.DragStarted Event + +Event handler for the Scrollable drag started event. + +```csharp +public event EventHandler<DragEventArgs> DragStarted; +``` + +Implements DragStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Scrollable.ScrollFinished Event + +Occurs when the scroll finishes. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollFinished; +``` + +Implements ScrollFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Scrollable.Scrolling Event + +Occurs while scrolling. + +```csharp +public event EventHandler<ScrollEventArgs> Scrolling; +``` + +Implements Scrolling + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Scrollable.ScrollStarted Event + +Occurs when the scroll starts. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollStarted; +``` + +Implements ScrollStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollableLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollableLayoutManager.md new file mode 100644 index 0000000000..516abfcc31 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollableLayoutManager.md @@ -0,0 +1,155 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ScrollableLayoutManager Class + +Provides functionality for arranging and measuring the children of a Scrollable. + +```csharp +public class ScrollableLayoutManager : Tizen.UI.Layouts.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.Layouts.LayoutManager 🡒 ScrollableLayoutManager +### Constructors + + + +## ScrollableLayoutManager(Scrollable) Constructor + +Initializes a new instance of the ScrollableLayoutManager class. + +```csharp +public ScrollableLayoutManager(Tizen.UI.Components.Scrollable view); +``` +#### Parameters + + + +`view` [Scrollable](Tizen.UI.Components.Scrollable.md 'Tizen.UI.Components.Scrollable') + +The Scrollable that owns the layout manager. +### Properties + + + +## ScrollableLayoutManager.Scrollable Property + +Gets the Scrollable that owns the layout manager. + +```csharp +public Tizen.UI.Components.Scrollable Scrollable { get; } +``` + +#### Property Value +[Scrollable](Tizen.UI.Components.Scrollable.md 'Tizen.UI.Components.Scrollable') +### Methods + + + +## ScrollableLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements ArrangeChildren(Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## ScrollableLayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +Implements Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Selectable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Selectable.md new file mode 100644 index 0000000000..fc51df7fe1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Selectable.md @@ -0,0 +1,167 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Selectable Class + +SelectableComponent. +It provides [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged') event when it activated. + +```csharp +public class Selectable : Tizen.UI.Components.Clickable, +Tizen.UI.Components.ISelectable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 Selectable + +Derived +↳ [GroupSelectable](Tizen.UI.Components.GroupSelectable.md 'Tizen.UI.Components.GroupSelectable') +↳ [SelectableBox](Tizen.UI.Components.SelectableBox.md 'Tizen.UI.Components.SelectableBox') + +Implements [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') +### Constructors + + + +## Selectable() Constructor + +Constructs a new selectable. + +```csharp +public Selectable(); +``` +### Properties + + + +## Selectable.IsSelectable Property + +Indicates whether it is selectable or not. + +```csharp +public bool IsSelectable { get; set; } +``` + +Implements [IsSelectable](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelectable 'Tizen.UI.Components.ISelectable.IsSelectable') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Selectable.IsSelected Property + +Indicates whether it is selected or not. + +```csharp +public bool IsSelected { get; set; } +``` + +Implements [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Selectable.SelectedChangedCommand Property + +Selected changed command. see [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.InputEventArgs> SelectedChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') +### Methods + + + +## Selectable.Toggle(KeyDeviceClass) Method + +Toggle the selection state of the component. + +```csharp +public virtual void Toggle(Tizen.UI.KeyDeviceClass device=Tizen.UI.KeyDeviceClass.None); +``` +#### Parameters + + + +`device` Tizen.UI.KeyDeviceClass + +Implements [Toggle(KeyDeviceClass)](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.Toggle(Tizen.UI.KeyDeviceClass) 'Tizen.UI.Components.ISelectable.Toggle(Tizen.UI.KeyDeviceClass)') +### Events + + + +## Selectable.SelectedChanged Event + +The event that is called when the value of [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') changes. + +```csharp +public event EventHandler<InputEventArgs> SelectedChanged; +``` + +Implements [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged') + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBindings_TView_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBindings_TView_.md new file mode 100644 index 0000000000..455cd8ddf8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBindings_TView_.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectableBindings<TView> Class + +Provides a set of static properties that represent the data-binding capabilities of the [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') class. + +```csharp +public static class SelectableBindings<TView> + where TView : Tizen.UI.View, Tizen.UI.Components.ISelectable +``` +#### Type parameters + + + +`TView` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SelectableBindings<TView> +### Properties + + + +## SelectableBindings<TView>.IsSelectedProperty Property + +Gets the binding property for the [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') property. + +```csharp +public static Tizen.UI.TwoWayBindingProperty<TView,bool> IsSelectedProperty { get; } +``` + +#### Property Value +Tizen.UI.TwoWayBindingProperty<[TView](Tizen.UI.Components.SelectableBindings_TView_.md#Tizen.UI.Components.SelectableBindings_TView_.TView 'Tizen.UI.Components.SelectableBindings<TView>.TView'),[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBox.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBox.md new file mode 100644 index 0000000000..b013689441 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBox.md @@ -0,0 +1,312 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectableBox Class + +Selectable component with a content. +It provides [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged') event when it activated. + +```csharp +public abstract class SelectableBox : Tizen.UI.Components.Selectable, +Tizen.UI.Components.ILayoutBox, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') 🡒 SelectableBox + +Derived +↳ [SelectableHStack](Tizen.UI.Components.SelectableHStack.md 'Tizen.UI.Components.SelectableHStack') +↳ [SelectableVStack](Tizen.UI.Components.SelectableVStack.md 'Tizen.UI.Components.SelectableVStack') + +Implements [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## SelectableBox.Children Property + +Children of the layout box. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +Implements [Children](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Children 'Tizen.UI.Components.ILayoutBox.Children') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## SelectableBox.Count Property + +Gets the number of elements contained in the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'). + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectableBox.IsReadOnly Property + +Gets a value indicating whether the [System.Collections.Generic.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectableBox.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public abstract Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## SelectableBox.this[int] Property + +Gets a content view with index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +Tizen.UI.View +### Methods + + + +## SelectableBox.Clear() Method + +Clears all children. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## SelectableBox.Contains(View) Method + +Whether it contains the specified child. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectableBox.CopyTo(View[], int) Method + +Copies the children to an array. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` Tizen.UI.View[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectableBox.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## SelectableBox.Insert(int, View) Method + +Inserts the specified content at the specified index. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`item` Tizen.UI.View + + + +## SelectableBox.RemoveAt(int) Method + +Removes the content at the specified index. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## SelectableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Add(View) Method + +Adds a child view. + +```csharp +void System.Collections.Generic.ICollection<Tizen.UI.View>.Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Add(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## SelectableBox.System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(View) Method + +Removes the specified content from the layout box. + +```csharp +bool System.Collections.Generic.ICollection<Tizen.UI.View>.Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` Tizen.UI.View + +Implements [Remove(View)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + + + +## SelectableBox.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through a collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableHStack.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableHStack.md new file mode 100644 index 0000000000..c89321a88c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableHStack.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectableHStack Class + +Selectable view with horizontal stacking layout. + +```csharp +public class SelectableHStack : Tizen.UI.Components.SelectableBox +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') 🡒 [SelectableBox](Tizen.UI.Components.SelectableBox.md 'Tizen.UI.Components.SelectableBox') 🡒 SelectableHStack +### Constructors + + + +## SelectableHStack() Constructor + +Constructs a new instance of a ClickableHStack. + +```csharp +public SelectableHStack(); +``` +### Properties + + + +## SelectableHStack.ItemAlignment Property + +Gets or sets the alignment for children + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.LayoutAlignment + + + +## SelectableHStack.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public override Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## SelectableHStack.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableVStack.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableVStack.md new file mode 100644 index 0000000000..3226afdda6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableVStack.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectableVStack Class + +Selectable view with vertical stacking layout. + +```csharp +public class SelectableVStack : Tizen.UI.Components.SelectableBox +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') 🡒 [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') 🡒 [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') 🡒 [SelectableBox](Tizen.UI.Components.SelectableBox.md 'Tizen.UI.Components.SelectableBox') 🡒 SelectableVStack +### Constructors + + + +## SelectableVStack() Constructor + +Constructs a new instance of a ClickableHStack. + +```csharp +public SelectableVStack(); +``` +### Properties + + + +## SelectableVStack.ItemAlignment Property + +Gets or sets the alignment for children + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.Layouts.LayoutAlignment + + + +## SelectableVStack.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public override Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## SelectableVStack.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +public float Spacing { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroup.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroup.md new file mode 100644 index 0000000000..20cc5f9137 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroup.md @@ -0,0 +1,484 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectionGroup Class + +SelectionGroup is the selection manager of [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable'). + +```csharp +public class SelectionGroup : +System.Collections.Generic.IList<Tizen.UI.Components.IGroupSelectable>, +System.Collections.Generic.ICollection<Tizen.UI.Components.IGroupSelectable>, +System.Collections.Generic.IEnumerable<Tizen.UI.Components.IGroupSelectable>, +System.Collections.IEnumerable, +Tizen.UI.Components.ISelectionGroup, +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SelectionGroup + +Implements [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable'), [ISelectionGroup](Tizen.UI.Components.ISelectionGroup.md 'Tizen.UI.Components.ISelectionGroup'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## SelectionGroup.Children Property + +Gets the list of child selectable. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Components.IGroupSelectable> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## SelectionGroup.Count Property + +Gets the number of child selectable. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectionGroup.IsReadOnly Property + +Gets a value indicating whether the list of selectables is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionGroup.Name Property + +The name of the selection group. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SelectionGroup.Selected Property + +The selected child in the group. + +```csharp +public Tizen.UI.Components.IGroupSelectable Selected { get; set; } +``` + +Implements [Selected](Tizen.UI.Components.ISelectionGroup.md#Tizen.UI.Components.ISelectionGroup.Selected 'Tizen.UI.Components.ISelectionGroup.Selected') + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + + + +## SelectionGroup.SelectedIndex Property + +The selected child index in the group. + +```csharp +public int SelectedIndex { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectionGroup.SelectionChangedCommand Property + +Selected child changed event command. [SelectionChanged](Tizen.UI.Components.SelectionGroup.md#Tizen.UI.Components.SelectionGroup.SelectionChanged 'Tizen.UI.Components.SelectionGroup.SelectionChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.GroupSelectionChangedEventArgs> SelectionChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## SelectionGroup.this[int] Property + +Gets the child selectable at the specified index. + +```csharp +public Tizen.UI.Components.IGroupSelectable this[int index] { get; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + + + +## SelectionGroup.this[string] Property + +Gets the selectable child by name. + +```csharp +public Tizen.UI.Components.IGroupSelectable this[string name] { get; } +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Property Value +[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') +### Methods + + + +## SelectionGroup.Add(IGroupSelectable) Method + +Add selectable child to selection group. + +```csharp +public void Add(Tizen.UI.Components.IGroupSelectable selectable); +``` +#### Parameters + + + +`selectable` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The selectable child. + + + +## SelectionGroup.Clear() Method + +Removes all selectabls from the group. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## SelectionGroup.Contains(IGroupSelectable) Method + +Check selection group contains specific child. + +```csharp +public bool Contains(Tizen.UI.Components.IGroupSelectable selectable); +``` +#### Parameters + + + +`selectable` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The selectable child. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionGroup.CopyTo(IGroupSelectable[], int) Method + +Copies the selectables in the selection group to the specified array, starting at the specified index. + +```csharp +public void CopyTo(Tizen.UI.Components.IGroupSelectable[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the selectable to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + + + +## SelectionGroup.Dispose() Method + +Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## SelectionGroup.Find(string) Method + +Find the selection group by group name. +if group is not exist, create new selection group. + +```csharp +public static Tizen.UI.Components.SelectionGroup Find(string groupName); +``` +#### Parameters + + + +`groupName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of group to find. + +#### Returns +[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') + + + +## SelectionGroup.Find(View) Method + +Find the selection group by group parent view. +if group is not exist, create new selection group. + +```csharp +public static Tizen.UI.Components.SelectionGroup Find(Tizen.UI.View parent); +``` +#### Parameters + + + +`parent` Tizen.UI.View + +The parent view to find. + +#### Returns +[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') + + + +## SelectionGroup.GetEnumerator() Method + +Returns an enumerator that iterates through the group. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.Components.IGroupSelectable> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the group. + + + +## SelectionGroup.IndexOf(IGroupSelectable) Method + +Gets the index of selectable child in the group. + +```csharp +public int IndexOf(Tizen.UI.Components.IGroupSelectable selectable); +``` +#### Parameters + + + +`selectable` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The selectable child. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectionGroup.Insert(int, IGroupSelectable) Method + +Inserts a selectable at the specified index in the group. + +```csharp +public void Insert(int index, Tizen.UI.Components.IGroupSelectable selectable); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child selectable at. + + + +`selectable` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The selectable child to insert. + + + +## SelectionGroup.Remove(IGroupSelectable) Method + +Remove selectable child from selection group. + +```csharp +public bool Remove(Tizen.UI.Components.IGroupSelectable selectable); +``` +#### Parameters + + + +`selectable` [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') + +The selectable child. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionGroup.RemoveAt(int) Method + +Remove selectable child from selection group. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the selectable child to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Events + + + +## SelectionGroup.SelectionChanged Event + +The event that is called when the value of [Selected](Tizen.UI.Components.SelectionGroup.md#Tizen.UI.Components.SelectionGroup.Selected 'Tizen.UI.Components.SelectionGroup.Selected') changes. + +```csharp +public event EventHandler<GroupSelectionChangedEventArgs> SelectionChanged; +``` + +Implements [SelectionChanged](Tizen.UI.Components.ISelectionGroup.md#Tizen.UI.Components.ISelectionGroup.SelectionChanged 'Tizen.UI.Components.ISelectionGroup.SelectionChanged') + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') +### Explicit Interface Implementations + + + +## SelectionGroup.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the group. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + +## SelectionGroup.this[int] Property + +Gets or sets the child selectable at the specified index. + +```csharp +Tizen.UI.Components.IGroupSelectable this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupBox_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupBox_T_.md new file mode 100644 index 0000000000..1dcb49b4f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupBox_T_.md @@ -0,0 +1,495 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectionGroupBox<T> Class + +A group view of tab items for tab bar implementation. + +```csharp +public abstract class SelectionGroupBox<T> : Tizen.UI.ContentView, +Tizen.UI.Components.ISelectionGroup, +Tizen.UI.Components.ILayoutBox, +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable + where T : Tizen.UI.View, Tizen.UI.Components.IGroupSelectable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 SelectionGroupBox<T> + +Implements [ISelectionGroup](Tizen.UI.Components.ISelectionGroup.md 'Tizen.UI.Components.ISelectionGroup'), [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox'), [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## SelectionGroupBox() Constructor + +Construct a new instance. + +```csharp +public SelectionGroupBox(); +``` +### Properties + + + +## SelectionGroupBox<T>.Children Property + +Children of the layout box. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +Implements [Children](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Children 'Tizen.UI.Components.ILayoutBox.Children') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## SelectionGroupBox<T>.Count Property + +Gets the number of child items. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectionGroupBox<T>.EmptySelectionAllowed Property + +Gets or sets a value indicating whether empty selection is allowed. +If it is set to true, it allows the no selection state when initializing or when deselecting selected item by code. + +```csharp +public bool EmptySelectionAllowed { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionGroupBox<T>.IsReadOnly Property + +Gets a value indicating whether the list of child items is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SelectionGroupBox<T>.ItemClickedCommand Property + +ItemClicked event command. [ItemClicked](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.ItemClicked 'Tizen.UI.Components.SelectionGroupBox<T>.ItemClicked'). Note that this only works where item is [IClickable](Tizen.UI.Components.IClickable.md 'Tizen.UI.Components.IClickable'). + +```csharp +public System.Action<object,Tizen.UI.Components.SelectionGroupItemClickedEventArgs> ItemClickedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[SelectionGroupItemClickedEventArgs](Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md 'Tizen.UI.Components.SelectionGroupItemClickedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## SelectionGroupBox<T>.Items Property + +Gets the list of child items. + +```csharp +public System.Collections.Generic.ICollection<T> Items { get; } +``` + +#### Property Value +[System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1') + + + +## SelectionGroupBox<T>.Padding Property + +Gets or sets the padding of the layout box. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Components.ILayoutBox.md#Tizen.UI.Components.ILayoutBox.Padding 'Tizen.UI.Components.ILayoutBox.Padding') + +#### Property Value +Tizen.UI.Thickness + + + +## SelectionGroupBox<T>.SelectedIndex Property + +Gets the current selected item index. + +```csharp +public int SelectedIndex { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SelectionGroupBox<T>.SelectedItem Property + +Gets the current selected item. + +```csharp +public T SelectedItem { get; } +``` + +#### Property Value +[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + + + +## SelectionGroupBox<T>.SelectionChangedCommand Property + +Selected child changed event command. [SelectionChanged](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.SelectionChanged 'Tizen.UI.Components.SelectionGroupBox<T>.SelectionChanged'). + +```csharp +public System.Action<object,Tizen.UI.Components.GroupSelectionChangedEventArgs> SelectionChangedCommand { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## SelectionGroupBox<T>.this[int] Property + +Gets or sets the tab items. + +```csharp +public T this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') +### Methods + + + +## SelectionGroupBox<T>.Add(T) Method + +Adds an item to Tab bar. + +```csharp +public void Add(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + +The child item to be added. + +Implements [Add(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## SelectionGroupBox<T>.Clear() Method + +Removes all child items from the list of child items. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## SelectionGroupBox<T>.Contains(T) Method + +Checks if the list of child items contains the specified child item. + +```csharp +public bool Contains(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + +The child item to check for. + +Implements [Contains(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Contains#System_Collections_Generic_ICollection_1_Contains__0_ 'System.Collections.Generic.ICollection`1.Contains(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the list of child items contains the child item, false otherwise. + + + +## SelectionGroupBox<T>.CopyTo(T[], int) Method + +Copies the child items in the list of child items to the specified array, starting at the specified index. + +```csharp +public void CopyTo(T[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the child items to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + +Implements [CopyTo(T[], int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.CopyTo#System_Collections_Generic_ICollection_1_CopyTo__0[],System_Int32_ 'System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)') + + + +## SelectionGroupBox<T>.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +public System.Collections.Generic.IEnumerator<T> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the list of child items. + + + +## SelectionGroupBox<T>.IndexOf(T) Method + +Gets the index of the specified child item in the list of child items. + +```csharp +public int IndexOf(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + +The child item to find the index of. + +Implements [IndexOf(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.IndexOf#System_Collections_Generic_IList_1_IndexOf__0_ 'System.Collections.Generic.IList`1.IndexOf(`0)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the child item, or -1 if it is not found. + + + +## SelectionGroupBox<T>.Insert(int, T) Method + +Inserts a child item at the specified index in the list of child items. + +```csharp +public void Insert(int index, T item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child item at. + + + +`item` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + +The child item to insert. + +Implements [Insert(int, T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Insert#System_Collections_Generic_IList_1_Insert_System_Int32,_0_ 'System.Collections.Generic.IList`1.Insert(System.Int32,`0)') + + + +## SelectionGroupBox<T>.Remove(T) Method + +Removes the item from Tab bar. + +```csharp +public bool Remove(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Components.SelectionGroupBox_T_.md#Tizen.UI.Components.SelectionGroupBox_T_.T 'Tizen.UI.Components.SelectionGroupBox<T>.T') + +The child item to be removed. + +Implements [Remove(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the item was removed, false otherwise. + + + +## SelectionGroupBox<T>.RemoveAt(int) Method + +Removes the child item at the specified index from the list of child items. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the child item to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Events + + + +## SelectionGroupBox<T>.ItemClicked Event + +Occurs when the one of item has clicked. Note that this only works where item is [IClickable](Tizen.UI.Components.IClickable.md 'Tizen.UI.Components.IClickable'). + +```csharp +public event EventHandler<SelectionGroupItemClickedEventArgs> ItemClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[SelectionGroupItemClickedEventArgs](Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md 'Tizen.UI.Components.SelectionGroupItemClickedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## SelectionGroupBox<T>.SelectionChanged Event + +Occures when the selected item is changed. + +```csharp +public event EventHandler<GroupSelectionChangedEventArgs> SelectionChanged; +``` + +Implements [SelectionChanged](Tizen.UI.Components.ISelectionGroup.md#Tizen.UI.Components.ISelectionGroup.SelectionChanged 'Tizen.UI.Components.ISelectionGroup.SelectionChanged') + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') +### Explicit Interface Implementations + + + +## SelectionGroupBox<T>.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child items. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + +## SelectionGroupBox<T>.Tizen.UI.Components.ISelectionGroup.Selected Property + +The selected child in the group. + +```csharp +Tizen.UI.Components.IGroupSelectable Tizen.UI.Components.ISelectionGroup.Selected { get; } +``` + +Implements [Selected](Tizen.UI.Components.ISelectionGroup.md#Tizen.UI.Components.ISelectionGroup.Selected 'Tizen.UI.Components.ISelectionGroup.Selected') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md new file mode 100644 index 0000000000..399a59b0f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md @@ -0,0 +1,81 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SelectionGroupItemClickedEventArgs Class + +The event arguments for the ItemClicked event for selection group components. + +```csharp +public class SelectionGroupItemClickedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 SelectionGroupItemClickedEventArgs +### Properties + + + +## SelectionGroupItemClickedEventArgs.ItemIndex Property + +```csharp +public int ItemIndex { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SnapControlExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SnapControlExtensions.md new file mode 100644 index 0000000000..754e4b2585 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SnapControlExtensions.md @@ -0,0 +1,112 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SnapControlExtensions Class + +Provides extension methods for setting snap points type and alignment on a Scrollable. + +```csharp +public static class SnapControlExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SnapControlExtensions +### Methods + + + +## SnapControlExtensions.SetSnap<T>(this T, SnapPointsType, SnapPointsAlignment) Method + +Sets the snap points type and alignment for the given Scrollable. + +```csharp +public static T SetSnap<T>(this T Scrollable, Tizen.UI.Layouts.SnapPointsType snapType, Tizen.UI.Layouts.SnapPointsAlignment align) + where T : Tizen.UI.Components.Scrollable; +``` +#### Type parameters + + + +`T` + +The type of the Scrollable. +#### Parameters + + + +`Scrollable` [T](Tizen.UI.Components.SnapControlExtensions.md#Tizen.UI.Components.SnapControlExtensions.SetSnap_T_(thisT,Tizen.UI.Layouts.SnapPointsType,Tizen.UI.Layouts.SnapPointsAlignment).T 'Tizen.UI.Components.SnapControlExtensions.SetSnap<T>(this T, Tizen.UI.Layouts.SnapPointsType, Tizen.UI.Layouts.SnapPointsAlignment).T') + +The Scrollable to apply the snap settings to. + + + +`snapType` Tizen.UI.Layouts.SnapPointsType + +The type of snap points to use + + + +`align` Tizen.UI.Layouts.SnapPointsAlignment + +The alignment of the snap points (e.g., Center, Start, End). + +#### Returns +[T](Tizen.UI.Components.SnapControlExtensions.md#Tizen.UI.Components.SnapControlExtensions.SetSnap_T_(thisT,Tizen.UI.Layouts.SnapPointsType,Tizen.UI.Layouts.SnapPointsAlignment).T 'Tizen.UI.Components.SnapControlExtensions.SetSnap<T>(this T, Tizen.UI.Layouts.SnapPointsType, Tizen.UI.Layouts.SnapPointsAlignment).T') +The modified Scrollable instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Swatch.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Swatch.md new file mode 100644 index 0000000000..37b3228c2b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Swatch.md @@ -0,0 +1,206 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Swatch Class + +Represents a color swatch generated from a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette'). + +A swatch contains a color, its population in the image, and suitable text colors for use over the swatch's color. + +```csharp +public sealed class Swatch +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Swatch +### Constructors + + + +## Swatch(int, int) Constructor + +Initializes a new instance of the [Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') class from an ARGB color value. + +```csharp +public Swatch(int colorValue, int population); +``` +#### Parameters + + + +`colorValue` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The ARGB color value. + + + +`population` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The population of the color in the image. + + + +## Swatch(int, int, int, int) Constructor + +Initializes a new instance of the [Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') class from RGB components. + +```csharp +public Swatch(int r, int g, int b, int population); +``` +#### Parameters + + + +`r` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The red component (0-255). + + + +`g` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The green component (0-255). + + + +`b` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The blue component (0-255). + + + +`population` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The population of the color in the image. + + + +## Swatch(Color, int) Constructor + +Initializes a new instance of the [Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') class. + +```csharp +public Swatch(Tizen.UI.Color color, int population); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +The color of the swatch. + + + +`population` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The population of the color in the image. +### Properties + + + +## Swatch.BodyTextColor Property + +Gets a text color that is suitable for use as a body text over this swatch's color. + +```csharp +public Tizen.UI.Color BodyTextColor { get; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Swatch.Color Property + +Gets the color of this swatch. + +```csharp +public Tizen.UI.Color Color { get; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Swatch.Population Property + +Gets the population of this color in the image. + +```csharp +public int Population { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Swatch.TitleTextColor Property + +Gets a text color that is suitable for use as a title text over this swatch's color. + +```csharp +public Tizen.UI.Color TitleTextColor { get; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SystemFeedback.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SystemFeedback.md new file mode 100644 index 0000000000..0b97ef0049 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SystemFeedback.md @@ -0,0 +1,124 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## SystemFeedback Class + +System feedback such as sound and haptic for the view. + +```csharp +public class SystemFeedback : Tizen.UI.Components.UIAttachable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') 🡒 SystemFeedback +### Constructors + + + +## SystemFeedback(InteractionType, string) Constructor + +Creates a new instance of a SystemFeedback. + +```csharp +public SystemFeedback(Tizen.UI.Components.InteractionType interactionType, string pattern); +``` +#### Parameters + + + +`interactionType` [InteractionType](Tizen.UI.Components.InteractionType.md 'Tizen.UI.Components.InteractionType') + +The type of interaction. + + + +`pattern` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The pattern to be played. The list of pattern is defined in Tizen.System.Feedback +### Methods + + + +## SystemFeedback.OnAttached(View) Method + +Called when this object is attached to the view. + +```csharp +public override void OnAttached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +## SystemFeedback.OnDetached(View) Method + +Called when this object is detached from the view. + +```csharp +public override void OnDetached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextBaseImpl.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextBaseImpl.md new file mode 100644 index 0000000000..cc25eabee1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextBaseImpl.md @@ -0,0 +1,554 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TextBaseImpl Class + +Basic DALi text object wrapper. + +```csharp +public abstract class TextBaseImpl : +System.IDisposable, +Tizen.UI.IText, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextPadding +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextBaseImpl + +Derived +↳ [InputTextBaseImpl](Tizen.UI.Components.InputTextBaseImpl.md 'Tizen.UI.Components.InputTextBaseImpl') +↳ [LabelImpl](Tizen.UI.Components.LabelImpl.md 'Tizen.UI.Components.LabelImpl') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable'), Tizen.UI.IText, Tizen.UI.ITextAlignment, Tizen.UI.ITextPadding +### Constructors + + + +## TextBaseImpl() Constructor + +Constructs a new instance. + +```csharp +public TextBaseImpl(); +``` +### Properties + + + +## TextBaseImpl.AdjustedFontSizeScale Property + +Gets the adjusted font size scale used for rendering after applying all constraints, +including the current [MinimumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale'), [MaximumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale'), +and system font size scale adjustments. + +```csharp +public float AdjustedFontSizeScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If [MinimumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale') is greater than [MaximumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale') +(an inverted range), the [MinimumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale') value takes precedence +and is used as the adjusted scale. + + + +## TextBaseImpl.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextBaseImpl.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextBaseImpl.FontSizeScale Property + +Gets or sets the scaling value of the font size. + +```csharp +public float FontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextBaseImpl.FontSlant Property + +Gets or sets the font style weight such as Tizen.UI.FontSlant.Italic. + +```csharp +public Tizen.UI.FontSlant FontSlant { get; set; } +``` + +#### Property Value +Tizen.UI.FontSlant + + + +## TextBaseImpl.FontWeight Property + +Gets or sets the font style weight such as Tizen.UI.FontWeight.Bold. + +```csharp +public Tizen.UI.FontWeight FontWeight { get; set; } +``` + +#### Property Value +Tizen.UI.FontWeight + + + +## TextBaseImpl.FontWidth Property + +Gets or sets the font style width such as [FontWeight](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.FontWeight 'Tizen.UI.Components.TextBaseImpl.FontWeight'). + +```csharp +public Tizen.UI.FontWidth FontWidth { get; set; } +``` + +#### Property Value +Tizen.UI.FontWidth + + + +## TextBaseImpl.Handle Property + +Gets the DALi pointer. + +```csharp +public System.IntPtr Handle { get; } +``` + +#### Property Value +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + + + +## TextBaseImpl.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements HorizontalAlignment + +#### Property Value +Tizen.UI.TextAlignment + + + +## TextBaseImpl.IsDisposed Property + +Gets whether this instance is disposed or not. + +```csharp +public bool IsDisposed { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextBaseImpl.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextBaseImpl.MaximumFontSizeScale Property + +Gets or sets the maximum allowable font size scale. + +```csharp +public float MaximumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is less than [MinimumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MinimumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.AdjustedFontSizeScale 'Tizen.UI.Components.TextBaseImpl.AdjustedFontSizeScale') will follow the minimum value. + + + +## TextBaseImpl.MinimumFontSizeScale Property + +Gets or sets the minimum allowable font size scale. + +```csharp +public float MinimumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +If this value is greater than [MaximumFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale 'Tizen.UI.Components.TextBaseImpl.MaximumFontSizeScale') (range inversion), +[AdjustedFontSizeScale](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.AdjustedFontSizeScale 'Tizen.UI.Components.TextBaseImpl.AdjustedFontSizeScale') will follow this minimum value. + + + +## TextBaseImpl.Outline Property + +Gets or sets the outline style for the text. +It is [Outline.None](https://docs.microsoft.com/en-us/dotnet/api/Outline.None 'Outline.None') by default. + +```csharp +public System.Nullable<Tizen.UI.Outline> Outline { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Outline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextBaseImpl.Owner Property + +Owner view + +```csharp +public Tizen.UI.View Owner { get; } +``` + +#### Property Value +Tizen.UI.View + + + +## TextBaseImpl.Strikethrough Property + +Gets or sets the strike through style for the text. + +```csharp +public System.Nullable<Tizen.UI.Strikethrough> Strikethrough { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Strikethrough[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextBaseImpl.SystemFontFamilyEnabled Property + +Gets or sets whether the [FontFamily](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.FontFamily 'Tizen.UI.Components.TextBaseImpl.FontFamily') should be determined based on the system settings. + +```csharp +public bool SystemFontFamilyEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextBaseImpl.SystemFontSizeScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextBaseImpl.Text Property + +Gets or sets the text to display in the UTF-8 format. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextBaseImpl.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## TextBaseImpl.TextOverflow Property + +Gets or sets the text ellipsize mode to be applied when the text overflows. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +Tizen.UI.TextOverflow + + + +## TextBaseImpl.TextShadow Property + +Gets or sets the drop shadow for the text. + +```csharp +public System.Nullable<Tizen.UI.TextShadow> TextShadow { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.TextShadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextBaseImpl.Underline Property + +Gets or sets the underline style for the text. + +```csharp +public System.Nullable<Tizen.UI.Underline> Underline { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')Tizen.UI.Underline[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextBaseImpl.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements VerticalAlignment + +#### Property Value +Tizen.UI.TextAlignment +### Methods + + + +## TextBaseImpl.Dispose() Method + +Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## TextBaseImpl.GetHeightForWidth(float) Method + +Gets for the given width. + +```csharp +public float GetHeightForWidth(float width); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width for which to calculate the height. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The height that best fits the given width. + + + +## TextBaseImpl.GetSpaceHeight() Method + +Calculates natural size of a space character. + +```csharp +public float GetSpaceHeight(); +``` + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextBaseImpl.Initialize(View, Action) Method + +Initialize an instance with owner view and resize handler. + +```csharp +public void Initialize(Tizen.UI.View owner, System.Action resizeHandler); +``` +#### Parameters + + + +`owner` Tizen.UI.View + + + +`resizeHandler` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + + + +## TextBaseImpl.SetFontVariation(string, float) Method + +Sets Font Variation with string tag. + +```csharp +public void SetFontVariation(string tag, float value); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag of font variation. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of font variation. + + + +## TextBaseImpl.SetTextPadding(Thickness) Method + +Sets the padding for the text within the view. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` Tizen.UI.Thickness + +The padding thickness. + +Implements SetTextPadding(Thickness)') +### Events + + + +## TextBaseImpl.AnchorClicked Event + +Occurs when the anchor is clicked in markup. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.AnchorClickedEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextTranslator.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextTranslator.md new file mode 100644 index 0000000000..7f7e97dd2b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextTranslator.md @@ -0,0 +1,83 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TextTranslator Class + +The class for providinf built-in text translator. + +```csharp +public static class TextTranslator +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextTranslator +### Fields + + + +## TextTranslator.Default Field + +The default text translator. It uses the multilingual resource manager to get the translated text. + +```csharp +public static readonly Func<string,string> Default; +``` + +#### Field Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TimeCounter.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TimeCounter.md new file mode 100644 index 0000000000..ccf7622a38 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TimeCounter.md @@ -0,0 +1,188 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TimeCounter Class + +A time counter component that indicates a specific time value. + +```csharp +public class TimeCounter : Tizen.UI.ContentView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 TimeCounter +### Constructors + + + +## TimeCounter() Constructor + +Constructs a new time counter. + +```csharp +public TimeCounter(); +``` + + + +## TimeCounter(int) Constructor + +Constructs a new time counter. + +```csharp +public TimeCounter(int totalTimeInMilliseconds); +``` +#### Parameters + + + +`totalTimeInMilliseconds` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Properties + + + +## TimeCounter.IsWarning Property + +Gets whether the timer is warning state. + +```csharp +public bool IsWarning { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TimeCounter.RemainingTime Property + +The current value. + +```csharp +public int RemainingTime { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +The [RemainingTime](Tizen.UI.Components.TimeCounter.md#Tizen.UI.Components.TimeCounter.RemainingTime 'Tizen.UI.Components.TimeCounter.RemainingTime') will be coerced to the range. + + + +## TimeCounter.TotalTime Property + +The range of values. + +```csharp +public int TotalTime { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +#### Exceptions + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when the maximum is less than or equal to the minimum. + +### Remarks +The [RemainingTime](Tizen.UI.Components.TimeCounter.md#Tizen.UI.Components.TimeCounter.RemainingTime 'Tizen.UI.Components.TimeCounter.RemainingTime') will be coerced to the range when the range changes. + + + +## TimeCounter.WarningTime Property + +The warning time in milliseconds. +The timer get into the warning state when the remaining time is less than or equal to the warning time. + +```csharp +public int WarningTime { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## TimeCounter.RemainingTimeChanged Event + +Invoked when the warning state of the timer progress changes. + +```csharp +public event EventHandler RemainingTimeChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## TimeCounter.WarningChanged Event + +Invoked when the warning state of the timer progress changes. + +```csharp +public event EventHandler WarningChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenFontFamilyLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenFontFamilyLoader.md new file mode 100644 index 0000000000..c776a1c19c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenFontFamilyLoader.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TizenFontFamilyLoader Class + +Implements a font family loader for tizen system default. + +```csharp +public class TizenFontFamilyLoader : +Tizen.UI.Components.IFontFamilyLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TizenFontFamilyLoader + +Implements [IFontFamilyLoader](Tizen.UI.Components.IFontFamilyLoader.md 'Tizen.UI.Components.IFontFamilyLoader') +### Constructors + + + +## TizenFontFamilyLoader() Constructor + +Creates an instance of TizenFontFamilyLoader. + +```csharp +public TizenFontFamilyLoader(); +``` +### Properties + + + +## TizenFontFamilyLoader.FontFamily Property + +Gets the current font family. + +```csharp +public string FontFamily { get; set; } +``` + +Implements [FontFamily](Tizen.UI.Components.IFontFamilyLoader.md#Tizen.UI.Components.IFontFamilyLoader.FontFamily 'Tizen.UI.Components.IFontFamilyLoader.FontFamily') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Events + + + +## TizenFontFamilyLoader.FontFamilyChanged Event + +Occurs when the font family is changed. + +```csharp +public event EventHandler FontFamilyChanged; +``` + +Implements [FontFamilyChanged](Tizen.UI.Components.IFontFamilyLoader.md#Tizen.UI.Components.IFontFamilyLoader.FontFamilyChanged 'Tizen.UI.Components.IFontFamilyLoader.FontFamilyChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenThemeLoader.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenThemeLoader.md new file mode 100644 index 0000000000..4ed378c674 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenThemeLoader.md @@ -0,0 +1,146 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TizenThemeLoader Class + +The default theme loader for Tizen. It is implemented using `Tizen.Applications.ThemeLoader`. + +```csharp +public class TizenThemeLoader : +Tizen.UI.Components.IThemeLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TizenThemeLoader + +Implements [IThemeLoader](Tizen.UI.Components.IThemeLoader.md 'Tizen.UI.Components.IThemeLoader') +### Constructors + + + +## TizenThemeLoader() Constructor + +Construct a new instance of the [TizenThemeLoader](Tizen.UI.Components.TizenThemeLoader.md 'Tizen.UI.Components.TizenThemeLoader'). + +```csharp +public TizenThemeLoader(); +``` +### Properties + + + +## TizenThemeLoader.CurrentResourcePath Property + +Gets the current resource path. + +```csharp +public string CurrentResourcePath { get; set; } +``` + +Implements [CurrentResourcePath](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.CurrentResourcePath 'Tizen.UI.Components.IThemeLoader.CurrentResourcePath') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TizenThemeLoader.CurrentThemeId Property + +Gets the current theme id. + +```csharp +public string CurrentThemeId { get; set; } +``` + +Implements [CurrentThemeId](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.CurrentThemeId 'Tizen.UI.Components.IThemeLoader.CurrentThemeId') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## TizenThemeLoader.LoadColorTable() Method + +Load color table for current theme. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,Tizen.UI.Color> LoadColorTable(); +``` + +Implements [LoadColorTable()](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.LoadColorTable() 'Tizen.UI.Components.IThemeLoader.LoadColorTable()') + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') +### Events + + + +## TizenThemeLoader.ThemeChanged Event + +Occurs when the theme is changed. + +```csharp +public event EventHandler ThemeChanged; +``` + +Implements [ThemeChanged](Tizen.UI.Components.IThemeLoader.md#Tizen.UI.Components.IThemeLoader.ThemeChanged 'Tizen.UI.Components.IThemeLoader.ThemeChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TokenTableExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TokenTableExtensions.md new file mode 100644 index 0000000000..30b3e580e5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TokenTableExtensions.md @@ -0,0 +1,137 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TokenTableExtensions Class + +Provides extension methods for the token table class. + +```csharp +public static class TokenTableExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TokenTableExtensions +### Methods + + + +## TokenTableExtensions.Bind(this View, IPropertySetter<Color>, Color) Method + +The method to bind target view with color token. +When color table is updated, binded view will be updated. + +```csharp +public static void Bind(this Tizen.UI.View view, Tizen.UI.Components.IPropertySetter<Tizen.UI.Color> setter, Tizen.UI.Color colorToken); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`setter` [Tizen.UI.Components.IPropertySetter<](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>')Tizen.UI.Color[>](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>') + + + +`colorToken` Tizen.UI.Color + + + +## TokenTableExtensions.Unbind(this ITokenTable<Color>, View, IPropertySetter<Color>) Method + +The workaround code to unbind token. + +```csharp +public static void Unbind(this Tizen.UI.ITokenTable<Tizen.UI.Color> colorTable, Tizen.UI.View target, Tizen.UI.Components.IPropertySetter<Tizen.UI.Color> setter); +``` +#### Parameters + + + +`colorTable` Tizen.UI.ITokenTable<Tizen.UI.Color> + + + +`target` Tizen.UI.View + + + +`setter` [Tizen.UI.Components.IPropertySetter<](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>')Tizen.UI.Color[>](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>') + + + +## TokenTableExtensions.Unbind(this View, IPropertySetter<Color>) Method + +The method to clear color token binding for a target. + +```csharp +public static void Unbind(this Tizen.UI.View view, Tizen.UI.Components.IPropertySetter<Tizen.UI.Color> setter); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`setter` [Tizen.UI.Components.IPropertySetter<](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>')Tizen.UI.Color[>](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TouchEffect.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TouchEffect.md new file mode 100644 index 0000000000..73ef9b2d19 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TouchEffect.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## TouchEffect Class + +A class providing UI touch effect constants. + +```csharp +public static class TouchEffect +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TouchEffect +### Properties + + + +## TouchEffect.Default Property + +Indicate default touch effect defined in the current platform. + +```csharp +public static Tizen.UI.Components.UIAttachable Default { get; } +``` + +#### Property Value +[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + + + +## TouchEffect.None Property + +Indicates none touch effect. + +```csharp +public static Tizen.UI.Components.UIAttachable None { get; } +``` + +#### Property Value +[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachable.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachable.md new file mode 100644 index 0000000000..3c8f39c88e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachable.md @@ -0,0 +1,104 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIAttachable Class + +The attachable data to a UIView. + +```csharp +public abstract class UIAttachable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIAttachable + +Derived +↳ [RecoilEffect](Tizen.UI.Components.RecoilEffect.md 'Tizen.UI.Components.RecoilEffect') +↳ [SystemFeedback](Tizen.UI.Components.SystemFeedback.md 'Tizen.UI.Components.SystemFeedback') +### Methods + + + +## UIAttachable.OnAttached(View) Method + +Called when this object is attached to the view. + +```csharp +public abstract void OnAttached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +## UIAttachable.OnDetached(View) Method + +Called when this object is detached from the view. + +```csharp +public abstract void OnDetached(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachableManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachableManager.md new file mode 100644 index 0000000000..5ed63b4a74 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachableManager.md @@ -0,0 +1,221 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIAttachableManager Class + +Manages attachable data on views. + +```csharp +public static class UIAttachableManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIAttachableManager +### Fields + + + +## UIAttachableManager.DisabledEffectKey Field + +The key used to attach disabled effect data to a view. + +```csharp +public static readonly string DisabledEffectKey; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIAttachableManager.SoundEffectKey Field + +The key used to attach sound effect data to a view. + +```csharp +public static readonly string SoundEffectKey; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIAttachableManager.TouchEffectKey Field + +The key used to attach touch effect data to a view. + +```csharp +public static readonly string TouchEffectKey; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## UIAttachableManager.Attach(this View, string, UIAttachable) Method + +Attaches data to a view. If there is already an attachable with the same key, it will be replaced. + +```csharp +public static void Attach(this Tizen.UI.View view, string key, Tizen.UI.Components.UIAttachable attachable); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to attach data to. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key of the attachable. + + + +`attachable` [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + +The attachable data to attach. + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown when view or attachable is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when key is null or empty. + + + +## UIAttachableManager.ClearAttachables(this View) Method + +Clears all attached data from a view. + +```csharp +public static void ClearAttachables(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to clear data from. + + + +## UIAttachableManager.Detach(this View, string) Method + +Detaches data from a view. If there is no attachable with the given key, nothing happens. + +```csharp +public static void Detach(this Tizen.UI.View view, string key); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to detach data from. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key of the attachable to detach. + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown when view is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when key is null or empty. + + + +## UIAttachableManager.GetAttachable(this View, string) Method + +Gets the currently attached data for a view. + +```csharp +public static Tizen.UI.Components.UIAttachable GetAttachable(this Tizen.UI.View view, string key); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to get data from. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key of the attachable to get. + +#### Returns +[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfig.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfig.md new file mode 100644 index 0000000000..953c46865f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfig.md @@ -0,0 +1,338 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIConfig Class + +The base class for UI configuration. +It provides default values for UI components. +The derived classes can override these values. + +```csharp +public class UIConfig +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIConfig +### Constructors + + + +## UIConfig() Constructor + +Creates a new instance of UIConfig. + +```csharp +public UIConfig(); +``` +### Properties + + + +## UIConfig.BaselineDpi Property + +The baseline dpi. +Default value is 160. + +```csharp +public int BaselineDpi { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## UIConfig.IgnoreDpi Property + +Indicates whether the dpi should be ignored or not. +Default value is true. + +```csharp +public bool IgnoreDpi { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +### Remarks +If it's true, the dp value will be treated as px. + + + +## UIConfig.IsBackKey Property + +Check if the key is for back. + +```csharp +public System.Func<string,bool> IsBackKey { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## UIConfig.IsDecreaseKey Property + +Check if the key is for decreasing. + +```csharp +public System.Func<string,bool> IsDecreaseKey { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## UIConfig.IsExecutionKey Property + +Check if the key is for execution. + +```csharp +public System.Func<string,bool> IsExecutionKey { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## UIConfig.IsIncreaseKey Property + +Check if the key is for increasing. + +```csharp +public System.Func<string,bool> IsIncreaseKey { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## UIConfig.LongPressKeyCount Property + +The required key pressed count to recognize long press. + +```csharp +public uint LongPressKeyCount { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## UIConfig.ScalingFactor Property + +The scaling factor. +Default value is 1.0f. + +```csharp +public float ScalingFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## UIConfig.CreateBorderTable() Method + +Creates borderline width tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,float> CreateBorderTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateColorTable() Method + +Creates color tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,Tizen.UI.Color> CreateColorTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateCornerTable() Method + +Creates corner tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,Tizen.UI.CornerRadius> CreateCornerTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.CornerRadius[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateEffectColorTable() Method + +Creates effect color tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,Tizen.UI.Color> CreateEffectColorTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.UI.Color[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateFontFamilyLoader() Method + +Creates a font family loader. + +```csharp +public virtual Tizen.UI.Components.IFontFamilyLoader CreateFontFamilyLoader(); +``` + +#### Returns +[IFontFamilyLoader](Tizen.UI.Components.IFontFamilyLoader.md 'Tizen.UI.Components.IFontFamilyLoader') + + + +## UIConfig.CreateFontScaleLoader() Method + +Creates a font scale loader. + +```csharp +public virtual Tizen.UI.Components.IFontScaleLoader CreateFontScaleLoader(); +``` + +#### Returns +[IFontScaleLoader](Tizen.UI.Components.IFontScaleLoader.md 'Tizen.UI.Components.IFontScaleLoader') + + + +## UIConfig.CreateFontSizeTable() Method + +Creates font family size tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,float> CreateFontSizeTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateFontTable() Method + +Creates font family tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,string> CreateFontTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateSpacingTable() Method + +Creates spacing tokens used in the application. + +```csharp +public virtual System.Collections.Generic.IDictionary<string,float> CreateSpacingTable(); +``` + +#### Returns +[System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + + + +## UIConfig.CreateThemeLoader() Method + +Creates a theme loader. + +```csharp +public virtual Tizen.UI.Components.IThemeLoader CreateThemeLoader(); +``` + +#### Returns +[IThemeLoader](Tizen.UI.Components.IThemeLoader.md 'Tizen.UI.Components.IThemeLoader') + + + +## UIConfig.CreateVariables() Method + +Creates variables for UI components. + +```csharp +public virtual Tizen.UI.Components.UIVariables CreateVariables(); +``` + +#### Returns +[UIVariables](Tizen.UI.Components.UIVariables.md 'Tizen.UI.Components.UIVariables') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfigManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfigManager.md new file mode 100644 index 0000000000..9b0bf23872 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfigManager.md @@ -0,0 +1,99 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIConfigManager Class + +The manager of UIConfig. + +```csharp +public static class UIConfigManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIConfigManager +### Properties + + + +## UIConfigManager.Current Property + +Gets the current UIConfig instance. + +```csharp +public static Tizen.UI.Components.UIConfig Current { get; } +``` + +#### Property Value +[UIConfig](Tizen.UI.Components.UIConfig.md 'Tizen.UI.Components.UIConfig') +### Methods + + + +## UIConfigManager.Init(UIConfig) Method + +Initialize UI configuration. + +```csharp +public static void Init(Tizen.UI.Components.UIConfig config); +``` +#### Parameters + + + +`config` [UIConfig](Tizen.UI.Components.UIConfig.md 'Tizen.UI.Components.UIConfig') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIShadowExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIShadowExtensions.md new file mode 100644 index 0000000000..8f2d909580 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIShadowExtensions.md @@ -0,0 +1,320 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIShadowExtensions Class + +Extensions methods for Tizen.UI.Shadow + +```csharp +public static class UIShadowExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIShadowExtensions +### Methods + + + +## UIShadowExtensions.CornerRadius(this IEnumerable<ColorVisual>, CornerRadius) Method + +Apply corner radius property to the target list of color visuals. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> CornerRadius(this System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> visuals, Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`visuals` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The target color visuals. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The corner radius to use. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +The target color visuals itself to allow method chaining. + + + +## UIShadowExtensions.CornerSquareness(this IEnumerable<ColorVisual>, CornerRadius) Method + +Apply corner squareness property to the target list of color visuals. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> CornerSquareness(this System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> visuals, Tizen.UI.CornerRadius cornerSquareness); +``` +#### Parameters + + + +`visuals` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The target color visuals. + + + +`cornerSquareness` Tizen.UI.CornerRadius + +The corner squareness to use. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +The target color visuals itself to allow method chaining. + + + +## UIShadowExtensions.ExtraSize(this IEnumerable<ColorVisual>, float, float) Method + +Apply corner squareness property to the target list of color visuals. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> ExtraSize(this System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> visuals, float extraWidth, float extraHeight); +``` +#### Parameters + + + +`visuals` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The target color visuals. + + + +`extraWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The extra width value to use. + + + +`extraHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The extra height value to use. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +The target color visuals itself to allow method chaining. + + + +## UIShadowExtensions.ToVisual(this IEnumerable<Shadow>) Method + +Convert a list of Shadow to a list of VisualBase. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> ToVisual(this System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> shadows); +``` +#### Parameters + + + +`shadows` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The Shadow to convert. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +A VisualBase representing the Shadow. + + + +## UIShadowExtensions.ToVisual(this IEnumerable<Shadow>, CornerRadius) Method + +Convert a list of Shadow to a list of VisualBase with a specified corner radius. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> ToVisual(this System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> shadows, Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`shadows` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The Shadow to convert. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The corner radius to use. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +A VisualBase representing the Shadow. + + + +## UIShadowExtensions.ToVisual(this IEnumerable<Shadow>, CornerRadius, CornerRadius) Method + +Convert a list of Shadow to a list of VisualBase with a specified corner radius. + +```csharp +public static System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.ColorVisual> ToVisual(this System.Collections.Generic.IEnumerable<Tizen.UI.Shadow> shadows, Tizen.UI.CornerRadius cornerRadius, Tizen.UI.CornerRadius cornerSquareness); +``` +#### Parameters + + + +`shadows` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Shadow[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The Shadow to convert. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The corner radius to use. + + + +`cornerSquareness` Tizen.UI.CornerRadius + +The corner squareness to use. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.ColorVisual[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +A VisualBase representing the Shadow. + + + +## UIShadowExtensions.ToVisual(this Shadow) Method + +Convert a Shadow to a VisualBase. + +```csharp +public static Tizen.UI.Visuals.ColorVisual ToVisual(this Tizen.UI.Shadow shadow); +``` +#### Parameters + + + +`shadow` Tizen.UI.Shadow + +The Shadow to convert. + +#### Returns +Tizen.UI.Visuals.ColorVisual +A VisualBase representing the Shadow. + + + +## UIShadowExtensions.ToVisual(this Shadow, CornerRadius) Method + +Convert a Shadow to a VisualBase with a specified corner radius. + +```csharp +public static Tizen.UI.Visuals.ColorVisual ToVisual(this Tizen.UI.Shadow shadow, Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`shadow` Tizen.UI.Shadow + +The Shadow to convert. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The corner radius to use. + +#### Returns +Tizen.UI.Visuals.ColorVisual +A VisualBase representing the Shadow. + + + +## UIShadowExtensions.ToVisual(this Shadow, CornerRadius, CornerRadius) Method + +Convert a Shadow to a VisualBase with a specified corner radius and squareness. + +```csharp +public static Tizen.UI.Visuals.ColorVisual ToVisual(this Tizen.UI.Shadow shadow, Tizen.UI.CornerRadius cornerRadius, Tizen.UI.CornerRadius cornerSquareness); +``` +#### Parameters + + + +`shadow` Tizen.UI.Shadow + +The Shadow to convert. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The corner radius to use. + + + +`cornerSquareness` Tizen.UI.CornerRadius + +The corner squareness to use. + +#### Returns +Tizen.UI.Visuals.ColorVisual +A VisualBase representing the Shadow. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIState.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIState.md new file mode 100644 index 0000000000..081b4a21cc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIState.md @@ -0,0 +1,643 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIState Struct + +Defines a value type of view state. + +```csharp +public readonly struct UIState : +System.IEquatable<Tizen.UI.Components.UIState> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Fields + + + +## UIState.All Field + +The All state is used in a selector class. It represents all states, so if this state is defined in a selector, the other states are ignored. + +```csharp +public static readonly UIState All; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Disabled Field + +Disabled State. + +```csharp +public static readonly UIState Disabled; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.DisabledFocused Field + +DisabledFocused State. + +```csharp +public static readonly UIState DisabledFocused; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.DisabledSelected Field + +DisabledSelected State. + +```csharp +public static readonly UIState DisabledSelected; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Focused Field + +Focused State. + +```csharp +public static readonly UIState Focused; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Normal Field + +Normal State. + +```csharp +public static readonly UIState Normal; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Other Field + +This is used in a selector class. It represents all other states except for states that are already defined in a selector. + +```csharp +public static readonly UIState Other; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Paused Field + +Paused State. (It is for the component paused state. Not for animatable playback state) + +```csharp +public static readonly UIState Paused; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Pressed Field + +Pressed State. + +```csharp +public static readonly UIState Pressed; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.PressedByKey Field + +Pressed caused by key state. + +```csharp +public static readonly UIState PressedByKey; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.PressedByTouch Field + +Pressed caused by touch state. + +```csharp +public static readonly UIState PressedByTouch; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Progressing Field + +Progressing State. + +```csharp +public static readonly UIState Progressing; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Selected Field + +Selected State. + +```csharp +public static readonly UIState Selected; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.SelectedFocused Field + +SelectedFocused State. + +```csharp +public static readonly UIState SelectedFocused; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.SelectedPressed Field + +SelectedPressed State. + +```csharp +public static readonly UIState SelectedPressed; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIState.Warning Field + +Warning State. + +```csharp +public static readonly UIState Warning; +``` + +#### Field Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +### Properties + + + +## UIState.Added Property + +Gets a constraint that a state is added compared with previous state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Added { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Changed Property + +Gets a constraint that a state is added or removed. + +```csharp +public Tizen.UI.Components.UIStateConstraint Changed { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Excluded Property + +Gets a constraint that a state must not include this state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Excluded { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Included Property + +Gets a constraint that a state must include this state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Included { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Is Property + +Gets a constraint that a state must be identical to this state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Is { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Not Property + +Gets a constraint that a state must not be identical to this state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Not { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + + + +## UIState.Removed Property + +Gets a constraint that a state is removed compared with previous state. + +```csharp +public Tizen.UI.Components.UIStateConstraint Removed { get; } +``` + +#### Property Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') +### Methods + + + +## UIState.Contains(UIState) Method + +Determines whether a state contains a specified state. + +```csharp +public bool Contains(Tizen.UI.Components.UIState state); +``` +#### Parameters + + + +`state` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The state to search for + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if the state contain a specified state, otherwise, false. + + + +## UIState.Create(string) Method + +Create an instance of the [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') with state name. + +```csharp +public static Tizen.UI.Components.UIState Create(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The state name. + +#### Returns +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') instance which has single state. + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown when the given name is null. + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +Thrown when the given name is invalid. + + + +## UIState.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Equals(object).obj 'Tizen.UI.Components.UIState.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## UIState.Equals(UIState) Method + +Indicates whether this instance and another specified [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') structure are equal. + +```csharp +public bool Equals(Tizen.UI.Components.UIState other); +``` +#### Parameters + + + +`other` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') structure to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [other](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Equals(Tizen.UI.Components.UIState).other 'Tizen.UI.Components.UIState.Equals(Tizen.UI.Components.UIState).other') and this instance are equal; otherwise, false. + + + +## UIState.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## UIState.HasIntersectionWith(UIState) Method + +Checks if there is a intersection part between this and the other. + +```csharp +public bool HasIntersectionWith(Tizen.UI.Components.UIState other); +``` +#### Parameters + + + +`other` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The other state to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if an intersection exists, otherwise false. + + + +## UIState.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. +### Operators + + + +## UIState.operator +(UIState, UIState) Operator + +The addition operator. + +```csharp +public static Tizen.UI.Components.UIState operator +(Tizen.UI.Components.UIState lhs, Tizen.UI.Components.UIState rhs); +``` +#### Parameters + + + +`lhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the left hand side. + + + +`rhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the right hand side. + +#### Returns +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') containing the result of the addition. + + + +## UIState.operator ==(UIState, UIState) Operator + +Compares whether the two ControlStates are same or not. + +```csharp +public static bool operator ==(Tizen.UI.Components.UIState lhs, Tizen.UI.Components.UIState rhs); +``` +#### Parameters + + + +`lhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the left hand side. + + + +`rhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the right hand side. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if the ControlStates are equal; otherwise, false. + + + +## UIState.operator !=(UIState, UIState) Operator + +Compares whether the two ControlStates are different or not. + +```csharp +public static bool operator !=(Tizen.UI.Components.UIState lhs, Tizen.UI.Components.UIState rhs); +``` +#### Parameters + + + +`lhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the left hand side. + + + +`rhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the right hand side. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if the ControlStates are not equal; otherwise, false. + + + +## UIState.operator ~(UIState) Operator + +The substraction operator. + +```csharp +public static Tizen.UI.Components.UIState operator ~(Tizen.UI.Components.UIState state); +``` +#### Parameters + + + +`state` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A target [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState'). + +#### Returns +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') containing the result of bitwise complement. + + + +## UIState.operator -(UIState, UIState) Operator + +The substraction operator. + +```csharp +public static Tizen.UI.Components.UIState operator -(Tizen.UI.Components.UIState lhs, Tizen.UI.Components.UIState rhs); +``` +#### Parameters + + + +`lhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the left hand side. + + + +`rhs` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +A [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') on the right hand side. + +#### Returns +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') containing the result of the substraction. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateChangedEventArgs.md new file mode 100644 index 0000000000..a75965f1ef --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateChangedEventArgs.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIStateChangedEventArgs Class + +The event arguments for the UIState changed event. + +```csharp +public class UIStateChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 UIStateChangedEventArgs +### Properties + + + +## UIStateChangedEventArgs.Current Property + +Gets or sets the current UIState. + +```csharp +public Tizen.UI.Components.UIState Current { get; set; } +``` + +#### Property Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +## UIStateChangedEventArgs.Previous Property + +Gets or sets the previous UIState. + +```csharp +public Tizen.UI.Components.UIState Previous { get; set; } +``` + +#### Property Value +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +### Methods + + + +## UIStateChangedEventArgs.Test(UIStateConstraint) Method + +Tests if the specified constraint is matched with this change. + +```csharp +public bool Test(Tizen.UI.Components.UIStateConstraint constraint); +``` +#### Parameters + + + +`constraint` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConnectingProperty_TView_.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConnectingProperty_TView_.md new file mode 100644 index 0000000000..5c87afba9d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConnectingProperty_TView_.md @@ -0,0 +1,146 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIStateConnectingProperty<TView> Class + +Represents a property for a view that can be connected to a state. + +```csharp +public class UIStateConnectingProperty<TView> +``` +#### Type parameters + + + +`TView` + +The type of the view. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIStateConnectingProperty<TView> +### Constructors + + + +## UIStateConnectingProperty(Func<TView,bool>, Action<TView,EventHandler>, Action<TView,EventHandler>) Constructor + +Create a new instance of the StateConnectingProperty. + +```csharp +public UIStateConnectingProperty(System.Func<TView,bool> getter, System.Action<TView,System.EventHandler> addObserver, System.Action<TView,System.EventHandler> removeObserver); +``` +#### Parameters + + + +`getter` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The boolean-type property getter function. + + + +`addObserver` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The action that adds an observer to the view. The observer should be [System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') type. + + + +`removeObserver` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The action that removes an observer from the view. +### Properties + + + +## UIStateConnectingProperty<TView>.AddObserver Property + +Gets the action that adds an observer to the view. + +```csharp +public System.Action<TView,System.EventHandler> AddObserver { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## UIStateConnectingProperty<TView>.Getter Property + +Gets the boolean-type property getter function. + +```csharp +public System.Func<TView,bool> Getter { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## UIStateConnectingProperty<TView>.RemoveObserver Property + +Gets the action that removed an observer from the view. + +```csharp +public System.Action<TView,System.EventHandler> RemoveObserver { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.UIStateConnectingProperty_TView_.md#Tizen.UI.Components.UIStateConnectingProperty_TView_.TView 'Tizen.UI.Components.UIStateConnectingProperty<TView>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConstraint.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConstraint.md new file mode 100644 index 0000000000..adb9e5951a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConstraint.md @@ -0,0 +1,245 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIStateConstraint Struct + +Represents a constraint for a state that will be given when calling [Match(UIStateChangedEventArgs)](Tizen.UI.Components.UIStateConstraint.md#Tizen.UI.Components.UIStateConstraint.Match(Tizen.UI.Components.UIStateChangedEventArgs) 'Tizen.UI.Components.UIStateConstraint.Match(Tizen.UI.Components.UIStateChangedEventArgs)'). + +```csharp +public readonly struct UIStateConstraint : +System.IEquatable<Tizen.UI.Components.UIStateConstraint> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## UIStateConstraint() Constructor + +Create a new value of the UIStateConstraint. + +```csharp +public UIStateConstraint(); +``` + + + +## UIStateConstraint(UIState, Func<UIState,UIStateChangedEventArgs,bool>) Constructor + +Create a new value of the UIStateConstraint. + +```csharp +public UIStateConstraint(Tizen.UI.Components.UIState state, System.Func<Tizen.UI.Components.UIState,Tizen.UI.Components.UIStateChangedEventArgs,bool> constraint); +``` +#### Parameters + + + +`state` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + + + +`constraint` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-3 'System.Func`3') +### Fields + + + +## UIStateConstraint.True Field + +No constraint. + +```csharp +public static UIStateConstraint True; +``` + +#### Field Value +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') +### Methods + + + +## UIStateConstraint.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object other); +``` +#### Parameters + + + +`other` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if obj and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## UIStateConstraint.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## UIStateConstraint.Match(UIStateChangedEventArgs) Method + +Determine if a specified state satisfies the constraint. + +```csharp +public bool Match(Tizen.UI.Components.UIStateChangedEventArgs e); +``` +#### Parameters + + + +`e` [UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs') + +The state changed event args to test if it satisfies the constraints. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the constraint is met, otherwise false. +### Operators + + + +## UIStateConstraint.operator ==(UIStateConstraint, UIStateConstraint) Operator + +Compares two UIStateConstraint for equality. + +```csharp +public static bool operator ==(Tizen.UI.Components.UIStateConstraint operand1, Tizen.UI.Components.UIStateConstraint operand2); +``` +#### Parameters + + + +`operand1` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The first operand object. + + + +`operand2` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The second operand object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both are equal, otherwise false. + + + +## UIStateConstraint.implicit operator UIStateConstraint(UIState) Operator + +Provides an implicit conversion between [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') and [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState'). + +```csharp +public static Tizen.UI.Components.UIStateConstraint implicit operator UIStateConstraint(Tizen.UI.Components.UIState state); +``` +#### Parameters + + + +`state` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') to convert. + +#### Returns +[UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') +The corresponding [Included](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Included 'Tizen.UI.Components.UIState.Included') constraint. + + + +## UIStateConstraint.operator !=(UIStateConstraint, UIStateConstraint) Operator + +Compares two UIStateConstraint for inequality. + +```csharp +public static bool operator !=(Tizen.UI.Components.UIStateConstraint operand1, Tizen.UI.Components.UIStateConstraint operand2); +``` +#### Parameters + + + +`operand1` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The first operand object. + + + +`operand2` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The second operand object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both are not equal, otherwise false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateManager.md new file mode 100644 index 0000000000..74b4a7bccd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateManager.md @@ -0,0 +1,215 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIStateManager Class + +Provides methods to get a UIState from a view or to notify UIState change. +Note that there is no direct way to set a view UIState to a view. +The indirect way is to set connected property. +To set [Disabled](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Disabled 'Tizen.UI.Components.UIState.Disabled'), for example, you need to set Tizen.UI.View.IsEnabled to false. + +```csharp +public static class UIStateManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIStateManager +### Methods + + + +## UIStateManager.AddStateChangedEventHandler<TView>(this TView, EventHandler<UIStateChangedEventArgs>) Method + +Add an action to be invoked when a UIState of target view changes. + +```csharp +public static void AddStateChangedEventHandler<TView>(this TView view, System.EventHandler<Tizen.UI.Components.UIStateChangedEventArgs> handler) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.UIStateManager.md#Tizen.UI.Components.UIStateManager.AddStateChangedEventHandler_TView_(thisTView,System.EventHandler_Tizen.UI.Components.UIStateChangedEventArgs_).TView 'Tizen.UI.Components.UIStateManager.AddStateChangedEventHandler<TView>(this TView, System.EventHandler<Tizen.UI.Components.UIStateChangedEventArgs>).TView') + +The target view. + + + +`handler` [System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + +The action to add. + + + +## UIStateManager.ConnectUIState<TView>(this TView, UIState, UIStateConnectingProperty<TView>) Method + +Connect a UIState to a property for a target view. +Only one connection is allowed for each UIState. + +```csharp +public static void ConnectUIState<TView>(this TView view, Tizen.UI.Components.UIState viewState, Tizen.UI.Components.UIStateConnectingProperty<TView> connectingProperty) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.UIStateManager.md#Tizen.UI.Components.UIStateManager.ConnectUIState_TView_(thisTView,Tizen.UI.Components.UIState,Tizen.UI.Components.UIStateConnectingProperty_TView_).TView 'Tizen.UI.Components.UIStateManager.ConnectUIState<TView>(this TView, Tizen.UI.Components.UIState, Tizen.UI.Components.UIStateConnectingProperty<TView>).TView') + +The view that has the connecting property. + + + +`viewState` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The UIState to connect. + + + +`connectingProperty` [Tizen.UI.Components.UIStateConnectingProperty<](Tizen.UI.Components.UIStateConnectingProperty_TView_.md 'Tizen.UI.Components.UIStateConnectingProperty<TView>')[TView](Tizen.UI.Components.UIStateManager.md#Tizen.UI.Components.UIStateManager.ConnectUIState_TView_(thisTView,Tizen.UI.Components.UIState,Tizen.UI.Components.UIStateConnectingProperty_TView_).TView 'Tizen.UI.Components.UIStateManager.ConnectUIState<TView>(this TView, Tizen.UI.Components.UIState, Tizen.UI.Components.UIStateConnectingProperty<TView>).TView')[>](Tizen.UI.Components.UIStateConnectingProperty_TView_.md 'Tizen.UI.Components.UIStateConnectingProperty<TView>') + +The connecting property. + + + +## UIStateManager.DisconnectUIState(this View, UIState) Method + +Disconnect the UIState-property connection of a view. + +```csharp +public static void DisconnectUIState(this Tizen.UI.View view, Tizen.UI.Components.UIState viewState); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The target view. + + + +`viewState` [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') + +The UIState to clean. + + + +## UIStateManager.GetState(this View) Method + +Gets a UIState of a view. + +```csharp +public static Tizen.UI.Components.UIState GetState(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view with UIState to get. + +#### Returns +[UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') +The view's view UIState. + + + +## UIStateManager.RemoveStateChangedEventHandler<TView>(this TView, EventHandler<UIStateChangedEventArgs>) Method + +Remove registered UIState related action from a view. + +```csharp +public static void RemoveStateChangedEventHandler<TView>(this TView view, System.EventHandler<Tizen.UI.Components.UIStateChangedEventArgs> handler) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.UIStateManager.md#Tizen.UI.Components.UIStateManager.RemoveStateChangedEventHandler_TView_(thisTView,System.EventHandler_Tizen.UI.Components.UIStateChangedEventArgs_).TView 'Tizen.UI.Components.UIStateManager.RemoveStateChangedEventHandler<TView>(this TView, System.EventHandler<Tizen.UI.Components.UIStateChangedEventArgs>).TView') + +The view to remove event handler from. + + + +`handler` [System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + +The handler to remove. + +### Remarks +This removes actions that are added by AddStateChangedEventHandler. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UITextManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UITextManager.md new file mode 100644 index 0000000000..5b1c3284bd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UITextManager.md @@ -0,0 +1,149 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UITextManager Class + +Text manager for UI. + +```csharp +public static class UITextManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UITextManager +### Properties + + + +## UITextManager.SystemFontFamily Property + +Gets the current font family. + +```csharp +public static string SystemFontFamily { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UITextManager.SystemFontScale Property + +Gets the current font scale. + +```csharp +public static float SystemFontScale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UITextManager.SystemLocaleLanguage Property + +Gets the current locale language. + +```csharp +public static string SystemLocaleLanguage { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Events + + + +## UITextManager.SystemFontFamilyChanged Event + +Occurs when the system font family is changed. + +```csharp +public static event EventHandler SystemFontFamilyChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## UITextManager.SystemFontScaleChanged Event + +Occurs when the system font scale is changed. + +```csharp +public static event EventHandler SystemFontScaleChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## UITextManager.SystemLocaleLanguageChanged Event + +Occurs when the system locale language is changed. + +```csharp +public static event EventHandler SystemLocaleLanguageChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIThemeManager.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIThemeManager.md new file mode 100644 index 0000000000..831f72ce3e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIThemeManager.md @@ -0,0 +1,123 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIThemeManager Class + +ThemeManager for UI. + +```csharp +public static class UIThemeManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIThemeManager +### Properties + + + +## UIThemeManager.CurrentResourcePath Property + +Gets the current resource path. + +```csharp +public static string CurrentResourcePath { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIThemeManager.CurrentThemeId Property + +Gets the current theme id. + +```csharp +public static string CurrentThemeId { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIThemeManager.CurrentThemeLoader Property + +Loads a color theme table. + +```csharp +public static Tizen.UI.Components.IThemeLoader CurrentThemeLoader { get; } +``` + +#### Property Value +[IThemeLoader](Tizen.UI.Components.IThemeLoader.md 'Tizen.UI.Components.IThemeLoader') +### Events + + + +## UIThemeManager.ThemeChanged Event + +Occurs when the theme is changed. + +```csharp +public static event EventHandler ThemeChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVariables.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVariables.md new file mode 100644 index 0000000000..a0d15291d7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVariables.md @@ -0,0 +1,427 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIVariables Class + +Defines the variables for UI. + +```csharp +public class UIVariables +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIVariables +### Properties + + + +## UIVariables.ClickableSoundEffect Property + +The sound effect of a clickable component. + +```csharp +public System.Lazy<Tizen.UI.Components.UIAttachable> ClickableSoundEffect { get; set; } +``` + +#### Property Value +[System.Lazy<](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1')[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1') + + + +## UIVariables.ClickableTouchEffect Property + +The touch effect of a clickable component when it is clicked. + +```csharp +public System.Lazy<Tizen.UI.Components.UIAttachable> ClickableTouchEffect { get; set; } +``` + +#### Property Value +[System.Lazy<](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1')[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1') + + + +## UIVariables.ComponentDisabledEffect Property + +The disabled effect of a component when it is disabled. + +```csharp +public System.Lazy<Tizen.UI.Components.UIAttachable> ComponentDisabledEffect { get; set; } +``` + +#### Property Value +[System.Lazy<](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1')[UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Lazy-1 'System.Lazy`1') + + + +## UIVariables.Current Property + +The currently configured variables. + +```csharp +public static Tizen.UI.Components.UIVariables Current { get; } +``` + +#### Property Value +[UIVariables](Tizen.UI.Components.UIVariables.md 'Tizen.UI.Components.UIVariables') + + + +## UIVariables.EffectDelayOnScroll Property + +The delay time in millisecond for showing the effect on scroll. + +```csharp +public int EffectDelayOnScroll { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## UIVariables.MaximumFontSizeScale Property + +The maximum scaling value of the font size. + +```csharp +public float MaximumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.MinimumFontSizeScale Property + +The minimum scaling value of the font size. + +```csharp +public float MinimumFontSizeScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.RecoilColor Property + +The color of recoil feedack overlay. + +```csharp +public Tizen.UI.Color RecoilColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## UIVariables.RecoilOffset Property + +The relative size decreasement for recoil feedack. + +```csharp +public float RecoilOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.RecoilScaleFactor Property + +the scale factor for recoil feedback. + +```csharp +public float RecoilScaleFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.RecoilScaleFactorForList Property + +the scale factor for recoil feedback of list items. + +```csharp +public float RecoilScaleFactorForList { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.ResizePolicyEnabled Property + +Whether the resize policy of UIView is enabled by default. + +```csharp +public bool ResizePolicyEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## UIVariables.ScaffoldFloatingOffset Property + +The relative offset of the floating action button from the bottom right corner of the screen. + +```csharp +public Tizen.UI.Point ScaffoldFloatingOffset { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## UIVariables.SystemFontSizeScaleEnabled Property + +The text components uses system font size scale by default. + +```csharp +public bool SystemFontSizeScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## UIVariables.SystemIndicatorThickness Property + +The thickness of the system indicator bar. + +```csharp +public float SystemIndicatorThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.SystemNavigationBarThickness Property + +The thickness of the system navigation bar. + +```csharp +public float SystemNavigationBarThickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.TextAnchorClickedColor Property + +The clicked link color for markup text. + +```csharp +public Tizen.UI.Color TextAnchorClickedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## UIVariables.TextAnchorColor Property + +The link color for markup text. + +```csharp +public Tizen.UI.Color TextAnchorColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## UIVariables.TextCursorColor Property + +The color of editable text cursor. + +```csharp +public Tizen.UI.Color TextCursorColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## UIVariables.TextCursorWidth Property + +The width size of editable text cursor. + +```csharp +public int TextCursorWidth { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## UIVariables.TextMarqueeGap Property + +The text marquee gap. + +```csharp +public float TextMarqueeGap { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## UIVariables.TextMarqueeLoopCount Property + +The text marquee loop count. + +```csharp +public int TextMarqueeLoopCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## UIVariables.TextMarqueeSpeed Property + +The text marquee speed. + +```csharp +public int TextMarqueeSpeed { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## UIVariables.TextSelectionColor Property + +The color of selected text. + +```csharp +public Tizen.UI.Color TextSelectionColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## UIVariables.TextSelectionHandleLeftImage Property + +The image of text selection handle (left). + +```csharp +public string TextSelectionHandleLeftImage { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIVariables.TextSelectionHandleRightImage Property + +The image of text selection handle (right). + +```csharp +public string TextSelectionHandleRightImage { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## UIVariables.this[string] Property + +Gets or sets the variable creator with the specified name. + +```csharp +public System.Func<Tizen.UI.Components.Variables> this[string name] { get; set; } +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[Variables](Tizen.UI.Components.Variables.md 'Tizen.UI.Components.Variables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVectorExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVectorExtensions.md new file mode 100644 index 0000000000..6d761b5fcb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVectorExtensions.md @@ -0,0 +1,125 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## UIVectorExtensions Class + +Provides extension methods for the UI vector, rect or extents. + +```csharp +public static class UIVectorExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UIVectorExtensions +### Methods + + + +## UIVectorExtensions.HasZero(this Point) Method + +Whether the vector has a zero value. + +```csharp +public static bool HasZero(this Tizen.UI.Point vector2); +``` +#### Parameters + + + +`vector2` Tizen.UI.Point + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## UIVectorExtensions.HasZero(this Size) Method + +Whether the vector has a zero value. + +```csharp +public static bool HasZero(this Tizen.UI.Size vector2); +``` +#### Parameters + + + +`vector2` Tizen.UI.Size + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## UIVectorExtensions.HasZeroSize(this Rect) Method + +Whether the vector has a zero value. + +```csharp +public static bool HasZeroSize(this Tizen.UI.Rect rect); +``` +#### Parameters + + + +`rect` Tizen.UI.Rect + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Variables.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Variables.md new file mode 100644 index 0000000000..e2ee092caf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Variables.md @@ -0,0 +1,190 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## Variables Class + +Variables used by UI components to construct inside. + +```csharp +public abstract class Variables : +System.IEquatable<Tizen.UI.Components.Variables> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Variables + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[Variables](Tizen.UI.Components.Variables.md 'Tizen.UI.Components.Variables')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## Variables() Constructor + +Constructs a new instance. + +```csharp +public Variables(); +``` +### Properties + + + +## Variables.this[string] Property + +```csharp +public object this[string name] { get; set; } +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Property Value +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +### Methods + + + +## Variables.GetNullable<T>(string, T) Method + +Gets the nullable item with given name. + +```csharp +public T GetNullable<T>(string name, T fallback); +``` +#### Type parameters + + + +`T` + +The type of the nullable item. +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the nullable item. + + + +`fallback` [T](Tizen.UI.Components.Variables.md#Tizen.UI.Components.Variables.GetNullable_T_(string,T).T 'Tizen.UI.Components.Variables.GetNullable<T>(string, T).T') + +The fallback value if the nullable item does not exist. + +#### Returns +[T](Tizen.UI.Components.Variables.md#Tizen.UI.Components.Variables.GetNullable_T_(string,T).T 'Tizen.UI.Components.Variables.GetNullable<T>(string, T).T') +The nullable item if it exists, otherwise throws an exception. + + + +## Variables.HasNullable(string) Method + +Gets whether the nullable item with given name exists or not. + +```csharp +public bool HasNullable(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the nullable item. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the nullable item exists, otherwise false. + + + +## Variables.TryGetNullable<T>(string, T) Method + +Tries to get the nullable item with given name. + +```csharp +public bool TryGetNullable<T>(string name, out T value); +``` +#### Type parameters + + + +`T` + +The type of the nullable item. +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the nullable item. + + + +`value` [T](Tizen.UI.Components.Variables.md#Tizen.UI.Components.Variables.TryGetNullable_T_(string,T).T 'Tizen.UI.Components.Variables.TryGetNullable<T>(string, T).T') + +The nullable item if it exists, otherwise default value. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the nullable item exists, otherwise false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ViewExtensions.md new file mode 100644 index 0000000000..bf16d0479f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ViewExtensions.md @@ -0,0 +1,845 @@ +### [Tizen.UI.Components](Tizen.UI.Components.md 'Tizen.UI.Components') + +## ViewExtensions Class + +Provides extension methods for the View class. + +```csharp +public static class ViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewExtensions +### Methods + + + +## ViewExtensions.AttachChild(this View, View) Method + +Attach an isolated child. + +```csharp +public static void AttachChild(this Tizen.UI.View parent, Tizen.UI.View child); +``` +#### Parameters + + + +`parent` Tizen.UI.View + + + +`child` Tizen.UI.View + + + +## ViewExtensions.BackgroundColor(this View) Method + +Experimental getter for background color + +```csharp +public static Tizen.UI.Color BackgroundColor(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + +#### Returns +Tizen.UI.Color +The background color value. + + + +## ViewExtensions.BackgroundColor(this View, Color) Method + +Experimental setter for background color + +```csharp +public static Tizen.UI.View BackgroundColor(this Tizen.UI.View view, Tizen.UI.Color backgroundColor); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + + + +`backgroundColor` Tizen.UI.Color + +The background color value to be set. + +#### Returns +Tizen.UI.View +The view itself. + + + +## ViewExtensions.BorderlineColor(this View) Method + +Gets the color for the borderline of the View. + +```csharp +public static Tizen.UI.Color BorderlineColor(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + +#### Returns +Tizen.UI.Color +The borderline color value. + + + +## ViewExtensions.BorderlineColor(this View, Color) Method + +Sets the color for the borderline of the View. + +```csharp +public static Tizen.UI.View BorderlineColor(this Tizen.UI.View view, Tizen.UI.Color borderlineColor); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + + + +`borderlineColor` Tizen.UI.Color + +The borderline color value to be set. + +#### Returns +Tizen.UI.View +The view itself. + + + +## ViewExtensions.Color(this View) Method + +Gets the color for the View. + +```csharp +public static Tizen.UI.Color Color(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + +#### Returns +Tizen.UI.Color +The color value. + + + +## ViewExtensions.Color(this View, Color) Method + +Sets the color for the View. + +```csharp +public static Tizen.UI.View Color(this Tizen.UI.View view, Tizen.UI.Color color); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The extension target. + + + +`color` Tizen.UI.Color + +The color value to be set. + +#### Returns +Tizen.UI.View +The view itself. + + + +## ViewExtensions.DetachChild(this View, View) Method + +Detach an isolated child. + +```csharp +public static void DetachChild(this Tizen.UI.View parent, Tizen.UI.View child); +``` +#### Parameters + + + +`parent` Tizen.UI.View + + + +`child` Tizen.UI.View + + + +## ViewExtensions.DetachFromParent(this View) Method + +Detach itself from the parent. + +```csharp +public static void DetachFromParent(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +## ViewExtensions.DisabledEffect<TView>(this TView, UIAttachable) Method + +Sets the disabled effect for the view. This method attaches a given effect to a view using [Attach(this View, string, UIAttachable)](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.Attach(thisTizen.UI.View,string,Tizen.UI.Components.UIAttachable) 'Tizen.UI.Components.UIAttachableManager.Attach(this Tizen.UI.View, string, Tizen.UI.Components.UIAttachable)') with a key [DisabledEffectKey](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.DisabledEffectKey 'Tizen.UI.Components.UIAttachableManager.DisabledEffectKey'). + +```csharp +public static TView DisabledEffect<TView>(this TView view, Tizen.UI.Components.UIAttachable effect) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.DisabledEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.DisabledEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') + +The extension target. + + + +`effect` [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + +The effect to apply. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.DisabledEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.DisabledEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') +The view itself to allow chaining. + + + +## ViewExtensions.GetNavigation<TView>(this TView) Method + +Gets the nearest navigation object such as Navigator from its parent to the root view. + +```csharp +public static Tizen.UI.Components.INavigation GetNavigation<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.GetNavigation_TView_(thisTView).TView 'Tizen.UI.Components.ViewExtensions.GetNavigation<TView>(this TView).TView') + +#### Returns +[INavigation](Tizen.UI.Components.INavigation.md 'Tizen.UI.Components.INavigation') +The nearest navigation object such as Navigator from its parent to the root view. + + + +## ViewExtensions.GetRootNavigation<TView>(this TView) Method + +Gets the root navigation object such as Navigator from its parent to the root view. + +```csharp +public static Tizen.UI.Components.INavigation GetRootNavigation<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.GetRootNavigation_TView_(thisTView).TView 'Tizen.UI.Components.ViewExtensions.GetRootNavigation<TView>(this TView).TView') + +#### Returns +[INavigation](Tizen.UI.Components.INavigation.md 'Tizen.UI.Components.INavigation') +The root navigation object such as Navigator from its parent to the root view. + + + +## ViewExtensions.GetScreenBounds<TView>(this TView) Method + +Gets the view's screen bounds. + +```csharp +public static Tizen.UI.Rect GetScreenBounds<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.GetScreenBounds_TView_(thisTView).TView 'Tizen.UI.Components.ViewExtensions.GetScreenBounds<TView>(this TView).TView') + +#### Returns +Tizen.UI.Rect + + + +## ViewExtensions.SoundEffect<TView>(this TView, UIAttachable) Method + +Sets the sound effect for the view. This method attaches a given effect to a view using [Attach(this View, string, UIAttachable)](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.Attach(thisTizen.UI.View,string,Tizen.UI.Components.UIAttachable) 'Tizen.UI.Components.UIAttachableManager.Attach(this Tizen.UI.View, string, Tizen.UI.Components.UIAttachable)') with a key [SoundEffectKey](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.SoundEffectKey 'Tizen.UI.Components.UIAttachableManager.SoundEffectKey'). + +```csharp +public static TView SoundEffect<TView>(this TView view, Tizen.UI.Components.UIAttachable effect) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.SoundEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.SoundEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') + +The extension target. + + + +`effect` [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + +The effect to apply. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.SoundEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.SoundEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') +The view itself to allow chaining. + + + +## ViewExtensions.TouchEffect<TView>(this TView, UIAttachable) Method + +Sets the feedback effect for the view on touch. This method attaches a given effect to a view using [Attach(this View, string, UIAttachable)](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.Attach(thisTizen.UI.View,string,Tizen.UI.Components.UIAttachable) 'Tizen.UI.Components.UIAttachableManager.Attach(this Tizen.UI.View, string, Tizen.UI.Components.UIAttachable)') with a key [TouchEffectKey](Tizen.UI.Components.UIAttachableManager.md#Tizen.UI.Components.UIAttachableManager.TouchEffectKey 'Tizen.UI.Components.UIAttachableManager.TouchEffectKey'). + +```csharp +public static TView TouchEffect<TView>(this TView view, Tizen.UI.Components.UIAttachable effect) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.TouchEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.TouchEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') + +The extension target. + + + +`effect` [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') + +The touch feedback effect to apply. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.TouchEffect_TView_(thisTView,Tizen.UI.Components.UIAttachable).TView 'Tizen.UI.Components.ViewExtensions.TouchEffect<TView>(this TView, Tizen.UI.Components.UIAttachable).TView') +The view itself to allow chaining. + + + +## ViewExtensions.UnderShadow<TView>(this TView, IEnumerable<VisualObject>) Method + +Compose the under shadow layer with given list of visuals. + +```csharp +public static TView UnderShadow<TView>(this TView view, System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.VisualObject> visuals) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The view inheriting from Tizen.UI.View. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnderShadow_TView_(thisTView,System.Collections.Generic.IEnumerable_Tizen.UI.Visuals.VisualObject_).TView 'Tizen.UI.Components.ViewExtensions.UnderShadow<TView>(this TView, System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.VisualObject>).TView') + +The target view. + + + +`visuals` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')Tizen.UI.Visuals.VisualObject[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The visual list. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnderShadow_TView_(thisTView,System.Collections.Generic.IEnumerable_Tizen.UI.Visuals.VisualObject_).TView 'Tizen.UI.Components.ViewExtensions.UnderShadow<TView>(this TView, System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.VisualObject>).TView') +The view itself. + +### Remarks +The composed visuals can be modified by accessing with the Tizen.UI.Visuals.ViewExtensions.Visuals(Tizen.UI.View)') and Tizen.UI.Visuals.VisualManager.ShadowLayer. + + + +## ViewExtensions.UnderShadow<TView>(this TView, VisualObject[]) Method + +Compose the under shadow layer with given list of visuals. + +```csharp +public static TView UnderShadow<TView>(this TView view, params Tizen.UI.Visuals.VisualObject[] visuals) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The view inheriting from Tizen.UI.View. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnderShadow_TView_(thisTView,Tizen.UI.Visuals.VisualObject[]).TView 'Tizen.UI.Components.ViewExtensions.UnderShadow<TView>(this TView, Tizen.UI.Visuals.VisualObject[]).TView') + +The target view. + + + +`visuals` Tizen.UI.Visuals.VisualObject[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The visual list. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnderShadow_TView_(thisTView,Tizen.UI.Visuals.VisualObject[]).TView 'Tizen.UI.Components.ViewExtensions.UnderShadow<TView>(this TView, Tizen.UI.Visuals.VisualObject[]).TView') +The view itself. + +### Remarks +The composed visuals can be modified by accessing with the Tizen.UI.Visuals.ViewExtensions.Visuals(Tizen.UI.View)') and Tizen.UI.Visuals.VisualManager.ShadowLayer. + + + +## ViewExtensions.UnsetWhen<TView>(this TView) Method + +Remove all handlers registered to the view. + +```csharp +public static TView UnsetWhen<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView).TView') + +The extension target. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView).TView') +The view itself to allow chaining. + + + +## ViewExtensions.UnsetWhen<TView>(this TView, string) Method + +Remove all registered handlers with key. + +```csharp +public static TView UnsetWhen<TView>(this TView view, string key) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView,string).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView, string).TView') + +The extension target. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key that can manage the handler. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView,string).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView, string).TView') +The view itself to allow chaining. + + + +## ViewExtensions.UnsetWhen<TView>(this TView, Action<TView,UIStateChangedEventArgs>) Method + +Remove all registered specified handler. + +```csharp +public static TView UnsetWhen<TView>(this TView view, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs> handler) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>).TView') + +The extension target. + + + +`handler` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>).TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The event handler to be removed. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhen_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhen<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>).TView') +The view itself to allow chaining. + + + +## ViewExtensions.UnsetWhenIfNotProcessing<TView>(this TView, string) Method + +Remove all registered handlers with key only if this is not in any when handler execution. + +```csharp +public static TView UnsetWhenIfNotProcessing<TView>(this TView view, string key) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhenIfNotProcessing_TView_(thisTView,string).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhenIfNotProcessing<TView>(this TView, string).TView') + +The extension target. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key that can manage the handler. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.UnsetWhenIfNotProcessing_TView_(thisTView,string).TView 'Tizen.UI.Components.ViewExtensions.UnsetWhenIfNotProcessing<TView>(this TView, string).TView') +The view itself to allow chaining. + + + +## ViewExtensions.When<TView>(this TView, string, Action<TView,UIStateChangedEventArgs>, bool) Method + +Provide an easy way to handling state. + +```csharp +public static TView When<TView>(this TView view, string key, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs> handler, bool initialExecution=true) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') + +The extension target. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key that can manage the handler. + + + +`handler` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The event handler to be invoked when the state changes. + + + +`initialExecution` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, execute a given handler once in the call of this method. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') +The view itself to allow chaining. + + + +## ViewExtensions.When<TView>(this TView, string, UIStateConstraint, Action<TView,UIStateChangedEventArgs>, bool) Method + +Provide an easy way to handling state. + +```csharp +public static TView When<TView>(this TView view, string key, Tizen.UI.Components.UIStateConstraint constraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs> handler, bool initialExecution=true) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') + +The extension target. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key that can manage the handler. + + + +`constraint` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The constraint for the state of view. + + + +`handler` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The event handler to be invoked when the state changes. + + + +`initialExecution` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, execute a given handler once in the call of this method regardless of the constraint. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,string,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, string, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') +The view itself to allow chaining. + + + +## ViewExtensions.When<TView>(this TView, Action<TView,UIStateChangedEventArgs>, bool) Method + +Provide an easy way to handling state. + +```csharp +public static TView When<TView>(this TView view, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs> handler, bool initialExecution=true) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') + +The extension target. + + + +`handler` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The event handler to be invoked when the state changes. + + + +`initialExecution` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, execute a given handler once in the call of this method. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') +The view itself to allow chaining. + + + +## ViewExtensions.When<TView>(this TView, UIStateConstraint, Action<TView,UIStateChangedEventArgs>, bool) Method + +Provide an easy way to handling state. + +```csharp +public static TView When<TView>(this TView view, Tizen.UI.Components.UIStateConstraint constraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs> handler, bool initialExecution=true) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') + +The extension target. + + + +`constraint` [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') + +The constraint for the state of view. + + + +`handler` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The event handler to be invoked when the state changes. + + + +`initialExecution` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, execute a given handler once in the call of this method regardless of the constraint. + +#### Returns +[TView](Tizen.UI.Components.ViewExtensions.md#Tizen.UI.Components.ViewExtensions.When_TView_(thisTView,Tizen.UI.Components.UIStateConstraint,System.Action_TView,Tizen.UI.Components.UIStateChangedEventArgs_,bool).TView 'Tizen.UI.Components.ViewExtensions.When<TView>(this TView, Tizen.UI.Components.UIStateConstraint, System.Action<TView,Tizen.UI.Components.UIStateChangedEventArgs>, bool).TView') +The view itself to allow chaining. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.md b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.md new file mode 100644 index 0000000000..eb51d7eeb6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.md @@ -0,0 +1,180 @@ + +## Tizen.UI.Components Namespace + +| Classes | | +| :--- | :--- | +| [AnimatedImageVisualMap](Tizen.UI.Components.AnimatedImageVisualMap.md 'Tizen.UI.Components.AnimatedImageVisualMap') | AnimatedImageVisualMap is a class that represents a property map for the animated image visual. | +| [AnimatedLayout](Tizen.UI.Components.AnimatedLayout.md 'Tizen.UI.Components.AnimatedLayout') | Provides animated layout functionalities | +| [Clickable](Tizen.UI.Components.Clickable.md 'Tizen.UI.Components.Clickable') | Clickable is a base class for components that can be clicked.
It provides [Clicked](Tizen.UI.Components.Clickable.md#Tizen.UI.Components.Clickable.Clicked 'Tizen.UI.Components.Clickable.Clicked') event. | +| [ClickableBox](Tizen.UI.Components.ClickableBox.md 'Tizen.UI.Components.ClickableBox') | Clickable component with .
It provides [Clicked](Tizen.UI.Components.Clickable.md#Tizen.UI.Components.Clickable.Clicked 'Tizen.UI.Components.Clickable.Clicked') event. | +| [ClickableGrid](Tizen.UI.Components.ClickableGrid.md 'Tizen.UI.Components.ClickableGrid') | Clickable view with grid layout. | +| [ClickableHStack](Tizen.UI.Components.ClickableHStack.md 'Tizen.UI.Components.ClickableHStack') | Clickable view with horizontal stacking layout. | +| [ClickableVStack](Tizen.UI.Components.ClickableVStack.md 'Tizen.UI.Components.ClickableVStack') | Clickable view with vertical stacking layout. | +| [DestroyUtility](Tizen.UI.Components.DestroyUtility.md 'Tizen.UI.Components.DestroyUtility') | Provides extension methods for disposables. | +| [DummyFontFamilyLoader](Tizen.UI.Components.DummyFontFamilyLoader.md 'Tizen.UI.Components.DummyFontFamilyLoader') | Implements a dummy font family loader. | +| [DummyFontScaleLoader](Tizen.UI.Components.DummyFontScaleLoader.md 'Tizen.UI.Components.DummyFontScaleLoader') | Implements a dummy font scale loader. | +| [DummyThemeLoader](Tizen.UI.Components.DummyThemeLoader.md 'Tizen.UI.Components.DummyThemeLoader') | Implements a dummy font scale loader. | +| [GroupSelectable](Tizen.UI.Components.GroupSelectable.md 'Tizen.UI.Components.GroupSelectable') | Group selectable component is a component that can be selected among the [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup'). | +| [GroupSelectableBox](Tizen.UI.Components.GroupSelectableBox.md 'Tizen.UI.Components.GroupSelectableBox') | Selectable component with a content. | +| [GroupSelectionChangedEventArgs](Tizen.UI.Components.GroupSelectionChangedEventArgs.md 'Tizen.UI.Components.GroupSelectionChangedEventArgs') | The event arguments for the GroupSelectionChangedEventArgs event. | +| [InputEditorImpl](Tizen.UI.Components.InputEditorImpl.md 'Tizen.UI.Components.InputEditorImpl') | Wrapper class of DALi text editor. | +| [InputEventArgs](Tizen.UI.Components.InputEventArgs.md 'Tizen.UI.Components.InputEventArgs') | Event arguments for component input event. | +| [InputFieldImpl](Tizen.UI.Components.InputFieldImpl.md 'Tizen.UI.Components.InputFieldImpl') | Wrapper class of DALi text field. | +| [InputTextBaseImpl](Tizen.UI.Components.InputTextBaseImpl.md 'Tizen.UI.Components.InputTextBaseImpl') | Basic DALi input text object wrapper. | +| [InteractiveProgress](Tizen.UI.Components.InteractiveProgress.md 'Tizen.UI.Components.InteractiveProgress') | A interactive progress component that indicates a specific value from a continuous or discrete range of values. | +| [InteractiveProgressHelper](Tizen.UI.Components.InteractiveProgressHelper.md 'Tizen.UI.Components.InteractiveProgressHelper') | A helper class of interactive progress providing value converting methods. | +| [JsonParser](Tizen.UI.Components.JsonParser.md 'Tizen.UI.Components.JsonParser') | JsonParser is a helper class to parse JSON file. | +| [LabelImpl](Tizen.UI.Components.LabelImpl.md 'Tizen.UI.Components.LabelImpl') | Wrapper class of DALi text label.
Note that this creates a native instance that can be accessed through [Handle](Tizen.UI.Components.TextBaseImpl.md#Tizen.UI.Components.TextBaseImpl.Handle 'Tizen.UI.Components.TextBaseImpl.Handle') which you should release manually using [ReleaseNativeHandle](https://docs.microsoft.com/en-us/dotnet/api/ReleaseNativeHandle 'ReleaseNativeHandle'). | +| [LocalizationExtensions](Tizen.UI.Components.LocalizationExtensions.md 'Tizen.UI.Components.LocalizationExtensions') | Provides extension methods for the localization. | +| [LottieImageVisualMap](Tizen.UI.Components.LottieImageVisualMap.md 'Tizen.UI.Components.LottieImageVisualMap') | LottieImageVisualMap is a class that represents a property map for the lottie image visual. | +| [Navigator](Tizen.UI.Components.Navigator.md 'Tizen.UI.Components.Navigator') | Navigator is a container class that supports view navigation with the stack data structure.
Navigator manages two types of stacks, navigation stack and modal stack.
The modal stack contains modal views such as dialog.
The navigation stack contains the rest of the views.
The views in the modal stack are above the views in the navigation stack.
Views pushed by the modal methods such as [PushModalAsync(View)](Tizen.UI.Components.Navigator.md#Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View) 'Tizen.UI.Components.Navigator.PushModalAsync(Tizen.UI.View)') are pushed onto the modal stack as modal views. | +| [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette') | A class that extracts prominent colors from an image.


This is a helper class to extract colors from a Tizen.UI.PixelBuffer
It can generate a number of selected color swatches based on the image. | +| [Pressable](Tizen.UI.Components.Pressable.md 'Tizen.UI.Components.Pressable') | Pressable is a base class for components that can be pressed.
It provides [PressedChanged](Tizen.UI.Components.Pressable.md#Tizen.UI.Components.Pressable.PressedChanged 'Tizen.UI.Components.Pressable.PressedChanged') event. | +| [PressableBox](Tizen.UI.Components.PressableBox.md 'Tizen.UI.Components.PressableBox') | Pressable component with a content. | +| [Progress](Tizen.UI.Components.Progress.md 'Tizen.UI.Components.Progress') | A progress component that indicates a specific value from a continuous or discrete range of values. | +| [PropertySetter<TView,TValue>](Tizen.UI.Components.PropertySetter_TView,TValue_.md 'Tizen.UI.Components.PropertySetter<TView,TValue>') | Describes a property setter. | +| [RecoilEffect](Tizen.UI.Components.RecoilEffect.md 'Tizen.UI.Components.RecoilEffect') | Recoil visaul feedback that makes view dimmed and scaled. | +| [ScaffoldBase](Tizen.UI.Components.ScaffoldBase.md 'Tizen.UI.Components.ScaffoldBase') | A base class of scaffold which need to be root view of application.
Application can have a scaffold in a window to layout content properly
with some spefical UI layout and behavior. | +| [Scrollable](Tizen.UI.Components.Scrollable.md 'Tizen.UI.Components.Scrollable') | A scrollable view that can be scrolled. | +| [ScrollableLayoutManager](Tizen.UI.Components.ScrollableLayoutManager.md 'Tizen.UI.Components.ScrollableLayoutManager') | Provides functionality for arranging and measuring the children of a Scrollable. | +| [ScrollBarBase](Tizen.UI.Components.ScrollBarBase.md 'Tizen.UI.Components.ScrollBarBase') | A base class representing a scroll bar that can be used to control the scrolling of a view. | +| [Selectable](Tizen.UI.Components.Selectable.md 'Tizen.UI.Components.Selectable') | SelectableComponent.
It provides [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged') event when it activated. | +| [SelectableBindings<TView>](Tizen.UI.Components.SelectableBindings_TView_.md 'Tizen.UI.Components.SelectableBindings<TView>') | Provides a set of static properties that represent the data-binding capabilities of the [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') class. | +| [SelectableBox](Tizen.UI.Components.SelectableBox.md 'Tizen.UI.Components.SelectableBox') | Selectable component with a content.
It provides [SelectedChanged](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.SelectedChanged 'Tizen.UI.Components.ISelectable.SelectedChanged') event when it activated. | +| [SelectableHStack](Tizen.UI.Components.SelectableHStack.md 'Tizen.UI.Components.SelectableHStack') | Selectable view with horizontal stacking layout. | +| [SelectableVStack](Tizen.UI.Components.SelectableVStack.md 'Tizen.UI.Components.SelectableVStack') | Selectable view with vertical stacking layout. | +| [SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') | SelectionGroup is the selection manager of [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable'). | +| [SelectionGroupBox<T>](Tizen.UI.Components.SelectionGroupBox_T_.md 'Tizen.UI.Components.SelectionGroupBox<T>') | A group view of tab items for tab bar implementation. | +| [SelectionGroupItemClickedEventArgs](Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md 'Tizen.UI.Components.SelectionGroupItemClickedEventArgs') | The event arguments for the ItemClicked event for selection group components. | +| [SnapControlExtensions](Tizen.UI.Components.SnapControlExtensions.md 'Tizen.UI.Components.SnapControlExtensions') | Provides extension methods for setting snap points type and alignment on a Scrollable. | +| [Swatch](Tizen.UI.Components.Swatch.md 'Tizen.UI.Components.Swatch') | Represents a color swatch generated from a [Palette](Tizen.UI.Components.Palette.md 'Tizen.UI.Components.Palette').


A swatch contains a color, its population in the image, and suitable text colors for use over the swatch's color. | +| [SystemFeedback](Tizen.UI.Components.SystemFeedback.md 'Tizen.UI.Components.SystemFeedback') | System feedback such as sound and haptic for the view. | +| [TextBaseImpl](Tizen.UI.Components.TextBaseImpl.md 'Tizen.UI.Components.TextBaseImpl') | Basic DALi text object wrapper. | +| [TextTranslator](Tizen.UI.Components.TextTranslator.md 'Tizen.UI.Components.TextTranslator') | The class for providinf built-in text translator. | +| [TimeCounter](Tizen.UI.Components.TimeCounter.md 'Tizen.UI.Components.TimeCounter') | A time counter component that indicates a specific time value. | +| [TizenFontFamilyLoader](Tizen.UI.Components.TizenFontFamilyLoader.md 'Tizen.UI.Components.TizenFontFamilyLoader') | Implements a font family loader for tizen system default. | +| [TizenThemeLoader](Tizen.UI.Components.TizenThemeLoader.md 'Tizen.UI.Components.TizenThemeLoader') | The default theme loader for Tizen. It is implemented using `Tizen.Applications.ThemeLoader`. | +| [TokenTableExtensions](Tizen.UI.Components.TokenTableExtensions.md 'Tizen.UI.Components.TokenTableExtensions') | Provides extension methods for the token table class. | +| [TouchEffect](Tizen.UI.Components.TouchEffect.md 'Tizen.UI.Components.TouchEffect') | A class providing UI touch effect constants. | +| [UIAttachable](Tizen.UI.Components.UIAttachable.md 'Tizen.UI.Components.UIAttachable') | The attachable data to a UIView. | +| [UIAttachableManager](Tizen.UI.Components.UIAttachableManager.md 'Tizen.UI.Components.UIAttachableManager') | Manages attachable data on views. | +| [UIConfig](Tizen.UI.Components.UIConfig.md 'Tizen.UI.Components.UIConfig') | The base class for UI configuration.
It provides default values for UI components.
The derived classes can override these values. | +| [UIConfigManager](Tizen.UI.Components.UIConfigManager.md 'Tizen.UI.Components.UIConfigManager') | The manager of UIConfig. | +| [UIShadowExtensions](Tizen.UI.Components.UIShadowExtensions.md 'Tizen.UI.Components.UIShadowExtensions') | Extensions methods for Tizen.UI.Shadow | +| [UIStateChangedEventArgs](Tizen.UI.Components.UIStateChangedEventArgs.md 'Tizen.UI.Components.UIStateChangedEventArgs') | The event arguments for the UIState changed event. | +| [UIStateConnectingProperty<TView>](Tizen.UI.Components.UIStateConnectingProperty_TView_.md 'Tizen.UI.Components.UIStateConnectingProperty<TView>') | Represents a property for a view that can be connected to a state. | +| [UIStateManager](Tizen.UI.Components.UIStateManager.md 'Tizen.UI.Components.UIStateManager') | Provides methods to get a UIState from a view or to notify UIState change.
Note that there is no direct way to set a view UIState to a view.
The indirect way is to set connected property.
To set [Disabled](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Disabled 'Tizen.UI.Components.UIState.Disabled'), for example, you need to set Tizen.UI.View.IsEnabled to false. | +| [UITextManager](Tizen.UI.Components.UITextManager.md 'Tizen.UI.Components.UITextManager') | Text manager for UI. | +| [UIThemeManager](Tizen.UI.Components.UIThemeManager.md 'Tizen.UI.Components.UIThemeManager') | ThemeManager for UI. | +| [UIVariables](Tizen.UI.Components.UIVariables.md 'Tizen.UI.Components.UIVariables') | Defines the variables for UI. | +| [UIVectorExtensions](Tizen.UI.Components.UIVectorExtensions.md 'Tizen.UI.Components.UIVectorExtensions') | Provides extension methods for the UI vector, rect or extents. | +| [Variables](Tizen.UI.Components.Variables.md 'Tizen.UI.Components.Variables') | Variables used by UI components to construct inside. | +| [ViewExtensions](Tizen.UI.Components.ViewExtensions.md 'Tizen.UI.Components.ViewExtensions') | Provides extension methods for the View class. | + +| Structs | | +| :--- | :--- | +| [ClosedRange<T>](Tizen.UI.Components.ClosedRange_T_.md 'Tizen.UI.Components.ClosedRange<T>') | A range that is inclusive of both ends. | +| [UIState](Tizen.UI.Components.UIState.md 'Tizen.UI.Components.UIState') | Defines a value type of view state. | +| [UIStateConstraint](Tizen.UI.Components.UIStateConstraint.md 'Tizen.UI.Components.UIStateConstraint') | Represents a constraint for a state that will be given when calling [Match(UIStateChangedEventArgs)](Tizen.UI.Components.UIStateConstraint.md#Tizen.UI.Components.UIStateConstraint.Match(Tizen.UI.Components.UIStateChangedEventArgs) 'Tizen.UI.Components.UIStateConstraint.Match(Tizen.UI.Components.UIStateChangedEventArgs)'). | + +| Interfaces | | +| :--- | :--- | +| [IAnchoredModal](Tizen.UI.Components.IAnchoredModal.md 'Tizen.UI.Components.IAnchoredModal') | A modal content to be poped up from the anchor object. | +| [IAnimatedImage](Tizen.UI.Components.IAnimatedImage.md 'Tizen.UI.Components.IAnimatedImage') | Interface for animated image. | +| [IClickable](Tizen.UI.Components.IClickable.md 'Tizen.UI.Components.IClickable') | Clickable element interface. | +| [IClickableVariables](Tizen.UI.Components.IClickableVariables.md 'Tizen.UI.Components.IClickableVariables') | Variables used for clickable. | +| [IColorProvider](Tizen.UI.Components.IColorProvider.md 'Tizen.UI.Components.IColorProvider') | Interface for providing color. | +| [IDecoratableText](Tizen.UI.Components.IDecoratableText.md 'Tizen.UI.Components.IDecoratableText') | An interface to express decoratable text. | +| [IDoubleTitle](Tizen.UI.Components.IDoubleTitle.md 'Tizen.UI.Components.IDoubleTitle') | Interface describes a double title. | +| [IEdgeEffect](Tizen.UI.Components.IEdgeEffect.md 'Tizen.UI.Components.IEdgeEffect') | Edge effect for over scroll in scrollable view.
when the scrollable view reach the end edge of scroll,
pulling over the view process the Egde effect. | +| [IFlexibleText](Tizen.UI.Components.IFlexibleText.md 'Tizen.UI.Components.IFlexibleText') | An interface to express flexible text. | +| [IFontFamilyLoader](Tizen.UI.Components.IFontFamilyLoader.md 'Tizen.UI.Components.IFontFamilyLoader') | Interface for loading system font family. | +| [IFontScaleLoader](Tizen.UI.Components.IFontScaleLoader.md 'Tizen.UI.Components.IFontScaleLoader') | Interface for loading system font scale. | +| [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable') | Represents group selectable element.
[SelectionGroup](Tizen.UI.Components.SelectionGroup.md 'Tizen.UI.Components.SelectionGroup') can control the selection of group selectable. | +| [IImage](Tizen.UI.Components.IImage.md 'Tizen.UI.Components.IImage') | Interface for image. | +| [ILayoutBox](Tizen.UI.Components.ILayoutBox.md 'Tizen.UI.Components.ILayoutBox') | The interface implemeting a view has a specific layout. | +| [IModalContainer](Tizen.UI.Components.IModalContainer.md 'Tizen.UI.Components.IModalContainer') | A container that can show a modal content. It should have a scrim to block the background. | +| [INavigateBackHandler](Tizen.UI.Components.INavigateBackHandler.md 'Tizen.UI.Components.INavigateBackHandler') | The INavigateBackHandler interface defines methods to handle navigating back. | +| [INavigation](Tizen.UI.Components.INavigation.md 'Tizen.UI.Components.INavigation') | The INavigation interface defines methods to navigate views with the stack data structure. | +| [INavigationAnimation](Tizen.UI.Components.INavigationAnimation.md 'Tizen.UI.Components.INavigationAnimation') | The INavigationAnimation interface defines functions called for the transition animation during navigation. | +| [INavigationAnimationController](Tizen.UI.Components.INavigationAnimationController.md 'Tizen.UI.Components.INavigationAnimationController') | The INavigationAnimationController interface defines interfaces for navigation animation. | +| [INavigationTransition](Tizen.UI.Components.INavigationTransition.md 'Tizen.UI.Components.INavigationTransition') | The INavigationTransition interface defines methods to notice the changes of the navigation transition such as appearing or disappearing. | +| [IPressable](Tizen.UI.Components.IPressable.md 'Tizen.UI.Components.IPressable') | Represents pressable element.
All derived class of Tizen.UI.View that implements this interface can have [Pressed](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Pressed 'Tizen.UI.Components.UIState.Pressed') state when [IsPressed](Tizen.UI.Components.IPressable.md#Tizen.UI.Components.IPressable.IsPressed 'Tizen.UI.Components.IPressable.IsPressed') is true. | +| [IPropertySetter<TValue>](Tizen.UI.Components.IPropertySetter_TValue_.md 'Tizen.UI.Components.IPropertySetter<TValue>') | The interface for property setter. | +| [ISelectable](Tizen.UI.Components.ISelectable.md 'Tizen.UI.Components.ISelectable') | Represents selectable element.
All derived class of Tizen.UI.View that implements this interface can have [Selected](Tizen.UI.Components.UIState.md#Tizen.UI.Components.UIState.Selected 'Tizen.UI.Components.UIState.Selected') state when [IsSelected](Tizen.UI.Components.ISelectable.md#Tizen.UI.Components.ISelectable.IsSelected 'Tizen.UI.Components.ISelectable.IsSelected') is true. | +| [ISelectionGroup](Tizen.UI.Components.ISelectionGroup.md 'Tizen.UI.Components.ISelectionGroup') | Interface for a group of [IGroupSelectable](Tizen.UI.Components.IGroupSelectable.md 'Tizen.UI.Components.IGroupSelectable'). | +| [IThemeLoader](Tizen.UI.Components.IThemeLoader.md 'Tizen.UI.Components.IThemeLoader') | Interface for loading system theme. | +| [ITitle](Tizen.UI.Components.ITitle.md 'Tizen.UI.Components.ITitle') | Interface describes a title. | +| [ITouchEffectTarget](Tizen.UI.Components.ITouchEffectTarget.md 'Tizen.UI.Components.ITouchEffectTarget') | Interface for touch effect target. | + +| Enums | | +| :--- | :--- | +| [ClickKeyType](Tizen.UI.Components.ClickKeyType.md 'Tizen.UI.Components.ClickKeyType') | The type of click key. | +| [EdgeDirection](Tizen.UI.Components.EdgeDirection.md 'Tizen.UI.Components.EdgeDirection') | The direction of edge. | +| [EdgeState](Tizen.UI.Components.EdgeState.md 'Tizen.UI.Components.EdgeState') | The State of edge effect. | +| [FloatingOrigin](Tizen.UI.Components.FloatingOrigin.md 'Tizen.UI.Components.FloatingOrigin') | The position where the floating target is placed. | +| [IconPlacement](Tizen.UI.Components.IconPlacement.md 'Tizen.UI.Components.IconPlacement') | Specifieds the placement of the icon relative to other content. | +| [InteractionType](Tizen.UI.Components.InteractionType.md 'Tizen.UI.Components.InteractionType') | The interaction type of view. | +| [ModalPivot](Tizen.UI.Components.ModalPivot.md 'Tizen.UI.Components.ModalPivot') | Enumeration for the pivot type of modal. | +| [OffScreenRenderingMode](Tizen.UI.Components.OffScreenRenderingMode.md 'Tizen.UI.Components.OffScreenRenderingMode') | Enumeration for the mode of offscreen rendering. | +| [OverScrollMode](Tizen.UI.Components.OverScrollMode.md 'Tizen.UI.Components.OverScrollMode') | Mode of action over scroll after edge reached. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayout.md new file mode 100644 index 0000000000..441dc72a4f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayout.md @@ -0,0 +1,104 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## AbsoluteLayout Class + +The AbsoluteLayout class is a layout container that positions its children at fixed coordinates relative to the layout bounds. + +```csharp +public class AbsoluteLayout : Tizen.UI.Layouts.Layout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 AbsoluteLayout +### Methods + + + +## AbsoluteLayout.Add(View, Rect, AbsoluteLayoutFlags) Method + +Adds a child view to the AbsoluteLayout with the specified bounds and flags. + +```csharp +public void Add(Tizen.UI.View view, Tizen.UI.Rect bounds, Tizen.UI.Layouts.AbsoluteLayoutFlags flags); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The child view to add. + + + +`bounds` Tizen.UI.Rect + +The bounds of the child view. + + + +`flags` [AbsoluteLayoutFlags](Tizen.UI.Layouts.AbsoluteLayoutFlags.md 'Tizen.UI.Layouts.AbsoluteLayoutFlags') + +The absolute layout flags for the child view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutExtensions.md new file mode 100644 index 0000000000..179f367bad --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutExtensions.md @@ -0,0 +1,164 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## AbsoluteLayoutExtensions Class + +Provides a series of extension methods that support positioning Tizen.UI.Views in [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout')s. + +```csharp +public static class AbsoluteLayoutExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AbsoluteLayoutExtensions +### Methods + + + +## AbsoluteLayoutExtensions.LayoutBounds<TView>(this TView, float, float, float, float) Method + +Sets the position and size of a Tizen.UI.View in an [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout').
+This only works if the Tizen.UI.View is included in the [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout') and used. + +```csharp +public static TView LayoutBounds<TView>(this TView view, float x, float y, float width, float height) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.AbsoluteLayoutExtensions.md#Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutBounds_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutBounds<TView>(this TView, float, float, float, float).TView') + +The view to set the layout bounds for. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x position of the view. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y position of the view. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the view. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the view. + +#### Returns +[TView](Tizen.UI.Layouts.AbsoluteLayoutExtensions.md#Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutBounds_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutBounds<TView>(this TView, float, float, float, float).TView') +The view itself, to allow for method chaining. + + + +## AbsoluteLayoutExtensions.LayoutFlags<TView>(this TView, AbsoluteLayoutFlags) Method + +Set a flag that indicates that the layout bounds position and size values for a child are proportional to the size of the [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout').
+This only works if the Tizen.UI.View is included in the [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout') and used. + +```csharp +public static TView LayoutFlags<TView>(this TView view, Tizen.UI.Layouts.AbsoluteLayoutFlags flag) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.AbsoluteLayoutExtensions.md#Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutFlags_TView_(thisTView,Tizen.UI.Layouts.AbsoluteLayoutFlags).TView 'Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutFlags<TView>(this TView, Tizen.UI.Layouts.AbsoluteLayoutFlags).TView') + +The view to set the layout flags for. + + + +`flag` [AbsoluteLayoutFlags](Tizen.UI.Layouts.AbsoluteLayoutFlags.md 'Tizen.UI.Layouts.AbsoluteLayoutFlags') + +The layout flag to set. + +#### Returns +[TView](Tizen.UI.Layouts.AbsoluteLayoutExtensions.md#Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutFlags_TView_(thisTView,Tizen.UI.Layouts.AbsoluteLayoutFlags).TView 'Tizen.UI.Layouts.AbsoluteLayoutExtensions.LayoutFlags<TView>(this TView, Tizen.UI.Layouts.AbsoluteLayoutFlags).TView') +The view itself, to allow for method chaining. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutFlags.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutFlags.md new file mode 100644 index 0000000000..34a87124b0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutFlags.md @@ -0,0 +1,120 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## AbsoluteLayoutFlags Enum + +Enumeration for AbsoluteLayoutFlags. + +```csharp +public enum AbsoluteLayoutFlags +``` +### Fields + + + +`All` -1 + +Indicates that all properties of the child element should be proportional to its parent. + + + +`HeightProportional` 8 + +Indicates that the height of the child element should be proportional to its parent. + + + +`None` 0 + +No flags set. + + + +`PositionProportional` 3 + +Indicates that both the X and Y positions of the child element should be proportional to its parent. + + + +`SizeProportional` 12 + +Indicates that both the width and height of the child element should be proportional to its parent. + + + +`WidthProportional` 4 + +Indicates that the width of the child element should be proportional to its parent. + + + +`XProportional` 1 + +Indicates that the X position of the child element should be proportional to its parent. + + + +`YProportional` 2 + +Indicates that the Y position of the child element should be proportional to its parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutManager.md new file mode 100644 index 0000000000..4b5b087ae5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutManager.md @@ -0,0 +1,159 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## AbsoluteLayoutManager Class + +The AbsoluteLayoutManager class is responsible for measuring and arranging the children of an AbsoluteLayout. + +```csharp +public class AbsoluteLayoutManager : Tizen.UI.Layouts.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 AbsoluteLayoutManager +### Constructors + + + +## AbsoluteLayoutManager(ILayout) Constructor + +Initializes a new instance of the AbsoluteLayoutManager class. + +```csharp +public AbsoluteLayoutManager(Tizen.UI.Layouts.ILayout absoluteLayout); +``` +#### Parameters + + + +`absoluteLayout` [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') + +The AbsoluteLayout associated with this AbsoluteLayoutManager. +### Properties + + + +## AbsoluteLayoutManager.AbsoluteLayout Property + +Gets the AbsoluteLayout associated with this AbsoluteLayoutManager. + +```csharp +public Tizen.UI.Layouts.ILayout AbsoluteLayout { get; } +``` + +#### Property Value +[ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Methods + + + +## AbsoluteLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the AbsoluteLayout within the given bounds. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds within which to arrange the children. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the children. + + + +## AbsoluteLayoutManager.Measure(float, float) Method + +Measures the size of the AbsoluteLayout using the given constraints. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width constraint to use when measuring the AbsoluteLayout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height constraint to use when measuring the AbsoluteLayout. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the AbsoluteLayout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteParam.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteParam.md new file mode 100644 index 0000000000..7bd2655ea1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteParam.md @@ -0,0 +1,101 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## AbsoluteParam Class + +The AbsoluteParam class provides layout parameters for the AbsoluteLayout. + +```csharp +public class AbsoluteParam +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AbsoluteParam +### Properties + + + +## AbsoluteParam.LayoutBounds Property + +Gets or sets the layout bounds of the view. + +```csharp +public Tizen.UI.Rect LayoutBounds { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## AbsoluteParam.LayoutFlags Property + +Gets or sets the layout flags for the view. + +```csharp +public Tizen.UI.Layouts.AbsoluteLayoutFlags LayoutFlags { get; set; } +``` + +#### Property Value +[AbsoluteLayoutFlags](Tizen.UI.Layouts.AbsoluteLayoutFlags.md 'Tizen.UI.Layouts.AbsoluteLayoutFlags') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Dimension.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Dimension.md new file mode 100644 index 0000000000..52a2cc3a14 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Dimension.md @@ -0,0 +1,198 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## Dimension Class + +Provides a set of static methods for working with dimensions. + +```csharp +public static class Dimension +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Dimension +### Fields + + + +## Dimension.Maximum Field + +The constant representing the maximum dimension value. + +```csharp +public const float Maximum = ∞; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Dimension.Minimum Field + +The constant representing the minimum dimension value. + +```csharp +public const float Minimum = 0; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Dimension.Unset Field + +The constant representing the unset dimension value. + +```csharp +public const float Unset = NaN; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Dimension.IsExplicitSet(float) Method + +Checks if the given float value is explicitly set. + +```csharp +public static bool IsExplicitSet(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The float value to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the value is explicitly set, false otherwise. + + + +## Dimension.IsMaximumSet(float) Method + +Checks if the given value has been set to its maximum value. + +```csharp +public static bool IsMaximumSet(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the value has been set to its maximum value, false otherwise. + + + +## Dimension.IsMinimumSet(float) Method + +Checks if the given value is set to its minimum value. + +```csharp +public static bool IsMinimumSet(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the value is set to its minimum value, false otherwise. + + + +## Dimension.ResolveMinimum(float) Method + +Resolves the minimum dimension value. + +```csharp +public static float ResolveMinimum(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The dimension value to resolve. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The resolved dimension value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignContent.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignContent.md new file mode 100644 index 0000000000..e8a74af121 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignContent.md @@ -0,0 +1,114 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexAlignContent Enum + +Enumerates values that control how multiple rows or columns of child elements are aligned. + +```csharp +public enum FlexAlignContent +``` +### Fields + + + +`Center` 2 + +Indicates that the group of rows will be centered within the parent. + + + +`End` 4 + +Indicates that the group of rows will be stacked against the end of the parent. + + + +`SpaceAround` 6 + +Indicates that all rows will have the same amount of space above and below themselves them, except the top and bottom row, which will have half as much space between themselves and the top and bottom of the parent, respectively. + + + +`SpaceBetween` 5 + +Indicates that the top and bottom row will align with the top and bottom of the parent, and the remaining rows will have identical space above and below themselves. + + + +`SpaceEvenly` 7 + +Indicates that all rows will have the same amount of space above and below themselves them, including the top and bottom row. + + + +`Start` 3 + +Indicates that the group of rows will be stacked against the start of the parent. + + + +`Stretch` 1 + +Indicates that the collection of rows will stretch to fill the parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignItems.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignItems.md new file mode 100644 index 0000000000..6952204c55 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignItems.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexAlignItems Enum + +Enumerates values that control the alignment of child elements. + +```csharp +public enum FlexAlignItems +``` +### Fields + + + +`Center` 2 + +Indicates that child elements will be centered within the parent. + + + +`End` 4 + +Indicates that child elements will be placed against the end of the parent. + + + +`Start` 3 + +Indicates that child elements will be placed against the start of the parent. + + + +`Stretch` 1 + +Indicates that child elements will stretch from start to end of the parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignSelf.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignSelf.md new file mode 100644 index 0000000000..2dba3f9e05 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignSelf.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexAlignSelf Enum + +Enumerates values that control how and whether a child element overrides alignment attributes applied by its parent. + +```csharp +public enum FlexAlignSelf +``` +### Fields + + + +`Auto` 0 + +Indicates that the element will use the alignment supplied by the FlexAlignItems value provided to its parent. + + + +`Center` 2 + +Indicates that the element will be centered within the parent. + + + +`End` 4 + +Indicates that the element will be placed against the end of the parent. + + + +`Start` 3 + +Indicates that the element will be placed against the start of the parent. + + + +`Stretch` 1 + +Indicates that the element will stretch from start to end of the parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBasis.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBasis.md new file mode 100644 index 0000000000..ae7e881236 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBasis.md @@ -0,0 +1,200 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexBasis Struct + +Specifies the initial size of the flex item. + +```csharp +public struct FlexBasis : +System.IEquatable<Tizen.UI.Layouts.FlexBasis> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## FlexBasis(float, bool) Constructor + +Initializes a new instance of the FlexBasis class with the specified length. + +```csharp +public FlexBasis(float length, bool isRelative=false); +``` +#### Parameters + + + +`length` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`isRelative` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Fields + + + +## FlexBasis.Auto Field + +Automatic sizing. + +```csharp +public static readonly FlexBasis Auto; +``` + +#### Field Value +[FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') +### Properties + + + +## FlexBasis.Length Property + +Gets the length of the FlexBasis. + +```csharp +public readonly float Length { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## FlexBasis.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object? obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Layouts.FlexBasis.md#Tizen.UI.Layouts.FlexBasis.Equals(object).obj 'Tizen.UI.Layouts.FlexBasis.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## FlexBasis.Equals(FlexBasis) Method + +Compares two FlexBasis objects for equality. + +```csharp +public bool Equals(Tizen.UI.Layouts.FlexBasis other); +``` +#### Parameters + + + +`other` [FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') + +The FlexBasis object to compare with the current FlexBasis object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the FlexBasis objects are equal; otherwise, false. + + + +## FlexBasis.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. +### Operators + + + +## FlexBasis.implicit operator FlexBasis(float) Operator + +Defines an implicit conversion of a float value to a [FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') instance. + +```csharp +public static Tizen.UI.Layouts.FlexBasis implicit operator FlexBasis(float length); +``` +#### Parameters + + + +`length` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The length of the basis. + +#### Returns +[FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBox.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBox.md new file mode 100644 index 0000000000..9df07343ec --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBox.md @@ -0,0 +1,196 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexBox Class + +FlexBox is a Layout that efficiently lays out it's children in a manner similar to that of CSS Flexbox. + +```csharp +public class FlexBox : Tizen.UI.Layouts.Layout, +Tizen.UI.Layouts.IFlexBox, +Tizen.UI.Layouts.ILayout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 FlexBox + +Implements [IFlexBox](Tizen.UI.Layouts.IFlexBox.md 'Tizen.UI.Layouts.IFlexBox'), [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Constructors + + + +## FlexBox() Constructor + +Initializes a new instance of the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') class. + +```csharp +public FlexBox(); +``` +### Properties + + + +## FlexBox.AlignContent Property + +Gets or sets a value that controls how multiple rows or columns of child elements are aligned. + +```csharp +public Tizen.UI.Layouts.FlexAlignContent AlignContent { get; set; } +``` + +#### Property Value +[FlexAlignContent](Tizen.UI.Layouts.FlexAlignContent.md 'Tizen.UI.Layouts.FlexAlignContent') + + + +## FlexBox.AlignItems Property + +Gets or sets a value that controls how child elements are laid out within their row or column. + +```csharp +public Tizen.UI.Layouts.FlexAlignItems AlignItems { get; set; } +``` + +#### Property Value +[FlexAlignItems](Tizen.UI.Layouts.FlexAlignItems.md 'Tizen.UI.Layouts.FlexAlignItems') + + + +## FlexBox.Direction Property + +Gets or sets the flex direction for child elements within this layout. + +```csharp +public Tizen.UI.Layouts.FlexDirection Direction { get; set; } +``` + +#### Property Value +[FlexDirection](Tizen.UI.Layouts.FlexDirection.md 'Tizen.UI.Layouts.FlexDirection') + + + +## FlexBox.JustifyContent Property + +Gets or sets a value that that describes how child elements are justified when there is extra space around them. + +```csharp +public Tizen.UI.Layouts.FlexJustify JustifyContent { get; set; } +``` + +#### Property Value +[FlexJustify](Tizen.UI.Layouts.FlexJustify.md 'Tizen.UI.Layouts.FlexJustify') + + + +## FlexBox.Position Property + +Gets or sets a value that controls whether the coordinates of child elements are specified in absolute or relative terms. + +```csharp +public Tizen.UI.Layouts.FlexPosition Position { get; set; } +``` + +#### Property Value +[FlexPosition](Tizen.UI.Layouts.FlexPosition.md 'Tizen.UI.Layouts.FlexPosition') + + + +## FlexBox.Wrap Property + +Gets or sets a value that controls whether and how child elements within this layout wrap. + +```csharp +public Tizen.UI.Layouts.FlexWrap Wrap { get; set; } +``` + +#### Property Value +[FlexWrap](Tizen.UI.Layouts.FlexWrap.md 'Tizen.UI.Layouts.FlexWrap') +### Methods + + + +## FlexBox.Measure(float, float) Method + +Measures the layout with the specified available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width to measure the layout with. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height to measure the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after measuring. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBoxExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBoxExtensions.md new file mode 100644 index 0000000000..3d6a579785 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBoxExtensions.md @@ -0,0 +1,998 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexBoxExtensions Class + +Provides a series of extension methods that support positioning a Tizen.UI.View in a [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox'). + +```csharp +public static class FlexBoxExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 FlexBoxExtensions +### Methods + + + +## FlexBoxExtensions.AlignItems<TView>(this TView, FlexAlignItems) Method + +Sets the align-items property of the FlexBox.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView AlignItems<TView>(this TView view, Tizen.UI.Layouts.FlexAlignItems alignItems) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AlignItems_TView_(thisTView,Tizen.UI.Layouts.FlexAlignItems).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AlignItems<TView>(this TView, Tizen.UI.Layouts.FlexAlignItems).TView') + +The FlexBox. + + + +`alignItems` [FlexAlignItems](Tizen.UI.Layouts.FlexAlignItems.md 'Tizen.UI.Layouts.FlexAlignItems') + +The align-items value to set. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AlignItems_TView_(thisTView,Tizen.UI.Layouts.FlexAlignItems).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AlignItems<TView>(this TView, Tizen.UI.Layouts.FlexAlignItems).TView') +The FlexBox. + + + +## FlexBoxExtensions.AlignSelf<TView>(this TView, FlexAlignSelf) Method + +Sets the align-self property of the view.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView AlignSelf<TView>(this TView view, Tizen.UI.Layouts.FlexAlignSelf alignSelf) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AlignSelf_TView_(thisTView,Tizen.UI.Layouts.FlexAlignSelf).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AlignSelf<TView>(this TView, Tizen.UI.Layouts.FlexAlignSelf).TView') + +The view to set the property on. + + + +`alignSelf` [FlexAlignSelf](Tizen.UI.Layouts.FlexAlignSelf.md 'Tizen.UI.Layouts.FlexAlignSelf') + +The align-self value. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AlignSelf_TView_(thisTView,Tizen.UI.Layouts.FlexAlignSelf).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AlignSelf<TView>(this TView, Tizen.UI.Layouts.FlexAlignSelf).TView') +The view itself. + + + +## FlexBoxExtensions.AutoAlign<TView>(this TView) Method + +Sets the align-self property of the view to auto.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView AutoAlign<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AutoAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AutoAlign<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AutoAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AutoAlign<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.AutoBasis<TView>(this TView) Method + +Sets the flex basis property of the view to auto.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView AutoBasis<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AutoBasis_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AutoBasis<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.AutoBasis_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.AutoBasis<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.Basis<TView>(this TView, float) Method + +Sets the flex basis property of the view to an absolute value.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Basis<TView>(this TView view, float length) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Basis_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Basis<TView>(this TView, float).TView') + +The view to set the property on. + + + +`length` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The absolute length of the basis. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Basis_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Basis<TView>(this TView, float).TView') +The view itself. + + + +## FlexBoxExtensions.CenterAlign<TView>(this TView) Method + +Sets the align-self property of the view to center.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView CenterAlign<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterAlign<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterAlign<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.CenterItems<TView>(this TView) Method + +Sets the align-items property of the FlexBox to center.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView CenterItems<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterItems<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterItems<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.CenterJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to center.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView CenterJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.CenterJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.CenterJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.Column<TView>(this TView) Method + +Sets the direction of the FlexBox to column.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Column<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Column_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Column<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Column_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Column<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.ColumnReverse<TView>(this TView) Method + +Sets the direction of the FlexBox to column-reverse.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView ColumnReverse<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.ColumnReverse_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.ColumnReverse<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.ColumnReverse_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.ColumnReverse<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.Direction<TView>(this TView, FlexDirection) Method + +Sets the direction of the FlexBox.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Direction<TView>(this TView view, Tizen.UI.Layouts.FlexDirection direction) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Direction_TView_(thisTView,Tizen.UI.Layouts.FlexDirection).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Direction<TView>(this TView, Tizen.UI.Layouts.FlexDirection).TView') + +The FlexBox. + + + +`direction` [FlexDirection](Tizen.UI.Layouts.FlexDirection.md 'Tizen.UI.Layouts.FlexDirection') + +The direction to set. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Direction_TView_(thisTView,Tizen.UI.Layouts.FlexDirection).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Direction<TView>(this TView, Tizen.UI.Layouts.FlexDirection).TView') +The FlexBox. + + + +## FlexBoxExtensions.EndAlign<TView>(this TView) Method + +Sets the align-self property of the view to end.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView EndAlign<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndAlign<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndAlign<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.EndItems<TView>(this TView) Method + +Sets the align-items property of the FlexBox to end.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView EndItems<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndItems<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndItems<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.EndJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to end.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView EndJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.EndJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.EndJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.Grow<TView>(this TView, float) Method + +Sets the flex grow property of the view.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Grow<TView>(this TView view, float grow) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Grow_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Grow<TView>(this TView, float).TView') + +The view to set the property on. + + + +`grow` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The flex grow value. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Grow_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Grow<TView>(this TView, float).TView') +The view itself. + + + +## FlexBoxExtensions.JustifyContent<TView>(this TView, FlexJustify) Method + +Sets the justify-content property of the FlexBox.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView JustifyContent<TView>(this TView view, Tizen.UI.Layouts.FlexJustify justifyContent) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.JustifyContent_TView_(thisTView,Tizen.UI.Layouts.FlexJustify).TView 'Tizen.UI.Layouts.FlexBoxExtensions.JustifyContent<TView>(this TView, Tizen.UI.Layouts.FlexJustify).TView') + +The FlexBox. + + + +`justifyContent` [FlexJustify](Tizen.UI.Layouts.FlexJustify.md 'Tizen.UI.Layouts.FlexJustify') + +The justify-content value to set. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.JustifyContent_TView_(thisTView,Tizen.UI.Layouts.FlexJustify).TView 'Tizen.UI.Layouts.FlexBoxExtensions.JustifyContent<TView>(this TView, Tizen.UI.Layouts.FlexJustify).TView') +The FlexBox. + + + +## FlexBoxExtensions.Order<TView>(this TView, int) Method + +Sets the order property of the view.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Order<TView>(this TView view, int order) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Order_TView_(thisTView,int).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Order<TView>(this TView, int).TView') + +The view to set the property on. + + + +`order` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The order value. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Order_TView_(thisTView,int).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Order<TView>(this TView, int).TView') +The view itself. + + + +## FlexBoxExtensions.RelativeBasis<TView>(this TView, float) Method + +Sets the flex basis property of the view to a relative value.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView RelativeBasis<TView>(this TView view, float length) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.RelativeBasis_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.RelativeBasis<TView>(this TView, float).TView') + +The view to set the property on. + + + +`length` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative length of the basis. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.RelativeBasis_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.RelativeBasis<TView>(this TView, float).TView') +The view itself. + + + +## FlexBoxExtensions.Row<TView>(this TView) Method + +Sets the direction of the FlexBox to row.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Row<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Row_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Row<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Row_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Row<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.RowReverse<TView>(this TView) Method + +Sets the direction of the FlexBox to row-reverse.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView RowReverse<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.RowReverse_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.RowReverse<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.RowReverse_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.RowReverse<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.Shrink<TView>(this TView, float) Method + +Sets the flex shrink property of the view.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView Shrink<TView>(this TView view, float shrink) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Shrink_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Shrink<TView>(this TView, float).TView') + +The view to set the property on. + + + +`shrink` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The flex shrink value. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.Shrink_TView_(thisTView,float).TView 'Tizen.UI.Layouts.FlexBoxExtensions.Shrink<TView>(this TView, float).TView') +The view itself. + + + +## FlexBoxExtensions.SpaceAroundJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to space-around.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView SpaceAroundJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceAroundJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceAroundJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceAroundJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceAroundJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.SpaceBetweenJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to space-between.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView SpaceBetweenJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceBetweenJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceBetweenJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceBetweenJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceBetweenJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.SpaceEvenlyJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to space-evenly.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView SpaceEvenlyJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceEvenlyJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceEvenlyJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.SpaceEvenlyJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.SpaceEvenlyJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.StartAlign<TView>(this TView) Method + +Sets the align-self property of the view to start.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView StartAlign<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartAlign<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartAlign<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.StartItems<TView>(this TView) Method + +Sets the align-items property of the FlexBox to start.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView StartItems<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartItems<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartItems<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.StartJustify<TView>(this TView) Method + +Sets the justify-content property of the FlexBox to start.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView StartJustify<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartJustify<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StartJustify_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StartJustify<TView>(this TView).TView') +The FlexBox. + + + +## FlexBoxExtensions.StretchAlign<TView>(this TView) Method + +Sets the align-self property of the view to stretch.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView StretchAlign<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StretchAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StretchAlign<TView>(this TView).TView') + +The view to set the property on. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StretchAlign_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StretchAlign<TView>(this TView).TView') +The view itself. + + + +## FlexBoxExtensions.StretchItems<TView>(this TView) Method + +Sets the align-items property of the FlexBox to stretch.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static TView StretchItems<TView>(this TView view) + where TView : Tizen.UI.Layouts.FlexBox; +``` +#### Type parameters + + + +`TView` + +The type of the FlexBox. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StretchItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StretchItems<TView>(this TView).TView') + +The FlexBox. + +#### Returns +[TView](Tizen.UI.Layouts.FlexBoxExtensions.md#Tizen.UI.Layouts.FlexBoxExtensions.StretchItems_TView_(thisTView).TView 'Tizen.UI.Layouts.FlexBoxExtensions.StretchItems<TView>(this TView).TView') +The FlexBox. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexDirection.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexDirection.md new file mode 100644 index 0000000000..5e5ae21c0a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexDirection.md @@ -0,0 +1,96 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexDirection Enum + +Enumerates values that specify row and columen flex layout directions, relative to the directions for the device locale. + +```csharp +public enum FlexDirection +``` +### Fields + + + +`Column` 2 + +Indicates that child elements will be laid out in the default column layout direction for the locale. + + + +`ColumnReverse` 3 + +Indicates that child elements will be laid out in the reverse of the default column layout direction for the locale. + + + +`Row` 0 + +Indicates that child elements will be laid out in the default row layout direction for the locale. + + + +`RowReverse` 1 + +Indicates that child elements will be laid out in the reverse of the default row layout direction for the locale. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexJustify.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexJustify.md new file mode 100644 index 0000000000..ab471f685b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexJustify.md @@ -0,0 +1,108 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexJustify Enum + +Enumerates values that describe how child elements are justified when there is extra space around them. + +```csharp +public enum FlexJustify +``` +### Fields + + + +`Center` 2 + +Indicates that child elements will be grouped toward the center of the parent. + + + +`End` 4 + +Indicates that child elements will be justified to the end of the line. + + + +`SpaceAround` 6 + +Indicates that child elements will be spaced with one unit of space at the beginning and end, and two units of space between them, so that the elements and the space fill the line. + + + +`SpaceBetween` 5 + +Indicates that child elements will be spaced with equal space between units and no space at either end of the line, so that the elements and the space fill the line. + + + +`SpaceEvenly` 7 + +Indicates that child elements will be spaced to have the same space between each element as there is between the beginning and end elements and the nearest edges of the parent. + + + +`Start` 3 + +Indicates that child elements will be justified to the start of the line. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexLayoutManager.md new file mode 100644 index 0000000000..77b22c261d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexLayoutManager.md @@ -0,0 +1,119 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexLayoutManager Class + +Provides a layout manager for FlexBox layout. + +```csharp +public class FlexLayoutManager : +Tizen.UI.Layouts.ILayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 FlexLayoutManager + +Implements [ILayoutManager](Tizen.UI.Layouts.ILayoutManager.md 'Tizen.UI.Layouts.ILayoutManager') +### Constructors + + + +## FlexLayoutManager(IFlexBox) Constructor + +Initializes a new instance of the FlexLayoutManager class. + +```csharp +public FlexLayoutManager(Tizen.UI.Layouts.IFlexBox flexLayout); +``` +#### Parameters + + + +`flexLayout` [IFlexBox](Tizen.UI.Layouts.IFlexBox.md 'Tizen.UI.Layouts.IFlexBox') + +The IFlexBox instance to be managed by this layout manager. +### Methods + + + +## FlexLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the FlexBox according to the layout rules. + +```csharp +public Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The final size of the FlexBox after arranging its children. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexParam.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexParam.md new file mode 100644 index 0000000000..9e06ed0ac7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexParam.md @@ -0,0 +1,139 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexParam Class + +Provides layout parameters for the FlexBox. + +```csharp +public class FlexParam +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 FlexParam +### Properties + + + +## FlexParam.AlignSelf Property + +Gets or sets the alignment in the block direction for the selected item inside a flexbox. + +```csharp +public Tizen.UI.Layouts.FlexAlignSelf AlignSelf { get; set; } +``` + +#### Property Value +[FlexAlignSelf](Tizen.UI.Layouts.FlexAlignSelf.md 'Tizen.UI.Layouts.FlexAlignSelf') + + + +## FlexParam.Basis Property + +Gets or sets the initial main size of a flex item. + +```csharp +public Tizen.UI.Layouts.FlexBasis Basis { get; set; } +``` + +#### Property Value +[FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') + + + +## FlexParam.Grow Property + +Gets or sets the flex grow factor, which specifies how much of the flexbox's remaining space should be assigned to the flex item's main size. + +```csharp +public float Grow { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## FlexParam.Order Property + +Gets or sets the order to lay out an item in a flexbox. + +```csharp +public int Order { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## FlexParam.Shrink Property + +Gets or sets the flex shrink factor of a flex item. + +```csharp +public float Shrink { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexPosition.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexPosition.md new file mode 100644 index 0000000000..681254343b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexPosition.md @@ -0,0 +1,84 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexPosition Enum + +Enumerates values that control how layout coordinates are interpreted when specifying the positions of child elements. + +```csharp +public enum FlexPosition +``` +### Fields + + + +`Absolute` 1 + +Indicates that coordinates are given in device-independent pixels. + + + +`Relative` 0 + +Indicates that coordinates are values in the range [0,1], where 01 align the child element's left or right edge with the corresponding edge of the parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexWrap.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexWrap.md new file mode 100644 index 0000000000..e33656af80 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexWrap.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## FlexWrap Enum + +Enumerates values that control whether and how to wrap items in a FlexBox. + +```csharp +public enum FlexWrap +``` +### Fields + + + +`NoWrap` 0 + +Indicates that child elements will be packed into a single row or column. + + + +`Reverse` 2 + +Indicates that rows of child elements will be wrapped in the direction opposite to the natural wrap direction for the locale. + + + +`Wrap` 1 + +Indicates that rows of child elements will be wrapped in the natural wrap direction for the locale. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Grid.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Grid.md new file mode 100644 index 0000000000..3f0c281537 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Grid.md @@ -0,0 +1,210 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## Grid Class + +A layout that arranges views in rows and columns. + +```csharp +public class Grid : Tizen.UI.Layouts.Layout, +Tizen.UI.Layouts.IGridLayout, +Tizen.UI.Layouts.ILayout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 Grid + +Implements [IGridLayout](Tizen.UI.Layouts.IGridLayout.md 'Tizen.UI.Layouts.IGridLayout'), [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Properties + + + +## Grid.ColumnDefinitions Property + +Provides the interface for the bound property that gets or sets the collection of ColumnDefinitions objects that control the heights of each column. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Layouts.GridColumnDefinition> ColumnDefinitions { get; set; } +``` + +Implements [ColumnDefinitions](Tizen.UI.Layouts.IGridLayout.md#Tizen.UI.Layouts.IGridLayout.ColumnDefinitions 'Tizen.UI.Layouts.IGridLayout.ColumnDefinitions') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## Grid.ColumnSpacing Property + +Gets or sets the amount of space between columns in the Grid. + +```csharp +public float ColumnSpacing { get; set; } +``` + +Implements [ColumnSpacing](Tizen.UI.Layouts.IGridLayout.md#Tizen.UI.Layouts.IGridLayout.ColumnSpacing 'Tizen.UI.Layouts.IGridLayout.ColumnSpacing') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Grid.RowDefinitions Property + +Provides the interface for the bound property that gets or sets the collection of RowDefinition objects that control the heights of each row. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Layouts.GridRowDefinition> RowDefinitions { get; set; } +``` + +Implements [RowDefinitions](Tizen.UI.Layouts.IGridLayout.md#Tizen.UI.Layouts.IGridLayout.RowDefinitions 'Tizen.UI.Layouts.IGridLayout.RowDefinitions') + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## Grid.RowSpacing Property + +Gets or sets the amount of space between rows in the Grid. + +```csharp +public float RowSpacing { get; set; } +``` + +Implements [RowSpacing](Tizen.UI.Layouts.IGridLayout.md#Tizen.UI.Layouts.IGridLayout.RowSpacing 'Tizen.UI.Layouts.IGridLayout.RowSpacing') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Grid.Add(View, int, int) Method + +Adds a view to the grid at the specified row and column with a row span of 1 and a column span of 1. + +```csharp +public void Add(Tizen.UI.View view, int row, int col); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to add. + + + +`row` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row index where the view should be added. + + + +`col` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column index where the view should be added. + + + +## Grid.Add(View, int, int, int, int) Method + +Adds a view to the grid at the specified row and column position, with the specified row and column span. + +```csharp +public void Add(Tizen.UI.View view, int row, int rowSpan, int col, int colSpan); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to add to the grid. + + + +`row` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row index where the view should be added. + + + +`rowSpan` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of rows the view should span. + + + +`col` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column index where the view should be added. + + + +`colSpan` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of columns the view should span. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridColumnDefinition.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridColumnDefinition.md new file mode 100644 index 0000000000..61c55f1b6c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridColumnDefinition.md @@ -0,0 +1,128 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridColumnDefinition Class + +Represents a column definition Grid layout. + +```csharp +public class GridColumnDefinition +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GridColumnDefinition +### Properties + + + +## GridColumnDefinition.Width Property + +Gets or sets the width of the column. The default value is GridLength.Star. + +```csharp +public Tizen.UI.Layouts.GridLength Width { get; set; } +``` + +#### Property Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') +### Operators + + + +## GridColumnDefinition.implicit operator GridColumnDefinition(float) Operator + +Implicitly converts a float value to a GridColumnDefinition object. + +```csharp +public static Tizen.UI.Layouts.GridColumnDefinition implicit operator GridColumnDefinition(float width); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the column. + +#### Returns +[GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition') + + + +## GridColumnDefinition.implicit operator GridColumnDefinition(GridLength) Operator + +Implicitly converts a GridLength value to a GridColumnDefinition object. + +```csharp +public static Tizen.UI.Layouts.GridColumnDefinition implicit operator GridColumnDefinition(Tizen.UI.Layouts.GridLength width); +``` +#### Parameters + + + +`width` [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') + +The width of the column. + +#### Returns +[GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridExtensions.md new file mode 100644 index 0000000000..4cb7c9c0cb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridExtensions.md @@ -0,0 +1,486 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridExtensions Class + +Provides a series of extension methods that support configuring a [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid'). + +```csharp +public static class GridExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GridExtensions +### Methods + + + +## GridExtensions.Column<TView,TColumn>(this TView, TColumn) Method + +Sets the column index of the specified view using an enum value.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Column<TView,TColumn>(this TView view, TColumn column) + where TView : Tizen.UI.View + where TColumn : System.Enum; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TColumn` + +The type of the column enum. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn).TView') + +The view to set the column index for. + + + +`column` [TColumn](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn).TColumn 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn).TColumn') + +The column enum value to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn).TView') +The view with the specified column index. + + + +## GridExtensions.Column<TView,TColumn>(this TView, TColumn, TColumn) Method + +Sets the column index and column span of the specified view using enum values.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Column<TView,TColumn>(this TView view, TColumn column, TColumn last) + where TView : Tizen.UI.View + where TColumn : System.Enum; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TColumn` + +The type of the column enum. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn,TColumn).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn, TColumn).TView') + +The view to set the column index and column span for. + + + +`column` [TColumn](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn,TColumn).TColumn 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn, TColumn).TColumn') + +The column enum value to set. + + + +`last` [TColumn](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn,TColumn).TColumn 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn, TColumn).TColumn') + +The last column enum value. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView,TColumn_(thisTView,TColumn,TColumn).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView,TColumn>(this TView, TColumn, TColumn).TView') +The view with the specified column index and column span. + + + +## GridExtensions.Column<TView>(this TView, int) Method + +Sets the column index of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Column<TView>(this TView view, int column) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView>(this TView, int).TView') + +The view to set the column index for. + + + +`column` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column index to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView>(this TView, int).TView') +The view with the specified column index. + + + +## GridExtensions.Column<TView>(this TView, int, int) Method + +Sets the column index and column span of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Column<TView>(this TView view, int column, int span) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView_(thisTView,int,int).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView>(this TView, int, int).TView') + +The view to set the column index and column span for. + + + +`column` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column index to set. + + + +`span` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column span to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Column_TView_(thisTView,int,int).TView 'Tizen.UI.Layouts.GridExtensions.Column<TView>(this TView, int, int).TView') +The view with the specified column index and column span. + + + +## GridExtensions.ColumnSpan<TView>(this TView, int) Method + +Sets the column span of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView ColumnSpan<TView>(this TView view, int span) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.ColumnSpan_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.ColumnSpan<TView>(this TView, int).TView') + +The view to set the column span for. + + + +`span` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The column span to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.ColumnSpan_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.ColumnSpan<TView>(this TView, int).TView') +The view with the specified column span. + + + +## GridExtensions.Row<TView,TRow>(this TView, TRow) Method + +Sets the row index of the specified view using an enum value.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Row<TView,TRow>(this TView view, TRow row) + where TView : Tizen.UI.View + where TRow : System.Enum; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TRow` + +The type of the row enum. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow).TView') + +The view to set the row index for. + + + +`row` [TRow](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow).TRow 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow).TRow') + +The row enum value to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow).TView') +The view with the specified row index. + + + +## GridExtensions.Row<TView,TRow>(this TView, TRow, TRow) Method + +Sets the row index and row span of the specified view using enum values.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Row<TView,TRow>(this TView view, TRow row, TRow last) + where TView : Tizen.UI.View + where TRow : System.Enum; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TRow` + +The type of the row enum. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow,TRow).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow, TRow).TView') + +The view to set the row index and row span for. + + + +`row` [TRow](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow,TRow).TRow 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow, TRow).TRow') + +The row enum value to set. + + + +`last` [TRow](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow,TRow).TRow 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow, TRow).TRow') + +The last row enum value. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView,TRow_(thisTView,TRow,TRow).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView,TRow>(this TView, TRow, TRow).TView') +The view with the specified row index and row span. + + + +## GridExtensions.Row<TView>(this TView, int) Method + +Sets the row index of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Row<TView>(this TView view, int row) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView>(this TView, int).TView') + +The view to set the row index for. + + + +`row` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row index to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView>(this TView, int).TView') +The view with the specified row index. + + + +## GridExtensions.Row<TView>(this TView, int, int) Method + +Sets the row index and row span of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView Row<TView>(this TView view, int row, int span) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView_(thisTView,int,int).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView>(this TView, int, int).TView') + +The view to set the row index and row span for. + + + +`row` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row index to set. + + + +`span` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row span to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.Row_TView_(thisTView,int,int).TView 'Tizen.UI.Layouts.GridExtensions.Row<TView>(this TView, int, int).TView') +The view with the specified row index and row span. + + + +## GridExtensions.RowSpan<TView>(this TView, int) Method + +Sets the row span of the specified view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static TView RowSpan<TView>(this TView view, int span) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.RowSpan_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.RowSpan<TView>(this TView, int).TView') + +The view to set the row span for. + + + +`span` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The row span to set. + +#### Returns +[TView](Tizen.UI.Layouts.GridExtensions.md#Tizen.UI.Layouts.GridExtensions.RowSpan_TView_(thisTView,int).TView 'Tizen.UI.Layouts.GridExtensions.RowSpan<TView>(this TView, int).TView') +The view with the specified row span. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLayoutManager.md new file mode 100644 index 0000000000..00a2023c89 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLayoutManager.md @@ -0,0 +1,159 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridLayoutManager Class + +Provides a layout manager for a grid layout. + +```csharp +public class GridLayoutManager : Tizen.UI.Layouts.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 GridLayoutManager +### Constructors + + + +## GridLayoutManager(IGridLayout) Constructor + +Initializes a new instance of the [GridLayoutManager](Tizen.UI.Layouts.GridLayoutManager.md 'Tizen.UI.Layouts.GridLayoutManager') class. + +```csharp +public GridLayoutManager(Tizen.UI.Layouts.IGridLayout layout); +``` +#### Parameters + + + +`layout` [IGridLayout](Tizen.UI.Layouts.IGridLayout.md 'Tizen.UI.Layouts.IGridLayout') + +The grid layout. +### Properties + + + +## GridLayoutManager.Grid Property + +Gets the grid layout. + +```csharp +public Tizen.UI.Layouts.IGridLayout Grid { get; } +``` + +#### Property Value +[IGridLayout](Tizen.UI.Layouts.IGridLayout.md 'Tizen.UI.Layouts.IGridLayout') +### Methods + + + +## GridLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the grid layout. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds of the grid layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The actual size of the arranged grid layout. + + + +## GridLayoutManager.Measure(float, float) Method + +Measures the size of the grid layout. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width constraint. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height constraint. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the grid layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLength.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLength.md new file mode 100644 index 0000000000..12ae1fa707 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLength.md @@ -0,0 +1,246 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridLength Struct + +Used to define the size of Grid ColumnDefinition and RowDefinition. + +```csharp +public readonly struct GridLength +``` +### Constructors + + + +## GridLength(float) Constructor + +Initializes a new absolute GridLength. + +```csharp +public GridLength(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of the new grid length. + + + +## GridLength(float, GridUnitType) Constructor + +Initializes a new GridLength. + +```csharp +public GridLength(float value, Tizen.UI.Layouts.GridUnitType type); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The size of the GridLength. + + + +`type` [GridUnitType](Tizen.UI.Layouts.GridUnitType.md 'Tizen.UI.Layouts.GridUnitType') + +The GridUnitType (Auto, Star, Absolute) of the GridLength. + +#### Exceptions + +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +### Fields + + + +## GridLength.Auto Field + +A ready to reuse GridLength of GridUnitType.Auto. + +```csharp +public static readonly GridLength Auto; +``` + +#### Field Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') + + + +## GridLength.Star Field + +A ready to reuse GridLength of GridUnitType.Star with a Value of 1. + +```csharp +public static readonly GridLength Star; +``` + +#### Field Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') +### Properties + + + +## GridLength.IsAbsolute Property + +Gets whether or not the GridUnitType of the GridLength is GridUnitType.Absolute. + +```csharp +public bool IsAbsolute { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLength.IsAuto Property + +Gets whether or not the GridUnitType of the GridLength is GridUnitType.Auto. + +```csharp +public bool IsAuto { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLength.IsStar Property + +Gets a value that indicates whether the GridUnitType of the GridLength is GridUnitType.Star. + +```csharp +public bool IsStar { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## GridLength.Value Property + +Gets the Value of the GridLength. + +```csharp +public float Value { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## GridLength.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object? obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Equals(object).obj 'Tizen.UI.Layouts.GridLength.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## GridLength.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## GridLength.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridParam.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridParam.md new file mode 100644 index 0000000000..9023c86738 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridParam.md @@ -0,0 +1,126 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridParam Class + +Provides a set of properties for managing the layout of a view within a grid layout. + +```csharp +public class GridParam +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GridParam +### Properties + + + +## GridParam.Column Property + +Gets or sets the column index of the view in the grid layout. + +```csharp +public int Column { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GridParam.ColumnSpan Property + +Gets or sets the number of columns that the view should span across. + +```csharp +public int ColumnSpan { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GridParam.Row Property + +Gets or sets the row index of the view in the grid layout. + +```csharp +public int Row { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## GridParam.RowSpan Property + +Gets or sets the number of rows that the view should span across. + +```csharp +public int RowSpan { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Columns.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Columns.md new file mode 100644 index 0000000000..05da49d7bd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Columns.md @@ -0,0 +1,95 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts').[GridRowColumns](Tizen.UI.Layouts.GridRowColumns.md 'Tizen.UI.Layouts.GridRowColumns') + +## GridRowColumns.Columns Class + +Provides a set of methods for defining the columns of a Grid using C# Layouts. + +```csharp +public static class GridRowColumns.Columns +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Columns +### Methods + + + +## GridRowColumns.Columns.Define(GridLength[]) Method + +Defines a set of columns with the specified widths. + +```csharp +public static System.Collections.Generic.IList<Tizen.UI.Layouts.GridColumnDefinition> Define(params Tizen.UI.Layouts.GridLength[] widths); +``` +#### Parameters + + + +`widths` [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The widths of the columns. + +#### Returns +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') +A list of GridColumnDefinition objects. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Rows.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Rows.md new file mode 100644 index 0000000000..f0c120a116 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Rows.md @@ -0,0 +1,95 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts').[GridRowColumns](Tizen.UI.Layouts.GridRowColumns.md 'Tizen.UI.Layouts.GridRowColumns') + +## GridRowColumns.Rows Class + +Provides a set of methods for defining the rows of a Grid using C# Layouts. + +```csharp +public static class GridRowColumns.Rows +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Rows +### Methods + + + +## GridRowColumns.Rows.Define(GridLength[]) Method + +Defines a set of rows with the specified heights. + +```csharp +public static System.Collections.Generic.IList<Tizen.UI.Layouts.GridRowDefinition> Define(params Tizen.UI.Layouts.GridLength[] heights); +``` +#### Parameters + + + +`heights` [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +An array of [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') values that specify the heights of the rows. + +#### Returns +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') +A list of [GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition') objects that represent the rows. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.md new file mode 100644 index 0000000000..242abf7040 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.md @@ -0,0 +1,166 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridRowColumns Class + +Provides a series of extension methods that support configuring a [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid'). + +```csharp +public static class GridRowColumns +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GridRowColumns +### Properties + + + +## GridRowColumns.Auto Property + +Represents an automatic grid row or column size. + +```csharp +public static Tizen.UI.Layouts.GridLength Auto { get; } +``` + +#### Property Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') + + + +## GridRowColumns.Star Property + +Represents a star-sized grid row or column size. + +```csharp +public static Tizen.UI.Layouts.GridLength Star { get; } +``` + +#### Property Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') +### Methods + + + +## GridRowColumns.All<TEnum>() Method + +Returns the number of rows or columns that can be addressed using the specified enum type. + +```csharp +public static int All<TEnum>() + where TEnum : System.Enum; +``` +#### Type parameters + + + +`TEnum` + +The type of the enum. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The number of rows or columns that can be addressed using the specified enum type. + + + +## GridRowColumns.Last<TEnum>() Method + +Returns the last row or column index that can be addressed using the specified enum type. + +```csharp +public static int Last<TEnum>() + where TEnum : System.Enum; +``` +#### Type parameters + + + +`TEnum` + +The type of the enum. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The last row or column index that can be addressed using the specified enum type. + + + +## GridRowColumns.Stars(float) Method + +Creates a star-sized grid row or column size with the specified weight. + +```csharp +public static Tizen.UI.Layouts.GridLength Stars(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The weight of the star-sized grid row or column. + +#### Returns +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') +A star-sized grid row or column size with the specified weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowDefinition.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowDefinition.md new file mode 100644 index 0000000000..4ba40648be --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowDefinition.md @@ -0,0 +1,128 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridRowDefinition Class + +Represents a row definition in a grid layout. + +```csharp +public class GridRowDefinition +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 GridRowDefinition +### Properties + + + +## GridRowDefinition.Height Property + +Gets or sets the height of the row. + +```csharp +public Tizen.UI.Layouts.GridLength Height { get; set; } +``` + +#### Property Value +[GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') +### Operators + + + +## GridRowDefinition.implicit operator GridRowDefinition(float) Operator + +Implicitly converts a float to a [GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition'). + +```csharp +public static Tizen.UI.Layouts.GridRowDefinition implicit operator GridRowDefinition(float height); +``` +#### Parameters + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the row. + +#### Returns +[GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition') + + + +## GridRowDefinition.implicit operator GridRowDefinition(GridLength) Operator + +Implicitly converts a [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') to a [GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition'). + +```csharp +public static Tizen.UI.Layouts.GridRowDefinition implicit operator GridRowDefinition(Tizen.UI.Layouts.GridLength height); +``` +#### Parameters + + + +`height` [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') + +The height of the row. + +#### Returns +[GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridUnitType.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridUnitType.md new file mode 100644 index 0000000000..f8c391b235 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridUnitType.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## GridUnitType Enum + +Enumerates values that control how the [Value](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Value 'Tizen.UI.Layouts.GridLength.Value') property is interpreted for row and column definitions. + +```csharp +public enum GridUnitType +``` +### Fields + + + +`Absolute` 0 + +Interpret the [Value](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Value 'Tizen.UI.Layouts.GridLength.Value') property value as the number of device-specific units. + + + +`Auto` 2 + +Interpret the [Value](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Value 'Tizen.UI.Layouts.GridLength.Value') property value as a proportional weight, to be laid out after rows and columns with Absolute or Auto are accounted for. + + + +`Star` 1 + +Ignore the [Value](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Value 'Tizen.UI.Layouts.GridLength.Value') property value and choose a size that fits the children of the row or column. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStack.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStack.md new file mode 100644 index 0000000000..7a3d36685c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStack.md @@ -0,0 +1,74 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## HStack Class + +Represents a horizontal stack layout that arranges child elements in a single row. + +```csharp +public class HStack : Tizen.UI.Layouts.StackBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') 🡒 HStack + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStackLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStackLayoutManager.md new file mode 100644 index 0000000000..d495d93acf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStackLayoutManager.md @@ -0,0 +1,145 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## HStackLayoutManager Class + +HStackLayoutManager is a layout manager that arranges its children horizontally within a given space. + +```csharp +public class HStackLayoutManager : Tizen.UI.Layouts.StackLayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 [StackLayoutManager](Tizen.UI.Layouts.StackLayoutManager.md 'Tizen.UI.Layouts.StackLayoutManager') 🡒 HStackLayoutManager +### Constructors + + + +## HStackLayoutManager(IStackLayout) Constructor + +Initializes a new instance of the HStackLayoutManager class. + +```csharp +public HStackLayoutManager(Tizen.UI.Layouts.IStackLayout layout); +``` +#### Parameters + + + +`layout` [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') + +The layout that uses this layout manager. +### Methods + + + +## HStackLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## HStackLayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IFlexBox.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IFlexBox.md new file mode 100644 index 0000000000..e1e780abef --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IFlexBox.md @@ -0,0 +1,102 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## IFlexBox Interface + +Defines the contract for a FlexBox layout, extending ILayout with FlexBox-specific layout operations. + +```csharp +public interface IFlexBox : +Tizen.UI.Layouts.ILayout +``` + +Derived +↳ [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') + +Implements [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Methods + + + +## IFlexBox.Layout(float, float) Method + +Performs the layout calculation for the FlexBox and its children. +This method is used by the FlexLayoutManager to arrange and measure the FlexBox. + +```csharp +void Layout(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IGridLayout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IGridLayout.md new file mode 100644 index 0000000000..0d4591bcab --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IGridLayout.md @@ -0,0 +1,130 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## IGridLayout Interface + +Defines the contract for a grid-based layout. + +```csharp +public interface IGridLayout : +Tizen.UI.Layouts.ILayout +``` + +Derived +↳ [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') + +Implements [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Properties + + + +## IGridLayout.ColumnDefinitions Property + +Gets the collection of ColumnDefinitions objects that control the widths of each column. + +```csharp +System.Collections.Generic.IList<Tizen.UI.Layouts.GridColumnDefinition> ColumnDefinitions { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## IGridLayout.ColumnSpacing Property + +Gets or sets the amount of space between columns in the Grid. + +```csharp +float ColumnSpacing { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IGridLayout.RowDefinitions Property + +Gets the collection of RowDefinition objects that control the heights of each row. + +```csharp +System.Collections.Generic.IList<Tizen.UI.Layouts.GridRowDefinition> RowDefinitions { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## IGridLayout.RowSpacing Property + +Gets or sets the amount of space between rows in the Grid. + +```csharp +float RowSpacing { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayout.md new file mode 100644 index 0000000000..99682f682c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayout.md @@ -0,0 +1,160 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ILayout Interface + +Defines the contract for a class that can provide layout functionality for its children using a LayoutManager. + +```csharp +public interface ILayout +``` + +Derived +↳ [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') +↳ [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') +↳ [IFlexBox](Tizen.UI.Layouts.IFlexBox.md 'Tizen.UI.Layouts.IFlexBox') +↳ [IGridLayout](Tizen.UI.Layouts.IGridLayout.md 'Tizen.UI.Layouts.IGridLayout') +↳ [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') +↳ [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') +↳ [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') +### Properties + + + +## ILayout.Children Property + +Gets the children of the layout. + +```csharp +System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')Tizen.UI.View[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ILayout.DesiredHeight Property + +Gets the desired height of the layout. + +```csharp +float DesiredHeight { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ILayout.DesiredWidth Property + +Gets the desired width of the layout. + +```csharp +float DesiredWidth { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ILayout.LayoutDirection Property + +Gets the layout direction of the layout. + +```csharp +Tizen.UI.LayoutDirection LayoutDirection { get; } +``` + +#### Property Value +Tizen.UI.LayoutDirection + + + +## ILayout.LayoutParam Property + +Gets the attached LayoutParam for the layout. + +```csharp +Tizen.UI.Layouts.LayoutParam LayoutParam { get; } +``` + +#### Property Value +[LayoutParam](Tizen.UI.Layouts.LayoutParam.md 'Tizen.UI.Layouts.LayoutParam') + + + +## ILayout.Padding Property + +Gets the padding of the layout. + +```csharp +Tizen.UI.Thickness Padding { get; } +``` + +#### Property Value +Tizen.UI.Thickness + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayoutManager.md new file mode 100644 index 0000000000..e68a3bedc1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayoutManager.md @@ -0,0 +1,125 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ILayoutManager Interface + +Defines the interface for a layout manager, which is responsible for measuring and arranging the children of a layout. + +```csharp +public interface ILayoutManager +``` + +Derived +↳ [FlexLayoutManager](Tizen.UI.Layouts.FlexLayoutManager.md 'Tizen.UI.Layouts.FlexLayoutManager') +↳ [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') +### Methods + + + +## ILayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## ILayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IStackLayout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IStackLayout.md new file mode 100644 index 0000000000..042425ad40 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IStackLayout.md @@ -0,0 +1,104 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## IStackLayout Interface + +Defines the contract for a stack-based layout. + +```csharp +public interface IStackLayout : +Tizen.UI.Layouts.ILayout +``` + +Derived +↳ [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') + +Implements [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Properties + + + +## IStackLayout.ItemAlignment Property + +Gets or sets the alignment of the child elements within the stack. + +```csharp +Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; } +``` + +#### Property Value +[LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + + + +## IStackLayout.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +float Spacing { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Layout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Layout.md new file mode 100644 index 0000000000..2c80155041 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Layout.md @@ -0,0 +1,196 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## Layout Class + +Layout is an abstract class that defines the base functionality for all layout classes. It provides a mechanism for arranging and positioning child views within its bounds. + +```csharp +public abstract class Layout : Tizen.UI.ViewGroup, +Tizen.UI.Layouts.ILayout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Layout + +Derived +↳ [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout') +↳ [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') +↳ [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') +↳ [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') +↳ [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') + +Implements [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Constructors + + + +## Layout() Constructor + +Initializes a new instance of the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') class. + +```csharp +public Layout(); +``` +### Properties + + + +## Layout.IsManualLayout Property + +Gets or sets a value indicating whether the layout is manual layout or not. + +```csharp +public static bool IsManualLayout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Layout.IsOnPseudoLayout Property + +Gets or sets a value indicating whether the layout is on pseudo layout. + +```csharp +public bool IsOnPseudoLayout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Layout.Padding Property + +Gets or sets the padding of the layout. + +```csharp +public Tizen.UI.Thickness Padding { get; set; } +``` + +Implements [Padding](Tizen.UI.Layouts.ILayout.md#Tizen.UI.Layouts.ILayout.Padding 'Tizen.UI.Layouts.ILayout.Padding') + +#### Property Value +Tizen.UI.Thickness +### Methods + + + +## Layout.Measure(float, float) Method + +Measures the layout with the specified available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width to measure the layout with. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height to measure the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after measuring. + + + +## Layout.UpdateLayout() Method + +Updates the layout. + +```csharp +public void UpdateLayout(); +``` + + + +## Layout.UpdateLayout(Rect) Method + +Updates the layout with the specified bounds. + +```csharp +public virtual Tizen.UI.Size UpdateLayout(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds to update the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after updating. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutAlignment.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutAlignment.md new file mode 100644 index 0000000000..37d536eef4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutAlignment.md @@ -0,0 +1,97 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## LayoutAlignment Enum + +Enumeration that represent LayoutAlignment. + +```csharp +public enum LayoutAlignment +``` +### Fields + + + +`Center` 2 + +The center of an alignment. + + + +`End` 3 + +Align with the trailing edge of the available space, as determined by Tizen.UI.View.LayoutDirection. + + + +`Fill` 0 + +Fill the entire area if possible. + + + +`Start` 1 + +Align with the leading edge of the available space, as determined by Tizen.UI.View.LayoutDirection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutExtensions.md new file mode 100644 index 0000000000..beb14c0e90 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutExtensions.md @@ -0,0 +1,1138 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## LayoutExtensions Class + +Provides a series of extension methods that support positioning Tizen.UI.Views in [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout')s. + +```csharp +public static class LayoutExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LayoutExtensions +### Methods + + + +## LayoutExtensions.Arrange(this View, Rect, bool) Method + +Arranges the view within the specified rectangle.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static void Arrange(this Tizen.UI.View view, Tizen.UI.Rect rect, bool ignoreRTL=false); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to arrange. + + + +`rect` Tizen.UI.Rect + +The rectangle within which to arrange the view. + + + +`ignoreRTL` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A flag indicating whether to ignore right-to-left layout direction. + + + +## LayoutExtensions.Center<TView>(this TView) Method + +Sets the horizontal and vertical layout alignment of the view to [Center](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Center 'Tizen.UI.Layouts.LayoutAlignment.Center').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Center<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Center_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Center<TView>(this TView).TView') + +The view to set the layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Center_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Center<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.CenterHorizontal<TView>(this TView) Method + +Sets the horizontal layout alignment of the view to [Center](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Center 'Tizen.UI.Layouts.LayoutAlignment.Center').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView CenterHorizontal<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.CenterHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.CenterHorizontal<TView>(this TView).TView') + +The view to set the horizontal layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.CenterHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.CenterHorizontal<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.CenterVertical<TView>(this TView) Method + +Sets the vertical layout alignment of the view to [Center](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Center 'Tizen.UI.Layouts.LayoutAlignment.Center').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView CenterVertical<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.CenterVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.CenterVertical<TView>(this TView).TView') + +The view to set the vertical layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.CenterVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.CenterVertical<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.ComputeDesiredSize(this View, float, float) Method + +Computes the desired size of the specified view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static Tizen.UI.Size ComputeDesiredSize(this Tizen.UI.View view, float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view whose desired size should be computed. + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width constraint. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height constraint. + +#### Returns +Tizen.UI.Size +The desired size of the view. + + + +## LayoutExtensions.End<TView>(this TView) Method + +Sets the horizontal and vertical layout alignment of the view to [End](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.End 'Tizen.UI.Layouts.LayoutAlignment.End').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView End<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.End_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.End<TView>(this TView).TView') + +The view to set the layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.End_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.End<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.EndHorizontal<TView>(this TView) Method + +Sets the horizontal layout alignment of the view to [End](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.End 'Tizen.UI.Layouts.LayoutAlignment.End').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView EndHorizontal<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.EndHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.EndHorizontal<TView>(this TView).TView') + +The view to set the horizontal layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.EndHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.EndHorizontal<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.EndVertical<TView>(this TView) Method + +Sets the vertical layout alignment of the view to [End](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.End 'Tizen.UI.Layouts.LayoutAlignment.End').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView EndVertical<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.EndVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.EndVertical<TView>(this TView).TView') + +The view to set the vertical layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.EndVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.EndVertical<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.Expand<TView>(this TView) Method + +Expands the given view to fill its parent layout.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Expand<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Expand_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Expand<TView>(this TView).TView') + +The view to expand. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Expand_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Expand<TView>(this TView).TView') +The same view instance with updated expand property. + + + +## LayoutExtensions.Expand<TView>(this TView, float) Method + +Sets the expand property of the given view, which determines how much space the view should occupy within HStack/VStack.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Expand<TView>(this TView view, float weight) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Expand_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Expand<TView>(this TView, float).TView') + +The view to set the expand property on. + + + +`weight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The weight value indicating the proportion of space the view should take up relative to other views in the layout. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Expand_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Expand<TView>(this TView, float).TView') +The same view instance with updated expand property. + + + +## LayoutExtensions.Fill<TView>(this TView) Method + +Sets the horizontal and vertical layout alignment of the specified Tizen.UI.View instance to [Fill](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Fill 'Tizen.UI.Layouts.LayoutAlignment.Fill').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Fill<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Fill_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Fill<TView>(this TView).TView') + +The view to set the layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Fill_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Fill<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.FillHorizontal<TView>(this TView) Method + +Sets the horizontal layout alignment of the specified Tizen.UI.View instance to [Fill](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Fill 'Tizen.UI.Layouts.LayoutAlignment.Fill').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView FillHorizontal<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.FillHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.FillHorizontal<TView>(this TView).TView') + +The view to set the horizontal layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.FillHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.FillHorizontal<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.FillVertical<TView>(this TView) Method + +Sets the vertical layout alignment of the specified Tizen.UI.View instance to [Fill](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Fill 'Tizen.UI.Layouts.LayoutAlignment.Fill').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView FillVertical<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.FillVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.FillVertical<TView>(this TView).TView') + +The view to set the vertical layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.FillVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.FillVertical<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.HorizontalLayoutAlignment<TView>(this TView, LayoutAlignment) Method + +Sets the horizontal layout alignment of the view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView HorizontalLayoutAlignment<TView>(this TView view, Tizen.UI.Layouts.LayoutAlignment alignment) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.HorizontalLayoutAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.HorizontalLayoutAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') + +The view to set the horizontal layout alignment for. + + + +`alignment` [LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + +The horizontal layout alignment to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.HorizontalLayoutAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.HorizontalLayoutAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') +The view itself. + + + +## LayoutExtensions.ItemAlignment<TView>(this TView, LayoutAlignment) Method + +Sets the item alignment of the stack base layout.
+This only works if the Tizen.UI.View is included in the [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') and used. + +```csharp +public static TView ItemAlignment<TView>(this TView view, Tizen.UI.Layouts.LayoutAlignment alignment) + where TView : Tizen.UI.Layouts.StackBase; +``` +#### Type parameters + + + +`TView` + +The type of the stack base. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.ItemAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.ItemAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') + +The view to set the item alignment for. + + + +`alignment` [LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + +The item alignment to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.ItemAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.ItemAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') +The stack base itself. + + + +## LayoutExtensions.Margin<TView>(this TView, float) Method + +Sets the margin of the specified Tizen.UI.View in the layout.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Margin<TView>(this TView view, float uniformSize) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float).TView') + +The view to set the margin for. + + + +`uniformSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform margin size to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float).TView') +The view itself. + + + +## LayoutExtensions.Margin<TView>(this TView, float, float) Method + +Sets the margin of the specified Tizen.UI.View in the layout.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Margin<TView>(this TView view, float horizontalSize, float verticalSize) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float, float).TView') + +The view to set the margin for. + + + +`horizontalSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal margin size to set. + + + +`verticalSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical margin size to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float, float).TView') +The view itself. + + + +## LayoutExtensions.Margin<TView>(this TView, float, float, float, float) Method + +Sets the margin of the specified [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') instance.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Margin<TView>(this TView view, float left, float top, float right, float bottom) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the layout. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float, float, float, float).TView') + +The layout to set the margin for. + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The left margin to set. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top margin to set. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The right margin to set. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom margin to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, float, float, float, float).TView') +The layout itself. + + + +## LayoutExtensions.Margin<TView>(this TView, Thickness) Method + +Sets the margin of the specified Tizen.UI.View in the layout.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Margin<TView>(this TView view, Tizen.UI.Thickness margin) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, Tizen.UI.Thickness).TView') + +The view to set the margin for. + + + +`margin` Tizen.UI.Thickness + +The margin to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Margin_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.Layouts.LayoutExtensions.Margin<TView>(this TView, Tizen.UI.Thickness).TView') +The view itself. + + + +## LayoutExtensions.MaximumHeight<TView>(this TView, float) Method + +Sets the maximum height of the view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView MaximumHeight<TView>(this TView view, float max) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MaximumHeight_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MaximumHeight<TView>(this TView, float).TView') + +The view to set the maximum height for. + + + +`max` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The maximum height to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MaximumHeight_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MaximumHeight<TView>(this TView, float).TView') +The view itself. + + + +## LayoutExtensions.MinimumHeight<TView>(this TView, float) Method + +Sets the minimum height of the view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView MinimumHeight<TView>(this TView view, float min) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MinimumHeight_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MinimumHeight<TView>(this TView, float).TView') + +The view to set the minimum height for. + + + +`min` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The minimum height to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MinimumHeight_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MinimumHeight<TView>(this TView, float).TView') +The view itself. + + + +## LayoutExtensions.MinimumWidth<TView>(this TView, float) Method + +Sets the minimum width of the view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView MinimumWidth<TView>(this TView view, float min) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MinimumWidth_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MinimumWidth<TView>(this TView, float).TView') + +The view to set the minimum width for. + + + +`min` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The minimum width to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.MinimumWidth_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.MinimumWidth<TView>(this TView, float).TView') +The view itself. + + + +## LayoutExtensions.Padding<TView>(this TView, float, float, float, float) Method + +Sets the padding of the specified [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') instance. + +```csharp +public static TView Padding<TView>(this TView view, float left, float top, float right, float bottom) + where TView : Tizen.UI.Layouts.Layout; +``` +#### Type parameters + + + +`TView` + +The type of the layout. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Padding_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Padding<TView>(this TView, float, float, float, float).TView') + +The layout to set the padding for. + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The left padding to set. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top padding to set. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The right padding to set. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom padding to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Padding_TView_(thisTView,float,float,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Padding<TView>(this TView, float, float, float, float).TView') +The layout itself. + + + +## LayoutExtensions.Padding<TView>(this TView, Thickness) Method + +Sets the padding of the specified [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') instance. + +```csharp +public static TView Padding<TView>(this TView view, Tizen.UI.Thickness padding) + where TView : Tizen.UI.Layouts.Layout; +``` +#### Type parameters + + + +`TView` + +The type of the layout. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Padding_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.Layouts.LayoutExtensions.Padding<TView>(this TView, Tizen.UI.Thickness).TView') + +The layout to set the padding for. + + + +`padding` Tizen.UI.Thickness + +The padding to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Padding_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.Layouts.LayoutExtensions.Padding<TView>(this TView, Tizen.UI.Thickness).TView') +The layout itself. + + + +## LayoutExtensions.Start<TView>(this TView) Method + +Sets the horizontal and vertical layout alignment of the specified Tizen.UI.View instance to [Start](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Start 'Tizen.UI.Layouts.LayoutAlignment.Start').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView Start<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Start_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Start<TView>(this TView).TView') + +The view to set the layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Start_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.Start<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.StartHorizontal<TView>(this TView) Method + +Sets the horizontal layout alignment of the specified Tizen.UI.View instance to [Start](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Start 'Tizen.UI.Layouts.LayoutAlignment.Start').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView StartHorizontal<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.StartHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.StartHorizontal<TView>(this TView).TView') + +The view to set the horizontal layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.StartHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.StartHorizontal<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.StartVertical<TView>(this TView) Method + +Sets the vertical layout alignment of the specified Tizen.UI.View instance to [Start](Tizen.UI.Layouts.LayoutAlignment.md#Tizen.UI.Layouts.LayoutAlignment.Start 'Tizen.UI.Layouts.LayoutAlignment.Start').
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView StartVertical<TView>(this TView view) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.StartVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.StartVertical<TView>(this TView).TView') + +The view to set the vertical layout alignment for. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.StartVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.LayoutExtensions.StartVertical<TView>(this TView).TView') +The view itself. + + + +## LayoutExtensions.Translate<TView>(this TView, float, float) Method + +Translates the position of the specified view by the given x and y offsets. +This extension method applies a translation transformation to the view's layout. + +```csharp +public static TView Translate<TView>(this TView view, float x, float y) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Translate_TView_(thisTView,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Translate<TView>(this TView, float, float).TView') + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.Translate_TView_(thisTView,float,float).TView 'Tizen.UI.Layouts.LayoutExtensions.Translate<TView>(this TView, float, float).TView') + + + +## LayoutExtensions.TranslateX<TView>(this TView, float) Method + +Sets the horizontal translation value applied to the view, which affects its layout position. + +```csharp +public static TView TranslateX<TView>(this TView view, float x) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.TranslateX_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.TranslateX<TView>(this TView, float).TView') + +The target view to apply the horizontal translation to. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X-coordinate value by which to translate the view. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.TranslateX_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.TranslateX<TView>(this TView, float).TView') + + + +## LayoutExtensions.TranslateY<TView>(this TView, float) Method + +Sets the vertical translation value applied to the view, which affects its layout position. + +```csharp +public static TView TranslateY<TView>(this TView view, float y) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.TranslateY_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.TranslateY<TView>(this TView, float).TView') + +The target view to apply the vertically translation to. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y-coordinate value by which to translate the view. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.TranslateY_TView_(thisTView,float).TView 'Tizen.UI.Layouts.LayoutExtensions.TranslateY<TView>(this TView, float).TView') + + + +## LayoutExtensions.VerticalLayoutAlignment<TView>(this TView, LayoutAlignment) Method + +Sets the vertical layout alignment of the view.
+This only works if the Tizen.UI.View is included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static TView VerticalLayoutAlignment<TView>(this TView view, Tizen.UI.Layouts.LayoutAlignment alignment) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.VerticalLayoutAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.VerticalLayoutAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') + +The view to set the vertical layout alignment for. + + + +`alignment` [LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + +The vertical layout alignment to set. + +#### Returns +[TView](Tizen.UI.Layouts.LayoutExtensions.md#Tizen.UI.Layouts.LayoutExtensions.VerticalLayoutAlignment_TView_(thisTView,Tizen.UI.Layouts.LayoutAlignment).TView 'Tizen.UI.Layouts.LayoutExtensions.VerticalLayoutAlignment<TView>(this TView, Tizen.UI.Layouts.LayoutAlignment).TView') +The view itself. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutHelper.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutHelper.md new file mode 100644 index 0000000000..758f86f865 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutHelper.md @@ -0,0 +1,248 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## LayoutHelper Class + +Provides common layout logic for ViewGroup instances. +This class uses composition to provide layout functionality, simplifying the implementation of custom layouts. + +```csharp +public class LayoutHelper : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LayoutHelper + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## LayoutHelper(ViewGroup, ILayoutManager) Constructor + +Initializes a new instance of the [LayoutHelper](Tizen.UI.Layouts.LayoutHelper.md 'Tizen.UI.Layouts.LayoutHelper') class. + +```csharp +public LayoutHelper(Tizen.UI.ViewGroup viewGroup, Tizen.UI.Layouts.ILayoutManager layoutManager); +``` +#### Parameters + + + +`viewGroup` Tizen.UI.ViewGroup + +The ViewGroup instance this helper will provide functionality for. + + + +`layoutManager` [ILayoutManager](Tizen.UI.Layouts.ILayoutManager.md 'Tizen.UI.Layouts.ILayoutManager') + +The layout manager instance to use for layout operations. +### Properties + + + +## LayoutHelper.Measured Property + +Gets or sets a value indicating whether the layout has been measured. + +```csharp +public bool Measured { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## LayoutHelper.Dispose() Method + +Disposes the object and releases all resources associated with it. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## LayoutHelper.Measure(float, float) Method + +Measures the layout with the specified available width and height. + +```csharp +public Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width to measure the layout with. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height to measure the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after measuring. + + + +## LayoutHelper.OnChildAdded(View) Method + +Called when a child is added to the layout. The implementer should call this from their OnChildAdded method. + +```csharp +public void OnChildAdded(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view that was added to the layout. + + + +## LayoutHelper.OnChildMeasureInvalidatedOverride(View) Method + +Called when the child measure is invalidated. The implementer should call this from their OnChildMeasureInvalidatedOverride method. + +```csharp +public void OnChildMeasureInvalidatedOverride(Tizen.UI.View child); +``` +#### Parameters + + + +`child` Tizen.UI.View + +The child that was invalidated. + + + +## LayoutHelper.OnChildRemoved(View) Method + +Called when a child is removed from the layout. The implementer should call this from their OnChildRemoved method. + +```csharp +public void OnChildRemoved(Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view that was removed from the layout. + + + +## LayoutHelper.OnMeasureInvalidated() Method + +Called when the measure of the layout is invalidated. The implementer should call this from their OnMeasureInvalidatedOverride method. + +```csharp +public void OnMeasureInvalidated(); +``` + + + +## LayoutHelper.UpdateLayout() Method + +Updates the layout. + +```csharp +public void UpdateLayout(); +``` + + + +## LayoutHelper.UpdateLayout(Rect) Method + +Updates the layout with the specified bounds. + +```csharp +public Tizen.UI.Size UpdateLayout(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds to update the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after updating. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutManager.md new file mode 100644 index 0000000000..0ca6653b4d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutManager.md @@ -0,0 +1,213 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## LayoutManager Class + +Represents a base class for layout managers. + +```csharp +public abstract class LayoutManager : +Tizen.UI.Layouts.ILayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LayoutManager + +Derived +↳ [AbsoluteLayoutManager](Tizen.UI.Layouts.AbsoluteLayoutManager.md 'Tizen.UI.Layouts.AbsoluteLayoutManager') +↳ [GridLayoutManager](Tizen.UI.Layouts.GridLayoutManager.md 'Tizen.UI.Layouts.GridLayoutManager') +↳ [ScrollLayoutManager](Tizen.UI.Layouts.ScrollLayoutManager.md 'Tizen.UI.Layouts.ScrollLayoutManager') +↳ [StackLayoutManager](Tizen.UI.Layouts.StackLayoutManager.md 'Tizen.UI.Layouts.StackLayoutManager') + +Implements [ILayoutManager](Tizen.UI.Layouts.ILayoutManager.md 'Tizen.UI.Layouts.ILayoutManager') +### Constructors + + + +## LayoutManager(ILayout) Constructor + +Initializes a new instance of the [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') class. + +```csharp +public LayoutManager(Tizen.UI.Layouts.ILayout layout); +``` +#### Parameters + + + +`layout` [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') + +The layout that owns the layout manager. +### Properties + + + +## LayoutManager.Layout Property + +Gets the layout that owns the layout manager. + +```csharp +public Tizen.UI.Layouts.ILayout Layout { get; } +``` + +#### Property Value +[ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Methods + + + +## LayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +public abstract Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## LayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +public abstract Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + +## LayoutManager.ResolveConstraints(float, float, float, float, float) Method + +Resolves the constraints for the layout. + +```csharp +public static float ResolveConstraints(float externalConstraint, float explicitLength, float measuredLength, float min=0f, float max=float.PositiveInfinity); +``` +#### Parameters + + + +`externalConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The external constraint for the layout. + + + +`explicitLength` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The explicit length for the layout. + + + +`measuredLength` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The measured length for the layout. + + + +`min` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The minimum length for the layout. + + + +`max` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The maximum length for the layout. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The resolved constraint for the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutParam.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutParam.md new file mode 100644 index 0000000000..5b00e779ce --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutParam.md @@ -0,0 +1,221 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## LayoutParam Class + +Provides layout parameters for the view. + +```csharp +public class LayoutParam +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LayoutParam +### Properties + + + +## LayoutParam.Expand Property + +Represents the expand property of LayoutParam, which defines how much the view should expand relative to other layouts on HStack or VStack. + +```csharp +public float Expand { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The expansion is determined by the proportion of the set expand value to the total expand value of the siblings + + + +## LayoutParam.HorizontalLayoutAlignment Property + +Gets or sets the horizontal layout alignment of the view. + +```csharp +public Tizen.UI.Layouts.LayoutAlignment HorizontalLayoutAlignment { get; set; } +``` + +#### Property Value +[LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + + + +## LayoutParam.Margin Property + +Gets or sets the margin of the view. + +```csharp +public Tizen.UI.Thickness Margin { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## LayoutParam.MaximumHeight Property + +Gets or sets the maximum height of the view. + +```csharp +public float MaximumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.MaximumWidth Property + +Gets or sets the maximum width of the view. + +```csharp +public float MaximumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.MeasuredSize Property + +Gets or sets the measured size of the view. + +```csharp +public Tizen.UI.Size MeasuredSize { get; set; } +``` + +#### Property Value +Tizen.UI.Size + + + +## LayoutParam.MinimumHeight Property + +Gets or sets the minimum height of the view. + +```csharp +public float MinimumHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.MinimumWidth Property + +Gets or sets the minimum width of the view. + +```csharp +public float MinimumWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.TranslateX Property + +Gets or sets the horizontal translation value applied to the view, which affects its layout position. + +```csharp +public float TranslateX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.TranslateY Property + +Gets or sets the vertical translation value applied to the view, which affects its layout position. + +```csharp +public float TranslateY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LayoutParam.VerticalLayoutAlignment Property + +Gets or sets the vertical layout alignment of the view. + +```csharp +public Tizen.UI.Layouts.LayoutAlignment VerticalLayoutAlignment { get; set; } +``` + +#### Property Value +[LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayout.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayout.md new file mode 100644 index 0000000000..2b3dee6c46 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayout.md @@ -0,0 +1,424 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ScrollLayout Class + +A scrollable view that can be scrolled. + +```csharp +public class ScrollLayout : Tizen.UI.Layouts.Layout, +Tizen.UI.IDescendantFocusObserver, +Tizen.UI.IScrollable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 ScrollLayout + +Implements Tizen.UI.IDescendantFocusObserver, Tizen.UI.IScrollable +### Constructors + + + +## ScrollLayout() Constructor + +Initializes a new instance of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') class. + +```csharp +public ScrollLayout(); +``` +### Properties + + + +## ScrollLayout.Content Property + +Gets or sets the content of the scroll view. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + +## ScrollLayout.HorizontalScrollBarVisibility Property + +Gets or sets the visibility of the horizontal scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility HorizontalScrollBarVisibility { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollBarVisibility + + + +## ScrollLayout.IsScrolling Property + +Gets a value indicating whether the scroll is currently in progress. + +```csharp +public bool IsScrolling { get; set; } +``` + +Implements IsScrolling + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ScrollLayout.ScrollBar Property + +Gets or sets the scroll bar. + +```csharp +public Tizen.UI.IScrollBar ScrollBar { get; set; } +``` + +#### Property Value +Tizen.UI.IScrollBar + + + +## ScrollLayout.ScrollDirection Property + +Gets or sets the direction of the scroll. + +```csharp +public Tizen.UI.ScrollDirection ScrollDirection { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollDirection + + + +## ScrollLayout.ScrollingDestinationHandler Property + +The ScrollingDestinationHandler property sets or gets a function that handles the scrolling destination calculation. + +```csharp +public System.Func<Tizen.UI.Point,Tizen.UI.Point> ScrollingDestinationHandler { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')Tizen.UI.Point[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## ScrollLayout.ScrollPosition Property + +Gets the current scroll position. + +```csharp +public Tizen.UI.Point ScrollPosition { get; } +``` + +#### Property Value +Tizen.UI.Point + + + +## ScrollLayout.ScrollSize Property + +Gets or sets the size of the scrollable content. + +```csharp +public Tizen.UI.Size ScrollSize { get; set; } +``` + +#### Property Value +Tizen.UI.Size + + + +## ScrollLayout.VerticalScrollBarVisibility Property + +Gets or sets the visibility of the vertical scroll bar. + +```csharp +public Tizen.UI.ScrollBarVisibility VerticalScrollBarVisibility { get; set; } +``` + +#### Property Value +Tizen.UI.ScrollBarVisibility + + + +## ScrollLayout.ViewPort Property + +Gets the scroll bounds of the ScrollView content. + +```csharp +public Tizen.UI.Rect ViewPort { get; } +``` + +Implements ViewPort + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## ScrollLayout.ScrollTo(float, bool) Method + +Scrolls the content to the specified position. + +```csharp +public System.Threading.Tasks.Task ScrollTo(float position, bool animation); +``` +#### Parameters + + + +`position` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The position to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## ScrollLayout.ScrollTo(Point, bool) Method + +Scrolls the content to the specified position. + +```csharp +public System.Threading.Tasks.Task ScrollTo(Tizen.UI.Point position, bool animation); +``` +#### Parameters + + + +`position` Tizen.UI.Point + +The position to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## ScrollLayout.ScrollTo(View, bool, ScrollToPosition) Method + +Scrolls the content to the specified child view. + +```csharp +public System.Threading.Tasks.Task ScrollTo(Tizen.UI.View child, bool animation, Tizen.UI.ScrollToPosition scrollToPosition); +``` +#### Parameters + + + +`child` Tizen.UI.View + +The child view to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + + + +`scrollToPosition` Tizen.UI.ScrollToPosition + +The position to which the child view will be scrolled. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. + + + +## ScrollLayout.UpdateLayout(Rect) Method + +Updates the layout with the specified bounds. + +```csharp +public override Tizen.UI.Size UpdateLayout(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The bounds to update the layout with. + +#### Returns +Tizen.UI.Size +The size of the layout after updating. +### Events + + + +## ScrollLayout.DragFinished Event + +Event handler for when the dragging of the ScrollView ends. + +```csharp +public event EventHandler<DragEventArgs> DragFinished; +``` + +Implements DragFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## ScrollLayout.Dragging Event + +Event handler for the Dragging event. + +```csharp +public event EventHandler<DragEventArgs> Dragging; +``` + +Implements Dragging + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## ScrollLayout.DragStarted Event + +Event handler for the ScrollView drag started event. + +```csharp +public event EventHandler<DragEventArgs> DragStarted; +``` + +Implements DragStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.DragEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## ScrollLayout.ScrollFinished Event + +Occurs when the scroll finishes. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollFinished; +``` + +Implements ScrollFinished + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## ScrollLayout.Scrolling Event + +Occurs while scrolling. + +```csharp +public event EventHandler<ScrollEventArgs> Scrolling; +``` + +Implements Scrolling + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## ScrollLayout.ScrollStarted Event + +Occurs when the scroll starts. + +```csharp +public event EventHandler<ScrollEventArgs> ScrollStarted; +``` + +Implements ScrollStarted + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.ScrollEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayoutManager.md new file mode 100644 index 0000000000..644266536b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayoutManager.md @@ -0,0 +1,159 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ScrollLayoutManager Class + +Provides functionality for arranging and measuring the children of a ScrollView. + +```csharp +public class ScrollLayoutManager : Tizen.UI.Layouts.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 ScrollLayoutManager +### Constructors + + + +## ScrollLayoutManager(ScrollLayout) Constructor + +Initializes a new instance of the ScrollViewLayoutManager class. + +```csharp +public ScrollLayoutManager(Tizen.UI.Layouts.ScrollLayout view); +``` +#### Parameters + + + +`view` [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') + +The ScrollView that owns the layout manager. +### Properties + + + +## ScrollLayoutManager.ScrollView Property + +Gets the ScrollView that owns the layout manager. + +```csharp +public Tizen.UI.Layouts.ScrollLayout ScrollView { get; } +``` + +#### Property Value +[ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') +### Methods + + + +## ScrollLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## ScrollLayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollViewExtensions.md new file mode 100644 index 0000000000..81aea98868 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollViewExtensions.md @@ -0,0 +1,524 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ScrollViewExtensions Class + +Provides a series of extension methods that support configuring [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout'). + +```csharp +public static class ScrollViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ScrollViewExtensions +### Methods + + + +## ScrollViewExtensions.HorizontalScrollBarVisibility<TView>(this TView, ScrollBarVisibility) Method + +Sets the horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to the specified value. + +```csharp +public static TView HorizontalScrollBarVisibility<TView>(this TView view, Tizen.UI.ScrollBarVisibility scrollBarVisibility) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.HorizontalScrollBarVisibility_TView_(thisTView,Tizen.UI.ScrollBarVisibility).TView 'Tizen.UI.Layouts.ScrollViewExtensions.HorizontalScrollBarVisibility<TView>(this TView, Tizen.UI.ScrollBarVisibility).TView') + +The view to configure. + + + +`scrollBarVisibility` Tizen.UI.ScrollBarVisibility + +The horizontal scroll bar visibility to set. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.HorizontalScrollBarVisibility_TView_(thisTView,Tizen.UI.ScrollBarVisibility).TView 'Tizen.UI.Layouts.ScrollViewExtensions.HorizontalScrollBarVisibility<TView>(this TView, Tizen.UI.ScrollBarVisibility).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAlways<TView>(this TView) Method + +Sets the vertical and horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Always. + +```csharp +public static TView ScrollBarAlways<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlways_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlways<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlways_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlways<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAlwaysHorizontal<TView>(this TView) Method + +Sets the horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Always. + +```csharp +public static TView ScrollBarAlwaysHorizontal<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysHorizontal<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysHorizontal<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAlwaysVertical<TView>(this TView) Method + +Sets the vertical scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Always. + +```csharp +public static TView ScrollBarAlwaysVertical<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysVertical<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAlwaysVertical<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAuto<TView>(this TView) Method + +Sets the vertical and horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Auto. + +```csharp +public static TView ScrollBarAuto<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAuto_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAuto<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAuto_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAuto<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAutoHorizontal<TView>(this TView) Method + +Sets the horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Auto. + +```csharp +public static TView ScrollBarAutoHorizontal<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoHorizontal<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoHorizontal<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarAutoVertical<TView>(this TView) Method + +Sets the vertical scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Auto. + +```csharp +public static TView ScrollBarAutoVertical<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoVertical<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarAutoVertical<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarNever<TView>(this TView) Method + +Sets the vertical and horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Never. + +```csharp +public static TView ScrollBarNever<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNever_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNever<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNever_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNever<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBarNeverHorizontal<TView>(this TView) Method + +Sets the horizontal scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Never. + +```csharp +public static TView ScrollBarNeverHorizontal<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNeverHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNeverHorizontal<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNeverHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBarNeverHorizontal<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollbarNeverVertical<TView>(this TView) Method + +Sets the vertical scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollBarVisibility.Never. + +```csharp +public static TView ScrollbarNeverVertical<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollbarNeverVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollbarNeverVertical<TView>(this TView).TView') + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollbarNeverVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollbarNeverVertical<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollBoth<TView>(this TView) Method + +Sets the scroll direction of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to both vertical and horizontal. + +```csharp +public static TView ScrollBoth<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBoth_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBoth<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollBoth_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollBoth<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollDirection<TView>(this TView, ScrollDirection) Method + +Sets the scroll direction of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to the specified value. + +```csharp +public static TView ScrollDirection<TView>(this TView view, Tizen.UI.ScrollDirection scrollDirection) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollDirection_TView_(thisTView,Tizen.UI.ScrollDirection).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollDirection<TView>(this TView, Tizen.UI.ScrollDirection).TView') + +The view to configure. + + + +`scrollDirection` Tizen.UI.ScrollDirection + +The scroll direction to set. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollDirection_TView_(thisTView,Tizen.UI.ScrollDirection).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollDirection<TView>(this TView, Tizen.UI.ScrollDirection).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollHorizontal<TView>(this TView) Method + +Sets the scroll direction of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollDirection.Horizontal. + +```csharp +public static TView ScrollHorizontal<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollHorizontal<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollHorizontal_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollHorizontal<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.ScrollVertical<TView>(this TView) Method + +Sets the scroll direction of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to Tizen.UI.ScrollDirection.Vertical. + +```csharp +public static TView ScrollVertical<TView>(this TView view) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollVertical<TView>(this TView).TView') + +The view to configure. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.ScrollVertical_TView_(thisTView).TView 'Tizen.UI.Layouts.ScrollViewExtensions.ScrollVertical<TView>(this TView).TView') +The configured view. + + + +## ScrollViewExtensions.VerticalScrollBarVisibility<TView>(this TView, ScrollBarVisibility) Method + +Sets the vertical scroll bar visibility of the [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') to the specified value. + +```csharp +public static TView VerticalScrollBarVisibility<TView>(this TView view, Tizen.UI.ScrollBarVisibility scrollBarVisibility) + where TView : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.VerticalScrollBarVisibility_TView_(thisTView,Tizen.UI.ScrollBarVisibility).TView 'Tizen.UI.Layouts.ScrollViewExtensions.VerticalScrollBarVisibility<TView>(this TView, Tizen.UI.ScrollBarVisibility).TView') + +The view to configure. + + + +`scrollBarVisibility` Tizen.UI.ScrollBarVisibility + +The vertical scroll bar visibility to set. + +#### Returns +[TView](Tizen.UI.Layouts.ScrollViewExtensions.md#Tizen.UI.Layouts.ScrollViewExtensions.VerticalScrollBarVisibility_TView_(thisTView,Tizen.UI.ScrollBarVisibility).TView 'Tizen.UI.Layouts.ScrollViewExtensions.VerticalScrollBarVisibility<TView>(this TView, Tizen.UI.ScrollBarVisibility).TView') +The configured view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapControlExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapControlExtensions.md new file mode 100644 index 0000000000..5b73c7cf96 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapControlExtensions.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## SnapControlExtensions Class + +Provides extension methods for setting snap points type and alignment on a ScrollView. + +```csharp +public static class SnapControlExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SnapControlExtensions +### Methods + + + +## SnapControlExtensions.SetSnap<T>(this T, SnapPointsType, SnapPointsAlignment) Method + +Sets the snap points type and alignment for the given ScrollView. + +```csharp +public static T SetSnap<T>(this T scrollView, Tizen.UI.Layouts.SnapPointsType snapType, Tizen.UI.Layouts.SnapPointsAlignment align) + where T : Tizen.UI.Layouts.ScrollLayout; +``` +#### Type parameters + + + +`T` + +The type of the ScrollView. +#### Parameters + + + +`scrollView` [T](Tizen.UI.Layouts.SnapControlExtensions.md#Tizen.UI.Layouts.SnapControlExtensions.SetSnap_T_(thisT,Tizen.UI.Layouts.SnapPointsType,Tizen.UI.Layouts.SnapPointsAlignment).T 'Tizen.UI.Layouts.SnapControlExtensions.SetSnap<T>(this T, Tizen.UI.Layouts.SnapPointsType, Tizen.UI.Layouts.SnapPointsAlignment).T') + +The ScrollView to apply the snap settings to. + + + +`snapType` [SnapPointsType](Tizen.UI.Layouts.SnapPointsType.md 'Tizen.UI.Layouts.SnapPointsType') + +The type of snap points to use + + + +`align` [SnapPointsAlignment](Tizen.UI.Layouts.SnapPointsAlignment.md 'Tizen.UI.Layouts.SnapPointsAlignment') + +The alignment of the snap points (e.g., Center, Start, End). + +#### Returns +[T](Tizen.UI.Layouts.SnapControlExtensions.md#Tizen.UI.Layouts.SnapControlExtensions.SetSnap_T_(thisT,Tizen.UI.Layouts.SnapPointsType,Tizen.UI.Layouts.SnapPointsAlignment).T 'Tizen.UI.Layouts.SnapControlExtensions.SetSnap<T>(this T, Tizen.UI.Layouts.SnapPointsType, Tizen.UI.Layouts.SnapPointsAlignment).T') +The modified ScrollView instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsAlignment.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsAlignment.md new file mode 100644 index 0000000000..d8dd45509e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsAlignment.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## SnapPointsAlignment Enum + +Specifies how snap points are aligned with items. + +```csharp +public enum SnapPointsAlignment +``` +### Fields + + + +`Center` 1 + +Indicates that snap points are aligned with the center of items. + + + +`End` 2 + +Indicates that snap points are aligned with the trailing edge of items. + + + +`Start` 0 + +Indicates that snap points are aligned with the leading edge of items. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsType.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsType.md new file mode 100644 index 0000000000..44bed150c2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsType.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## SnapPointsType Enum + +Specifies the behavior of snap points when scrolling. + +```csharp +public enum SnapPointsType +``` +### Fields + + + +`Mandatory` 1 + +Indicates that content always snaps to the closest snap point to where scrolling would naturally stop, along the direction of inertia. + + + +`MandatorySingle` 2 + +Indicates the same behavior as Mandatory, but only scrolls one item at a time. + + + +`None` 0 + +Indicates that scrolling does not snap to items. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBase.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBase.md new file mode 100644 index 0000000000..1ea0c2002e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBase.md @@ -0,0 +1,113 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## StackBase Class + +The StackBase class is an abstract class that represents a layout container. It is used to arrange child elements in a vertical or horizontal stack. + +```csharp +public abstract class StackBase : Tizen.UI.Layouts.Layout, +Tizen.UI.Layouts.IStackLayout, +Tizen.UI.Layouts.ILayout +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 StackBase + +Derived +↳ [HStack](Tizen.UI.Layouts.HStack.md 'Tizen.UI.Layouts.HStack') +↳ [VStack](Tizen.UI.Layouts.VStack.md 'Tizen.UI.Layouts.VStack') + +Implements [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout'), [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') +### Properties + + + +## StackBase.ItemAlignment Property + +Gets or sets the alignment of the child elements within the stack. + +```csharp +public Tizen.UI.Layouts.LayoutAlignment ItemAlignment { get; set; } +``` + +Implements [ItemAlignment](Tizen.UI.Layouts.IStackLayout.md#Tizen.UI.Layouts.IStackLayout.ItemAlignment 'Tizen.UI.Layouts.IStackLayout.ItemAlignment') + +#### Property Value +[LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') + + + +## StackBase.Spacing Property + +Gets or sets the spacing between child elements in the stack. + +```csharp +public float Spacing { get; set; } +``` + +Implements [Spacing](Tizen.UI.Layouts.IStackLayout.md#Tizen.UI.Layouts.IStackLayout.Spacing 'Tizen.UI.Layouts.IStackLayout.Spacing') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBaseExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBaseExtensions.md new file mode 100644 index 0000000000..3d311ea4f0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBaseExtensions.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## StackBaseExtensions Class + +Provides a series of extension methods that support configuring [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') layouts such as [HStack](Tizen.UI.Layouts.HStack.md 'Tizen.UI.Layouts.HStack') and [VStack](Tizen.UI.Layouts.VStack.md 'Tizen.UI.Layouts.VStack'). + +```csharp +public static class StackBaseExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 StackBaseExtensions +### Methods + + + +## StackBaseExtensions.Spacing<TView>(this TView, float) Method + +Sets the spacing between child elements of the StackBase object. + +```csharp +public static TView Spacing<TView>(this TView view, float spacing) + where TView : Tizen.UI.Layouts.StackBase; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.Layouts.StackBaseExtensions.md#Tizen.UI.Layouts.StackBaseExtensions.Spacing_TView_(thisTView,float).TView 'Tizen.UI.Layouts.StackBaseExtensions.Spacing<TView>(this TView, float).TView') + +The StackBase object. + + + +`spacing` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The spacing value to set. + +#### Returns +[TView](Tizen.UI.Layouts.StackBaseExtensions.md#Tizen.UI.Layouts.StackBaseExtensions.Spacing_TView_(thisTView,float).TView 'Tizen.UI.Layouts.StackBaseExtensions.Spacing<TView>(this TView, float).TView') +The stack base layout itself. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackLayoutManager.md new file mode 100644 index 0000000000..466ce3ea8a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackLayoutManager.md @@ -0,0 +1,109 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## StackLayoutManager Class + +Provides a base class for layout managers that arrange child elements in a stack. + +```csharp +public abstract class StackLayoutManager : Tizen.UI.Layouts.LayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 StackLayoutManager + +Derived +↳ [HStackLayoutManager](Tizen.UI.Layouts.HStackLayoutManager.md 'Tizen.UI.Layouts.HStackLayoutManager') +↳ [VStackLayoutManager](Tizen.UI.Layouts.VStackLayoutManager.md 'Tizen.UI.Layouts.VStackLayoutManager') +### Constructors + + + +## StackLayoutManager(IStackLayout) Constructor + +Initializes a new instance of the [StackLayoutManager](Tizen.UI.Layouts.StackLayoutManager.md 'Tizen.UI.Layouts.StackLayoutManager') class. + +```csharp +public StackLayoutManager(Tizen.UI.Layouts.IStackLayout stack); +``` +#### Parameters + + + +`stack` [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') + +The stack control that uses this layout manager. +### Properties + + + +## StackLayoutManager.Stack Property + +Gets the stack control that uses this layout manager. + +```csharp +public Tizen.UI.Layouts.IStackLayout Stack { get; } +``` + +#### Property Value +[IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStack.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStack.md new file mode 100644 index 0000000000..cceaa58b15 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStack.md @@ -0,0 +1,74 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## VStack Class + +Represents a vertical stack layout that arranges child elements in a single row. + +```csharp +public class VStack : Tizen.UI.Layouts.StackBase +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') 🡒 [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') 🡒 VStack + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStackLayoutManager.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStackLayoutManager.md new file mode 100644 index 0000000000..fb07a1f9d8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStackLayoutManager.md @@ -0,0 +1,143 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## VStackLayoutManager Class + +VStackLayoutManager is a layout manager that arranges its children vertically within a given space. + +```csharp +public class VStackLayoutManager : Tizen.UI.Layouts.StackLayoutManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') 🡒 [StackLayoutManager](Tizen.UI.Layouts.StackLayoutManager.md 'Tizen.UI.Layouts.StackLayoutManager') 🡒 VStackLayoutManager +### Constructors + + + +## VStackLayoutManager(IStackLayout) Constructor + +Initializes a new instance of the VStackLayoutManager class. + +```csharp +public VStackLayoutManager(Tizen.UI.Layouts.IStackLayout stackLayout); +``` +#### Parameters + + + +`stackLayout` [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') +### Methods + + + +## VStackLayoutManager.ArrangeChildren(Rect) Method + +Arranges the children of the layout. + +```csharp +public override Tizen.UI.Size ArrangeChildren(Tizen.UI.Rect bounds); +``` +#### Parameters + + + +`bounds` Tizen.UI.Rect + +The available space for the layout. + +Implements [ArrangeChildren(Rect)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect) 'Tizen.UI.Layouts.ILayoutManager.ArrangeChildren(Tizen.UI.Rect)') + +#### Returns +Tizen.UI.Size +The arranged size of the layout. + + + +## VStackLayoutManager.Measure(float, float) Method + +Measures the size of the layout. + +```csharp +public override Tizen.UI.Size Measure(float widthConstraint, float heightConstraint); +``` +#### Parameters + + + +`widthConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the layout. + + + +`heightConstraint` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the layout. + +Implements [Measure(float, float)](Tizen.UI.Layouts.ILayoutManager.md#Tizen.UI.Layouts.ILayoutManager.Measure(float,float) 'Tizen.UI.Layouts.ILayoutManager.Measure(float, float)') + +#### Returns +Tizen.UI.Size +The measured size of the layout. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ViewExtensions.md new file mode 100644 index 0000000000..e96a0fb38f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ViewExtensions.md @@ -0,0 +1,159 @@ +### [Tizen.UI.Layouts](Tizen.UI.Layouts.md 'Tizen.UI.Layouts') + +## ViewExtensions Class + +Provides extension methods needed when Tizen.UI.Views are included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. + +```csharp +public static class ViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewExtensions +### Methods + + + +## ViewExtensions.AbsoluteParam(this View) Method + +Gets the attached AbsoluteParam for the view.
+This only works if the Tizen.UI.View is included in the [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout') and used. + +```csharp +public static Tizen.UI.Layouts.AbsoluteParam AbsoluteParam(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to get the AbsoluteParam for. + +#### Returns +[AbsoluteParam](Tizen.UI.Layouts.AbsoluteParam.md 'Tizen.UI.Layouts.AbsoluteParam') +The AbsoluteParam attached to the view. + + + +## ViewExtensions.FlexParam(this View) Method + +Attaches the FlexParam to the view.
+This only works if the Tizen.UI.View is included in the [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') and used. + +```csharp +public static Tizen.UI.Layouts.FlexParam FlexParam(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +#### Returns +[FlexParam](Tizen.UI.Layouts.FlexParam.md 'Tizen.UI.Layouts.FlexParam') +The FlexParam attached to the view. + + + +## ViewExtensions.GridParam(this View) Method + +Gets the attached GridParam for the view.
+This only works if the Tizen.UI.View is included in the [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') and used. + +```csharp +public static Tizen.UI.Layouts.GridParam GridParam(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to get the GridParam for. + +#### Returns +[GridParam](Tizen.UI.Layouts.GridParam.md 'Tizen.UI.Layouts.GridParam') +The GridParam attached to the view. + + + +## ViewExtensions.LayoutParam(this View) Method + +Gets the attached LayoutParam for the view. + +```csharp +public static Tizen.UI.Layouts.LayoutParam LayoutParam(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to get the LayoutParam for. + +#### Returns +[LayoutParam](Tizen.UI.Layouts.LayoutParam.md 'Tizen.UI.Layouts.LayoutParam') +The LayoutParam attached to the view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.md b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.md new file mode 100644 index 0000000000..0e0d2fa61e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.md @@ -0,0 +1,130 @@ +## Tizen.UI.Layouts Namespace + +| Classes | | +| :--- | :--- | +| [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout') | The AbsoluteLayout class is a layout container that positions its children at fixed coordinates relative to the layout bounds. | +| [AbsoluteLayoutExtensions](Tizen.UI.Layouts.AbsoluteLayoutExtensions.md 'Tizen.UI.Layouts.AbsoluteLayoutExtensions') | Provides a series of extension methods that support positioning Tizen.UI.Views in [AbsoluteLayout](Tizen.UI.Layouts.AbsoluteLayout.md 'Tizen.UI.Layouts.AbsoluteLayout')s. | +| [AbsoluteLayoutManager](Tizen.UI.Layouts.AbsoluteLayoutManager.md 'Tizen.UI.Layouts.AbsoluteLayoutManager') | The AbsoluteLayoutManager class is responsible for measuring and arranging the children of an AbsoluteLayout. | +| [AbsoluteParam](Tizen.UI.Layouts.AbsoluteParam.md 'Tizen.UI.Layouts.AbsoluteParam') | The AbsoluteParam class provides layout parameters for the AbsoluteLayout. | +| [Dimension](Tizen.UI.Layouts.Dimension.md 'Tizen.UI.Layouts.Dimension') | Provides a set of static methods for working with dimensions. | +| [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox') | FlexBox is a Layout that efficiently lays out it's children in a manner similar to that of CSS Flexbox. | +| [FlexBoxExtensions](Tizen.UI.Layouts.FlexBoxExtensions.md 'Tizen.UI.Layouts.FlexBoxExtensions') | Provides a series of extension methods that support positioning a Tizen.UI.View in a [FlexBox](Tizen.UI.Layouts.FlexBox.md 'Tizen.UI.Layouts.FlexBox'). | +| [FlexLayoutManager](Tizen.UI.Layouts.FlexLayoutManager.md 'Tizen.UI.Layouts.FlexLayoutManager') | Provides a layout manager for FlexBox layout. | +| [FlexParam](Tizen.UI.Layouts.FlexParam.md 'Tizen.UI.Layouts.FlexParam') | Provides layout parameters for the FlexBox. | +| [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid') | A layout that arranges views in rows and columns. | +| [GridColumnDefinition](Tizen.UI.Layouts.GridColumnDefinition.md 'Tizen.UI.Layouts.GridColumnDefinition') | Represents a column definition Grid layout. | +| [GridExtensions](Tizen.UI.Layouts.GridExtensions.md 'Tizen.UI.Layouts.GridExtensions') | Provides a series of extension methods that support configuring a [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid'). | +| [GridLayoutManager](Tizen.UI.Layouts.GridLayoutManager.md 'Tizen.UI.Layouts.GridLayoutManager') | Provides a layout manager for a grid layout. | +| [GridParam](Tizen.UI.Layouts.GridParam.md 'Tizen.UI.Layouts.GridParam') | Provides a set of properties for managing the layout of a view within a grid layout. | +| [GridRowColumns](Tizen.UI.Layouts.GridRowColumns.md 'Tizen.UI.Layouts.GridRowColumns') | Provides a series of extension methods that support configuring a [Grid](Tizen.UI.Layouts.Grid.md 'Tizen.UI.Layouts.Grid'). | +| [GridRowColumns.Columns](Tizen.UI.Layouts.GridRowColumns.Columns.md 'Tizen.UI.Layouts.GridRowColumns.Columns') | Provides a set of methods for defining the columns of a Grid using C# Layouts. | +| [GridRowColumns.Rows](Tizen.UI.Layouts.GridRowColumns.Rows.md 'Tizen.UI.Layouts.GridRowColumns.Rows') | Provides a set of methods for defining the rows of a Grid using C# Layouts. | +| [GridRowDefinition](Tizen.UI.Layouts.GridRowDefinition.md 'Tizen.UI.Layouts.GridRowDefinition') | Represents a row definition in a grid layout. | +| [HStack](Tizen.UI.Layouts.HStack.md 'Tizen.UI.Layouts.HStack') | Represents a horizontal stack layout that arranges child elements in a single row. | +| [HStackLayoutManager](Tizen.UI.Layouts.HStackLayoutManager.md 'Tizen.UI.Layouts.HStackLayoutManager') | HStackLayoutManager is a layout manager that arranges its children horizontally within a given space. | +| [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') | Layout is an abstract class that defines the base functionality for all layout classes. It provides a mechanism for arranging and positioning child views within its bounds. | +| [LayoutExtensions](Tizen.UI.Layouts.LayoutExtensions.md 'Tizen.UI.Layouts.LayoutExtensions') | Provides a series of extension methods that support positioning Tizen.UI.Views in [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout')s. | +| [LayoutHelper](Tizen.UI.Layouts.LayoutHelper.md 'Tizen.UI.Layouts.LayoutHelper') | Provides common layout logic for ViewGroup instances.
This class uses composition to provide layout functionality, simplifying the implementation of custom layouts. | +| [LayoutManager](Tizen.UI.Layouts.LayoutManager.md 'Tizen.UI.Layouts.LayoutManager') | Represents a base class for layout managers. | +| [LayoutParam](Tizen.UI.Layouts.LayoutParam.md 'Tizen.UI.Layouts.LayoutParam') | Provides layout parameters for the view. | +| [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout') | A scrollable view that can be scrolled. | +| [ScrollLayoutManager](Tizen.UI.Layouts.ScrollLayoutManager.md 'Tizen.UI.Layouts.ScrollLayoutManager') | Provides functionality for arranging and measuring the children of a ScrollView. | +| [ScrollViewExtensions](Tizen.UI.Layouts.ScrollViewExtensions.md 'Tizen.UI.Layouts.ScrollViewExtensions') | Provides a series of extension methods that support configuring [ScrollLayout](Tizen.UI.Layouts.ScrollLayout.md 'Tizen.UI.Layouts.ScrollLayout'). | +| [SnapControlExtensions](Tizen.UI.Layouts.SnapControlExtensions.md 'Tizen.UI.Layouts.SnapControlExtensions') | Provides extension methods for setting snap points type and alignment on a ScrollView. | +| [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') | The StackBase class is an abstract class that represents a layout container. It is used to arrange child elements in a vertical or horizontal stack. | +| [StackBaseExtensions](Tizen.UI.Layouts.StackBaseExtensions.md 'Tizen.UI.Layouts.StackBaseExtensions') | Provides a series of extension methods that support configuring [StackBase](Tizen.UI.Layouts.StackBase.md 'Tizen.UI.Layouts.StackBase') layouts such as [HStack](Tizen.UI.Layouts.HStack.md 'Tizen.UI.Layouts.HStack') and [VStack](Tizen.UI.Layouts.VStack.md 'Tizen.UI.Layouts.VStack'). | +| [StackLayoutManager](Tizen.UI.Layouts.StackLayoutManager.md 'Tizen.UI.Layouts.StackLayoutManager') | Provides a base class for layout managers that arrange child elements in a stack. | +| [ViewExtensions](Tizen.UI.Layouts.ViewExtensions.md 'Tizen.UI.Layouts.ViewExtensions') | Provides extension methods needed when Tizen.UI.Views are included in the [Layout](Tizen.UI.Layouts.Layout.md 'Tizen.UI.Layouts.Layout') and used. | +| [VStack](Tizen.UI.Layouts.VStack.md 'Tizen.UI.Layouts.VStack') | Represents a vertical stack layout that arranges child elements in a single row. | +| [VStackLayoutManager](Tizen.UI.Layouts.VStackLayoutManager.md 'Tizen.UI.Layouts.VStackLayoutManager') | VStackLayoutManager is a layout manager that arranges its children vertically within a given space. | + +| Structs | | +| :--- | :--- | +| [FlexBasis](Tizen.UI.Layouts.FlexBasis.md 'Tizen.UI.Layouts.FlexBasis') | Specifies the initial size of the flex item. | +| [GridLength](Tizen.UI.Layouts.GridLength.md 'Tizen.UI.Layouts.GridLength') | Used to define the size of Grid ColumnDefinition and RowDefinition. | + +| Interfaces | | +| :--- | :--- | +| [IFlexBox](Tizen.UI.Layouts.IFlexBox.md 'Tizen.UI.Layouts.IFlexBox') | Defines the contract for a FlexBox layout, extending ILayout with FlexBox-specific layout operations. | +| [IGridLayout](Tizen.UI.Layouts.IGridLayout.md 'Tizen.UI.Layouts.IGridLayout') | Defines the contract for a grid-based layout. | +| [ILayout](Tizen.UI.Layouts.ILayout.md 'Tizen.UI.Layouts.ILayout') | Defines the contract for a class that can provide layout functionality for its children using a LayoutManager. | +| [ILayoutManager](Tizen.UI.Layouts.ILayoutManager.md 'Tizen.UI.Layouts.ILayoutManager') | Defines the interface for a layout manager, which is responsible for measuring and arranging the children of a layout. | +| [IStackLayout](Tizen.UI.Layouts.IStackLayout.md 'Tizen.UI.Layouts.IStackLayout') | Defines the contract for a stack-based layout. | + +| Enums | | +| :--- | :--- | +| [AbsoluteLayoutFlags](Tizen.UI.Layouts.AbsoluteLayoutFlags.md 'Tizen.UI.Layouts.AbsoluteLayoutFlags') | Enumeration for AbsoluteLayoutFlags. | +| [FlexAlignContent](Tizen.UI.Layouts.FlexAlignContent.md 'Tizen.UI.Layouts.FlexAlignContent') | Enumerates values that control how multiple rows or columns of child elements are aligned. | +| [FlexAlignItems](Tizen.UI.Layouts.FlexAlignItems.md 'Tizen.UI.Layouts.FlexAlignItems') | Enumerates values that control the alignment of child elements. | +| [FlexAlignSelf](Tizen.UI.Layouts.FlexAlignSelf.md 'Tizen.UI.Layouts.FlexAlignSelf') | Enumerates values that control how and whether a child element overrides alignment attributes applied by its parent. | +| [FlexDirection](Tizen.UI.Layouts.FlexDirection.md 'Tizen.UI.Layouts.FlexDirection') | Enumerates values that specify row and columen flex layout directions, relative to the directions for the device locale. | +| [FlexJustify](Tizen.UI.Layouts.FlexJustify.md 'Tizen.UI.Layouts.FlexJustify') | Enumerates values that describe how child elements are justified when there is extra space around them. | +| [FlexPosition](Tizen.UI.Layouts.FlexPosition.md 'Tizen.UI.Layouts.FlexPosition') | Enumerates values that control how layout coordinates are interpreted when specifying the positions of child elements. | +| [FlexWrap](Tizen.UI.Layouts.FlexWrap.md 'Tizen.UI.Layouts.FlexWrap') | Enumerates values that control whether and how to wrap items in a FlexBox. | +| [GridUnitType](Tizen.UI.Layouts.GridUnitType.md 'Tizen.UI.Layouts.GridUnitType') | Enumerates values that control how the [Value](Tizen.UI.Layouts.GridLength.md#Tizen.UI.Layouts.GridLength.Value 'Tizen.UI.Layouts.GridLength.Value') property is interpreted for row and column definitions. | +| [LayoutAlignment](Tizen.UI.Layouts.LayoutAlignment.md 'Tizen.UI.Layouts.LayoutAlignment') | Enumeration that represent LayoutAlignment. | +| [SnapPointsAlignment](Tizen.UI.Layouts.SnapPointsAlignment.md 'Tizen.UI.Layouts.SnapPointsAlignment') | Specifies how snap points are aligned with items. | +| [SnapPointsType](Tizen.UI.Layouts.SnapPointsType.md 'Tizen.UI.Layouts.SnapPointsType') | Specifies the behavior of snap points when scrolling. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ArcTo.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ArcTo.md new file mode 100644 index 0000000000..52d26a69d9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ArcTo.md @@ -0,0 +1,191 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## ArcTo Class + +Represents a command that appends a line and arc to the current path. + +```csharp +public class ArcTo : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ArcTo + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## ArcTo(float, float, float, float, float, bool) Constructor + +Appends the specified arc to the path. + +```csharp +public ArcTo(float x, float y, float radius, float startAngle, float sweep, bool closed); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end point of the arc. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end point of the arc. + + + +`radius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the arc. + + + +`startAngle` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The starting angle of the arc, in radians. + + + +`sweep` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of the arc, in radians. + + + +`closed` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the arc should be connected to the start point by a straight line. +### Properties + + + +## ArcTo.Closed Property + +Gets a value indicating whether the arc should be connected to the start point by a straight line. + +```csharp +public bool Closed { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ArcTo.Radius Property + +Gets the radius of the arc. + +```csharp +public float Radius { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ArcTo.StartAngle Property + +Gets the starting angle of the arc, in radians. + +```csharp +public float StartAngle { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ArcTo.Sweep Property + +Gets the angle of the arc, in radians. + +```csharp +public float Sweep { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ArcTo.X Property + +Gets the x-coordinate of the end point of the arc. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ArcTo.Y Property + +Gets the y-coordinate of the end point of the arc. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.BezierTo.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.BezierTo.md new file mode 100644 index 0000000000..3ab86e2511 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.BezierTo.md @@ -0,0 +1,191 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## BezierTo Class + +Represents a command that draws a cubic Bezier curve to the current point. + +```csharp +public class BezierTo : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BezierTo + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## BezierTo(float, float, float, float, float, float) Constructor + +Draws a Bezier curve to the specified point. + +```csharp +public BezierTo(float endPointX, float endPointY, float controlPoint1X, float controlPoint1Y, float controlPoint2X, float controlPoint2Y); +``` +#### Parameters + + + +`endPointX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end point. + + + +`endPointY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end point. + + + +`controlPoint1X` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the first control point. + + + +`controlPoint1Y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the first control point. + + + +`controlPoint2X` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the second control point. + + + +`controlPoint2Y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the second control point. +### Properties + + + +## BezierTo.ControlPoint1X Property + +Gets the x-coordinate of the first control point. + +```csharp +public float ControlPoint1X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BezierTo.ControlPoint1Y Property + +Gets the y-coordinate of the first control point. + +```csharp +public float ControlPoint1Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BezierTo.ControlPoint2X Property + +Gets the x-coordinate of the second control point. + +```csharp +public float ControlPoint2X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BezierTo.ControlPoint2Y Property + +Gets the y-coordinate of the second control point. + +```csharp +public float ControlPoint2Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BezierTo.EndPointX Property + +Gets the x-coordinate of the end point. + +```csharp +public float EndPointX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BezierTo.EndPointY Property + +Gets the y-coordinate of the end point. + +```csharp +public float EndPointY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Close.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Close.md new file mode 100644 index 0000000000..2d7d17d674 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Close.md @@ -0,0 +1,75 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Close Class + +Represents a command that closes the current subpath by drawing a straight line from the current point to the starting point of the subpath. + +```csharp +public class Close : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Close + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## Close() Constructor + +Closes this context and flushes its content so that it can be rendered. + +```csharp +public Close(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.CustomShape.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.CustomShape.md new file mode 100644 index 0000000000..e312bfeda0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.CustomShape.md @@ -0,0 +1,94 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## CustomShape Class + +Represents a custom [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape'). + +```csharp +public class CustomShape : Tizen.UI.Primitives2D.Shape +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') 🡒 CustomShape +### Constructors + + + +## CustomShape(IEnumerable<IPath>) Constructor + +Initializes a new instance of the CustomShape class. + +```csharp +public CustomShape(System.Collections.Generic.IEnumerable<Tizen.UI.Primitives2D.IPath> path=null); +``` +#### Parameters + + + +`path` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +The path commands used to define the shape. +### Properties + + + +## CustomShape.Path Property + +Gets or sets the path commands used to define the shape. + +```csharp +public System.Collections.Generic.IEnumerable<Tizen.UI.Primitives2D.IPath> Path { get; set; } +``` + +#### Property Value +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawCircle.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawCircle.md new file mode 100644 index 0000000000..4008d0ccf3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawCircle.md @@ -0,0 +1,128 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## DrawCircle Class + +Represents a command to draw a circle on a shape. + +```csharp +public class DrawCircle : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DrawCircle + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## DrawCircle(float, float, float) Constructor + +Draws a circle on the canvas. + +```csharp +public DrawCircle(float centerX, float centerY, float radius); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`radius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Properties + + + +## DrawCircle.CenterX Property + +Gets the x-coordinate of the center of the circle. + +```csharp +public float CenterX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawCircle.CenterY Property + +Gets the y-coordinate of the center of the circle. + +```csharp +public float CenterY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawCircle.Radius Property + +Gets the radius of the circle. + +```csharp +public float Radius { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawOval.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawOval.md new file mode 100644 index 0000000000..065c158924 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawOval.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## DrawOval Class + +Represents a command to draw an oval on a shape. + +```csharp +public class DrawOval : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DrawOval + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## DrawOval(float, float, float, float) Constructor + +Draws an oval on the canvas. + +```csharp +public DrawOval(float centerX, float centerY, float radiusX, float radiusY); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the center of the oval. + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the center of the oval. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-radius of the oval. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-radius of the oval. +### Properties + + + +## DrawOval.CenterX Property + +Gets or sets the x-coordinate of the center point of the oval. + +```csharp +public float CenterX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawOval.CenterY Property + +Gets or sets the y-coordinate of the center point of the oval. + +```csharp +public float CenterY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawOval.RadiusX Property + +Gets or sets the radius of the oval along the x-axis. + +```csharp +public float RadiusX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawOval.RadiusY Property + +Gets or sets the radius of the oval along the y-axis. + +```csharp +public float RadiusY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRect.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRect.md new file mode 100644 index 0000000000..0795f07ef4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRect.md @@ -0,0 +1,145 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## DrawRect Class + +Represents a command to draw a rectangle. + +```csharp +public class DrawRect : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DrawRect + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## DrawRect(float, float, float, float) Constructor + +Draws a rectangle specified by a coordinate pair, a width, and a height. + +```csharp +public DrawRect(float x, float y, float width, float height); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Properties + + + +## DrawRect.Height Property + +Gets the height of the rectangle. + +```csharp +public float Height { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRect.Width Property + +Gets the width of the rectangle. + +```csharp +public float Width { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRect.X Property + +Gets the x-coordinate of the upper-left corner of the rectangle. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRect.Y Property + +Gets the y-coordinate of the upper-left corner of the rectangle. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRoundRect.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRoundRect.md new file mode 100644 index 0000000000..1143bd1106 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRoundRect.md @@ -0,0 +1,191 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## DrawRoundRect Class + +Represents a command to draw a rounded rectangle. + +```csharp +public class DrawRoundRect : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DrawRoundRect + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## DrawRoundRect(float, float, float, float, float, float) Constructor + +Draws a rounded rectangle. + +```csharp +public DrawRoundRect(float x, float y, float width, float height, float radiusX, float radiusY); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the rectangle. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-radius of the rounded corners. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-radius of the rounded corners. +### Properties + + + +## DrawRoundRect.Height Property + +The height of the rectangle. + +```csharp +public float Height { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRoundRect.RadiusX Property + +The x-radius of the rounded corners. + +```csharp +public float RadiusX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRoundRect.RadiusY Property + +The y-radius of the rounded corners. + +```csharp +public float RadiusY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRoundRect.Width Property + +The width of the rectangle. + +```csharp +public float Width { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRoundRect.X Property + +The x-coordinate of the upper-left corner of the rectangle. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DrawRoundRect.Y Property + +The y-coordinate of the upper-left corner of the rectangle. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Drawable.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Drawable.md new file mode 100644 index 0000000000..adff57f490 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Drawable.md @@ -0,0 +1,173 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Drawable Class + +The Drawable class is an abstract class that provides a base for all drawable objects. + +```csharp +public abstract class Drawable : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Drawable + +Derived +↳ [DrawableGroup](Tizen.UI.Primitives2D.DrawableGroup.md 'Tizen.UI.Primitives2D.DrawableGroup') +↳ [ImageDrawable](Tizen.UI.Primitives2D.ImageDrawable.md 'Tizen.UI.Primitives2D.ImageDrawable') +↳ [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') +### Properties + + + +## Drawable.BoundingBox Property + +Gets the bounding box of the drawable object. + +```csharp +public Tizen.UI.Rect BoundingBox { get; } +``` + +#### Property Value +Tizen.UI.Rect +### Methods + + + +## Drawable.ClipPath(Drawable) Method + +Sets the clip path for the drawable object. + +```csharp +public void ClipPath(Tizen.UI.Primitives2D.Drawable clip); +``` +#### Parameters + + + +`clip` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The clip path to set. + + + +## Drawable.Rotate(float) Method + +Rotates the position of the drawable object by the specified degree. + +```csharp +public void Rotate(float degree); +``` +#### Parameters + + + +`degree` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The degree to rotate the position by. + + + +## Drawable.Scale(float) Method + +Scales the size of the drawable object by the specified factor. + +```csharp +public void Scale(float factor); +``` +#### Parameters + + + +`factor` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The factor to scale the size by. + + + +## Drawable.Transform(float[]) Method + +Sets the transform matrix of the drawable object. + +```csharp +public void Transform(float[] matrix); +``` +#### Parameters + + + +`matrix` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The transform matrix to set. + + + +## Drawable.Translate(float, float) Method + +Translates the position of the drawable object by the specified amount. + +```csharp +public void Translate(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to translate on the x-axis. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to translate on the y-axis. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawableGroup.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawableGroup.md new file mode 100644 index 0000000000..29400cec65 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawableGroup.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## DrawableGroup Class + +[DrawableGroup](Tizen.UI.Primitives2D.DrawableGroup.md 'Tizen.UI.Primitives2D.DrawableGroup') is a class that manages a collection of drawables and draws them as a group. + +```csharp +public class DrawableGroup : Tizen.UI.Primitives2D.Drawable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 DrawableGroup +### Constructors + + + +## DrawableGroup() Constructor + +Creates a new instance of the [DrawableGroup](Tizen.UI.Primitives2D.DrawableGroup.md 'Tizen.UI.Primitives2D.DrawableGroup') class. + +```csharp +public DrawableGroup(); +``` +### Properties + + + +## DrawableGroup.Drawables Property + +Gets a read-only collection of drawables in the group. + +```csharp +public System.Collections.Generic.IReadOnlyCollection<Tizen.UI.Primitives2D.Drawable> Drawables { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') +### Methods + + + +## DrawableGroup.Add(Drawable) Method + +Adds a [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') to the group. + +```csharp +public void Add(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to add. + + + +## DrawableGroup.Clear() Method + +Removes all drawables from the group. + +```csharp +public void Clear(); +``` + + + +## DrawableGroup.Contains(Drawable) Method + +Checks if the group contains a specific drawable. + +```csharp +public bool Contains(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the group contains the specified drawable, false otherwise. + + + +## DrawableGroup.Remove(Drawable) Method + +Removes a [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') from the group. + +```csharp +public void Remove(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to remove. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Ellipse.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Ellipse.md new file mode 100644 index 0000000000..b23c05fedf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Ellipse.md @@ -0,0 +1,151 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Ellipse Class + +Draws an ellipse. + +```csharp +public class Ellipse : Tizen.UI.Primitives2D.Shape +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') 🡒 Ellipse +### Constructors + + + +## Ellipse(float, float, float, float) Constructor + +Initializes a new instance of the Ellipse class. + +```csharp +public Ellipse(float centerX, float centerY, float radiusX, float radiusY); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +X coordinate of the center of the ellipse. + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Y coordinate of the center of the ellipse. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +X radius of the ellipse. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Y radius of the ellipse. +### Properties + + + +## Ellipse.CenterX Property + +Gets or sets the X coordinate of the center of the ellipse. + +```csharp +public float CenterX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Ellipse.CenterY Property + +Gets or sets the Y coordinate of the center of the ellipse. + +```csharp +public float CenterY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Ellipse.RadiusX Property + +Gets or sets the X radius of the ellipse. + +```csharp +public float RadiusX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Ellipse.RadiusY Property + +Gets or sets the Y radius of the ellipse. + +```csharp +public float RadiusY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.FillRule.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.FillRule.md new file mode 100644 index 0000000000..4c0221df5e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.FillRule.md @@ -0,0 +1,72 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## FillRule Enum + +Possible path fill type values. + +```csharp +public enum FillRule +``` +### Fields + + + +`EvenOdd` 1 + +Specifies that "inside" is computed by an odd number of edge crossings. + + + +`Winding` 0 + +Specifies that "inside" is computed by a non-zero sum of signed edge crossings. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.GradientPaint.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.GradientPaint.md new file mode 100644 index 0000000000..5a15c75adc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.GradientPaint.md @@ -0,0 +1,210 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## GradientPaint Class + +Abstract class representing a gradient paint. + +```csharp +public abstract class GradientPaint : Tizen.UI.NObject, +Tizen.UI.Primitives2D.IPaint +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 GradientPaint + +Derived +↳ [LinearGradientPaint](Tizen.UI.Primitives2D.LinearGradientPaint.md 'Tizen.UI.Primitives2D.LinearGradientPaint') +↳ [RadialGradientPaint](Tizen.UI.Primitives2D.RadialGradientPaint.md 'Tizen.UI.Primitives2D.RadialGradientPaint') + +Implements [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint') +### Properties + + + +## GradientPaint.FillRule Property + +Gets or sets the fill rule of the gradient paint. + +```csharp +public Tizen.UI.Primitives2D.FillRule FillRule { get; set; } +``` + +Implements [FillRule](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.FillRule 'Tizen.UI.Primitives2D.IPaint.FillRule') + +#### Property Value +[FillRule](Tizen.UI.Primitives2D.FillRule.md 'Tizen.UI.Primitives2D.FillRule') + + + +## GradientPaint.GradientStops Property + +Gets or sets the gradient stops of the gradient paint. + +```csharp +public Tizen.UI.GradientStop[] GradientStops { get; set; } +``` + +#### Property Value +Tizen.UI.GradientStop[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +## GradientPaint.Spread Property + +Gets or sets the spread type of the gradient paint. + +```csharp +public Tizen.UI.Primitives2D.SpreadType Spread { get; set; } +``` + +#### Property Value +[SpreadType](Tizen.UI.Primitives2D.SpreadType.md 'Tizen.UI.Primitives2D.SpreadType') + + + +## GradientPaint.StrokeCap Property + +Gets or sets the stroke cap of the gradient paint. + +```csharp +public Tizen.UI.Primitives2D.StrokeCap StrokeCap { get; set; } +``` + +Implements [StrokeCap](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeCap 'Tizen.UI.Primitives2D.IPaint.StrokeCap') + +#### Property Value +[StrokeCap](Tizen.UI.Primitives2D.StrokeCap.md 'Tizen.UI.Primitives2D.StrokeCap') + + + +## GradientPaint.StrokeDashArray Property + +Gets or sets the stroke dash array of the gradient paint. + +```csharp +public float[] StrokeDashArray { get; set; } +``` + +Implements [StrokeDashArray](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeDashArray 'Tizen.UI.Primitives2D.IPaint.StrokeDashArray') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +## GradientPaint.StrokeJoin Property + +Gets or sets the stroke join of the gradient paint. + +```csharp +public Tizen.UI.Primitives2D.StrokeJoin StrokeJoin { get; set; } +``` + +Implements [StrokeJoin](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeJoin 'Tizen.UI.Primitives2D.IPaint.StrokeJoin') + +#### Property Value +[StrokeJoin](Tizen.UI.Primitives2D.StrokeJoin.md 'Tizen.UI.Primitives2D.StrokeJoin') + + + +## GradientPaint.StrokeWidth Property + +Gets or sets the stroke width of the gradient paint. + +```csharp +public float StrokeWidth { get; set; } +``` + +Implements [StrokeWidth](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeWidth 'Tizen.UI.Primitives2D.IPaint.StrokeWidth') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## GradientPaint.Fill(Shape) Method + +Fills the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') with the gradient paint. + +```csharp +public void Fill(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to fill. + +Implements [Fill(Shape)](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.Fill(Tizen.UI.Primitives2D.Shape) 'Tizen.UI.Primitives2D.IPaint.Fill(Tizen.UI.Primitives2D.Shape)') + + + +## GradientPaint.Stroke(Shape) Method + +Strokes the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') with the gradient paint. + +```csharp +public void Stroke(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to stroke. + +Implements [Stroke(Shape)](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.Stroke(Tizen.UI.Primitives2D.Shape) 'Tizen.UI.Primitives2D.IPaint.Stroke(Tizen.UI.Primitives2D.Shape)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPaint.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPaint.md new file mode 100644 index 0000000000..311444ed4f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPaint.md @@ -0,0 +1,164 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## IPaint Interface + +Interface for defining paint objects used to draw shapes on a canvas. + +```csharp +public interface IPaint +``` + +Derived +↳ [GradientPaint](Tizen.UI.Primitives2D.GradientPaint.md 'Tizen.UI.Primitives2D.GradientPaint') +↳ [SolidPaint](Tizen.UI.Primitives2D.SolidPaint.md 'Tizen.UI.Primitives2D.SolidPaint') +### Properties + + + +## IPaint.FillRule Property + +Gets or sets the [FillRule](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.FillRule 'Tizen.UI.Primitives2D.IPaint.FillRule') used to determine which points are inside or outside a shape. + +```csharp +Tizen.UI.Primitives2D.FillRule FillRule { get; set; } +``` + +#### Property Value +[FillRule](Tizen.UI.Primitives2D.FillRule.md 'Tizen.UI.Primitives2D.FillRule') + + + +## IPaint.StrokeCap Property + +Gets or sets the [StrokeCap](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeCap 'Tizen.UI.Primitives2D.IPaint.StrokeCap') style used when drawing lines. + +```csharp +Tizen.UI.Primitives2D.StrokeCap StrokeCap { get; set; } +``` + +#### Property Value +[StrokeCap](Tizen.UI.Primitives2D.StrokeCap.md 'Tizen.UI.Primitives2D.StrokeCap') + + + +## IPaint.StrokeDashArray Property + +Gets or sets the array of dash pattern lengths used to stroke paths. + +```csharp +float[] StrokeDashArray { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +## IPaint.StrokeJoin Property + +Gets or sets the [StrokeJoin](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeJoin 'Tizen.UI.Primitives2D.IPaint.StrokeJoin') style used when joining lines. + +```csharp +Tizen.UI.Primitives2D.StrokeJoin StrokeJoin { get; set; } +``` + +#### Property Value +[StrokeJoin](Tizen.UI.Primitives2D.StrokeJoin.md 'Tizen.UI.Primitives2D.StrokeJoin') + + + +## IPaint.StrokeWidth Property + +Gets or sets the width of the stroke used when drawing shapes. + +```csharp +float StrokeWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## IPaint.Fill(Shape) Method + +Fills the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') using the current paint settings. + +```csharp +void Fill(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to fill. + + + +## IPaint.Stroke(Shape) Method + +Strokes the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') using the current paint settings. + +```csharp +void Stroke(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to stroke. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPath.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPath.md new file mode 100644 index 0000000000..2df9627c2c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPath.md @@ -0,0 +1,88 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## IPath Interface + +Defines a command that can be executed on a [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') object. + +```csharp +public interface IPath +``` + +Derived +↳ [ArcTo](Tizen.UI.Primitives2D.ArcTo.md 'Tizen.UI.Primitives2D.ArcTo') +↳ [BezierTo](Tizen.UI.Primitives2D.BezierTo.md 'Tizen.UI.Primitives2D.BezierTo') +↳ [Close](Tizen.UI.Primitives2D.Close.md 'Tizen.UI.Primitives2D.Close') +↳ [DrawCircle](Tizen.UI.Primitives2D.DrawCircle.md 'Tizen.UI.Primitives2D.DrawCircle') +↳ [DrawOval](Tizen.UI.Primitives2D.DrawOval.md 'Tizen.UI.Primitives2D.DrawOval') +↳ [DrawRect](Tizen.UI.Primitives2D.DrawRect.md 'Tizen.UI.Primitives2D.DrawRect') +↳ [DrawRoundRect](Tizen.UI.Primitives2D.DrawRoundRect.md 'Tizen.UI.Primitives2D.DrawRoundRect') +↳ [LineTo](Tizen.UI.Primitives2D.LineTo.md 'Tizen.UI.Primitives2D.LineTo') +↳ [MoveTo](Tizen.UI.Primitives2D.MoveTo.md 'Tizen.UI.Primitives2D.MoveTo') +### Methods + + + +## IPath.Execute(Shape) Method + +Executes the command on the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') object. + +```csharp +void Execute(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The Shape object on which the command should be executed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ImageDrawable.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ImageDrawable.md new file mode 100644 index 0000000000..f662311a9d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ImageDrawable.md @@ -0,0 +1,132 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## ImageDrawable Class + +Represents an image element on the screen. + +```csharp +public class ImageDrawable : Tizen.UI.Primitives2D.Drawable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 ImageDrawable +### Constructors + + + +## ImageDrawable(string, float, float) Constructor + +Constructor of ImageDrawable class. + +```csharp +public ImageDrawable(string url, float width, float height); +``` +#### Parameters + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the image file. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the image. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the image. +### Properties + + + +## ImageDrawable.Height Property + +Gets or sets the height of the image. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageDrawable.Url Property + +Gets or sets the URL of the image file. + +```csharp +public string Url { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageDrawable.Width Property + +Gets or sets the width of the image. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LineTo.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LineTo.md new file mode 100644 index 0000000000..4b59d2f855 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LineTo.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## LineTo Class + +Represents a command to add a line from the last point to the specified point. + +```csharp +public class LineTo : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 LineTo + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## LineTo(float, float) Constructor + +Add a line from the last point to the specified point. + +```csharp +public LineTo(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end of a line. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end of a line. +### Properties + + + +## LineTo.X Property + +Gets the x-coordinate of the end of a line. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## LineTo.Y Property + +Gets the y-coordinate of the end of a line. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LinearGradientPaint.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LinearGradientPaint.md new file mode 100644 index 0000000000..6cba14d941 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LinearGradientPaint.md @@ -0,0 +1,135 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## LinearGradientPaint Class + +Represents a linear gradient paint object. + +```csharp +public class LinearGradientPaint : Tizen.UI.Primitives2D.GradientPaint +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [GradientPaint](Tizen.UI.Primitives2D.GradientPaint.md 'Tizen.UI.Primitives2D.GradientPaint') 🡒 LinearGradientPaint +### Constructors + + + +## LinearGradientPaint() Constructor + +Initializes a new instance of the [LinearGradient](https://docs.microsoft.com/en-us/dotnet/api/LinearGradient 'LinearGradient') class. + +```csharp +public LinearGradientPaint(); +``` + + + +## LinearGradientPaint(float, float, float, float) Constructor + +Initializes a new instance of the [LinearGradientPaint](Tizen.UI.Primitives2D.LinearGradientPaint.md 'Tizen.UI.Primitives2D.LinearGradientPaint') class with the specified start and end points. + +```csharp +public LinearGradientPaint(float startPointX, float startPointY, float endPointX, float endPointY); +``` +#### Parameters + + + +`startPointX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the start point. + + + +`startPointY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the start point. + + + +`endPointX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end point. + + + +`endPointY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end point. +### Properties + + + +## LinearGradientPaint.EndPoint Property + +Gets or sets the end point of the linear gradient. + +```csharp +public Tizen.UI.Point EndPoint { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## LinearGradientPaint.StartPoint Property + +Gets or sets the start point of the linear gradient. + +```csharp +public Tizen.UI.Point StartPoint { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.MoveTo.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.MoveTo.md new file mode 100644 index 0000000000..adaa15e070 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.MoveTo.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## MoveTo Class + +Represents a command that sets the beginning of the next contour to the specified point. + +```csharp +public class MoveTo : +Tizen.UI.Primitives2D.IPath +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MoveTo + +Implements [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +### Constructors + + + +## MoveTo(float, float) Constructor + +Set the beginning of the next contour to the point. + +```csharp +public MoveTo(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the start of a new contour. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the start of a new contour. +### Properties + + + +## MoveTo.X Property + +Gets the x-coordinate of the start of a new contour. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## MoveTo.Y Property + +Gets the y-coordinate of the start of a new contour. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Path.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Path.md new file mode 100644 index 0000000000..2e0f1d4026 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Path.md @@ -0,0 +1,349 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Path Class + +Provides a set of static methods for creating [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') objects. + +```csharp +public static class Path +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Path +### Methods + + + +## Path.ArcTo(float, float, float, float, float, bool) Method + +Appends the specified arc to the path. + +```csharp +public static Tizen.UI.Primitives2D.IPath ArcTo(float x, float y, float radius, float startAngle, float sweep, bool closed); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end point of the arc. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end point of the arc. + + + +`radius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the arc. + + + +`startAngle` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The starting angle of the arc, in radians. + + + +`sweep` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of the arc, in radians. + + + +`closed` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the arc should be connected to the start point by a straight line. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +An [MovArcToeTo](https://docs.microsoft.com/en-us/dotnet/api/MovArcToeTo 'MovArcToeTo') object. + + + +## Path.BezierTo(float, float, float, float, float, float) Method + +Draws a Bezier curve to the specified point. + +```csharp +public static Tizen.UI.Primitives2D.IPath BezierTo(float endPointX, float endPointY, float controlPoint1X, float controlPoint1Y, float controlPoint2X, float controlPoint2Y); +``` +#### Parameters + + + +`endPointX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end point. + + + +`endPointY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end point. + + + +`controlPoint1X` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the first control point. + + + +`controlPoint1Y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the first control point. + + + +`controlPoint2X` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the second control point. + + + +`controlPoint2Y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the second control point. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [BezierTo(float, float, float, float, float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.BezierTo(float,float,float,float,float,float) 'Tizen.UI.Primitives2D.Path.BezierTo(float, float, float, float, float, float)') object. + + + +## Path.Close() Method + +Closes this context and flushes its content so that it can be rendered. + +```csharp +public static Tizen.UI.Primitives2D.IPath Close(); +``` + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [Close()](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.Close() 'Tizen.UI.Primitives2D.Path.Close()') object. + + + +## Path.DrawCircle(float, float, float) Method + +Draws a circle on the canvas. + +```csharp +public static Tizen.UI.Primitives2D.IPath DrawCircle(float centerX, float centerY, float radius); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +`radius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [DrawCircle(float, float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.DrawCircle(float,float,float) 'Tizen.UI.Primitives2D.Path.DrawCircle(float, float, float)') object. + + + +## Path.DrawOval(float, float, float, float) Method + +Draws an oval on the canvas. + +```csharp +public static Tizen.UI.Primitives2D.IPath DrawOval(float centerX, float centerY, float radiusX, float radiusY); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the center of the oval. + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the center of the oval. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-radius of the oval. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-radius of the oval. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [DrawOval(float, float, float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.DrawOval(float,float,float,float) 'Tizen.UI.Primitives2D.Path.DrawOval(float, float, float, float)') object. + + + +## Path.DrawRoundRect(float, float, float, float, float, float) Method + +Draws a rounded rectangle. + +```csharp +public static Tizen.UI.Primitives2D.IPath DrawRoundRect(float x, float y, float width, float height, float radiusX, float radiusY); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the rectangle. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-radius of the rounded corners. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-radius of the rounded corners. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [DrawRoundRect(float, float, float, float, float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.DrawRoundRect(float,float,float,float,float,float) 'Tizen.UI.Primitives2D.Path.DrawRoundRect(float, float, float, float, float, float)') object. + + + +## Path.LineTo(float, float) Method + +Add a line from the last point to the specified point. + +```csharp +public static Tizen.UI.Primitives2D.IPath LineTo(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the end of a line. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the end of a line. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [LineTo(float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.LineTo(float,float) 'Tizen.UI.Primitives2D.Path.LineTo(float, float)') object. + + + +## Path.MoveTo(float, float) Method + +Set the beginning of the next contour to the point. + +```csharp +public static Tizen.UI.Primitives2D.IPath MoveTo(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the start of a new contour. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the start of a new contour. + +#### Returns +[IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') +A [MoveTo(float, float)](Tizen.UI.Primitives2D.Path.md#Tizen.UI.Primitives2D.Path.MoveTo(float,float) 'Tizen.UI.Primitives2D.Path.MoveTo(float, float)') object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RadialGradientPaint.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RadialGradientPaint.md new file mode 100644 index 0000000000..800daabfea --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RadialGradientPaint.md @@ -0,0 +1,129 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## RadialGradientPaint Class + +Represents a radial gradient paint object. + +```csharp +public class RadialGradientPaint : Tizen.UI.Primitives2D.GradientPaint +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [GradientPaint](Tizen.UI.Primitives2D.GradientPaint.md 'Tizen.UI.Primitives2D.GradientPaint') 🡒 RadialGradientPaint +### Constructors + + + +## RadialGradientPaint() Constructor + +Initializes a new instance of the [RadialGradientPaint](Tizen.UI.Primitives2D.RadialGradientPaint.md 'Tizen.UI.Primitives2D.RadialGradientPaint') class. + +```csharp +public RadialGradientPaint(); +``` + + + +## RadialGradientPaint(float, float, float) Constructor + +Initializes a new instance of the [RadialGradientPaint](Tizen.UI.Primitives2D.RadialGradientPaint.md 'Tizen.UI.Primitives2D.RadialGradientPaint') class with the specified center point and radius. + +```csharp +public RadialGradientPaint(float centerX, float centerY, float radius); +``` +#### Parameters + + + +`centerX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the center point. + + + +`centerY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the center point. + + + +`radius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the radial gradient. +### Properties + + + +## RadialGradientPaint.Center Property + +Gets or sets the center point of the radial gradient. + +```csharp +public Tizen.UI.Point Center { get; set; } +``` + +#### Property Value +Tizen.UI.Point + + + +## RadialGradientPaint.Radius Property + +Gets or sets the radius of the radial gradient. + +```csharp +public float Radius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Rectangle.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Rectangle.md new file mode 100644 index 0000000000..dbdfd88545 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Rectangle.md @@ -0,0 +1,151 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Rectangle Class + +Represents a rectangle shape. + +```csharp +public class Rectangle : Tizen.UI.Primitives2D.Shape +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') 🡒 Rectangle +### Constructors + + + +## Rectangle(float, float, float, float) Constructor + +Initializes a new instance of the [Rectangle](Tizen.UI.Primitives2D.Rectangle.md 'Tizen.UI.Primitives2D.Rectangle') class. + +```csharp +public Rectangle(float x, float y, float width, float height); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the rectangle. +### Properties + + + +## Rectangle.Height Property + +Gets or sets the height of the rectangle. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rectangle.Width Property + +Gets or sets the width of the rectangle. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rectangle.X Property + +Gets or sets the x-coordinate of the upper-left corner of the rectangle. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rectangle.Y Property + +Gets or sets the y-coordinate of the upper-left corner of the rectangle. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RoundRectangle.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RoundRectangle.md new file mode 100644 index 0000000000..e4804f4423 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RoundRectangle.md @@ -0,0 +1,189 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## RoundRectangle Class + +Represents a round rectangle shape. + +```csharp +public class RoundRectangle : Tizen.UI.Primitives2D.Shape +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') 🡒 RoundRectangle +### Constructors + + + +## RoundRectangle(float, float, float, float, float, float) Constructor + +Initializes a new instance of the RoundRectangle class with the specified position, size, and corner radius. + +```csharp +public RoundRectangle(float x, float y, float width, float height, float radiusX, float radiusY); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the round rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the round rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the round rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the round rectangle. + + + +`radiusX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-radius of the round rectangle. + + + +`radiusY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-radius of the round rectangle. +### Properties + + + +## RoundRectangle.Height Property + +Gets or sets the height of the round rectangle. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundRectangle.RadiusX Property + +Gets or sets the x-radius of the round rectangle. + +```csharp +public float RadiusX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundRectangle.RadiusY Property + +Gets or sets the y-radius of the round rectangle. + +```csharp +public float RadiusY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundRectangle.Width Property + +Gets or sets the width of the round rectangle. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundRectangle.X Property + +Gets or sets the x-coordinate of the upper-left corner of the round rectangle. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundRectangle.Y Property + +Gets or sets the y-coordinate of the upper-left corner of the round rectangle. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Shape.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Shape.md new file mode 100644 index 0000000000..a2511566ab --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Shape.md @@ -0,0 +1,103 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## Shape Class + +Provides a base class for shape elements. + +```csharp +public abstract class Shape : Tizen.UI.Primitives2D.Drawable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') 🡒 Shape + +Derived +↳ [CustomShape](Tizen.UI.Primitives2D.CustomShape.md 'Tizen.UI.Primitives2D.CustomShape') +↳ [Ellipse](Tizen.UI.Primitives2D.Ellipse.md 'Tizen.UI.Primitives2D.Ellipse') +↳ [Rectangle](Tizen.UI.Primitives2D.Rectangle.md 'Tizen.UI.Primitives2D.Rectangle') +↳ [RoundRectangle](Tizen.UI.Primitives2D.RoundRectangle.md 'Tizen.UI.Primitives2D.RoundRectangle') +### Methods + + + +## Shape.Fill(IPaint) Method + +Fills the shape using the specified [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint'). + +```csharp +public void Fill(Tizen.UI.Primitives2D.IPaint paint); +``` +#### Parameters + + + +`paint` [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint') + +The paint object used to fill the shape. + + + +## Shape.Stroke(IPaint) Method + +Strokes the shape using the specified [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint'). + +```csharp +public void Stroke(Tizen.UI.Primitives2D.IPaint paint); +``` +#### Parameters + + + +`paint` [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint') + +The paint object used to stroke the shape. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SolidPaint.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SolidPaint.md new file mode 100644 index 0000000000..201e3c2bef --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SolidPaint.md @@ -0,0 +1,220 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## SolidPaint Class + +Represents a solid paint object used for drawing shapes. + +```csharp +public class SolidPaint : +Tizen.UI.Primitives2D.IPaint +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SolidPaint + +Implements [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint') +### Constructors + + + +## SolidPaint() Constructor + +Initializes a new instance of the [SolidPaint](Tizen.UI.Primitives2D.SolidPaint.md 'Tizen.UI.Primitives2D.SolidPaint') class. + +```csharp +public SolidPaint(); +``` + + + +## SolidPaint(Color) Constructor + +Initializes a new instance of the [SolidPaint](Tizen.UI.Primitives2D.SolidPaint.md 'Tizen.UI.Primitives2D.SolidPaint') class with the specified color. + +```csharp +public SolidPaint(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` Tizen.UI.Color + +The color of the paint. +### Properties + + + +## SolidPaint.Color Property + +Gets or sets the color of the paint. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## SolidPaint.FillRule Property + +Gets or sets the fill rule used to determine which points are inside or outside the shape. + +```csharp +public Tizen.UI.Primitives2D.FillRule FillRule { get; set; } +``` + +Implements [FillRule](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.FillRule 'Tizen.UI.Primitives2D.IPaint.FillRule') + +#### Property Value +[FillRule](Tizen.UI.Primitives2D.FillRule.md 'Tizen.UI.Primitives2D.FillRule') + + + +## SolidPaint.StrokeCap Property + +Gets or sets the cap style of the stroke. + +```csharp +public Tizen.UI.Primitives2D.StrokeCap StrokeCap { get; set; } +``` + +Implements [StrokeCap](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeCap 'Tizen.UI.Primitives2D.IPaint.StrokeCap') + +#### Property Value +[StrokeCap](Tizen.UI.Primitives2D.StrokeCap.md 'Tizen.UI.Primitives2D.StrokeCap') + + + +## SolidPaint.StrokeDashArray Property + +Gets or sets the dash array of the stroke. + +```csharp +public float[] StrokeDashArray { get; set; } +``` + +Implements [StrokeDashArray](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeDashArray 'Tizen.UI.Primitives2D.IPaint.StrokeDashArray') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + +## SolidPaint.StrokeJoin Property + +Gets or sets the join style of the stroke. + +```csharp +public Tizen.UI.Primitives2D.StrokeJoin StrokeJoin { get; set; } +``` + +Implements [StrokeJoin](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeJoin 'Tizen.UI.Primitives2D.IPaint.StrokeJoin') + +#### Property Value +[StrokeJoin](Tizen.UI.Primitives2D.StrokeJoin.md 'Tizen.UI.Primitives2D.StrokeJoin') + + + +## SolidPaint.StrokeWidth Property + +Gets or sets the width of the stroke. + +```csharp +public float StrokeWidth { get; set; } +``` + +Implements [StrokeWidth](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.StrokeWidth 'Tizen.UI.Primitives2D.IPaint.StrokeWidth') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## SolidPaint.Fill(Shape) Method + +Fills the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') with the paint. + +```csharp +public void Fill(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to fill. + +Implements [Fill(Shape)](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.Fill(Tizen.UI.Primitives2D.Shape) 'Tizen.UI.Primitives2D.IPaint.Fill(Tizen.UI.Primitives2D.Shape)') + + + +## SolidPaint.Stroke(Shape) Method + +Strokes the specified [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') with the paint. + +```csharp +public void Stroke(Tizen.UI.Primitives2D.Shape shape); +``` +#### Parameters + + + +`shape` [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') + +The shape to stroke. + +Implements [Stroke(Shape)](Tizen.UI.Primitives2D.IPaint.md#Tizen.UI.Primitives2D.IPaint.Stroke(Tizen.UI.Primitives2D.Shape) 'Tizen.UI.Primitives2D.IPaint.Stroke(Tizen.UI.Primitives2D.Shape)') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SpreadType.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SpreadType.md new file mode 100644 index 0000000000..be3a6f45ac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SpreadType.md @@ -0,0 +1,78 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## SpreadType Enum + +Defines the different methods of spreading the colors of a gradient across its area. + +```csharp +public enum SpreadType +``` +### Fields + + + +`Pad` 0 + +The gradient colors will be distributed evenly across the area, with any remaining space filled with the color of the first color stop. + + + +`Reflect` 1 + +The gradient colors will be reflected at the edge of the area, creating a mirrored pattern. + + + +`Repeat` 2 + +The gradient colors will be repeated in a tiled pattern across the area. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeCap.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeCap.md new file mode 100644 index 0000000000..67979854cb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeCap.md @@ -0,0 +1,78 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## StrokeCap Enum + +Gets or sets a value indicating how the start and end of stroked lines and paths are treated. + +```csharp +public enum StrokeCap +``` +### Fields + + + +`Flat` 2 + +Begin/end contours with no extension. + + + +`Round` 1 + +Begin/end contours with a semi-circle extension. + + + +`Square` 0 + +Begin/end contours with a half square extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeJoin.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeJoin.md new file mode 100644 index 0000000000..209e573f3f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeJoin.md @@ -0,0 +1,78 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## StrokeJoin Enum + +Join style for stroking operations. + +```csharp +public enum StrokeJoin +``` +### Fields + + + +`Bevel` 0 + +Connect path segments with a flat bevel join. + + + +`Miter` 2 + +Connect path segments with a sharp join. + + + +`Round` 1 + +Connect path segments with a round join. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.VectorView.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.VectorView.md new file mode 100644 index 0000000000..edc4156b2e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.VectorView.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D.md 'Tizen.UI.Primitives2D') + +## VectorView Class + +The [VectorView](Tizen.UI.Primitives2D.VectorView.md 'Tizen.UI.Primitives2D.VectorView') class is a Tizen.UI.View that displays a list of drawables. + +```csharp +public class VectorView : Tizen.UI.View +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 VectorView +### Constructors + + + +## VectorView() Constructor + +Creates a new instance of the [VectorView](Tizen.UI.Primitives2D.VectorView.md 'Tizen.UI.Primitives2D.VectorView') class. + +```csharp +public VectorView(); +``` +### Properties + + + +## VectorView.Drawables Property + +Gets the read-only collection of drawables in the vector view. + +```csharp +public System.Collections.Generic.IReadOnlyCollection<Tizen.UI.Primitives2D.Drawable> Drawables { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') +### Methods + + + +## VectorView.Add(Drawable) Method + +Adds a new [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') to the vector view. + +```csharp +public void Add(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to add. + + + +## VectorView.Clear() Method + +Removes all drawables from the vector view. + +```csharp +public void Clear(); +``` + + + +## VectorView.Contains(Drawable) Method + +Checks if the [VectorView](Tizen.UI.Primitives2D.VectorView.md 'Tizen.UI.Primitives2D.VectorView') contains a specific [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable'). + +```csharp +public bool Contains(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the vector view contains the specified drawable, false otherwise. + + + +## VectorView.Remove(Drawable) Method + +Removes a [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') from the vector view. + +```csharp +public void Remove(Tizen.UI.Primitives2D.Drawable drawable); +``` +#### Parameters + + + +`drawable` [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') + +The drawable to remove. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.md b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.md new file mode 100644 index 0000000000..8f8d5e80d0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.md @@ -0,0 +1,90 @@ +## Tizen.UI.Primitives2D Namespace + +| Classes | | +| :--- | :--- | +| [ArcTo](Tizen.UI.Primitives2D.ArcTo.md 'Tizen.UI.Primitives2D.ArcTo') | Represents a command that appends a line and arc to the current path. | +| [BezierTo](Tizen.UI.Primitives2D.BezierTo.md 'Tizen.UI.Primitives2D.BezierTo') | Represents a command that draws a cubic Bezier curve to the current point. | +| [Close](Tizen.UI.Primitives2D.Close.md 'Tizen.UI.Primitives2D.Close') | Represents a command that closes the current subpath by drawing a straight line from the current point to the starting point of the subpath. | +| [CustomShape](Tizen.UI.Primitives2D.CustomShape.md 'Tizen.UI.Primitives2D.CustomShape') | Represents a custom [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape'). | +| [Drawable](Tizen.UI.Primitives2D.Drawable.md 'Tizen.UI.Primitives2D.Drawable') | The Drawable class is an abstract class that provides a base for all drawable objects. | +| [DrawableGroup](Tizen.UI.Primitives2D.DrawableGroup.md 'Tizen.UI.Primitives2D.DrawableGroup') | [DrawableGroup](Tizen.UI.Primitives2D.DrawableGroup.md 'Tizen.UI.Primitives2D.DrawableGroup') is a class that manages a collection of drawables and draws them as a group. | +| [DrawCircle](Tizen.UI.Primitives2D.DrawCircle.md 'Tizen.UI.Primitives2D.DrawCircle') | Represents a command to draw a circle on a shape. | +| [DrawOval](Tizen.UI.Primitives2D.DrawOval.md 'Tizen.UI.Primitives2D.DrawOval') | Represents a command to draw an oval on a shape. | +| [DrawRect](Tizen.UI.Primitives2D.DrawRect.md 'Tizen.UI.Primitives2D.DrawRect') | Represents a command to draw a rectangle. | +| [DrawRoundRect](Tizen.UI.Primitives2D.DrawRoundRect.md 'Tizen.UI.Primitives2D.DrawRoundRect') | Represents a command to draw a rounded rectangle. | +| [Ellipse](Tizen.UI.Primitives2D.Ellipse.md 'Tizen.UI.Primitives2D.Ellipse') | Draws an ellipse. | +| [GradientPaint](Tizen.UI.Primitives2D.GradientPaint.md 'Tizen.UI.Primitives2D.GradientPaint') | Abstract class representing a gradient paint. | +| [ImageDrawable](Tizen.UI.Primitives2D.ImageDrawable.md 'Tizen.UI.Primitives2D.ImageDrawable') | Represents an image element on the screen. | +| [LinearGradientPaint](Tizen.UI.Primitives2D.LinearGradientPaint.md 'Tizen.UI.Primitives2D.LinearGradientPaint') | Represents a linear gradient paint object. | +| [LineTo](Tizen.UI.Primitives2D.LineTo.md 'Tizen.UI.Primitives2D.LineTo') | Represents a command to add a line from the last point to the specified point. | +| [MoveTo](Tizen.UI.Primitives2D.MoveTo.md 'Tizen.UI.Primitives2D.MoveTo') | Represents a command that sets the beginning of the next contour to the specified point. | +| [Path](Tizen.UI.Primitives2D.Path.md 'Tizen.UI.Primitives2D.Path') | Provides a set of static methods for creating [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') objects. | +| [RadialGradientPaint](Tizen.UI.Primitives2D.RadialGradientPaint.md 'Tizen.UI.Primitives2D.RadialGradientPaint') | Represents a radial gradient paint object. | +| [Rectangle](Tizen.UI.Primitives2D.Rectangle.md 'Tizen.UI.Primitives2D.Rectangle') | Represents a rectangle shape. | +| [RoundRectangle](Tizen.UI.Primitives2D.RoundRectangle.md 'Tizen.UI.Primitives2D.RoundRectangle') | Represents a round rectangle shape. | +| [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') | Provides a base class for shape elements. | +| [SolidPaint](Tizen.UI.Primitives2D.SolidPaint.md 'Tizen.UI.Primitives2D.SolidPaint') | Represents a solid paint object used for drawing shapes. | +| [VectorView](Tizen.UI.Primitives2D.VectorView.md 'Tizen.UI.Primitives2D.VectorView') | The [VectorView](Tizen.UI.Primitives2D.VectorView.md 'Tizen.UI.Primitives2D.VectorView') class is a Tizen.UI.View that displays a list of drawables. | + +| Interfaces | | +| :--- | :--- | +| [IPaint](Tizen.UI.Primitives2D.IPaint.md 'Tizen.UI.Primitives2D.IPaint') | Interface for defining paint objects used to draw shapes on a canvas. | +| [IPath](Tizen.UI.Primitives2D.IPath.md 'Tizen.UI.Primitives2D.IPath') | Defines a command that can be executed on a [Shape](Tizen.UI.Primitives2D.Shape.md 'Tizen.UI.Primitives2D.Shape') object. | + +| Enums | | +| :--- | :--- | +| [FillRule](Tizen.UI.Primitives2D.FillRule.md 'Tizen.UI.Primitives2D.FillRule') | Possible path fill type values. | +| [SpreadType](Tizen.UI.Primitives2D.SpreadType.md 'Tizen.UI.Primitives2D.SpreadType') | Defines the different methods of spreading the colors of a gradient across its area. | +| [StrokeCap](Tizen.UI.Primitives2D.StrokeCap.md 'Tizen.UI.Primitives2D.StrokeCap') | Gets or sets a value indicating how the start and end of stroked lines and paths are treated. | +| [StrokeJoin](Tizen.UI.Primitives2D.StrokeJoin.md 'Tizen.UI.Primitives2D.StrokeJoin') | Join style for stroking operations. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md new file mode 100644 index 0000000000..feab980993 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md @@ -0,0 +1,326 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Animatable3DPropertyValue<T> Class + +Animatable3DPropertyValue is an abstract class that represents a property value that can be animated in 3D. + +```csharp +public abstract class Animatable3DPropertyValue<T> : +System.IDisposable + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of view that the property value belongs to. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Animatable3DPropertyValue<T> + +Derived +↳ [CustomPropertyValue<T>](Tizen.UI.Scene3D.CustomPropertyValue_T_.md 'Tizen.UI.Scene3D.CustomPropertyValue<T>') +↳ [FieldOfViewPropertyValue<T>](Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md 'Tizen.UI.Scene3D.FieldOfViewPropertyValue<T>') +↳ [OpacityPropertyValue<T>](Tizen.UI.Scene3D.OpacityPropertyValue_T_.md 'Tizen.UI.Scene3D.OpacityPropertyValue<T>') +↳ [OrthographicSizePropertyValue<T>](Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md 'Tizen.UI.Scene3D.OrthographicSizePropertyValue<T>') +↳ [Position3DPropertyValue<T>](Tizen.UI.Scene3D.Position3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Position3DPropertyValue<T>') +↳ [Rotation3DPropertyValue<T>](Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Rotation3DPropertyValue<T>') +↳ [Scale3DPropertyValue<T>](Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Scale3DPropertyValue<T>') +↳ [Size3DPropertyValue<T>](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Size3DPropertyValue<T>') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## Animatable3DPropertyValue<T>.Value Property + +Gets the Tizen.UI.NativeHandle.PropertyValueHandle of the property. + +```csharp +public abstract Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## Animatable3DPropertyValue<T>.CreateCustomValue(string, object, bool) Method + +Creates a new Tizen.UI.CustomPropertyValue object with the given property name and value. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateCustomValue(string propertyName, object value, bool useVector3=false); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the custom property. + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The value of the custom property. + + + +`useVector3` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +#### Returns +Tizen.UI.AnimatablePropertyValue +The new CustomPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateCustomValue(string, PropertyValueHandle) Method + +Creates a new Tizen.UI.CustomPropertyValue object with the given property name and value. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateCustomValue(string propertyName, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the custom property. + + + +`value` Tizen.UI.NativeHandle.PropertyValueHandle + +The value of the custom property. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new CustomPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateOpacityValue(float) Method + +Creates a new Tizen.UI.OpacityPropertyValue object with the given value. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateOpacityValue(float opacity); +``` +#### Parameters + + + +`opacity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The opacity value. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new OpacityPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateOrthographicSizeValue(float) Method + +Creates a new [OrthographicSizePropertyValue](https://docs.microsoft.com/en-us/dotnet/api/OrthographicSizePropertyValue 'OrthographicSizePropertyValue') object with the given value. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateOrthographicSizeValue(float orthographicSize); +``` +#### Parameters + + + +`orthographicSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The orthographic size value. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new OrthographicSizePropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreatePosition3DValue(float, float, float) Method + +Creates a new [Position3DPropertyValue<T>](Tizen.UI.Scene3D.Position3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Position3DPropertyValue<T>') object with the given values. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreatePosition3DValue(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the position. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the position. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the position. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new Position3DPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateScale3DValue(Size3D) Method + +Creates a new [CreateScale3DValue(Size3D)](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.CreateScale3DValue(Tizen.UI.Scene3D.Size3D) 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.CreateScale3DValue(Tizen.UI.Scene3D.Size3D)') object with the given values. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateScale3DValue(Tizen.UI.Scene3D.Size3D scale); +``` +#### Parameters + + + +`scale` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The scale values. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new Scale3DPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateSize3DValue(float, float, float) Method + +Creates a new [Size3DPropertyValue](https://docs.microsoft.com/en-us/dotnet/api/Size3DPropertyValue 'Size3DPropertyValue') object with the given values. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateSize3DValue(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the size. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the size. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the size. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new Size3DPropertyValue object. + + + +## Animatable3DPropertyValue<T>.CreateSize3DValue(Size3D) Method + +Creates a new [Size3DPropertyValue](https://docs.microsoft.com/en-us/dotnet/api/Size3DPropertyValue 'Size3DPropertyValue') object with the given values. + +```csharp +public static Tizen.UI.Scene3D.Animatable3DPropertyValue<T> CreateSize3DValue(Tizen.UI.Scene3D.Size3D size); +``` +#### Parameters + + + +`size` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The size values. + +#### Returns +[Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') +The new Size3DPropertyValue object. + + + +## Animatable3DPropertyValue<T>.Dispose() Method + +Disposes the Animatable3DPropertyValue object. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## Animatable3DPropertyValue<T>.GetTargetProperty(T) Method + +Gets the Tizen.UI.NativeHandle.AnimatablePropertyHandle for the animation. + +```csharp +public abstract Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md#Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>.T') + +The view to which the property belongs. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The target property handle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animation3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animation3D.md new file mode 100644 index 0000000000..5aabd50866 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animation3D.md @@ -0,0 +1,182 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Animation3D Class + +[Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') class provides a way to animate [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject')s in 3D space. + +```csharp +public class Animation3D : Tizen.UI.Animation +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.Animation 🡒 Animation3D +### Constructors + + + +## Animation3D() Constructor + +Initializes a new instance of the Animation3D class. + +```csharp +public Animation3D(); +``` + + + +## Animation3D(IntPtr, bool) Constructor + +Initializes a new instance of the Animation3D class with specified handle. + +```csharp +public Animation3D(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the native Animation3D object. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the new instance owns the handle. +### Methods + + + +## Animation3D.AnimateBy<T>(T, Animatable3DPropertyValue<T>, int, int, AlphaFunction) Method + +Animates the specified property of the target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') by the specified value. + +```csharp +public void AnimateBy<T>(T target, Tizen.UI.Scene3D.Animatable3DPropertyValue<T> prop, int delayMs, int durationMs, Tizen.UI.AlphaFunction alpha=null) + where T : Tizen.UI.Scene3D.SceneObject; +``` +#### Type parameters + + + +`T` + +The type of the target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject'). +#### Parameters + + + +`target` [T](Tizen.UI.Scene3D.Animation3D.md#Tizen.UI.Scene3D.Animation3D.AnimateBy_T_(T,Tizen.UI.Scene3D.Animatable3DPropertyValue_T_,int,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Scene3D.Animation3D.AnimateBy<T>(T, Tizen.UI.Scene3D.Animatable3DPropertyValue<T>, int, int, Tizen.UI.AlphaFunction).T') + +The target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') to animate. + + + +`prop` [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animation3D.md#Tizen.UI.Scene3D.Animation3D.AnimateBy_T_(T,Tizen.UI.Scene3D.Animatable3DPropertyValue_T_,int,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Scene3D.Animation3D.AnimateBy<T>(T, Tizen.UI.Scene3D.Animatable3DPropertyValue<T>, int, int, Tizen.UI.AlphaFunction).T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') + +The property to animate. + + + +`delayMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The delay before the animation starts, in milliseconds. + + + +`durationMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation, in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function to apply to the animation. + + + +## Animation3D.AnimateTo<T>(T, Animatable3DPropertyValue<T>, int, int, AlphaFunction) Method + +Animates the specified property of the target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') to the specified value. + +```csharp +public void AnimateTo<T>(T target, Tizen.UI.Scene3D.Animatable3DPropertyValue<T> prop, int delayMs, int durationMs, Tizen.UI.AlphaFunction alpha=null) + where T : Tizen.UI.Scene3D.SceneObject; +``` +#### Type parameters + + + +`T` + +The type of the target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject'). +#### Parameters + + + +`target` [T](Tizen.UI.Scene3D.Animation3D.md#Tizen.UI.Scene3D.Animation3D.AnimateTo_T_(T,Tizen.UI.Scene3D.Animatable3DPropertyValue_T_,int,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Scene3D.Animation3D.AnimateTo<T>(T, Tizen.UI.Scene3D.Animatable3DPropertyValue<T>, int, int, Tizen.UI.AlphaFunction).T') + +The target [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') to animate. + + + +`prop` [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Animation3D.md#Tizen.UI.Scene3D.Animation3D.AnimateTo_T_(T,Tizen.UI.Scene3D.Animatable3DPropertyValue_T_,int,int,Tizen.UI.AlphaFunction).T 'Tizen.UI.Scene3D.Animation3D.AnimateTo<T>(T, Tizen.UI.Scene3D.Animatable3DPropertyValue<T>, int, int, Tizen.UI.AlphaFunction).T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') + +The property to animate. + + + +`delayMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The delay before the animation starts, in milliseconds. + + + +`durationMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation, in milliseconds. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function to apply to the animation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Camera.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Camera.md new file mode 100644 index 0000000000..4e3ecc6a1b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Camera.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Camera Class + +Represents a camera that projects a 3D scene onto a 2D surface. + +```csharp +public class Camera : Tizen.UI.Scene3D.SceneObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 Camera +### Constructors + + + +## Camera() Constructor + +Initializes a new instance of the ProjectionCamera class with default settings. + +```csharp +public Camera(); +``` +### Properties + + + +## Camera.AspectRatio Property + +Gets or sets the aspect ratio of the camera. + +```csharp +public float AspectRatio { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Camera.FarPlaneDistance Property + +Gets or sets the distance of the far plane of the camera. + +```csharp +public float FarPlaneDistance { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Camera.FieldOfView Property + +Gets or sets the field of view of the camera, in degrees. + +```csharp +public float FieldOfView { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Camera.NearPlaneDistance Property + +Gets or sets the distance of the near plane of the camera. + +```csharp +public float NearPlaneDistance { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Camera.OrthographicSize Property + +Gets or sets the size of the camera's viewing box. + +```csharp +public float OrthographicSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Camera.ProjectionDirection Property + +Gets or sets the projection direction of the camera. + +```csharp +public Tizen.UI.Scene3D.ProjectionDirection ProjectionDirection { get; set; } +``` + +#### Property Value +[ProjectionDirection](Tizen.UI.Scene3D.ProjectionDirection.md 'Tizen.UI.Scene3D.ProjectionDirection') + + + +## Camera.UseOrthographicProjection Property + +Gets or sets whether camera uses orthographic projection mode. +UseOrthographicProjection defines how the camera shows 3D objects or scene on a 2D plane with projection. + +```csharp +public bool UseOrthographicProjection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CameraExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CameraExtensions.md new file mode 100644 index 0000000000..308f35e6e3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CameraExtensions.md @@ -0,0 +1,115 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## CameraExtensions Class + +Provides extension methods for the Camera class. + +```csharp +public static class CameraExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 CameraExtensions +### Methods + + + +## CameraExtensions.ConvertFovFromHorizontalToVertical(this Camera, float, float) Method + +Converts the horizontal field of view (FOV) to a vertical FOV based on the given aspect ratio. + +```csharp +public static float ConvertFovFromHorizontalToVertical(this Tizen.UI.Scene3D.Camera camera, float aspect, float fieldOfView); +``` +#### Parameters + + + +`camera` [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + +The camera object. + + + +`aspect` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The aspect ratio of the camera. + + + +`fieldOfView` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal field of view in radians. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The vertical field of view in radians. + + + +## CameraExtensions.ConvertFovFromVerticalToHorizontal(this Camera, float, float) Method + +Converts the vertical field of view (FOV) to a horizontal FOV based on the given aspect ratio. + +```csharp +public static float ConvertFovFromVerticalToHorizontal(this Tizen.UI.Scene3D.Camera camera, float aspect, float fieldOfView); +``` +#### Parameters + + + +`camera` [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + +The camera object. + + + +`aspect` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The aspect ratio of the camera. + + + +`fieldOfView` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical field of view in radians. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The horizontal field of view in radians. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CustomPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CustomPropertyValue_T_.md new file mode 100644 index 0000000000..2591f79767 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CustomPropertyValue_T_.md @@ -0,0 +1,117 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## CustomPropertyValue<T> Class + +Represents a custom property value that can be animated in 3D. + +```csharp +public class CustomPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of the object. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.CustomPropertyValue_T_.md#Tizen.UI.Scene3D.CustomPropertyValue_T_.T 'Tizen.UI.Scene3D.CustomPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 CustomPropertyValue<T> +### Constructors + + + +## CustomPropertyValue(string, PropertyValueHandle) Constructor + +Initializes a new instance of the Tizen.UI.CustomPropertyValue class. + +```csharp +public CustomPropertyValue(string propertyName, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property. + + + +`value` Tizen.UI.NativeHandle.PropertyValueHandle + +The value of the property. +### Properties + + + +## CustomPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## CustomPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property handle for the specified view. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.CustomPropertyValue_T_.md#Tizen.UI.Scene3D.CustomPropertyValue_T_.T 'Tizen.UI.Scene3D.CustomPropertyValue<T>.T') + +The view. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The target property handle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md new file mode 100644 index 0000000000..d2732bd4f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md @@ -0,0 +1,124 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## FieldOfViewPropertyValue<T> Class + +Represents a property value for a field of view animation. + +```csharp +public class FieldOfViewPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of the view to which the property value will be applied. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md#Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.T 'Tizen.UI.Scene3D.FieldOfViewPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 FieldOfViewPropertyValue<T> +### Constructors + + + +## FieldOfViewPropertyValue(float) Constructor + +Initializes a new instance of the [FieldOfViewPropertyValue<T>](Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md 'Tizen.UI.Scene3D.FieldOfViewPropertyValue<T>') class. + +```csharp +public FieldOfViewPropertyValue(float fieldOfView); +``` +#### Parameters + + + +`fieldOfView` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The field of view value in degrees. +### Properties + + + +## FieldOfViewPropertyValue<T>.FieldOfView Property + +Gets the field of view value in degrees. + +```csharp +public float FieldOfView { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## FieldOfViewPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## FieldOfViewPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md#Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.T 'Tizen.UI.Scene3D.FieldOfViewPropertyValue<T>.T') + +The view to which the property value will be applied. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The handle of the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.IMotionData.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.IMotionData.md new file mode 100644 index 0000000000..63f4218ea5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.IMotionData.md @@ -0,0 +1,63 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## IMotionData Interface + +The IMotionData interface defines the methods required for a model motion definition. + +```csharp +public interface IMotionData +``` + +Derived +↳ [MotionData](Tizen.UI.Scene3D.MotionData.md 'Tizen.UI.Scene3D.MotionData') +### Methods + + + +## IMotionData.CreateNativeHandle() Method + +Creates a native handle of motion data. + +```csharp +Tizen.UI.Scene3D.NativeHandle.MotionDataHandle CreateNativeHandle(); +``` + +#### Returns +[MotionDataHandle](Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md 'Tizen.UI.Scene3D.NativeHandle.MotionDataHandle') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Light.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Light.md new file mode 100644 index 0000000000..0f51d2dc25 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Light.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Light Class + +Light object that projects its effect along a specific direction. + +```csharp +public class Light : Tizen.UI.Scene3D.SceneObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 Light +### Constructors + + + +## Light() Constructor + +Creates an instance of a light source in a 3D scene. + +```csharp +public Light(); +``` +### Properties + + + +## Light.IsShadowEnabled Property + +Gets or sets a value that indicates whether the light enable shadow or not. + +```csharp +public bool IsShadowEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Light.IsShadowSoftFilteringEnabled Property + +Gets or sets a value that indicates whether the shadow edge soften or not. + +```csharp +public bool IsShadowSoftFilteringEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Light.MultipliedColor Property + +Gets or sets the multiplied color of the light. + +```csharp +public Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Material.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Material.md new file mode 100644 index 0000000000..dbd59bc233 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Material.md @@ -0,0 +1,178 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Material Class + +Class for setting Material properties of 3D models. + +```csharp +public class Material : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Material +### Constructors + + + +## Material() Constructor + +Create an initialized Material. + +```csharp +public Material(); +``` +### Properties + + + +## Material.AlphaMode Property + +Property for the alpha blending mode of the material. + +```csharp +public Tizen.UI.Scene3D.MaterialAlphaMode AlphaMode { get; set; } +``` + +#### Property Value +[MaterialAlphaMode](Tizen.UI.Scene3D.MaterialAlphaMode.md 'Tizen.UI.Scene3D.MaterialAlphaMode') + + + +## Material.BaseColorFactor Property + +Property for the base color factor of the material. + +```csharp +public Tizen.UI.Color BaseColorFactor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Material.BaseColorUrl Property + +Property for the URL of the base color texture. + +```csharp +public string BaseColorUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Material.MetallicFactor Property + +Property for the metallic factor of the material. + +```csharp +public float MetallicFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Material.MetallicRoughnessUrl Property + +Property for the URL of the metallic roughness texture. + +```csharp +public string MetallicRoughnessUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Material.Name Property + +The name of the Material. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Material.NormalScale Property + +Property for the scale of the normal texture. + +```csharp +public float NormalScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Material.NormalUrl Property + +Property for the URL of the normal texture. + +```csharp +public string NormalUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Material.RoughnessFactor Property + +Property for the roughness factor of the material. + +```csharp +public float RoughnessFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MaterialAlphaMode.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MaterialAlphaMode.md new file mode 100644 index 0000000000..d330ea2ecc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MaterialAlphaMode.md @@ -0,0 +1,65 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## MaterialAlphaMode Enum + +MaterialAlphaMode is enum for Material's AlphaMode + +```csharp +public enum MaterialAlphaMode +``` +### Fields + + + +`Blend` 2 + +This indicates that the material is transparent and that the alpha value should be used to blend the material with the background. + + + +`Mask` 1 + +This indicates that the material is either fully opaque or fully transparent depending on the alpha value. The alpha value is used to mask out areas of the material that should be transparent. + + + +`Opaque` 0 + +This indicates that the material is fully opaque and that the alpha value should be ignored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3D.md new file mode 100644 index 0000000000..623ca0ff08 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3D.md @@ -0,0 +1,282 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Model3D Class + +Provides functionality for 3-D models. + +```csharp +public class Model3D : Tizen.UI.Scene3D.SceneObjectGroup<Tizen.UI.Scene3D.SceneObject> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 [Tizen.UI.Scene3D.SceneObjectGroup<](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>')[SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject')[>](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>') 🡒 Model3D +### Constructors + + + +## Model3D() Constructor + +Initializes a new instance of the Model3D class. + +```csharp +public Model3D(); +``` + + + +## Model3D(string, string) Constructor + +Initializes a new instance of the Model3D class with a specified model URL and resource directory URL. + +```csharp +public Model3D(string modelUrl, string resourceDirectoryUrl=""); +``` +#### Parameters + + + +`modelUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the model file. + + + +`resourceDirectoryUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the directory containing the model's resources. +### Properties + + + +## Model3D.IsResourceReady Property + +Queries if all resources required by a Model3D are loaded and ready. + +```csharp +public bool IsResourceReady { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Model3D.MultipliedColor Property + +Gets or sets the multiplied color of the model. + +```csharp +public Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## Model3D.RootNode Property + +Retrieves root ModelNode of this Model. + +```csharp +public Tizen.UI.Scene3D.ModelNode RootNode { get; } +``` + +#### Property Value +[ModelNode](Tizen.UI.Scene3D.ModelNode.md 'Tizen.UI.Scene3D.ModelNode') +### Methods + + + +## Model3D.ApplyCamera(int, Camera) Method + +Applies the camera at the specified index to the specified camera. + +```csharp +public bool ApplyCamera(int index, Tizen.UI.Scene3D.Camera camera); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the camera to apply. + + + +`camera` [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + +The camera to apply the camera to. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the camera was applied successfully, false otherwise. + + + +## Model3D.GetAnimation(int) Method + +Gets the animation at the specified index. + +```csharp +public Tizen.UI.Scene3D.Animation3D GetAnimation(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the animation. + +#### Returns +[Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') +The animation at the specified index. + + + +## Model3D.GetAnimation(string) Method + +Gets the animation at the specified name. + +```csharp +public Tizen.UI.Scene3D.Animation3D GetAnimation(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the animation. + +#### Returns +[Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') +The animation at the specified name. + + + +## Model3D.GetAnimationCount() Method + +Gets the number of animations in the model. + +```csharp +public int GetAnimationCount(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The number of animations in the model. + + + +## Model3D.GetCameraCount() Method + +Gets the number of cameras in the model. + +```csharp +public int GetCameraCount(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The number of cameras in the model. + + + +## Model3D.LoadMotionDataAnimation(IMotionData) Method + +Generate animation by MotionData. + +```csharp +public Tizen.UI.Scene3D.Animation3D LoadMotionDataAnimation(Tizen.UI.Scene3D.IMotionData motionData); +``` +#### Parameters + + + +`motionData` [IMotionData](Tizen.UI.Scene3D.IMotionData.md 'Tizen.UI.Scene3D.IMotionData') + +Source motion data. + +#### Returns +[Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') +Generated animation from then given motion data, or null if there is no animatable item in [motionData](Tizen.UI.Scene3D.Model3D.md#Tizen.UI.Scene3D.Model3D.LoadMotionDataAnimation(Tizen.UI.Scene3D.IMotionData).motionData 'Tizen.UI.Scene3D.Model3D.LoadMotionDataAnimation(Tizen.UI.Scene3D.IMotionData).motionData') +### Events + + + +## Model3D.KeyEvent Event + +Occurs when a key event is received by the Model3D. + +```csharp +public event EventHandler<KeyEventArgs> KeyEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.KeyEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Model3D.ResourceReady Event + +Occurs when the resources required by the model are ready. + +```csharp +public event EventHandler ResourceReady; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Model3D.TouchEvent Event + +Occurs when a touch event is received by the scene object. + +```csharp +public event EventHandler<TouchEventArgs> TouchEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')Tizen.UI.TouchEventArgs[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3DExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3DExtensions.md new file mode 100644 index 0000000000..9c790a9ee1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3DExtensions.md @@ -0,0 +1,67 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Model3DExtensions Class + +```csharp +public static class Model3DExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Model3DExtensions +### Methods + + + +## Model3DExtensions.GetCalculateCurrentScreenRect(this Model3D) Method + +Gets the screen position and size of the model. + +```csharp +public static Tizen.UI.Rect GetCalculateCurrentScreenRect(this Tizen.UI.Scene3D.Model3D model); +``` +#### Parameters + + + +`model` [Model3D](Tizen.UI.Scene3D.Model3D.md 'Tizen.UI.Scene3D.Model3D') + +#### Returns +Tizen.UI.Rect +The rectangle with with position and size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelNode.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelNode.md new file mode 100644 index 0000000000..dac1b1401d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelNode.md @@ -0,0 +1,87 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## ModelNode Class + +ModelNode is a class for representing the Node of Model3D in Scene3D. + +```csharp +public class ModelNode : Tizen.UI.Scene3D.SceneObjectGroup<Tizen.UI.Scene3D.ModelNode> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 [Tizen.UI.Scene3D.SceneObjectGroup<](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>')[ModelNode](Tizen.UI.Scene3D.ModelNode.md 'Tizen.UI.Scene3D.ModelNode')[>](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>') 🡒 ModelNode +### Constructors + + + +## ModelNode() Constructor + +Create an initialized ModelNode. + +```csharp +public ModelNode(); +``` +### Properties + + + +## ModelNode.ModelPrimitives Property + +Gets the list of Model Primitives. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Scene3D.ModelPrimitive> ModelPrimitives { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[ModelPrimitive](Tizen.UI.Scene3D.ModelPrimitive.md 'Tizen.UI.Scene3D.ModelPrimitive')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ModelNode.MultipliedColor Property + +Gets or sets the multiplied color of the ModelNode. + +```csharp +public Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelPrimitive.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelPrimitive.md new file mode 100644 index 0000000000..e495799b19 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelPrimitive.md @@ -0,0 +1,90 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## ModelPrimitive Class + +Class for Model Primitives for 3D Geometry and Material. + +```csharp +public class ModelPrimitive : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 ModelPrimitive +### Constructors + + + +## ModelPrimitive() Constructor + +Create an initialized ModelPrimitive. + +```csharp +public ModelPrimitive(); +``` +### Properties + + + +## ModelPrimitive.Geometry Property + +The Geometry object of the ModelNode object. + +```csharp +public Tizen.UI.Internal.Geometry Geometry { get; set; } +``` + +#### Property Value +Tizen.UI.Internal.Geometry + + + +## ModelPrimitive.Material Property + +The Material object of the ModelNode object. + +```csharp +public Tizen.UI.Scene3D.Material Material { get; set; } +``` + +#### Property Value +[Material](Tizen.UI.Scene3D.Material.md 'Tizen.UI.Scene3D.Material') + +### Remarks +This Material object is for setting Material properties of 3D models. Also, Material can be shared with multiple ModelPrimitives and if the value is modified, the rendering results of all ModelPrimitives using this Material will be changed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData.md new file mode 100644 index 0000000000..90abfdc772 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## MotionData Class + +The MotionData is an abstract class that provides a base for model motion definition. + +```csharp +public abstract class MotionData : +Tizen.UI.Scene3D.IMotionData +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MotionData + +Derived +↳ [MotionData<T>](Tizen.UI.Scene3D.MotionData_T_.md 'Tizen.UI.Scene3D.MotionData<T>') +↳ [MotionDataSet](Tizen.UI.Scene3D.MotionDataSet.md 'Tizen.UI.Scene3D.MotionDataSet') + +Implements [IMotionData](Tizen.UI.Scene3D.IMotionData.md 'Tizen.UI.Scene3D.IMotionData') +### Properties + + + +## MotionData.Duration Property + +Get or set the duration of this motion data in milliseconds. + +```csharp +public int Duration { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## MotionData.CreateNativeHandle() Method + +Creates a native handle of motion data. + +```csharp +public Tizen.UI.Scene3D.NativeHandle.MotionDataHandle CreateNativeHandle(); +``` + +Implements [CreateNativeHandle()](Tizen.UI.Scene3D.IMotionData.md#Tizen.UI.Scene3D.IMotionData.CreateNativeHandle() 'Tizen.UI.Scene3D.IMotionData.CreateNativeHandle()') + +#### Returns +[MotionDataHandle](Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md 'Tizen.UI.Scene3D.NativeHandle.MotionDataHandle') +The native handle of motion data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionDataSet.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionDataSet.md new file mode 100644 index 0000000000..d8a850679e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionDataSet.md @@ -0,0 +1,62 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## MotionDataSet Class + +MotionDataSet contains DataSet which is a list of MotionData. + +```csharp +public class MotionDataSet : Tizen.UI.Scene3D.MotionData +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [MotionData](Tizen.UI.Scene3D.MotionData.md 'Tizen.UI.Scene3D.MotionData') 🡒 MotionDataSet +### Properties + + + +## MotionDataSet.DataSet Property + +List of model motion definitions. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Scene3D.MotionData> DataSet { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[MotionData](Tizen.UI.Scene3D.MotionData.md 'Tizen.UI.Scene3D.MotionData')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData_T_.md new file mode 100644 index 0000000000..40340a1738 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData_T_.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## MotionData<T> Class + +Model motion definition. +MotionData has a pair of [MotionIndex](Tizen.UI.Scene3D.MotionData_T_.md#Tizen.UI.Scene3D.MotionData_T_.MotionIndex 'Tizen.UI.Scene3D.MotionData<T>.MotionIndex') and [MotionValue](Tizen.UI.Scene3D.MotionData_T_.md#Tizen.UI.Scene3D.MotionData_T_.MotionValue 'Tizen.UI.Scene3D.MotionData<T>.MotionValue'). +MotionIndex specifies the target of motion. +MotionValue is destination value of target for the motion. + +```csharp +public class MotionData<T> : Tizen.UI.Scene3D.MotionData +``` +#### Type parameters + + + +`T` + +The type of the destination value. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [MotionData](Tizen.UI.Scene3D.MotionData.md 'Tizen.UI.Scene3D.MotionData') 🡒 MotionData<T> +### Properties + + + +## MotionData<T>.MotionIndex Property + +Index of motion value. It will be used to specify the target of motion applied. + +```csharp +public Tizen.UI.Scene3D.MotionIndex MotionIndex { get; set; } +``` + +#### Property Value +[MotionIndex](Tizen.UI.Scene3D.MotionIndex.md 'Tizen.UI.Scene3D.MotionIndex') + + + +## MotionData<T>.MotionValue Property + +MotionValue is a pair of progress and a destination value. + +```csharp +public System.Collections.Generic.IList<(float progress,T value)> MotionValue { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[T](Tizen.UI.Scene3D.MotionData_T_.md#Tizen.UI.Scene3D.MotionData_T_.T 'Tizen.UI.Scene3D.MotionData<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionIndex.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionIndex.md new file mode 100644 index 0000000000..2aad944caf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionIndex.md @@ -0,0 +1,48 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## MotionIndex Class + +Index of motion value. It will be used to specify the target of motion applied. + +```csharp +public abstract class MotionIndex +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MotionIndex + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md new file mode 100644 index 0000000000..1e81f196fd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## AnimationHandle Class + +Represents a handle to a native Animation object. + +```csharp +public class AnimationHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 AnimationHandle +### Constructors + + + +## AnimationHandle() Constructor + +Initializes a new instance of the AnimationHandle class. + +```csharp +public AnimationHandle(); +``` +### Properties + + + +## AnimationHandle.IsInvalid Property + +Gets a value indicating whether the AnimationHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.CameraHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.CameraHandle.md new file mode 100644 index 0000000000..576685da0b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.CameraHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## CameraHandle Class + +Provides a managed wrapper for the native Camera object. + +```csharp +public class CameraHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 CameraHandle +### Constructors + + + +## CameraHandle() Constructor + +Initializes a new instance of the [CameraHandle](Tizen.UI.Scene3D.NativeHandle.CameraHandle.md 'Tizen.UI.Scene3D.NativeHandle.CameraHandle') class. + +```csharp +public CameraHandle(); +``` +### Properties + + + +## CameraHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md new file mode 100644 index 0000000000..b697429eff --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## MaterialHandle Class + +Represents a handle to a native Material object. + +```csharp +public class MaterialHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 MaterialHandle +### Constructors + + + +## MaterialHandle() Constructor + +Initializes a new instance of the MaterialHandle class. + +```csharp +public MaterialHandle(); +``` +### Properties + + + +## MaterialHandle.IsInvalid Property + +Gets a value indicating whether the MaterialHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md new file mode 100644 index 0000000000..a19fbbe52e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## ModelNodeHandle Class + +Represents a handle to a native ModelNode object. + +```csharp +public class ModelNodeHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 ModelNodeHandle +### Constructors + + + +## ModelNodeHandle() Constructor + +Initializes a new instance of the AnimationHandle class. + +```csharp +public ModelNodeHandle(); +``` +### Properties + + + +## ModelNodeHandle.IsInvalid Property + +Gets a value indicating whether the AnimationHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md new file mode 100644 index 0000000000..0c024c62f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## ModelPrimitiveHandle Class + +Represents a handle to a native ModelPrimitive object. + +```csharp +public class ModelPrimitiveHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 ModelPrimitiveHandle +### Constructors + + + +## ModelPrimitiveHandle() Constructor + +Initializes a new instance of the ModelPrimitiveHandle class. + +```csharp +public ModelPrimitiveHandle(); +``` +### Properties + + + +## ModelPrimitiveHandle.IsInvalid Property + +Gets a value indicating whether the ModelPrimitiveHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md new file mode 100644 index 0000000000..e55241ce62 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## MotionDataHandle Class + +Represents a handle to a native MotionData object. + +```csharp +public class MotionDataHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 MotionDataHandle +### Constructors + + + +## MotionDataHandle() Constructor + +Initializes a new instance of the MotionDataHandle class. + +```csharp +public MotionDataHandle(); +``` +### Properties + + + +## MotionDataHandle.IsInvalid Property + +Gets a value indicating whether the MotionDataHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md new file mode 100644 index 0000000000..b20cc86d79 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## MotionIndexHandle Class + +Represents a handle to a native MotionIndex object. + +```csharp +public class MotionIndexHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 MotionIndexHandle +### Constructors + + + +## MotionIndexHandle() Constructor + +Initializes a new instance of the MotionIndexHandle class. + +```csharp +public MotionIndexHandle(); +``` +### Properties + + + +## MotionIndexHandle.IsInvalid Property + +Gets a value indicating whether the MotionIndexHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md new file mode 100644 index 0000000000..d8c0671689 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md @@ -0,0 +1,73 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## MotionValueHandle Class + +Represents a handle to a native MotionValue object. + +```csharp +public class MotionValueHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 MotionValueHandle +### Constructors + + + +## MotionValueHandle() Constructor + +Initializes a new instance of the MotionValueHandle class. + +```csharp +public MotionValueHandle(); +``` +### Properties + + + +## MotionValueHandle.IsInvalid Property + +Gets a value indicating whether the MotionValueHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md new file mode 100644 index 0000000000..752189fe8d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md @@ -0,0 +1,134 @@ +### [Tizen.UI.Scene3D.NativeHandle](Tizen.UI.Scene3D.NativeHandle.md 'Tizen.UI.Scene3D.NativeHandle') + +## PropertyValueHandleExtensions Class + +Provides extension methods for converting objects to PropertyValue types. + +```csharp +public static class PropertyValueHandleExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PropertyValueHandleExtensions +### Methods + + + +## PropertyValueHandleExtensions.ToValue(this object) Method + +Converts an object to a PropertyValueHandle. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this object value); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to convert. + +#### Returns +Tizen.UI.NativeHandle.PropertyValueHandle +A new PropertyValueHandle containing the converted value. + + + +## PropertyValueHandleExtensions.ToValue(this Point3D) Method + +Extension method for converting a Point3D object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Scene3D.Point3D point3d); +``` +#### Parameters + + + +`point3d` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The Point3D object to be converted. + +#### Returns +Tizen.UI.NativeHandle.PropertyValueHandle +A new PropertyValueHandle object representing the given Point3D. + + + +## PropertyValueHandleExtensions.ToValue(this Quaternion) Method + +Extension method for converting a Quaternion object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Scene3D.Quaternion quaternion); +``` +#### Parameters + + + +`quaternion` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The Quaternion object to be converted. + +#### Returns +Tizen.UI.NativeHandle.PropertyValueHandle +A new PropertyValueHandle object representing the given Quaternion. + + + +## PropertyValueHandleExtensions.ToValue(this Size3D) Method + +Extension method for converting a Size3D object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Scene3D.Size3D size3d); +``` +#### Parameters + + + +`size3d` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The Size3D object to be converted. + +#### Returns +Tizen.UI.NativeHandle.PropertyValueHandle +A new PropertyValueHandle object representing the given Size3D. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.md new file mode 100644 index 0000000000..aff8ed045d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.md @@ -0,0 +1,52 @@ + +## Tizen.UI.Scene3D.NativeHandle Namespace + +| Classes | | +| :--- | :--- | +| [AnimationHandle](Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md 'Tizen.UI.Scene3D.NativeHandle.AnimationHandle') | Represents a handle to a native Animation object. | +| [CameraHandle](Tizen.UI.Scene3D.NativeHandle.CameraHandle.md 'Tizen.UI.Scene3D.NativeHandle.CameraHandle') | Provides a managed wrapper for the native Camera object. | +| [MaterialHandle](Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md 'Tizen.UI.Scene3D.NativeHandle.MaterialHandle') | Represents a handle to a native Material object. | +| [ModelNodeHandle](Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md 'Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle') | Represents a handle to a native ModelNode object. | +| [ModelPrimitiveHandle](Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md 'Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle') | Represents a handle to a native ModelPrimitive object. | +| [MotionDataHandle](Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md 'Tizen.UI.Scene3D.NativeHandle.MotionDataHandle') | Represents a handle to a native MotionData object. | +| [MotionIndexHandle](Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md 'Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle') | Represents a handle to a native MotionIndex object. | +| [MotionValueHandle](Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md 'Tizen.UI.Scene3D.NativeHandle.MotionValueHandle') | Represents a handle to a native MotionValue object. | +| [PropertyValueHandleExtensions](Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md 'Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions') | Provides extension methods for converting objects to PropertyValue types. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OpacityPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OpacityPropertyValue_T_.md new file mode 100644 index 0000000000..6875f05a81 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OpacityPropertyValue_T_.md @@ -0,0 +1,106 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## OpacityPropertyValue<T> Class + +Represents the opacity property value for an [Animatable3DPropertyValue<T>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>'). + +```csharp +public class OpacityPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of the object. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.OpacityPropertyValue_T_.md#Tizen.UI.Scene3D.OpacityPropertyValue_T_.T 'Tizen.UI.Scene3D.OpacityPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 OpacityPropertyValue<T> +### Properties + + + +## OpacityPropertyValue<T>.Opacity Property + +Gets the opacity value. + +```csharp +public float Opacity { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## OpacityPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## OpacityPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.OpacityPropertyValue_T_.md#Tizen.UI.Scene3D.OpacityPropertyValue_T_.T 'Tizen.UI.Scene3D.OpacityPropertyValue<T>.T') + +The view to animate. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The AnimatablePropertyHandle for the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md new file mode 100644 index 0000000000..eda5331da5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md @@ -0,0 +1,124 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## OrthographicSizePropertyValue<T> Class + +Represents a property value for an animatable 3D object that specifies the orthographic size. + +```csharp +public class OrthographicSizePropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of the 3D object. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md#Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.T 'Tizen.UI.Scene3D.OrthographicSizePropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 OrthographicSizePropertyValue<T> +### Constructors + + + +## OrthographicSizePropertyValue(float) Constructor + +Initializes a new instance of the [OrthographicSizePropertyValue<T>](Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md 'Tizen.UI.Scene3D.OrthographicSizePropertyValue<T>') class. + +```csharp +public OrthographicSizePropertyValue(float orthographicSize); +``` +#### Parameters + + + +`orthographicSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The orthographic size. +### Properties + + + +## OrthographicSizePropertyValue<T>.OrthographicSize Property + +Gets the orthographic size. + +```csharp +public float OrthographicSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## OrthographicSizePropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## OrthographicSizePropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md#Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.T 'Tizen.UI.Scene3D.OrthographicSizePropertyValue<T>.T') + +The view to which the property value will be applied. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The handle of the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Panel.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Panel.md new file mode 100644 index 0000000000..86e7ed1af9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Panel.md @@ -0,0 +1,77 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Panel Class + +Panel is a control to show 2D View on 3D Scene. + +```csharp +public class Panel : Tizen.UI.Scene3D.SceneObject, +Tizen.UI.IParentObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 Panel + +Implements Tizen.UI.IParentObject +### Constructors + + + +## Panel() Constructor + +Initializes a new instance of the Panel class. + +```csharp +public Panel(); +``` +### Properties + + + +## Panel.Content Property + +Root View of 2D UI content. + +```csharp +public Tizen.UI.View Content { get; set; } +``` + +#### Property Value +Tizen.UI.View + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Point3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Point3D.md new file mode 100644 index 0000000000..4e07aadf72 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Point3D.md @@ -0,0 +1,365 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Point3D Struct + +Represents a point in 3D space. + +```csharp +public struct Point3D +``` +### Constructors + + + +## Point3D(float, float, float) Constructor + +Initializes a new instance of the [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') struct. + +```csharp +public Point3D(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the point. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the point. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the point. + + + +## Point3D(Size3D) Constructor + +Initializes a new instance of the [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') struct. + +```csharp +public Point3D(Tizen.UI.Scene3D.Size3D sz); +``` +#### Parameters + + + +`sz` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +A [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') representing the size of the point. + + + +## Point3D(Vector3D) Constructor + +Initializes a new instance of the [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') struct. + +```csharp +public Point3D(Tizen.UI.Scene3D.Vector3D v); +``` +#### Parameters + + + +`v` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +A [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') representing the vector of the point. +### Fields + + + +## Point3D.Zero Field + +A point at the origin (0, 0, 0). + +```csharp +public static Point3D Zero; +``` + +#### Field Value +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') +### Properties + + + +## Point3D.IsEmpty Property + +Gets a value indicating whether the point is empty. + +```csharp +public bool IsEmpty { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Point3D.X Property + +The x-coordinate of the point. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Point3D.Y Property + +The y-coordinate of the point. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Point3D.Z Property + +The z-coordinate of the point. + +```csharp +public float Z { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Point3D.Deconstruct(float, float, float) Method + +Deconstructs the Point3D into its individual components (x, y, and z). + +```csharp +public void Deconstruct(out float x, out float y, out float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the point. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the point. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate point. + + + +## Point3D.Distance(Point3D) Method + +Calculates the distance between two points in 3D space. + +```csharp +public double Distance(Tizen.UI.Scene3D.Point3D other); +``` +#### Parameters + + + +`other` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The other point to calculate the distance to. + +#### Returns +[System.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System.Double') +The distance between the two points. + + + +## Point3D.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object o); +``` +#### Parameters + + + +`o` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if obj and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## Point3D.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## Point3D.Offset(float, float, float) Method + +Returns a new [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') that is offset by the specified distances. + +```csharp +public Tizen.UI.Scene3D.Point3D Offset(float dx, float dy, float dz); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The distance to offset the x-coordinate. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The distance to offset the y-coordinate. + + + +`dz` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The distance to offset the z-coordinate. + +#### Returns +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') +A new [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') offset by the specified distances. + + + +## Point3D.Round() Method + +Returns a new [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') with the coordinates rounded to the nearest integer values. + +```csharp +public Tizen.UI.Scene3D.Point3D Round(); +``` + +#### Returns +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') +A new [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') with the coordinates rounded to the nearest integer values. + + + +## Point3D.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. +### Operators + + + +## Point3D.explicit operator Size3D(Point3D) Operator + +Explicitly converts a [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') to a [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D'). + +```csharp +public static Tizen.UI.Scene3D.Size3D explicit operator Size3D(Tizen.UI.Scene3D.Point3D pt); +``` +#### Parameters + + + +`pt` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') to convert. + +#### Returns +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') +A new [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') with the same coordinates as the [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D'). + + + +## Point3D.explicit operator Vector3D(Point3D) Operator + +Explicitly converts a [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') to a [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D'). + +```csharp +public static Tizen.UI.Scene3D.Vector3D explicit operator Vector3D(Tizen.UI.Scene3D.Point3D pt); +``` +#### Parameters + + + +`pt` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') to convert. + +#### Returns +[Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') +A new [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') with the same coordinates as the [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D'). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Position3DPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Position3DPropertyValue_T_.md new file mode 100644 index 0000000000..c0f5daa24d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Position3DPropertyValue_T_.md @@ -0,0 +1,158 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Position3DPropertyValue<T> Class + +```csharp +public class Position3DPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Position3DPropertyValue_T_.md#Tizen.UI.Scene3D.Position3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Position3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 Position3DPropertyValue<T> +### Constructors + + + +## Position3DPropertyValue(float, float, float) Constructor + +Initializes a new instance of the [Position3DPropertyValue](https://docs.microsoft.com/en-us/dotnet/api/Position3DPropertyValue 'Position3DPropertyValue') class. + +```csharp +public Position3DPropertyValue(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the position. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the position. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the position. +### Properties + + + +## Position3DPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle + + + +## Position3DPropertyValue<T>.X Property + +Gets the x-coordinate of the position. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Position3DPropertyValue<T>.Y Property + +Gets the y-coordinate of the position. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Position3DPropertyValue<T>.Z Property + +Gets the z-coordinate of the position. + +```csharp +public float Z { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Position3DPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property of the view. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.Position3DPropertyValue_T_.md#Tizen.UI.Scene3D.Position3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Position3DPropertyValue<T>.T') + +The view. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The target property handle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ProjectionDirection.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ProjectionDirection.md new file mode 100644 index 0000000000..16a57ae34a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ProjectionDirection.md @@ -0,0 +1,59 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## ProjectionDirection Enum + +Enumeration for the direction of projection. + +```csharp +public enum ProjectionDirection +``` +### Fields + + + +`Horizontal` 1 + +Specifies a horizontal projection direction. + + + +`Vertical` 0 + +Specifies a vertical projection direction. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Quaternion.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Quaternion.md new file mode 100644 index 0000000000..1e95a4fe0e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Quaternion.md @@ -0,0 +1,572 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Quaternion Struct + +Represents a vector that is used to encode three-dimensional physical rotations. + +```csharp +public struct Quaternion +``` +### Constructors + + + +## Quaternion(float, float, float, float) Constructor + +Initializes a new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') struct with the specified [X](Tizen.UI.Scene3D.Quaternion.md#Tizen.UI.Scene3D.Quaternion.X 'Tizen.UI.Scene3D.Quaternion.X'), [Y](Tizen.UI.Scene3D.Quaternion.md#Tizen.UI.Scene3D.Quaternion.Y 'Tizen.UI.Scene3D.Quaternion.Y'), [Z](Tizen.UI.Scene3D.Quaternion.md#Tizen.UI.Scene3D.Quaternion.Z 'Tizen.UI.Scene3D.Quaternion.Z') and [W](Tizen.UI.Scene3D.Quaternion.md#Tizen.UI.Scene3D.Quaternion.W 'Tizen.UI.Scene3D.Quaternion.W') components. + +```csharp +public Quaternion(float x, float y, float z, float w); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the vector represented by the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion'). + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the vector represented by the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion'). + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the vector represented by the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion'). + + + +`w` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scalar component of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') that combines with the vector components to form the quaternion. + + + +## Quaternion(Vector3D, float) Constructor + +Initializes a new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') class. + +```csharp +public Quaternion(Tizen.UI.Scene3D.Vector3D axis, float angleInDegree); +``` +#### Parameters + + + +`axis` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The axis around which to rotate. + + + +`angleInDegree` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of rotation, in degrees. +### Fields + + + +## Quaternion.W Field + +The W value of the vector component of the quaternion. + +```csharp +public float W; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Quaternion.X Field + +The X value of the vector component of the quaternion. + +```csharp +public float X; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Quaternion.Y Field + +The Y value of the vector component of the quaternion. + +```csharp +public float Y; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Quaternion.Z Field + +The Z value of the vector component of the quaternion. + +```csharp +public float Z; +``` + +#### Field Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Properties + + + +## Quaternion.Angle Property + +Gets the angle of rotation represented by the vector in degrees. + +```csharp +public float Angle { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Quaternion.Axis Property + +Gets the axis of rotation represented by the vector. + +```csharp +public Tizen.UI.Scene3D.Vector3D Axis { get; } +``` + +#### Property Value +[Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + + + +## Quaternion.Identity Property + +Gets a quaternion that represents no rotation. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Identity { get; } +``` + +#### Property Value +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + + + +## Quaternion.IsIdentity Property + +Gets a value that indicates whether the current instance is the identity quaternion. + +```csharp +public bool IsIdentity { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Quaternion.Length Property + +Gets the length of the vector component of the quaternion. + +```csharp +public float Length { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Quaternion.LengthSquared Property + +Gets the squared length of the vector component of the quaternion. + +```csharp +public float LengthSquared { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Quaternion.Concatenate(Quaternion, Quaternion) Method + +Concatenates two quaternions. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Concatenate(Tizen.UI.Scene3D.Quaternion value1, Tizen.UI.Scene3D.Quaternion value2); +``` +#### Parameters + + + +`value1` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The first [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') to concatenate. + + + +`value2` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The second [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') to concatenate. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +A new [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') that represents the concatenated rotation. + + + +## Quaternion.Conjugate(Quaternion) Method + +Returns the conjugate of a specified quaternion. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Conjugate(Tizen.UI.Scene3D.Quaternion value); +``` +#### Parameters + + + +`value` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') value to conjugate. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The conjugated [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') value. + + + +## Quaternion.CreateFromAxisAngle(Vector3, float) Method + +Creates a quaternion from a unit vector and an angle to rotate around the vector. + +```csharp +public static Tizen.UI.Scene3D.Quaternion CreateFromAxisAngle(System.Numerics.Vector3 axis, float angle); +``` +#### Parameters + + + +`axis` [System.Numerics.Vector3](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector3 'System.Numerics.Vector3') + +The axis around which to rotate. + + + +`angle` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle, in radians, by which to rotate around the axis. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +A new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') class that represents the rotation around the specified axis and angle. + + + +## Quaternion.CreateFromRotationMatrix(Matrix4x4) Method + +Creates a quaternion from the specified rotation matrix. + +```csharp +public static Tizen.UI.Scene3D.Quaternion CreateFromRotationMatrix(System.Numerics.Matrix4x4 matrix); +``` +#### Parameters + + + +`matrix` [System.Numerics.Matrix4x4](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Matrix4x4 'System.Numerics.Matrix4x4') + +The rotation matrix to create the instance from. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +A new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') class representing the specified rotation matrix. + + + +## Quaternion.CreateFromYawPitchRoll(float, float, float) Method + +Creates a new quaternion from the given yaw, pitch, and roll. + +```csharp +public static Tizen.UI.Scene3D.Quaternion CreateFromYawPitchRoll(float yaw, float pitch, float roll); +``` +#### Parameters + + + +`yaw` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The yaw angle, in radians. + + + +`pitch` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The pitch angle, in radians. + + + +`roll` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The roll angle, in radians. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +A new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') class. + + + +## Quaternion.Dot(Quaternion, Quaternion) Method + +Calculates the dot product of two quaternions. + +```csharp +public static float Dot(Tizen.UI.Scene3D.Quaternion quaternion1, Tizen.UI.Scene3D.Quaternion quaternion2); +``` +#### Parameters + + + +`quaternion1` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The first input quaternion. + + + +`quaternion2` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The second input quaternion. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The dot product of the two quaternions. + + + +## Quaternion.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Scene3D.Quaternion.md#Tizen.UI.Scene3D.Quaternion.Equals(object).obj 'Tizen.UI.Scene3D.Quaternion.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## Quaternion.Equals(Quaternion) Method + +Returns a value that indicates whether this instance and a specified Quaternion instance or a specified object are equal. + +```csharp +public bool Equals(Tizen.UI.Scene3D.Quaternion other); +``` +#### Parameters + + + +`other` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The other quaternion. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the specified object is equal to the current instance; otherwise, false. + + + +## Quaternion.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## Quaternion.Inverse(Quaternion) Method + +Returns the inverse of a quaternion. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Inverse(Tizen.UI.Scene3D.Quaternion value); +``` +#### Parameters + + + +`value` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') to invert. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The inverted [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion'). + + + +## Quaternion.Lerp(Quaternion, Quaternion, float) Method + +Performs a linear interpolation between two quaternions based on a value that specifies the weighting of the second quaternion. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Lerp(Tizen.UI.Scene3D.Quaternion quaternion1, Tizen.UI.Scene3D.Quaternion quaternion2, float amount); +``` +#### Parameters + + + +`quaternion1` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The first input quaternion. + + + +`quaternion2` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The second input quaternion. + + + +`amount` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount of interpolation between the two quaternions. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The interpolated result. + + + +## Quaternion.Normalize(Quaternion) Method + +Divides each component of a specified Quaternion by its length. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Normalize(Tizen.UI.Scene3D.Quaternion value); +``` +#### Parameters + + + +`value` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The input [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') instance to normalize. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +A new instance of the [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') class with its values set to the normalized values of the given instance. + + + +## Quaternion.Slerp(Quaternion, Quaternion, float) Method + +Interpolates between two quaternions, using spherical linear interpolation. + +```csharp +public static Tizen.UI.Scene3D.Quaternion Slerp(Tizen.UI.Scene3D.Quaternion quaternion1, Tizen.UI.Scene3D.Quaternion quaternion2, float amount); +``` +#### Parameters + + + +`quaternion1` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The first quaternion. + + + +`quaternion2` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The second quaternion. + + + +`amount` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount of interpolation. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The interpolated quaternion. + + + +## Quaternion.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.QuaternionExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.QuaternionExtensions.md new file mode 100644 index 0000000000..9c4cf0d03c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.QuaternionExtensions.md @@ -0,0 +1,74 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## QuaternionExtensions Class + +```csharp +public static class QuaternionExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 QuaternionExtensions +### Methods + + + +## QuaternionExtensions.Rotate(this Quaternion, Vector3D) Method + +Rotate a vector3D with the Quaternion. + +```csharp +public static Tizen.UI.Scene3D.Vector3D Rotate(this Tizen.UI.Scene3D.Quaternion quaternion, Tizen.UI.Scene3D.Vector3D vector3D); +``` +#### Parameters + + + +`quaternion` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The Quaternion to rotate for. + + + +`vector3D` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The vector of vector3D to be rotated with this quaternion. + +#### Returns +[Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') +Vector3D that is the rotation result of this rotation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md new file mode 100644 index 0000000000..423bab276d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md @@ -0,0 +1,124 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Rotation3DPropertyValue<T> Class + +Represents a 3D rotation property value for animating a view. + +```csharp +public class Rotation3DPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of view to animate. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md#Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Rotation3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 Rotation3DPropertyValue<T> +### Constructors + + + +## Rotation3DPropertyValue(Quaternion) Constructor + +Initializes a new instance of the [Rotation3DPropertyValue<T>](Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Rotation3DPropertyValue<T>') class. + +```csharp +public Rotation3DPropertyValue(Tizen.UI.Scene3D.Quaternion quaternion); +``` +#### Parameters + + + +`quaternion` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The initial rotation value. +### Properties + + + +## Rotation3DPropertyValue<T>.Quaternion Property + +Gets the current rotation value. + +```csharp +public Tizen.UI.Scene3D.Quaternion Quaternion { get; } +``` + +#### Property Value +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + + + +## Rotation3DPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## Rotation3DPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md#Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Rotation3DPropertyValue<T>.T') + +The view to which the property value will be applied. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The handle of the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md new file mode 100644 index 0000000000..32060dcab5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md @@ -0,0 +1,136 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Scale3DPropertyValue<T> Class + +Represents a 3D scale property value that can be animated. + +```csharp +public class Scale3DPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of view to which the property value will be applied. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md#Tizen.UI.Scene3D.Scale3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Scale3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 Scale3DPropertyValue<T> +### Constructors + + + +## Scale3DPropertyValue(float, float, float) Constructor + +Initializes a new instance of the [Scale3DPropertyValue<T>](Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Scale3DPropertyValue<T>') class. + +```csharp +public Scale3DPropertyValue(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X component of the scale. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y component of the scale. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z component of the scale. +### Properties + + + +## Scale3DPropertyValue<T>.Scale Property + +Gets the scale of the property value. + +```csharp +public Tizen.UI.Scene3D.Size3D Scale { get; } +``` + +#### Property Value +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + + + +## Scale3DPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## Scale3DPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md#Tizen.UI.Scene3D.Scale3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Scale3DPropertyValue<T>.T') + +The view to which the property value will be applied. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The handle of the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scene3DView.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scene3DView.md new file mode 100644 index 0000000000..5aa3c085df --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scene3DView.md @@ -0,0 +1,332 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Scene3DView Class + +[Scene3DView](Tizen.UI.Scene3D.Scene3DView.md 'Tizen.UI.Scene3D.Scene3DView') is a Tizen.UI.View for displaying 3D [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject'). + +```csharp +public class Scene3DView : Tizen.UI.ViewGroup +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ViewGroup 🡒 Scene3DView +### Constructors + + + +## Scene3DView() Constructor + +Constructor of Scene3DView. + +```csharp +public Scene3DView(); +``` + + + +## Scene3DView(IntPtr, bool) Constructor + +Constructor of Scene3DView with specified handle and ownership. + +```csharp +public Scene3DView(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the scene view. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the object takes ownership of the handle. +### Properties + + + +## Scene3DView.Cameras Property + +List of cameras in the scene. + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.Scene3D.Camera> Cameras { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Scene3DView.DefaultCamera Property + +The default camera of the scene. + +```csharp +public Tizen.UI.Scene3D.Camera DefaultCamera { get; } +``` + +#### Property Value +[Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + + + +## Scene3DView.ImageBasedLightScaleFactor Property + +Gets or sets the ImageBasedLight ScaleFactor. +Scale factor controls light source intensity in [0.0f, 1.0f] + +```csharp +public float ImageBasedLightScaleFactor { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Scene3DView.Lights Property + +List of lights in the scene. + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.Scene3D.Light> Lights { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[Light](Tizen.UI.Scene3D.Light.md 'Tizen.UI.Scene3D.Light')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Scene3DView.Models Property + +List of models in the scene. + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.Scene3D.Model3D> Models { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[Model3D](Tizen.UI.Scene3D.Model3D.md 'Tizen.UI.Scene3D.Model3D')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Scene3DView.UseFramebuffer Property + +Gets or sets the UseFramebuffer. +If this property is true, rendering result of Scene3DView is drawn on FBO and it is mapping on this SceneView plane. +If this property is false, each item in Scene3DView is rendered on window directly. +Default is false. + +```csharp +public bool UseFramebuffer { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## Scene3DView.Add(SceneObject) Method + +Adds a [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') to the scene. + +```csharp +public void Add(Tizen.UI.Scene3D.SceneObject sceneObject); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + +The scene object to add. + + + +## Scene3DView.AnimateCameraTransition(Camera, int, AlphaFunction) Method + +Transitions the [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') to the specified camera. + +```csharp +public void AnimateCameraTransition(Tizen.UI.Scene3D.Camera camera, int duration, Tizen.UI.AlphaFunction alpha=null); +``` +#### Parameters + + + +`camera` [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + +The camera to transit to. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the transition. + + + +`alpha` Tizen.UI.AlphaFunction + +The alpha function to apply during the transition. + + + +## Scene3DView.GetCurrentCamera() Method + +Gets the current [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') of the scene. + +```csharp +public Tizen.UI.Scene3D.Camera GetCurrentCamera(); +``` + +#### Returns +[Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') +The current camera of the scene. + + + +## Scene3DView.Remove(SceneObject) Method + +Removes a [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') from the scene. + +```csharp +public void Remove(Tizen.UI.Scene3D.SceneObject sceneObject); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + +The scene object to remove. + + + +## Scene3DView.SetCurrentCamera(Camera) Method + +Sets the current [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') of the scene. + +```csharp +public void SetCurrentCamera(Tizen.UI.Scene3D.Camera camera); +``` +#### Parameters + + + +`camera` [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') + +The camera to set as the current camera. + + + +## Scene3DView.SetImageBasedLightingSource(string, string, float) Method + +Sets the image-based lighting source. + +```csharp +public void SetImageBasedLightingSource(string diffuseUrl, string specularUrl, float scaleFactor=1f); +``` +#### Parameters + + + +`diffuseUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the diffuse texture. + + + +`specularUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the specular texture. + + + +`scaleFactor` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scale factor of the lighting. + + + +## Scene3DView.SetKeyEventRouteTarget(Model3D) Method + +Sets the Model3D target to route key event. + +```csharp +public void SetKeyEventRouteTarget(Tizen.UI.Scene3D.Model3D model); +``` +#### Parameters + + + +`model` [Model3D](Tizen.UI.Scene3D.Model3D.md 'Tizen.UI.Scene3D.Model3D') +### Events + + + +## Scene3DView.CameraTransitionFinished Event + +Occurs when the camera transition is finished. + +```csharp +public event EventHandler CameraTransitionFinished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Scene3DView.ResourceReady Event + +Occurs when the resource is ready. + +```csharp +public event EventHandler ResourceReady; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObject.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObject.md new file mode 100644 index 0000000000..0f44f79347 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObject.md @@ -0,0 +1,253 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## SceneObject Class + +[SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') is a base class for all scene 3D objects. + +```csharp +public abstract class SceneObject : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 SceneObject + +Derived +↳ [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') +↳ [Light](Tizen.UI.Scene3D.Light.md 'Tizen.UI.Scene3D.Light') +↳ [Panel](Tizen.UI.Scene3D.Panel.md 'Tizen.UI.Scene3D.Panel') +↳ [SceneObjectGroup<T>](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>') +### Properties + + + +## SceneObject.IsVisible Property + +Gets or sets a value indicating whether the SceneObject is visible or not. + +```csharp +public bool IsVisible { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SceneObject.Name Property + +Gets or sets the name of the scene object. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## SceneObject.Opacity Property + +Gets or sets the opacity of the scene object. + +```csharp +public float Opacity { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SceneObject.Parent Property + +Gets the parent of the scene object. + +```csharp +public Tizen.UI.Scene3D.SceneObject Parent { get; } +``` + +#### Property Value +[SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + + + +## SceneObject.ParentObject Property + +Gets the parent object of the scene object. + +```csharp +public Tizen.UI.NObject ParentObject { get; } +``` + +#### Property Value +Tizen.UI.NObject + + + +## SceneObject.ParentOrigin Property + +Gets or sets the parent origin of the scene object. + +```csharp +public Tizen.UI.Scene3D.Point3D ParentOrigin { get; set; } +``` + +#### Property Value +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + + + +## SceneObject.PivotPoint Property + +Gets or sets the pivot point of the scene object. + +```csharp +public Tizen.UI.Scene3D.Point3D PivotPoint { get; set; } +``` + +#### Property Value +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +### Remarks +The pivot point is the center point around which the scene object rotates or scales. When a rotation or scaling operation is applied to the scene object, +it is performed relative to the pivot point. By changing the pivot point, you can control the origin and behavior of the rotation or scaling. + + + +## SceneObject.Position Property + +Gets or sets the position of the scene object. + +```csharp +public Tizen.UI.Scene3D.Point3D Position { get; set; } +``` + +#### Property Value +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + + + +## SceneObject.PositionUsesPivotPoint Property + +Gets or sets a value indicating whether the position of the scene object uses the pivot point. + +```csharp +public bool PositionUsesPivotPoint { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SceneObject.Rotation Property + +Gets or sets the rotation of the scene object. + +```csharp +public Tizen.UI.Scene3D.Quaternion Rotation { get; set; } +``` + +#### Property Value +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + + + +## SceneObject.Scale Property + +Gets or sets the scale factor applied to the scene object. + +```csharp +public Tizen.UI.Scene3D.Size3D Scale { get; set; } +``` + +#### Property Value +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + + + +## SceneObject.Size Property + +Gets or sets the size of the scene object. + +```csharp +public Tizen.UI.Scene3D.Size3D Size { get; set; } +``` + +#### Property Value +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') +### Methods + + + +## SceneObject.LookAt(Vector3D, Vector3D, Vector3D, Vector3D) Method + +Rotate the SceneObject look at specific position. +It will change the SceneObject's orientation property. + +```csharp +public void LookAt(Tizen.UI.Scene3D.Vector3D target, Tizen.UI.Scene3D.Vector3D up=default(Tizen.UI.Scene3D.Vector3D), Tizen.UI.Scene3D.Vector3D localForward=default(Tizen.UI.Scene3D.Vector3D), Tizen.UI.Scene3D.Vector3D localUp=default(Tizen.UI.Scene3D.Vector3D)); +``` +#### Parameters + + + +`target` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The target world position to look at. + + + +`up` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The up vector after target look at. If it is null, up vector become +Y axis + + + +`localForward` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The forward vector of scene object when it's orientation is not applied. If it is null, localForward vector become +Z axis + + + +`localUp` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The up vector of SceneObject when it's orientation is not applied. If it is null, localUp vector become +Y axis + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectExtensions.md new file mode 100644 index 0000000000..cddb09d452 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectExtensions.md @@ -0,0 +1,138 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## SceneObjectExtensions Class + +```csharp +public static class SceneObjectExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SceneObjectExtensions +### Methods + + + +## SceneObjectExtensions.AddRenderer(this SceneObject, Renderer) Method + +Adds a renderer to the sceneObject. + +```csharp +public static int AddRenderer(this Tizen.UI.Scene3D.SceneObject sceneObject, Tizen.UI.Internal.Renderer renderer); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + + + +`renderer` Tizen.UI.Internal.Renderer + +The renderer to add. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the Renderer that was added to the sceneObject. + + + +## SceneObjectExtensions.GetRendererAt(this SceneObject, int) Method + +Retrieves the renderer at the specified index. + +```csharp +public static Tizen.UI.Internal.Renderer GetRendererAt(this Tizen.UI.Scene3D.SceneObject sceneObject, int index); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the renderer to retrieve. + +#### Returns +Tizen.UI.Internal.Renderer +A Renderer object at the specified index. + + + +## SceneObjectExtensions.GetRendererCount(this SceneObject) Method + +Gets the number of renderers held by the sceneObject. + +```csharp +public static int GetRendererCount(this Tizen.UI.Scene3D.SceneObject sceneObject); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The number of renderers held by the sceneObject. + + + +## SceneObjectExtensions.RemoveRenderer(this SceneObject, Renderer) Method + +Removes a specified renderer from the sceneObject. + +```csharp +public static void RemoveRenderer(this Tizen.UI.Scene3D.SceneObject sceneObject, Tizen.UI.Internal.Renderer renderer); +``` +#### Parameters + + + +`sceneObject` [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + + + +`renderer` Tizen.UI.Internal.Renderer + +The renderer to remove. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectGroup_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectGroup_T_.md new file mode 100644 index 0000000000..a2474cb918 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectGroup_T_.md @@ -0,0 +1,328 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## SceneObjectGroup<T> Class + +SceneObjectGroup is a container class that manages an array of scene object. + +```csharp +public abstract class SceneObjectGroup<T> : Tizen.UI.Scene3D.SceneObject, +System.Collections.Generic.IList<T>, +System.Collections.Generic.ICollection<T>, +System.Collections.Generic.IEnumerable<T>, +System.Collections.IEnumerable + where T : Tizen.UI.Scene3D.SceneObject +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') 🡒 SceneObjectGroup<T> + +Derived +↳ [Model3D](Tizen.UI.Scene3D.Model3D.md 'Tizen.UI.Scene3D.Model3D') +↳ [ModelNode](Tizen.UI.Scene3D.ModelNode.md 'Tizen.UI.Scene3D.ModelNode') + +Implements [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Properties + + + +## SceneObjectGroup<T>.Children Property + +Gets the list of child scene objects. + +```csharp +public System.Collections.Generic.IList<T> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## SceneObjectGroup<T>.Count Property + +Gets the number of child scene objects. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## SceneObjectGroup<T>.IsReadOnly Property + +Gets a value indicating whether the list of child scene objects is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SceneObjectGroup<T>.this[int] Property + +Gets or sets the scene object at the specified index. + +```csharp +public T this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') +### Methods + + + +## SceneObjectGroup<T>.Add(T) Method + +Adds a child scene object to the end of the list of child scene objects. + +```csharp +public void Add(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') + +The child scene object to add. + +Implements [Add(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Add#System_Collections_Generic_ICollection_1_Add__0_ 'System.Collections.Generic.ICollection`1.Add(`0)') + + + +## SceneObjectGroup<T>.Clear() Method + +Removes all child scene objects from the list of child scene objects. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## SceneObjectGroup<T>.Contains(T) Method + +Checks if the list of child scene objects contains the specified child scene object. + +```csharp +public bool Contains(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') + +The child scene object to check for. + +Implements [Contains(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Contains#System_Collections_Generic_ICollection_1_Contains__0_ 'System.Collections.Generic.ICollection`1.Contains(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the list of child scene objects contains the child scene object, false otherwise. + + + +## SceneObjectGroup<T>.CopyTo(T[], int) Method + +Copies the child scene objects in the list of child scene objects to the specified array, starting at the specified index. + +```csharp +public void CopyTo(T[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the child scene objects to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + +Implements [CopyTo(T[], int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.CopyTo#System_Collections_Generic_ICollection_1_CopyTo__0[],System_Int32_ 'System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)') + + + +## SceneObjectGroup<T>.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child scene objects. + +```csharp +public System.Collections.Generic.IEnumerator<T> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the list of child scene objects. + + + +## SceneObjectGroup<T>.IndexOf(T) Method + +Gets the index of the specified child scene object in the list of child scene objects. + +```csharp +public int IndexOf(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') + +The child scene object to find the index of. + +Implements [IndexOf(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.IndexOf#System_Collections_Generic_IList_1_IndexOf__0_ 'System.Collections.Generic.IList`1.IndexOf(`0)') + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the child scene object, or -1 if it is not found. + + + +## SceneObjectGroup<T>.Insert(int, T) Method + +Inserts a child scene object at the specified index in the list of child scene objects. + +```csharp +public void Insert(int index, T item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child scene object at. + + + +`item` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') + +The child scene object to insert. + +Implements [Insert(int, T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Insert#System_Collections_Generic_IList_1_Insert_System_Int32,_0_ 'System.Collections.Generic.IList`1.Insert(System.Int32,`0)') + + + +## SceneObjectGroup<T>.Remove(T) Method + +Removes the specified child scene object from the list of child scene objects. + +```csharp +public bool Remove(T item); +``` +#### Parameters + + + +`item` [T](Tizen.UI.Scene3D.SceneObjectGroup_T_.md#Tizen.UI.Scene3D.SceneObjectGroup_T_.T 'Tizen.UI.Scene3D.SceneObjectGroup<T>.T') + +The child scene object to remove. + +Implements [Remove(T)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Remove#System_Collections_Generic_ICollection_1_Remove__0_ 'System.Collections.Generic.ICollection`1.Remove(`0)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the child scene object was removed, false otherwise. + + + +## SceneObjectGroup<T>.RemoveAt(int) Method + +Removes the child scene object at the specified index from the list of child scene objects. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the child scene object to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## SceneObjectGroup<T>.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child scene objects. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3D.md new file mode 100644 index 0000000000..da48c575e0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3D.md @@ -0,0 +1,241 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Size3D Struct + +Represents a three-dimensional size. + +```csharp +public struct Size3D +``` +### Constructors + + + +## Size3D(float, float, float) Constructor + +Initializes a new instance of the [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') structure with the specified width, height, and depth. + +```csharp +public Size3D(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the size. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the size. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The depth of the size. +### Fields + + + +## Size3D.Zero Field + +Gets a [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') structure that has a width, height, and depth of zero. + +```csharp +public static readonly Size3D Zero; +``` + +#### Field Value +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') +### Properties + + + +## Size3D.IsZero Property + +Gets a value indicating whether this [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') is equal [Zero](Tizen.UI.Scene3D.Size3D.md#Tizen.UI.Scene3D.Size3D.Zero 'Tizen.UI.Scene3D.Size3D.Zero') size. + +```csharp +public bool IsZero { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Size3D.X Property + +Gets or sets the width component of this [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') structure. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Size3D.Y Property + +Gets or sets the height component of this [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') structure. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Size3D.Z Property + +Gets or sets the depth component of this [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') structure. + +```csharp +public float Z { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Size3D.Deconstruct(float, float, float) Method + +Deconstructs the Size3D object into its individual components (X, Y, and Z). + +```csharp +public void Deconstruct(out float x, out float y, out float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X component of the Size3D. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y component of the Size3D. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z component of the Size3D. + + + +## Size3D.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Scene3D.Size3D.md#Tizen.UI.Scene3D.Size3D.Equals(object).obj 'Tizen.UI.Scene3D.Size3D.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## Size3D.Equals(Size3D) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public bool Equals(Tizen.UI.Scene3D.Size3D other); +``` +#### Parameters + + + +`other` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if obj and this instance are the same type and represent the same value, otherwise false. + + + +## Size3D.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## Size3D.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3DPropertyValue_T_.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3DPropertyValue_T_.md new file mode 100644 index 0000000000..28c041f37a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3DPropertyValue_T_.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Size3DPropertyValue<T> Class + +Represents a 3D size property value that can be animated. + +```csharp +public class Size3DPropertyValue<T> : Tizen.UI.Scene3D.Animatable3DPropertyValue<T> + where T : Tizen.UI.NObject +``` +#### Type parameters + + + +`T` + +The type of view that the property value applies to. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Scene3D.Animatable3DPropertyValue<](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>')[T](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md#Tizen.UI.Scene3D.Size3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Size3DPropertyValue<T>.T')[>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') 🡒 Size3DPropertyValue<T> +### Constructors + + + +## Size3DPropertyValue(float, float, float) Constructor + +Initializes a new instance of the [Size3DPropertyValue<T>](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Size3DPropertyValue<T>') class with the specified values. + +```csharp +public Size3DPropertyValue(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width component of the size. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height component of the size. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The depth component of the size. + + + +## Size3DPropertyValue(Size3D) Constructor + +Initializes a new instance of the [Size3DPropertyValue<T>](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Size3DPropertyValue<T>') class with the specified size. + +```csharp +public Size3DPropertyValue(Tizen.UI.Scene3D.Size3D size); +``` +#### Parameters + + + +`size` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The size to use. +### Properties + + + +## Size3DPropertyValue<T>.Size Property + +Gets the size represented by this property value. + +```csharp +public Tizen.UI.Scene3D.Size3D Size { get; } +``` + +#### Property Value +[Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + + + +## Size3DPropertyValue<T>.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyValueHandle +### Methods + + + +## Size3DPropertyValue<T>.GetTargetProperty(T) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(T view); +``` +#### Parameters + + + +`view` [T](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md#Tizen.UI.Scene3D.Size3DPropertyValue_T_.T 'Tizen.UI.Scene3D.Size3DPropertyValue<T>.T') + +The view to which the property value will be applied. + +#### Returns +Tizen.UI.NativeHandle.AnimatablePropertyHandle +The handle of the target property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TouchExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TouchExtensions.md new file mode 100644 index 0000000000..15a9118493 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TouchExtensions.md @@ -0,0 +1,66 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## TouchExtensions Class + +```csharp +public static class TouchExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TouchExtensions +### Methods + + + +## TouchExtensions.GetHitSceneObject(this Touch) Method + +Gets the scene object that passed the hit test. + +```csharp +public static Tizen.UI.Scene3D.SceneObject GetHitSceneObject(this Tizen.UI.Touch touch); +``` +#### Parameters + + + +`touch` Tizen.UI.Touch + +#### Returns +[SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TransformTypes.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TransformTypes.md new file mode 100644 index 0000000000..7a62ce2b20 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TransformTypes.md @@ -0,0 +1,107 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## TransformTypes Enum + +The list of transform property types what this TransformIndex can control. + +```csharp +public enum TransformTypes +``` +### Fields + + + +`Invalid` -1 + +Invalid type. + + + +`Position` 0 + +The position of ModelNode. MotionValue should be Point3D. + + + +`PositionX` 1 + +The x position of ModelNode. MotionValue should be float. + + + +`PositionY` 2 + +The y position of ModelNode. MotionValue should be float. + + + +`PositionZ` 3 + +The z position of ModelNode. MotionValue should be float. + + + +`Rotation` 4 + +The rotation of ModelNode. MotionValue should be Quaternion. + + + +`Scale` 5 + +The scale of ModelNode. MotionValue should be Size3D. + + + +`ScaleX` 6 + +The x scale of ModelNode. MotionValue should be float. + + + +`ScaleY` 7 + +The y scale of ModelNode. MotionValue should be float. + + + +`ScaleZ` 8 + +The z scale of ModelNode. MotionValue should be float. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Vector3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Vector3D.md new file mode 100644 index 0000000000..553b28bd72 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Vector3D.md @@ -0,0 +1,334 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## Vector3D Struct + +Represents a vector with three single-precision floating-point values. + +```csharp +public struct Vector3D +``` +### Constructors + + + +## Vector3D(float, float, float) Constructor + +Initializes a new instance of the [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') struct. + +```csharp +public Vector3D(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X component of the vector. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y component of the vector. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z component of the vector. + + + +## Vector3D(Point3D) Constructor + +Initializes a new instance of the [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') struct. + +```csharp +public Vector3D(Tizen.UI.Scene3D.Point3D v); +``` +#### Parameters + + + +`v` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') to convert to a [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D'). +### Properties + + + +## Vector3D.Length Property + +Gets the length of the vector. + +```csharp +public float Length { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Vector3D.LengthSquared Property + +Gets the squared length of the vector. + +```csharp +public float LengthSquared { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Vector3D.X Property + +Gets or sets the X component of the vector. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Vector3D.Y Property + +Gets or sets the Y component of the vector. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Vector3D.Z Property + +Gets or sets the Z component of the vector. + +```csharp +public float Z { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Vector3D.AngleBetween(Vector3D, Vector3D) Method + +Returns the angle between two vectors in degrees. + +```csharp +public static float AngleBetween(Tizen.UI.Scene3D.Vector3D v1, Tizen.UI.Scene3D.Vector3D v2); +``` +#### Parameters + + + +`v1` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The first vector. + + + +`v2` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The second vector. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The angle between the two vectors in degrees. + + + +## Vector3D.Cross(Vector3D, Vector3D) Method + +Returns the cross product of two vectors. + +```csharp +public static Tizen.UI.Scene3D.Vector3D Cross(Tizen.UI.Scene3D.Vector3D v1, Tizen.UI.Scene3D.Vector3D v2); +``` +#### Parameters + + + +`v1` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The first vector. + + + +`v2` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The second vector. + +#### Returns +[Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') +The cross product of the two vectors. + + + +## Vector3D.Dot(Vector3D, Vector3D) Method + +Returns the dot product of two vectors. + +```csharp +public static float Dot(Tizen.UI.Scene3D.Vector3D v1, Tizen.UI.Scene3D.Vector3D v2); +``` +#### Parameters + + + +`v1` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The first vector. + + + +`v2` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The second vector. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The dot product of the two vectors. + + + +## Vector3D.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object o); +``` +#### Parameters + + + +`o` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if obj and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## Vector3D.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## Vector3D.Normalize() Method + +Normalizes the vector. + +```csharp +public void Normalize(); +``` + + + +## Vector3D.Round() Method + +Rounds the vector's components to the nearest integer values. + +```csharp +public Tizen.UI.Scene3D.Vector3D Round(); +``` + +#### Returns +[Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') +The rounded vector. + + + +## Vector3D.ToString() Method + +Returns the fully qualified type name of this instance. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The fully qualified type name. +### Operators + + + +## Vector3D.explicit operator Point3D(Vector3D) Operator + +Converts a [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') to a [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D'). + +```csharp +public static Tizen.UI.Scene3D.Point3D explicit operator Point3D(Tizen.UI.Scene3D.Vector3D v); +``` +#### Parameters + + + +`v` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The vector to convert. + +#### Returns +[Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') +The converted point. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ViewExtensions.md new file mode 100644 index 0000000000..00eee8a752 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ViewExtensions.md @@ -0,0 +1,380 @@ +### [Tizen.UI.Scene3D](Tizen.UI.Scene3D.md 'Tizen.UI.Scene3D') + +## ViewExtensions Class + +```csharp +public static class ViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewExtensions +### Methods + + + +## ViewExtensions.GetRotation3D(this NObject) Method + +Gets the rotation of the NObject in the 3D space. + +```csharp +public static Tizen.UI.Scene3D.Quaternion GetRotation3D(this Tizen.UI.NObject obj); +``` +#### Parameters + + + +`obj` Tizen.UI.NObject + +The object to get the rotation for. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The rotation of the object + + + +## ViewExtensions.GetWorldRotation3D(this NObject) Method + +Gets the world rotation of the NObject in the 3D space. + +```csharp +public static Tizen.UI.Scene3D.Quaternion GetWorldRotation3D(this Tizen.UI.NObject obj); +``` +#### Parameters + + + +`obj` Tizen.UI.NObject + +The object to get the world rotation for. + +#### Returns +[Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') +The world rotation of the object + + + +## ViewExtensions.LookAt(this View, Vector3D, Vector3D, Vector3D, Vector3D) Method + +Rotate the View look at specific position. +It will change the View's rotation property. + +```csharp +public static void LookAt(this Tizen.UI.View view, Tizen.UI.Scene3D.Vector3D target, Tizen.UI.Scene3D.Vector3D up=default(Tizen.UI.Scene3D.Vector3D), Tizen.UI.Scene3D.Vector3D localForward=default(Tizen.UI.Scene3D.Vector3D), Tizen.UI.Scene3D.Vector3D localUp=default(Tizen.UI.Scene3D.Vector3D)); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`target` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The target world position to look at. + + + +`up` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The up vector after target look at. If it is null, up vector become +Y axis + + + +`localForward` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The forward vector of View when it's rotation is not applied. If it is null, localForward vector become +Z axis + + + +`localUp` [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') + +The up vector of View when it's rotation is not applied. If it is null, localUp vector become +Y axis + + + +## ViewExtensions.SetParentOrigin3D(this View, Point3D) Method + +Sets the parent origin of the view in 3D space. + +```csharp +public static void SetParentOrigin3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Point3D point); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`point` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The 3D point to set the parent origin for. + + + +## ViewExtensions.SetPivotPoint3D(this View, Point3D) Method + +Sets the pivot point of the view in 3D space. + +```csharp +public static void SetPivotPoint3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Point3D point); +``` +#### Parameters + + + +`view` Tizen.UI.View + + + +`point` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The 3D point to set the pivot point for. + + + +## ViewExtensions.SetPosition3D(this View, float, float, float) Method + +Sets the position of the view in the 3D space. + +```csharp +public static void SetPosition3D(this Tizen.UI.View view, float x, float y, float z); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the position for. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X position of the view. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y position of the view. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z position of the view. + + + +## ViewExtensions.SetPosition3D(this View, Point3D) Method + +Sets the position of the view in the 3D space. + +```csharp +public static void SetPosition3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Point3D point); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the position for. + + + +`point` [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') + +The position of the view. + + + +## ViewExtensions.SetPositionZ(this View, float) Method + +Sets the Z position of the view in the 3D space. + +```csharp +public static void SetPositionZ(this Tizen.UI.View view, float positionZ); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the position for. + + + +`positionZ` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z position of the view. + + + +## ViewExtensions.SetRotation3D(this View, Quaternion) Method + +Sets the rotation of the view in the 3D space. + +```csharp +public static void SetRotation3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Quaternion quaternion); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the rotation for. + + + +`quaternion` [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') + +The rotation of the view. + + + +## ViewExtensions.SetScale3D(this View, float, float, float) Method + +Sets the scale of the view in the 3D space. + +```csharp +public static void SetScale3D(this Tizen.UI.View view, float x, float y, float z); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the scale for. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X scale of the view. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y scale of the view. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z scale of the view. + + + +## ViewExtensions.SetScale3D(this View, Size3D) Method + +Sets the scale of the view in the 3D space. + +```csharp +public static void SetScale3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Size3D scale); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the scale for. + + + +`scale` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The scale of the view. + + + +## ViewExtensions.SetScaleZ(this View, float) Method + +Sets the Z scale of the view in the 3D space. + +```csharp +public static void SetScaleZ(this Tizen.UI.View view, float scaleZ); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the scale for. + + + +`scaleZ` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Z scale of the view. + + + +## ViewExtensions.SetSize3D(this View, Size3D) Method + +Sets the size of the view in the 3D space. + +```csharp +public static void SetSize3D(this Tizen.UI.View view, Tizen.UI.Scene3D.Size3D size); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to set the size for. + + + +`size` [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') + +The size of the view. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.md b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.md new file mode 100644 index 0000000000..f34197be98 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.md @@ -0,0 +1,90 @@ + +## Tizen.UI.Scene3D Namespace + +| Classes | | +| :--- | :--- | +| [Animatable3DPropertyValue<T>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>') | Animatable3DPropertyValue is an abstract class that represents a property value that can be animated in 3D. | +| [Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') | [Animation3D](Tizen.UI.Scene3D.Animation3D.md 'Tizen.UI.Scene3D.Animation3D') class provides a way to animate [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject')s in 3D space. | +| [Camera](Tizen.UI.Scene3D.Camera.md 'Tizen.UI.Scene3D.Camera') | Represents a camera that projects a 3D scene onto a 2D surface. | +| [CameraExtensions](Tizen.UI.Scene3D.CameraExtensions.md 'Tizen.UI.Scene3D.CameraExtensions') | Provides extension methods for the Camera class. | +| [CustomPropertyValue<T>](Tizen.UI.Scene3D.CustomPropertyValue_T_.md 'Tizen.UI.Scene3D.CustomPropertyValue<T>') | Represents a custom property value that can be animated in 3D. | +| [FieldOfViewPropertyValue<T>](Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md 'Tizen.UI.Scene3D.FieldOfViewPropertyValue<T>') | Represents a property value for a field of view animation. | +| [Light](Tizen.UI.Scene3D.Light.md 'Tizen.UI.Scene3D.Light') | Light object that projects its effect along a specific direction. | +| [Material](Tizen.UI.Scene3D.Material.md 'Tizen.UI.Scene3D.Material') | Class for setting Material properties of 3D models. | +| [Model3D](Tizen.UI.Scene3D.Model3D.md 'Tizen.UI.Scene3D.Model3D') | Provides functionality for 3-D models. | +| [Model3DExtensions](Tizen.UI.Scene3D.Model3DExtensions.md 'Tizen.UI.Scene3D.Model3DExtensions') | | +| [ModelNode](Tizen.UI.Scene3D.ModelNode.md 'Tizen.UI.Scene3D.ModelNode') | ModelNode is a class for representing the Node of Model3D in Scene3D. | +| [ModelPrimitive](Tizen.UI.Scene3D.ModelPrimitive.md 'Tizen.UI.Scene3D.ModelPrimitive') | Class for Model Primitives for 3D Geometry and Material. | +| [MotionData](Tizen.UI.Scene3D.MotionData.md 'Tizen.UI.Scene3D.MotionData') | The MotionData is an abstract class that provides a base for model motion definition. | +| [MotionData<T>](Tizen.UI.Scene3D.MotionData_T_.md 'Tizen.UI.Scene3D.MotionData<T>') | Model motion definition.
MotionData has a pair of [MotionIndex](Tizen.UI.Scene3D.MotionData_T_.md#Tizen.UI.Scene3D.MotionData_T_.MotionIndex 'Tizen.UI.Scene3D.MotionData<T>.MotionIndex') and [MotionValue](Tizen.UI.Scene3D.MotionData_T_.md#Tizen.UI.Scene3D.MotionData_T_.MotionValue 'Tizen.UI.Scene3D.MotionData<T>.MotionValue').
MotionIndex specifies the target of motion.
MotionValue is destination value of target for the motion. | +| [MotionDataSet](Tizen.UI.Scene3D.MotionDataSet.md 'Tizen.UI.Scene3D.MotionDataSet') | MotionDataSet contains DataSet which is a list of MotionData. | +| [MotionIndex](Tizen.UI.Scene3D.MotionIndex.md 'Tizen.UI.Scene3D.MotionIndex') | Index of motion value. It will be used to specify the target of motion applied. | +| [OpacityPropertyValue<T>](Tizen.UI.Scene3D.OpacityPropertyValue_T_.md 'Tizen.UI.Scene3D.OpacityPropertyValue<T>') | Represents the opacity property value for an [Animatable3DPropertyValue<T>](Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Animatable3DPropertyValue<T>'). | +| [OrthographicSizePropertyValue<T>](Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md 'Tizen.UI.Scene3D.OrthographicSizePropertyValue<T>') | Represents a property value for an animatable 3D object that specifies the orthographic size. | +| [Panel](Tizen.UI.Scene3D.Panel.md 'Tizen.UI.Scene3D.Panel') | Panel is a control to show 2D View on 3D Scene. | +| [Position3DPropertyValue<T>](Tizen.UI.Scene3D.Position3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Position3DPropertyValue<T>') | | +| [QuaternionExtensions](Tizen.UI.Scene3D.QuaternionExtensions.md 'Tizen.UI.Scene3D.QuaternionExtensions') | | +| [Rotation3DPropertyValue<T>](Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Rotation3DPropertyValue<T>') | Represents a 3D rotation property value for animating a view. | +| [Scale3DPropertyValue<T>](Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Scale3DPropertyValue<T>') | Represents a 3D scale property value that can be animated. | +| [Scene3DView](Tizen.UI.Scene3D.Scene3DView.md 'Tizen.UI.Scene3D.Scene3DView') | [Scene3DView](Tizen.UI.Scene3D.Scene3DView.md 'Tizen.UI.Scene3D.Scene3DView') is a Tizen.UI.View for displaying 3D [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject'). | +| [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') | [SceneObject](Tizen.UI.Scene3D.SceneObject.md 'Tizen.UI.Scene3D.SceneObject') is a base class for all scene 3D objects. | +| [SceneObjectExtensions](Tizen.UI.Scene3D.SceneObjectExtensions.md 'Tizen.UI.Scene3D.SceneObjectExtensions') | | +| [SceneObjectGroup<T>](Tizen.UI.Scene3D.SceneObjectGroup_T_.md 'Tizen.UI.Scene3D.SceneObjectGroup<T>') | SceneObjectGroup is a container class that manages an array of scene object. | +| [Size3DPropertyValue<T>](Tizen.UI.Scene3D.Size3DPropertyValue_T_.md 'Tizen.UI.Scene3D.Size3DPropertyValue<T>') | Represents a 3D size property value that can be animated. | +| [TouchExtensions](Tizen.UI.Scene3D.TouchExtensions.md 'Tizen.UI.Scene3D.TouchExtensions') | | +| [ViewExtensions](Tizen.UI.Scene3D.ViewExtensions.md 'Tizen.UI.Scene3D.ViewExtensions') | | + +| Structs | | +| :--- | :--- | +| [Point3D](Tizen.UI.Scene3D.Point3D.md 'Tizen.UI.Scene3D.Point3D') | Represents a point in 3D space. | +| [Quaternion](Tizen.UI.Scene3D.Quaternion.md 'Tizen.UI.Scene3D.Quaternion') | Represents a vector that is used to encode three-dimensional physical rotations. | +| [Size3D](Tizen.UI.Scene3D.Size3D.md 'Tizen.UI.Scene3D.Size3D') | Represents a three-dimensional size. | +| [Vector3D](Tizen.UI.Scene3D.Vector3D.md 'Tizen.UI.Scene3D.Vector3D') | Represents a vector with three single-precision floating-point values. | + +| Interfaces | | +| :--- | :--- | +| [IMotionData](Tizen.UI.Scene3D.IMotionData.md 'Tizen.UI.Scene3D.IMotionData') | The IMotionData interface defines the methods required for a model motion definition. | + +| Enums | | +| :--- | :--- | +| [MaterialAlphaMode](Tizen.UI.Scene3D.MaterialAlphaMode.md 'Tizen.UI.Scene3D.MaterialAlphaMode') | MaterialAlphaMode is enum for Material's AlphaMode | +| [ProjectionDirection](Tizen.UI.Scene3D.ProjectionDirection.md 'Tizen.UI.Scene3D.ProjectionDirection') | Enumeration for the direction of projection. | +| [TransformTypes](Tizen.UI.Scene3D.TransformTypes.md 'Tizen.UI.Scene3D.TransformTypes') | The list of transform property types what this TransformIndex can control. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.CustomRenderingView.md b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.CustomRenderingView.md new file mode 100644 index 0000000000..39ee3e52dc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.CustomRenderingView.md @@ -0,0 +1,70 @@ +### [Tizen.UI.Skia](Tizen.UI.Skia.md 'Tizen.UI.Skia') + +## CustomRenderingView Class + +[CustomRenderingView](Tizen.UI.Skia.CustomRenderingView.md 'Tizen.UI.Skia.CustomRenderingView') is an abstract class that provides a base for custom views that need to render their content using SkiaSharp. + +```csharp +public abstract class CustomRenderingView : Tizen.UI.ImageView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 CustomRenderingView + +Derived +↳ [SKCanvasView](Tizen.UI.Skia.SKCanvasView.md 'Tizen.UI.Skia.SKCanvasView') +### Methods + + + +## CustomRenderingView.Invalidate() Method + +Invalidates the view and requests a redraw. + +```csharp +public void Invalidate(); +``` +### Events + + + +## CustomRenderingView.PaintSurface Event + +Occurs when the view needs to be painted. + +```csharp +public event EventHandler<SKPaintSurfaceEventArgs> PaintSurface; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKCanvasView.md b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKCanvasView.md new file mode 100644 index 0000000000..e554df5b6d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKCanvasView.md @@ -0,0 +1,67 @@ +### [Tizen.UI.Skia](Tizen.UI.Skia.md 'Tizen.UI.Skia') + +## SKCanvasView Class + +[SKCanvasView](Tizen.UI.Skia.SKCanvasView.md 'Tizen.UI.Skia.SKCanvasView') is a custom rendering view that allows drawing using SkiaSharp. + +```csharp +public class SKCanvasView : Tizen.UI.Skia.CustomRenderingView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ImageView 🡒 [CustomRenderingView](Tizen.UI.Skia.CustomRenderingView.md 'Tizen.UI.Skia.CustomRenderingView') 🡒 SKCanvasView +### Constructors + + + +## SKCanvasView() Constructor + +Initializes a new instance of the [SKCanvasView](Tizen.UI.Skia.SKCanvasView.md 'Tizen.UI.Skia.SKCanvasView') class. + +```csharp +public SKCanvasView(); +``` +### Properties + + + +## SKCanvasView.IgnorePixelScaling Property + +Gets or sets a value indicating whether to ignore pixel scaling. + +```csharp +public bool IgnorePixelScaling { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKPaintSurfaceEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKPaintSurfaceEventArgs.md new file mode 100644 index 0000000000..fb41857eff --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKPaintSurfaceEventArgs.md @@ -0,0 +1,134 @@ +### [Tizen.UI.Skia](Tizen.UI.Skia.md 'Tizen.UI.Skia') + +## SKPaintSurfaceEventArgs Class + +Event arguments for [SKCanvasView.PaintSurface](https://docs.microsoft.com/en-us/dotnet/api/SKCanvasView.PaintSurface 'SKCanvasView.PaintSurface'). + +```csharp +public class SKPaintSurfaceEventArgs +``` + +Inheritance [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 SKPaintSurfaceEventArgs +### Constructors + + + +## SKPaintSurfaceEventArgs(SKSurface, SKImageInfo) Constructor + +Initializes a new instance of the [SKPaintSurfaceEventArgs](Tizen.UI.Skia.SKPaintSurfaceEventArgs.md 'Tizen.UI.Skia.SKPaintSurfaceEventArgs') class. + +```csharp +public SKPaintSurfaceEventArgs(SKSurface surface, SKImageInfo info); +``` +#### Parameters + + + +`surface` [SkiaSharp.SKSurface](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKSurface 'SkiaSharp.SKSurface') + +The surface that is being painted. + + + +`info` [SkiaSharp.SKImageInfo](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKImageInfo 'SkiaSharp.SKImageInfo') + +The image information for the current surface. + + + +## SKPaintSurfaceEventArgs(SKSurface, SKImageInfo, SKImageInfo) Constructor + +Initializes a new instance of the [SKPaintSurfaceEventArgs](Tizen.UI.Skia.SKPaintSurfaceEventArgs.md 'Tizen.UI.Skia.SKPaintSurfaceEventArgs') class. + +```csharp +public SKPaintSurfaceEventArgs(SKSurface surface, SKImageInfo info, SKImageInfo rawInfo); +``` +#### Parameters + + + +`surface` [SkiaSharp.SKSurface](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKSurface 'SkiaSharp.SKSurface') + +The surface that is being painted. + + + +`info` [SkiaSharp.SKImageInfo](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKImageInfo 'SkiaSharp.SKImageInfo') + +The image information for the current surface. + + + +`rawInfo` [SkiaSharp.SKImageInfo](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKImageInfo 'SkiaSharp.SKImageInfo') + +The raw image information for the current surface. +### Properties + + + +## SKPaintSurfaceEventArgs.Info Property + +Gets the image information for the current surface. + +```csharp +public SKImageInfo Info { get; } +``` + +#### Property Value +[SkiaSharp.SKImageInfo](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKImageInfo 'SkiaSharp.SKImageInfo') + + + +## SKPaintSurfaceEventArgs.RawInfo Property + +Gets the raw image information for the current surface. + +```csharp +public SKImageInfo RawInfo { get; } +``` + +#### Property Value +[SkiaSharp.SKImageInfo](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKImageInfo 'SkiaSharp.SKImageInfo') + + + +## SKPaintSurfaceEventArgs.Surface Property + +Gets the surface that is being painted. + +```csharp +public SKSurface Surface { get; } +``` + +#### Property Value +[SkiaSharp.SKSurface](https://docs.microsoft.com/en-us/dotnet/api/SkiaSharp.SKSurface 'SkiaSharp.SKSurface') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.md b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.md new file mode 100644 index 0000000000..69972b5ccf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.md @@ -0,0 +1,38 @@ +## Tizen.UI.Skia Namespace + +| Classes | | +| :--- | :--- | +| [CustomRenderingView](Tizen.UI.Skia.CustomRenderingView.md 'Tizen.UI.Skia.CustomRenderingView') | [CustomRenderingView](Tizen.UI.Skia.CustomRenderingView.md 'Tizen.UI.Skia.CustomRenderingView') is an abstract class that provides a base for custom views that need to render their content using SkiaSharp. | +| [SKCanvasView](Tizen.UI.Skia.SKCanvasView.md 'Tizen.UI.Skia.SKCanvasView') | [SKCanvasView](Tizen.UI.Skia.SKCanvasView.md 'Tizen.UI.Skia.SKCanvasView') is a custom rendering view that allows drawing using SkiaSharp. | +| [SKPaintSurfaceEventArgs](Tizen.UI.Skia.SKPaintSurfaceEventArgs.md 'Tizen.UI.Skia.SKPaintSurfaceEventArgs') | Event arguments for [SKCanvasView.PaintSurface](https://docs.microsoft.com/en-us/dotnet/api/SKCanvasView.PaintSurface 'SKCanvasView.PaintSurface'). | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ColorVisual.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ColorVisual.md new file mode 100644 index 0000000000..87c9f22726 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ColorVisual.md @@ -0,0 +1,64 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## ColorVisual Class + +ColorVisual is a class for creating a color visual. + +```csharp +public class ColorVisual : Tizen.UI.Visuals.RoundedVisual +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') 🡒 [RoundedVisual](Tizen.UI.Visuals.RoundedVisual.md 'Tizen.UI.Visuals.RoundedVisual') 🡒 ColorVisual +### Properties + + + +## ColorVisual.BlurRadius Property + +Gets or sets the blur radius of the color visual. + +```csharp +public float BlurRadius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ColorVisual.CutoutPolicy Property + +Gets or sets the cutout policy for the color visual, which determines how content is rendered around cutout regions. + +```csharp +public Tizen.UI.VisualCutoutPolicy CutoutPolicy { get; set; } +``` + +#### Property Value +Tizen.UI.VisualCutoutPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ImageVisual.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ImageVisual.md new file mode 100644 index 0000000000..0f70efb0ae --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ImageVisual.md @@ -0,0 +1,316 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## ImageVisual Class + +ImageVisual is a class for the image visual. + +```csharp +public class ImageVisual : Tizen.UI.Visuals.RoundedVisual +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') 🡒 [RoundedVisual](Tizen.UI.Visuals.RoundedVisual.md 'Tizen.UI.Visuals.RoundedVisual') 🡒 ImageVisual + +Derived +↳ [NPatchVisual](Tizen.UI.Visuals.NPatchVisual.md 'Tizen.UI.Visuals.NPatchVisual') +### Properties + + + +## ImageVisual.AlphaMaskUrl Property + +Gets or sets the URL of the alpha mask image resource. + +```csharp +public string AlphaMaskUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisual.CropToMask Property + +Gets or sets a value indicating whether to crop the image to the mask. + +```csharp +public bool CropToMask { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisual.DesiredHeight Property + +Gets or sets the desired image height.
+If not specified, the actual image height is used.
+For normal quad images only.
+Optional. + +```csharp +public float DesiredHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisual.DesiredWidth Property + +Gets or sets the desired image width.
+If not specified, the actual image width is used.
+For normal quad images only.
+Optional. + +```csharp +public float DesiredWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisual.FastTrackUploading Property + +Gets or sets whether to apply fast track uploading or not.
+ +```csharp +public bool FastTrackUploading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +### Remarks +If we use fast track uploading feature, It can upload texture without event-thead dependency. But also,
+ - Texture size is invalid until ResourceReady signal comes.
+ - Texture cannot be cached (We always try to load new image).
+ - Seamless visual change didn't supported.
+ - Alpha masking didn't supported. If you try, It will load as normal case.
+ - Synchronous loading didn't supported. If you try, It will load as normal case.
+ - Reload action didn't supported. If you try, It will load as normal case.
+ - Atlas loading didn't supported. If you try, It will load as normal case.
+ - Custom shader didn't supported. If you try, It will load as normal case. + + + +## ImageVisual.FittingMode Property + +Gets or sets the fitting mode of the image visual. + +```csharp +public Tizen.UI.FittingMode FittingMode { get; set; } +``` + +#### Property Value +Tizen.UI.FittingMode + + + +## ImageVisual.ImageLoadWithViewSize Property + +Gets or sets a value indicating whether the image should be loaded with the view size. + +```csharp +public bool ImageLoadWithViewSize { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +`true` if image load with view size; otherwise, `false`. + + + +## ImageVisual.LoadPolicy Property + +Gets or sets the Image Visual image loading policy.
+It decides if a texture should be loaded immediately after source set or only after the visual is added to the window. + +```csharp +public Tizen.UI.ImageLoadPolicy LoadPolicy { get; set; } +``` + +#### Property Value +Tizen.UI.ImageLoadPolicy + + + +## ImageVisual.MaskContentScale Property + +Gets or sets scale factor to apply to the content image before masking. + +```csharp +public float MaskContentScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisual.MaskingMode Property + +Gets or sets whether to apply mask on GPU or not.
+ +```csharp +public Tizen.UI.ImageMaskingMode MaskingMode { get; set; } +``` + +#### Property Value +Tizen.UI.ImageMaskingMode + + + +## ImageVisual.OrientationCorrection Property + +Gets or sets a value indicating whether to correct the image orientation. + +```csharp +public bool OrientationCorrection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisual.PixelArea Property + +Gets or sets the pixel area of the image visual. + +```csharp +public Tizen.UI.Rect PixelArea { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## ImageVisual.PreMultipliedAlpha Property + +Gets or sets the pre-multiplied alpha flag of the image. + +```csharp +public bool PreMultipliedAlpha { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisual.ReleasePolicy Property + +Gets or sets the Image Visual release policy.
+It decides if a texture should be released from the cache or kept to reduce the loading time.
+ +```csharp +public Tizen.UI.ImageReleasePolicy ReleasePolicy { get; set; } +``` + +#### Property Value +Tizen.UI.ImageReleasePolicy + + + +## ImageVisual.ResourceUrl Property + +Gets or sets the URL of the image resource + +```csharp +public string ResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisual.SynchronousLoading Property + +Gets or sets a value indicating whether to load the image synchronously. + +```csharp +public bool SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisual.WrapModeU Property + +Gets or sets the horizontal wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeU { get; set; } +``` + +#### Property Value +Tizen.UI.ImageWrapMode + + + +## ImageVisual.WrapModeV Property + +Gets or sets the vertical wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeV { get; set; } +``` + +#### Property Value +Tizen.UI.ImageWrapMode +### Methods + + + +## ImageVisual.Reload() Method + +Reloads the image resource. + +```csharp +public void Reload(); +``` + + + +## ImageVisual.Update() Method + +This method updates the visual properties of the image. + +```csharp +public void Update(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ColorVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ColorVisualMap.md new file mode 100644 index 0000000000..312c60bd6a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ColorVisualMap.md @@ -0,0 +1,75 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## ColorVisualMap Class + +The ColorVisualMap class is used to define the properties of a color visual. + +```csharp +public class ColorVisualMap : Tizen.UI.Visuals.Internal.RoundedVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') 🡒 [RoundedVisualMap](Tizen.UI.Visuals.Internal.RoundedVisualMap.md 'Tizen.UI.Visuals.Internal.RoundedVisualMap') 🡒 ColorVisualMap +### Constructors + + + +## ColorVisualMap() Constructor + +Constructor to instantiate the ColorVisualMap class. + +```csharp +public ColorVisualMap(); +``` +### Properties + + + +## ColorVisualMap.BlurRadius Property + +Gets or sets the blur radius of the color visual. + +```csharp +public float BlurRadius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ColorVisualMap.CutoutPolicy Property + +Gets or sets the cutout policy for the color visual, which determines how content is rendered around cutout regions. + +```csharp +public Tizen.UI.VisualCutoutPolicy CutoutPolicy { get; set; } +``` + +#### Property Value +Tizen.UI.VisualCutoutPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ImageVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ImageVisualMap.md new file mode 100644 index 0000000000..0a6e3398ba --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ImageVisualMap.md @@ -0,0 +1,306 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## ImageVisualMap Class + +The ImageVisualMap class is a class for setting the properties of the image visual. + +```csharp +public class ImageVisualMap : Tizen.UI.Visuals.Internal.RoundedVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') 🡒 [RoundedVisualMap](Tizen.UI.Visuals.Internal.RoundedVisualMap.md 'Tizen.UI.Visuals.Internal.RoundedVisualMap') 🡒 ImageVisualMap + +Derived +↳ [NPatchVisualMap](Tizen.UI.Visuals.Internal.NPatchVisualMap.md 'Tizen.UI.Visuals.Internal.NPatchVisualMap') +### Constructors + + + +## ImageVisualMap() Constructor + +Initializes a new instance of the [ImageVisualMap](Tizen.UI.Visuals.Internal.ImageVisualMap.md 'Tizen.UI.Visuals.Internal.ImageVisualMap') class. + +```csharp +public ImageVisualMap(); +``` +### Properties + + + +## ImageVisualMap.AlphaMaskUrl Property + +Gets or sets the URL of the alpha mask image resource. + +```csharp +public string AlphaMaskUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisualMap.CropToMask Property + +Gets or sets a value indicating whether to crop the image to the mask. + +```csharp +public bool CropToMask { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.DesiredHeight Property + +Gets or sets the desired image height.
+If not specified, the actual image height is used.
+For normal quad images only.
+Optional. + +```csharp +public float DesiredHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisualMap.DesiredWidth Property + +Gets or sets the desired image width.
+If not specified, the actual image width is used.
+For normal quad images only.
+Optional. + +```csharp +public float DesiredWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisualMap.FastTrackUploading Property + +Gets or sets whether to apply fast track uploading or not.
+ +```csharp +public bool FastTrackUploading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +### Remarks +If we use fast track uploading feature, It can upload texture without event-thead dependency. But also,
+ - Texture size is invalid until ResourceReady signal comes.
+ - Texture cannot be cached (We always try to load new image).
+ - Seamless visual change didn't supported.
+ - Alpha masking didn't supported. If you try, It will load as normal case.
+ - Synchronous loading didn't supported. If you try, It will load as normal case.
+ - Reload action didn't supported. If you try, It will load as normal case.
+ - Atlas loading didn't supported. If you try, It will load as normal case.
+ - Custom shader didn't supported. If you try, It will load as normal case. + + + +## ImageVisualMap.FittingMode Property + +Gets or sets the fitting mode of the image visual. + +```csharp +public Tizen.UI.FittingMode FittingMode { get; set; } +``` + +#### Property Value +Tizen.UI.FittingMode + + + +## ImageVisualMap.ImageLoadWithViewSize Property + +Gets or sets a value indicating whether the image should be loaded with the view size. + +```csharp +public bool ImageLoadWithViewSize { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +`true` if image load with view size; otherwise, `false`. + + + +## ImageVisualMap.LoadPolicy Property + +Gets or sets the Image Visual image loading policy.
+It decides if a texture should be loaded immediately after source set or only after the visual is added to the window. + +```csharp +public Tizen.UI.ImageLoadPolicy LoadPolicy { get; set; } +``` + +#### Property Value +Tizen.UI.ImageLoadPolicy + + + +## ImageVisualMap.MaskContentScale Property + +Gets or sets scale factor to apply to the content image before masking. + +```csharp +public float MaskContentScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## ImageVisualMap.MaskingMode Property + +Gets or sets whether to apply mask on GPU or not.
+ +```csharp +public Tizen.UI.ImageMaskingMode MaskingMode { get; set; } +``` + +#### Property Value +Tizen.UI.ImageMaskingMode + + + +## ImageVisualMap.OrientationCorrection Property + +Gets or sets a value indicating whether to correct the image orientation. + +```csharp +public bool OrientationCorrection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.PixelArea Property + +Gets or sets the pixel area of the image visual. + +```csharp +public Tizen.UI.Rect PixelArea { get; set; } +``` + +#### Property Value +Tizen.UI.Rect + + + +## ImageVisualMap.PreMultipliedAlpha Property + +Gets or sets the pre-multiplied alpha flag of the image. + +```csharp +public bool PreMultipliedAlpha { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.ReleasePolicy Property + +Gets or sets the Image Visual release policy.
+It decides if a texture should be released from the cache or kept to reduce the loading time.
+ +```csharp +public Tizen.UI.ImageReleasePolicy ReleasePolicy { get; set; } +``` + +#### Property Value +Tizen.UI.ImageReleasePolicy + + + +## ImageVisualMap.ResourceUrl Property + +Gets or sets the URL of the image resource + +```csharp +public string ResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisualMap.SynchronousLoading Property + +Gets or sets a value indicating whether to load the image synchronously. + +```csharp +public bool SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.WrapModeU Property + +Gets or sets the horizontal wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeU { get; set; } +``` + +#### Property Value +Tizen.UI.ImageWrapMode + + + +## ImageVisualMap.WrapModeV Property + +Gets or sets the vertical wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeV { get; set; } +``` + +#### Property Value +Tizen.UI.ImageWrapMode + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.NPatchVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.NPatchVisualMap.md new file mode 100644 index 0000000000..ddcf1934d4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.NPatchVisualMap.md @@ -0,0 +1,105 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## NPatchVisualMap Class + +The NPatchVisualMap is a class for setting the properties of the NPatchVisual. + +```csharp +public class NPatchVisualMap : Tizen.UI.Visuals.Internal.ImageVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') 🡒 [RoundedVisualMap](Tizen.UI.Visuals.Internal.RoundedVisualMap.md 'Tizen.UI.Visuals.Internal.RoundedVisualMap') 🡒 [ImageVisualMap](Tizen.UI.Visuals.Internal.ImageVisualMap.md 'Tizen.UI.Visuals.Internal.ImageVisualMap') 🡒 NPatchVisualMap +### Constructors + + + +## NPatchVisualMap() Constructor + +Constructor to instantiate the NPatchVisualMap class. + +```csharp +public NPatchVisualMap(); +``` +### Properties + + + +## NPatchVisualMap.AuxiliaryImageAlpha Property + +The alpha value of the auxiliary image. + +```csharp +public float AuxiliaryImageAlpha { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## NPatchVisualMap.AuxiliaryImageUrl Property + +The auxiliary image URL of the NPatchVisual. + +```csharp +public string AuxiliaryImageUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +### Remarks +Overlays the auxiliary image on top of an NPatch image. +The resulting visual image will be at least as large as the smallest possible n-patch or the auxiliary image, whichever is larger. + + + +## NPatchVisualMap.Border Property + +The border property of the NPatch image visual. + +```csharp +public Tizen.UI.Thickness Border { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## NPatchVisualMap.BorderOnly Property + +The border only property of the NPatchVisual. + +```csharp +public bool BorderOnly { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.RoundedVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.RoundedVisualMap.md new file mode 100644 index 0000000000..3ec907750e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.RoundedVisualMap.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## RoundedVisualMap Class + +RoundedVisualMap is an abstract class that represents a map for visuals that can have a rounded shape. + +```csharp +public abstract class RoundedVisualMap : Tizen.UI.Visuals.Internal.VisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') 🡒 RoundedVisualMap + +Derived +↳ [ColorVisualMap](Tizen.UI.Visuals.Internal.ColorVisualMap.md 'Tizen.UI.Visuals.Internal.ColorVisualMap') +↳ [ImageVisualMap](Tizen.UI.Visuals.Internal.ImageVisualMap.md 'Tizen.UI.Visuals.Internal.ImageVisualMap') +### Properties + + + +## RoundedVisualMap.BorderlineColor Property + +Gets or sets the borderline color of the visual object. + +```csharp +public Tizen.UI.Color BorderlineColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## RoundedVisualMap.BorderlineOffset Property + +Gets or sets the borderline offset of the visual object. + +```csharp +public float BorderlineOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The borderline offset indicates how far the borderline is from the visual object's boundary. +If the offset is 1, the borderline will be drawn outside the visual object's boundary. +If the offset is 0, the borderline will be drawn across the visual object's boundary. +If the offset is -1, the borderline will be drawn inside the visual object's boundary. + + + +## RoundedVisualMap.BorderlineWidth Property + +Gets or sets the borderline width of the visual object. + +```csharp +public float BorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundedVisualMap.CornerRadius Property + +Gets or sets the corner radius of the visual object. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.TextVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.TextVisualMap.md new file mode 100644 index 0000000000..d33eb791aa --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.TextVisualMap.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## TextVisualMap Class + +The TextVisualMap class is a class for the properties of the TextVisual. + +```csharp +public class TextVisualMap : Tizen.UI.Visuals.Internal.VisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') 🡒 TextVisualMap +### Constructors + + + +## TextVisualMap() Constructor + +Constructor to instantiate the TextVisualMap class. + +```csharp +public TextVisualMap(); +``` +### Properties + + + +## TextVisualMap.FontFamily Property + +Sets or gets the font family of the text visual. + +```csharp +public string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextVisualMap.FontSize Property + +Sets or gets the font size of the text visual. + +```csharp +public float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextVisualMap.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text visual. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + +## TextVisualMap.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextVisualMap.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool IsMultiline { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextVisualMap.Text Property + +Sets or gets the text of the TextVisual. + +```csharp +public string Text { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextVisualMap.TextColor Property + +Gets or sets the color of the text visual. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## TextVisualMap.VerticalAlignment Property + +Gets or sets the vertical alignment of the text visual. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.VisualMap.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.VisualMap.md new file mode 100644 index 0000000000..f37ff6f1b8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.VisualMap.md @@ -0,0 +1,235 @@ +### [Tizen.UI.Visuals.Internal](Tizen.UI.Visuals.Internal.md 'Tizen.UI.Visuals.Internal') + +## VisualMap Class + +The VisualMap class is an abstract class that provides a set of properties for visual objects. + +```csharp +public abstract class VisualMap : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 VisualMap + +Derived +↳ [RoundedVisualMap](Tizen.UI.Visuals.Internal.RoundedVisualMap.md 'Tizen.UI.Visuals.Internal.RoundedVisualMap') +↳ [TextVisualMap](Tizen.UI.Visuals.Internal.TextVisualMap.md 'Tizen.UI.Visuals.Internal.TextVisualMap') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## VisualMap.Color Property + +Gets or sets the color of the visual object. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## VisualMap.Handle Property + +Gets the PropertyMap handle for visual + +```csharp +public Tizen.UI.NativeHandle.PropertyMapHandle Handle { get; set; } +``` + +#### Property Value +Tizen.UI.NativeHandle.PropertyMapHandle + + + +## VisualMap.Height Property + +Gets or sets the height of the visual object. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualMap.ModifyHeight Property + +Modifies the height of the visual object. + +```csharp +public float ModifyHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +as pixel value, adjusted by adding or subtracting from the specified height + + + +## VisualMap.ModifyWidth Property + +Modifies the width of the visual object. + +```csharp +public float ModifyWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +as pixel value, adjusted by adding or subtracting from the specified width + + + +## VisualMap.Opacity Property + +Gets or sets the opacity of the visual object. + +```csharp +public float Opacity { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualMap.Origin Property + +Gets or sets the origin of the visual object. + +```csharp +public Tizen.UI.Visuals.VisualAlign Origin { get; set; } +``` + +#### Property Value +[VisualAlign](Tizen.UI.Visuals.VisualAlign.md 'Tizen.UI.Visuals.VisualAlign') + +### Remarks +The origin indicates the position of the visual object in the view. + + + +## VisualMap.TransformFlags Property + +Gets or sets the transform flags of the visual object. + +```csharp +public Tizen.UI.Visuals.TransformFlags TransformFlags { get; set; } +``` + +#### Property Value +[TransformFlags](Tizen.UI.Visuals.TransformFlags.md 'Tizen.UI.Visuals.TransformFlags') + +### Remarks +The transform flags indicate whether the position and size of the visual object are relative values or absolute pixel values. + + + +## VisualMap.Width Property + +Gets or sets the width of the visual object. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualMap.X Property + +Gets or sets the x position of the visual object. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualMap.Y Property + +Gets or sets the Y position of the visual object. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## VisualMap.SetDirty() Method + +Sets the map as dirty. + +```csharp +public void SetDirty(); +``` + + + +## VisualMap.UpdateTransformMap() Method + +Updates the transform map of the visual object. + +```csharp +public void UpdateTransformMap(); +``` +### Events + + + +## VisualMap.UpdateRequired Event + +Occurs when the update is required. + +```csharp +public event EventHandler UpdateRequired; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.md new file mode 100644 index 0000000000..663f1b20b3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.md @@ -0,0 +1,37 @@ + +## Tizen.UI.Visuals.Internal Namespace + +| Classes | | +| :--- | :--- | +| [ColorVisualMap](Tizen.UI.Visuals.Internal.ColorVisualMap.md 'Tizen.UI.Visuals.Internal.ColorVisualMap') | The ColorVisualMap class is used to define the properties of a color visual. | +| [ImageVisualMap](Tizen.UI.Visuals.Internal.ImageVisualMap.md 'Tizen.UI.Visuals.Internal.ImageVisualMap') | The ImageVisualMap class is a class for setting the properties of the image visual. | +| [NPatchVisualMap](Tizen.UI.Visuals.Internal.NPatchVisualMap.md 'Tizen.UI.Visuals.Internal.NPatchVisualMap') | The NPatchVisualMap is a class for setting the properties of the NPatchVisual. | +| [RoundedVisualMap](Tizen.UI.Visuals.Internal.RoundedVisualMap.md 'Tizen.UI.Visuals.Internal.RoundedVisualMap') | RoundedVisualMap is an abstract class that represents a map for visuals that can have a rounded shape. | +| [TextVisualMap](Tizen.UI.Visuals.Internal.TextVisualMap.md 'Tizen.UI.Visuals.Internal.TextVisualMap') | The TextVisualMap class is a class for the properties of the TextVisual. | +| [VisualMap](Tizen.UI.Visuals.Internal.VisualMap.md 'Tizen.UI.Visuals.Internal.VisualMap') | The VisualMap class is an abstract class that provides a set of properties for visual objects. | + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.NPatchVisual.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.NPatchVisual.md new file mode 100644 index 0000000000..c3f4a8856b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.NPatchVisual.md @@ -0,0 +1,94 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## NPatchVisual Class + +NPatchVisual is a class for the n-patch image visual. + +```csharp +public class NPatchVisual : Tizen.UI.Visuals.ImageVisual +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') 🡒 [RoundedVisual](Tizen.UI.Visuals.RoundedVisual.md 'Tizen.UI.Visuals.RoundedVisual') 🡒 [ImageVisual](Tizen.UI.Visuals.ImageVisual.md 'Tizen.UI.Visuals.ImageVisual') 🡒 NPatchVisual +### Properties + + + +## NPatchVisual.AuxiliaryImageAlpha Property + +The alpha value of the auxiliary image. + +```csharp +public float AuxiliaryImageAlpha { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## NPatchVisual.AuxiliaryImageUrl Property + +The auxiliary image URL of the NPatchVisual. + +```csharp +public string AuxiliaryImageUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +### Remarks +Overlays the auxiliary image on top of an NPatch image. +The resulting visual image will be at least as large as the smallest possible n-patch or the auxiliary image, whichever is larger. + + + +## NPatchVisual.Border Property + +The border property of the NPatch image visual. + +```csharp +public Tizen.UI.Thickness Border { get; set; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## NPatchVisual.BorderOnly Property + +The border only property of the NPatchVisual. + +```csharp +public bool BorderOnly { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.RoundedVisual.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.RoundedVisual.md new file mode 100644 index 0000000000..933eb67362 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.RoundedVisual.md @@ -0,0 +1,100 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## RoundedVisual Class + +RoundedVisual is a base class for visuals that can have a rounded shape. + +```csharp +public abstract class RoundedVisual : Tizen.UI.Visuals.VisualObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') 🡒 RoundedVisual + +Derived +↳ [ColorVisual](Tizen.UI.Visuals.ColorVisual.md 'Tizen.UI.Visuals.ColorVisual') +↳ [ImageVisual](Tizen.UI.Visuals.ImageVisual.md 'Tizen.UI.Visuals.ImageVisual') +### Properties + + + +## RoundedVisual.BorderlineColor Property + +Gets or sets the borderline color of the visual object. + +```csharp +public Tizen.UI.Color BorderlineColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## RoundedVisual.BorderlineOffset Property + +Gets or sets the borderline offset of the visual object. + +```csharp +public float BorderlineOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +The borderline offset indicates how far the borderline is from the visual object's boundary. +If the offset is 1, the borderline will be drawn outside the visual object's boundary. +If the offset is 0, the borderline will be drawn across the visual object's boundary. +If the offset is -1, the borderline will be drawn inside the visual object's boundary. + + + +## RoundedVisual.BorderlineWidth Property + +Gets or sets the borderline width of the visual object. + +```csharp +public float BorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RoundedVisual.CornerRadius Property + +Gets or sets the corner radius of the visual object. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +Tizen.UI.CornerRadius + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ShadowExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ShadowExtensions.md new file mode 100644 index 0000000000..5cc6b05303 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ShadowExtensions.md @@ -0,0 +1,86 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## ShadowExtensions Class + +Extension methods for shadow struct + +```csharp +public static class ShadowExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ShadowExtensions +### Methods + + + +## ShadowExtensions.ToVisual(this Shadow) Method + +This method creates a visual with the shadow information. + +```csharp +public static Tizen.UI.Visuals.ColorVisual ToVisual(this Tizen.UI.Shadow shadow); +``` +#### Parameters + + + +`shadow` Tizen.UI.Shadow + +The shadow object to create visual. + +#### Returns +[ColorVisual](Tizen.UI.Visuals.ColorVisual.md 'Tizen.UI.Visuals.ColorVisual') +The created visual. + + + +## ShadowExtensions.ToVisual(this Shadow, CornerRadius) Method + +This method creates a visual with the shadow information. + +```csharp +public static Tizen.UI.Visuals.ColorVisual ToVisual(this Tizen.UI.Shadow shadow, Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`shadow` Tizen.UI.Shadow + +The shadow object to create visual. + + + +`cornerRadius` Tizen.UI.CornerRadius + +The cornerRadius value to apply created visual. + +#### Returns +[ColorVisual](Tizen.UI.Visuals.ColorVisual.md 'Tizen.UI.Visuals.ColorVisual') +The created visual. + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TextVisual.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TextVisual.md new file mode 100644 index 0000000000..437ff0960a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TextVisual.md @@ -0,0 +1,153 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## TextVisual Class + +TextVisual is a class for the text visual. + +```csharp +public class TextVisual : Tizen.UI.Visuals.VisualObject, +Tizen.UI.IText +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') 🡒 TextVisual + +Implements Tizen.UI.IText +### Properties + + + +## TextVisual.EnableMarkup Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool EnableMarkup { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextVisual.FontFamily Property + +Sets or gets the font family of the text visual. + +```csharp +public string FontFamily { get; set; } +``` + +Implements FontFamily + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextVisual.FontSize Property + +Sets or gets the font size of the text visual. + +```csharp +public float FontSize { get; set; } +``` + +Implements FontSize + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextVisual.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text visual. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + +## TextVisual.MultiLine Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool MultiLine { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextVisual.Text Property + +Sets or gets the text of the TextVisual. + +```csharp +public string Text { get; set; } +``` + +Implements Text + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextVisual.TextColor Property + +Gets or sets the color of the text visual. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements TextColor + +#### Property Value +Tizen.UI.Color + + + +## TextVisual.VerticalAlignment Property + +Gets or sets the vertical alignment of the text visual. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +#### Property Value +Tizen.UI.TextAlignment + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TransformFlags.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TransformFlags.md new file mode 100644 index 0000000000..f7948bc0ec --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TransformFlags.md @@ -0,0 +1,83 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## TransformFlags Enum + +Enumeration for transform flags. + +```csharp +public enum TransformFlags +``` +### Fields + + + +`All` -1 + +Indicates that all properties of the child element should be proportional to its parent. + + + +`HeightProportional` 8 + +Indicates that the height of the child element should be proportional to its parent. + + + +`None` 0 + +No flags set. + + + +`PositionProportional` 3 + +Indicates that both the X and Y positions of the child element should be proportional to its parent. + + + +`SizeProportional` 12 + +Indicates that both the width and height of the child element should be proportional to its parent. + + + +`WidthProportional` 4 + +Indicates that the width of the child element should be proportional to its parent. + + + +`XProportional` 1 + +Indicates that the X position of the child element should be proportional to its parent. + + + +`YProportional` 2 + +Indicates that the Y position of the child element should be proportional to its parent. + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ViewExtensions.md new file mode 100644 index 0000000000..7f17e8e937 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ViewExtensions.md @@ -0,0 +1,116 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## ViewExtensions Class + +Extension methods for managing visual objects + +```csharp +public static class ViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewExtensions +### Methods + + + +## ViewExtensions.Add<T>(this T, VisualObject) Method + +Adds a visual to the view. + +```csharp +public static T Add<T>(this T view, Tizen.UI.Visuals.VisualObject visual) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.Visuals.ViewExtensions.md#Tizen.UI.Visuals.ViewExtensions.Add_T_(thisT,Tizen.UI.Visuals.VisualObject).T 'Tizen.UI.Visuals.ViewExtensions.Add<T>(this T, Tizen.UI.Visuals.VisualObject).T') + +The view to which the visual is added. + + + +`visual` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual to be added to the view. + +#### Returns +[T](Tizen.UI.Visuals.ViewExtensions.md#Tizen.UI.Visuals.ViewExtensions.Add_T_(thisT,Tizen.UI.Visuals.VisualObject).T 'Tizen.UI.Visuals.ViewExtensions.Add<T>(this T, Tizen.UI.Visuals.VisualObject).T') +The view with the added visual. + + + +## ViewExtensions.Remove(this View, VisualObject) Method + +Removes the specified visual from the view. + +```csharp +public static void Remove(this Tizen.UI.View view, Tizen.UI.Visuals.VisualObject visual); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The view to remove the visual from. + + + +`visual` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual to remove. + + + +## ViewExtensions.Visuals(this View) Method + +This method returns the VisualManager object associated with the given View. + +```csharp +public static Tizen.UI.Visuals.VisualManager Visuals(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` Tizen.UI.View + +The View object to retrieve the VisualManager from. + +#### Returns +[VisualManager](Tizen.UI.Visuals.VisualManager.md 'Tizen.UI.Visuals.VisualManager') +The VisualManager object associated with the given View. + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualAlign.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualAlign.md new file mode 100644 index 0000000000..9f7d871ec9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualAlign.md @@ -0,0 +1,89 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## VisualAlign Enum + +Enumeration for aligning visuals within their view boundaries. + +```csharp +public enum VisualAlign +``` +### Fields + + + +`BottomBegin` 6 + +Aligns the visual at the bottom-left corner of its view boundaries. + + + +`BottomCenter` 7 + +Aligns the visual at the bottom-center of its view boundaries. + + + +`BottomEnd` 8 + +Aligns the visual at the bottom-right corner of its view boundaries. + + + +`Center` 4 + +Aligns the visual at the center of its view boundaries. + + + +`CenterBegin` 3 + +Aligns the visual at the center-left of its view boundaries. + + + +`CenterEnd` 5 + +Aligns the visual at the center-right of its view boundaries. + + + +`TopBegin` 0 + +Aligns the visual at the top-left corner of its view boundaries. + + + +`TopCenter` 1 + +Aligns the visual at the top-center of its view boundaries. + + + +`TopEnd` 2 + +Aligns the visual at the top-right corner of its view boundaries. + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualManager.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualManager.md new file mode 100644 index 0000000000..e5c17460f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualManager.md @@ -0,0 +1,392 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## VisualManager Class + +VisualManager is a class that manages visuals. + +```csharp +public class VisualManager : +System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject>, +System.Collections.Generic.ICollection<Tizen.UI.Visuals.VisualObject>, +System.Collections.Generic.IEnumerable<Tizen.UI.Visuals.VisualObject>, +System.Collections.IEnumerable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 VisualManager + +Implements [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable') +### Constructors + + + +## VisualManager(View) Constructor + +Initializes a new instance of the VisualManager class. + +```csharp +public VisualManager(Tizen.UI.View owner); +``` +#### Parameters + + + +`owner` Tizen.UI.View + +The View object that owns this VisualManager. +### Properties + + + +## VisualManager.BackgroundLayer Property + +Gets the background layer for the visual object. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject> BackgroundLayer { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + +### Remarks +This layer is rendered below the background + + + +## VisualManager.ContentLayer Property + +Gets the content layer for the visual object. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject> ContentLayer { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + +### Remarks +This layer is rendered below the content. +It is a default layer of the visual object + + + +## VisualManager.Count Property + +Gets the number of visual objects in the content layer. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## VisualManager.DecorationLayer Property + +Gets the decoration layer for the visual object. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject> DecorationLayer { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + +### Remarks +This layer is rendered below the decoration + + + +## VisualManager.ForegroundEffectLayer Property + +Gets the foreground effect layer for the visual object. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject> ForegroundEffectLayer { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + +### Remarks +This layer is rendered below the foreground effect + + + +## VisualManager.IsReadOnly Property + +Gets a value indicating whether the VisualManager is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## VisualManager.Owner Property + +Gets the owner of the VisualManager. + +```csharp +public Tizen.UI.View Owner { get; } +``` + +#### Property Value +Tizen.UI.View + + + +## VisualManager.ShadowLayer Property + +Gets the shadow layer for the visual object. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.Visuals.VisualObject> ShadowLayer { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + +### Remarks +This layer is rendered below the shadow + + + +## VisualManager.this[int] Property + +Gets the visual at the specified index in the content layer + +```csharp +public Tizen.UI.Visuals.VisualObject this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') +### Methods + + + +## VisualManager.Add(VisualObject) Method + +Adds a visual to the content layer. + +```csharp +public void Add(Tizen.UI.Visuals.VisualObject item); +``` +#### Parameters + + + +`item` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual to add. + + + +## VisualManager.Clear() Method + +Clears all visual objects from the content layer. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## VisualManager.Contains(VisualObject) Method + +Checks whether the specified visual object exists in the content layer. + +```csharp +public bool Contains(Tizen.UI.Visuals.VisualObject item); +``` +#### Parameters + + + +`item` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual object to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the visual object exists in the content container, false otherwise. + + + +## VisualManager.CopyTo(VisualObject[], int) Method + +Copies the elements of the VisualBase collection to an Array, starting at a particular Array index. + +```csharp +public void CopyTo(Tizen.UI.Visuals.VisualObject[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The one-dimensional Array that is the destination of the elements copied from VisualBase collection. The Array must have zero-based indexing. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The zero-based index in array at which copying begins. + + + +## VisualManager.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.Visuals.VisualObject> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator that can be used to iterate through the collection. + + + +## VisualManager.IndexOf(VisualObject) Method + +Returns the zero-based index of the first occurrence of the specified visual in the content layer. + +```csharp +public int IndexOf(Tizen.UI.Visuals.VisualObject item); +``` +#### Parameters + + + +`item` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual to locate in the content layer. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The zero-based index of the first occurrence of the specified visual, if found; otherwise, -1. + + + +## VisualManager.Insert(int, VisualObject) Method + +Inserts a visual at the specified position in the content layer. + +```csharp +public void Insert(int index, Tizen.UI.Visuals.VisualObject item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The position at which to insert the visual. + + + +`item` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual to insert. + + + +## VisualManager.Remove(VisualObject) Method + +Removes the specified visual object from the content layer. + +```csharp +public bool Remove(Tizen.UI.Visuals.VisualObject item); +``` +#### Parameters + + + +`item` [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') + +The visual object to remove. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the visual object was removed successfully, false otherwise. + + + +## VisualManager.RemoveAt(int) Method + +Removes the child at the specified index from the content layer. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The zero-based index of the child to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## VisualManager.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the collection. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualObject.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualObject.md new file mode 100644 index 0000000000..db9197fdd8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualObject.md @@ -0,0 +1,205 @@ +### [Tizen.UI.Visuals](Tizen.UI.Visuals.md 'Tizen.UI.Visuals') + +## VisualObject Class + +VisualObject is the base class for all visuals. + +```csharp +public abstract class VisualObject : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 VisualObject + +Derived +↳ [RoundedVisual](Tizen.UI.Visuals.RoundedVisual.md 'Tizen.UI.Visuals.RoundedVisual') +↳ [TextVisual](Tizen.UI.Visuals.TextVisual.md 'Tizen.UI.Visuals.TextVisual') +### Properties + + + +## VisualObject.Color Property + +Gets or sets the color of the visual object. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## VisualObject.Height Property + +Gets or sets the height of the visual object. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualObject.ModifyHeight Property + +Modifies the height of the visual object. + +```csharp +public float ModifyHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +as pixel value, adjusted by adding or subtracting from the specified height + + + +## VisualObject.ModifyWidth Property + +Modifies the width of the visual object. + +```csharp +public float ModifyWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +### Remarks +as pixel value, adjusted by adding or subtracting from the specified width + + + +## VisualObject.Opacity Property + +Gets or sets the opacity of the visual object. + +```csharp +public float Opacity { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualObject.Origin Property + +Gets or sets the origin of the visual object. + +```csharp +public Tizen.UI.Visuals.VisualAlign Origin { get; set; } +``` + +#### Property Value +[VisualAlign](Tizen.UI.Visuals.VisualAlign.md 'Tizen.UI.Visuals.VisualAlign') + +### Remarks +The origin indicates the position of the visual object in the view. + + + +## VisualObject.SiblingOrder Property + +Sibling order of this VisualBase. + +```csharp +public int SiblingOrder { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +### Remarks +The sibling order is used to determine the draw order of the visuals. +The visuals with smaller sibling order are drawn bottom, +and the visuals with larger sibling order are drawn top. + +It will be changed automatically when the visuals are added to the view. +before attached the view it is 0 + + + +## VisualObject.TransformFlags Property + +Gets or sets the transform flags of the visual object. + +```csharp +public Tizen.UI.Visuals.TransformFlags TransformFlags { get; set; } +``` + +#### Property Value +[TransformFlags](Tizen.UI.Visuals.TransformFlags.md 'Tizen.UI.Visuals.TransformFlags') + +### Remarks +The transform flags indicate whether the position and size of the visual object are relative values or absolute pixel values. + + + +## VisualObject.Width Property + +Gets or sets the width of the visual object. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualObject.X Property + +Gets or sets the x position of the visual object. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## VisualObject.Y Property + +Gets or sets the Y position of the visual object. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.md b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.md new file mode 100644 index 0000000000..dc70a10f9b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.md @@ -0,0 +1,45 @@ + +## Tizen.UI.Visuals Namespace + +| Classes | | +| :--- | :--- | +| [ColorVisual](Tizen.UI.Visuals.ColorVisual.md 'Tizen.UI.Visuals.ColorVisual') | ColorVisual is a class for creating a color visual. | +| [ImageVisual](Tizen.UI.Visuals.ImageVisual.md 'Tizen.UI.Visuals.ImageVisual') | ImageVisual is a class for the image visual. | +| [NPatchVisual](Tizen.UI.Visuals.NPatchVisual.md 'Tizen.UI.Visuals.NPatchVisual') | NPatchVisual is a class for the n-patch image visual. | +| [RoundedVisual](Tizen.UI.Visuals.RoundedVisual.md 'Tizen.UI.Visuals.RoundedVisual') | RoundedVisual is a base class for visuals that can have a rounded shape. | +| [ShadowExtensions](Tizen.UI.Visuals.ShadowExtensions.md 'Tizen.UI.Visuals.ShadowExtensions') | Extension methods for shadow struct | +| [TextVisual](Tizen.UI.Visuals.TextVisual.md 'Tizen.UI.Visuals.TextVisual') | TextVisual is a class for the text visual. | +| [ViewExtensions](Tizen.UI.Visuals.ViewExtensions.md 'Tizen.UI.Visuals.ViewExtensions') | Extension methods for managing visual objects | +| [VisualManager](Tizen.UI.Visuals.VisualManager.md 'Tizen.UI.Visuals.VisualManager') | VisualManager is a class that manages visuals. | +| [VisualObject](Tizen.UI.Visuals.VisualObject.md 'Tizen.UI.Visuals.VisualObject') | VisualObject is the base class for all visuals. | + +| Enums | | +| :--- | :--- | +| [TransformFlags](Tizen.UI.Visuals.TransformFlags.md 'Tizen.UI.Visuals.TransformFlags') | Enumeration for transform flags. | +| [VisualAlign](Tizen.UI.Visuals.VisualAlign.md 'Tizen.UI.Visuals.VisualAlign') | Enumeration for aligning visuals within their view boundaries. | + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.Widget.md b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.Widget.md new file mode 100644 index 0000000000..fb2f1589fd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.Widget.md @@ -0,0 +1,85 @@ +### [Tizen.UI.Widget](Tizen.UI.Widget.md 'Tizen.UI.Widget') + +## Widget Class + +Widgets provide some common functionality required by all custom widgets. + +```csharp +public class Widget : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Widget +### Constructors + + + +## Widget() Constructor + +Constructor of widget class + +```csharp +public Widget(); +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.WidgetApplication.md b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.WidgetApplication.md new file mode 100644 index 0000000000..0b66698a27 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.WidgetApplication.md @@ -0,0 +1,108 @@ +### [Tizen.UI.Widget](Tizen.UI.Widget.md 'Tizen.UI.Widget') + +## WidgetApplication Class + +Represents an application that have UI screen. The WidgetApplication class has a default stage. + +```csharp +public class WidgetApplication +``` + +Inheritance Tizen.Applications.CoreApplication 🡒 WidgetApplication +### Constructors + + + +## WidgetApplication(Dictionary<Type,string>) Constructor + +Constructor of WidgetApplication class + +```csharp +public WidgetApplication(System.Collections.Generic.Dictionary<System.Type,string> widgetTypes); +``` +#### Parameters + + + +`widgetTypes` [System.Collections.Generic.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2')[System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System.Collections.Generic.Dictionary`2') + +Derived widget class type +### Methods + + + +## WidgetApplication.Run(string[]) Method + +Run WidgetApplication + +```csharp +public override void Run(string[] args); +``` +#### Parameters + + + +`args` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.md b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.md new file mode 100644 index 0000000000..815fac7dc8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.md @@ -0,0 +1,69 @@ +## Tizen.UI.Widget Namespace + +| Classes | | +| :--- | :--- | +| [Widget](Tizen.UI.Widget.Widget.md 'Tizen.UI.Widget.Widget') | Widgets provide some common functionality required by all custom widgets. | +| [WidgetApplication](Tizen.UI.Widget.WidgetApplication.md 'Tizen.UI.Widget.WidgetApplication') | Represents an application that have UI screen. The WidgetApplication class has a default stage. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.BorderViewModel.md b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.BorderViewModel.md new file mode 100644 index 0000000000..e736a83221 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.BorderViewModel.md @@ -0,0 +1,124 @@ +### [Tizen.UI.WindowBorder](Tizen.UI.WindowBorder.md 'Tizen.UI.WindowBorder').[BorderView](Tizen.UI.WindowBorder.BorderView.md 'Tizen.UI.WindowBorder.BorderView') + +## BorderView.BorderViewModel Class + +The BorderViewModel class provides the view model for the BorderView class. + +```csharp +public class BorderView.BorderViewModel : +System.ComponentModel.INotifyPropertyChanged +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BorderViewModel + +Implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged') +### Properties + + + +## BorderView.BorderViewModel.CloseAction Property + +Gets or sets the action to be performed when the window is closed. + +```csharp +public System.Action CloseAction { get; set; } +``` + +#### Property Value +[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + + + +## BorderView.BorderViewModel.IsMaximized Property + +Gets or sets a value indicating whether the window is maximized or not. + +```csharp +public bool IsMaximized { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## BorderView.BorderViewModel.MaximizeAction Property + +Gets or sets the action to be performed when the window is maximized or restored. + +```csharp +public System.Action<bool> MaximizeAction { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + + + +## BorderView.BorderViewModel.MinimizeAction Property + +Gets or sets the action to be performed when the window is minimized. + +```csharp +public System.Action MinimizeAction { get; set; } +``` + +#### Property Value +[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + + + +## BorderView.BorderViewModel.ResizeAction Property + +Gets or sets the action to be performed when the window is resized. + +```csharp +public System.Action<Tizen.UI.WindowResizeDirection> ResizeAction { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')Tizen.UI.WindowResizeDirection[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + + + +## BorderView.BorderViewModel.TargetWindow Property + +Gets or sets the target window of the BorderView. + +```csharp +public Tizen.UI.Window TargetWindow { get; set; } +``` + +#### Property Value +Tizen.UI.Window +### Events + + + +## BorderView.BorderViewModel.PropertyChanged Event + +Occurs when a property value changes. + +```csharp +public event PropertyChangedEventHandler PropertyChanged; +``` + +Implements [PropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged.PropertyChanged 'System.ComponentModel.INotifyPropertyChanged.PropertyChanged') + +#### Event Type +[System.ComponentModel.PropertyChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.PropertyChangedEventHandler 'System.ComponentModel.PropertyChangedEventHandler') + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.md b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.md new file mode 100644 index 0000000000..91afbbacb6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.md @@ -0,0 +1,195 @@ +### [Tizen.UI.WindowBorder](Tizen.UI.WindowBorder.md 'Tizen.UI.WindowBorder') + +## BorderView Class + +The BorderView class is a view that provides a border for a window. + +```csharp +public class BorderView : Tizen.UI.ContentView, +Tizen.UI.WindowBorder.IWindowBorderProvider +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Tizen.UI.NObject 🡒 Tizen.UI.View 🡒 Tizen.UI.ContentView 🡒 BorderView + +Implements [IWindowBorderProvider](Tizen.UI.WindowBorder.IWindowBorderProvider.md 'Tizen.UI.WindowBorder.IWindowBorderProvider') +### Constructors + + + +## BorderView() Constructor + +Constructor to create a new instance of BorderView class. + +```csharp +public BorderView(); +``` + + + +## BorderView(ViewTemplate) Constructor + +Constructor to create a new instance of BorderView class. + +```csharp +public BorderView(Tizen.UI.ViewTemplate header); +``` +#### Parameters + + + +`header` Tizen.UI.ViewTemplate + +The header view template of BorderView. + + + +## BorderView(ViewTemplate, ViewTemplate) Constructor + +Constructor to create a new instance of BorderView class. + +```csharp +public BorderView(Tizen.UI.ViewTemplate header, Tizen.UI.ViewTemplate footer); +``` +#### Parameters + + + +`header` Tizen.UI.ViewTemplate + +The header view template of BorderView. + + + +`footer` Tizen.UI.ViewTemplate + +The footer view template of BorderView. +### Properties + + + +## BorderView.BorderActiveColor Property + +Gets or sets the color of the border when it is active. + +```csharp +public Tizen.UI.Color BorderActiveColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## BorderView.BorderArea Property + +Gets the thickness of the border area. + +```csharp +public Tizen.UI.Thickness BorderArea { get; set; } +``` + +Implements [BorderArea](Tizen.UI.WindowBorder.IWindowBorderProvider.md#Tizen.UI.WindowBorder.IWindowBorderProvider.BorderArea 'Tizen.UI.WindowBorder.IWindowBorderProvider.BorderArea') + +#### Property Value +Tizen.UI.Thickness + + + +## BorderView.BorderColor Property + +Gets or sets the color of the border. + +```csharp +public Tizen.UI.Color BorderColor { get; set; } +``` + +#### Property Value +Tizen.UI.Color + + + +## BorderView.DefaultBorderWidth Property + +Gets or sets the default width of the border. + +```csharp +public float DefaultBorderWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## BorderView.EnableOverlayBorder Property + +Gets or sets a value indicating whether the overlay border is enabled or not. + +```csharp +public bool EnableOverlayBorder { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## BorderView.FooterTemplate Property + +Gets or sets the template used to create the footer of the border. + +```csharp +public Tizen.UI.ViewTemplate FooterTemplate { get; } +``` + +#### Property Value +Tizen.UI.ViewTemplate + + + +## BorderView.HeaderTemplate Property + +Gets or sets the template used to create the header of the border. + +```csharp +public Tizen.UI.ViewTemplate HeaderTemplate { get; } +``` + +#### Property Value +Tizen.UI.ViewTemplate +### Methods + + + +## BorderView.HideOverlayBorder() Method + +Hides the overlay border. + +```csharp +public void HideOverlayBorder(); +``` + + + +## BorderView.ShowOverlayBorder() Method + +Shows the overlay border. + +```csharp +public void ShowOverlayBorder(); +``` + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.IWindowBorderProvider.md b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.IWindowBorderProvider.md new file mode 100644 index 0000000000..8dc800cc1d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.IWindowBorderProvider.md @@ -0,0 +1,72 @@ +### [Tizen.UI.WindowBorder](Tizen.UI.WindowBorder.md 'Tizen.UI.WindowBorder') + +## IWindowBorderProvider Interface + +Provides an interface for managing the border of a window. + +```csharp +public interface IWindowBorderProvider +``` + +Derived +↳ [BorderView](Tizen.UI.WindowBorder.BorderView.md 'Tizen.UI.WindowBorder.BorderView') +### Properties + + + +## IWindowBorderProvider.BorderArea Property + +Gets the thickness of the border area. + +```csharp +Tizen.UI.Thickness BorderArea { get; } +``` + +#### Property Value +Tizen.UI.Thickness + + + +## IWindowBorderProvider.BorderView Property + +Gets the view representing the border. + +```csharp +Tizen.UI.View BorderView { get; } +``` + +#### Property Value +Tizen.UI.View +### Methods + + + +## IWindowBorderProvider.SetTargetWindow(Window) Method + +Sets the target window of the border. + +```csharp +void SetTargetWindow(Tizen.UI.Window window); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The target window. + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.WindowExtensions.md b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.WindowExtensions.md new file mode 100644 index 0000000000..68b7af9d71 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.WindowExtensions.md @@ -0,0 +1,88 @@ +### [Tizen.UI.WindowBorder](Tizen.UI.WindowBorder.md 'Tizen.UI.WindowBorder') + +## WindowExtensions Class + +Provides extension methods for Window border. + +```csharp +public static class WindowExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 WindowExtensions +### Methods + + + +## WindowExtensions.ClearBorderView(this Window) Method + +Clears the border view of the window. + +```csharp +public static void ClearBorderView(this Tizen.UI.Window window); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to clear the border view. + + + +## WindowExtensions.GetBorderLayer(this Window) Method + +Gets the border layer of the window. + +```csharp +public static Tizen.UI.Layer GetBorderLayer(this Tizen.UI.Window window); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to get the border layer. + +#### Returns +Tizen.UI.Layer +The border layer of the window. + + + +## WindowExtensions.SetBorderView(this Window, IWindowBorderProvider) Method + +Sets the border view of the window using the specified [IWindowBorderProvider](Tizen.UI.WindowBorder.IWindowBorderProvider.md 'Tizen.UI.WindowBorder.IWindowBorderProvider'). + +```csharp +public static void SetBorderView(this Tizen.UI.Window window, Tizen.UI.WindowBorder.IWindowBorderProvider provider); +``` +#### Parameters + + + +`window` Tizen.UI.Window + +The window to set the border view. + + + +`provider` [IWindowBorderProvider](Tizen.UI.WindowBorder.IWindowBorderProvider.md 'Tizen.UI.WindowBorder.IWindowBorderProvider') + +The [IWindowBorderProvider](Tizen.UI.WindowBorder.IWindowBorderProvider.md 'Tizen.UI.WindowBorder.IWindowBorderProvider') used to create and manage the border view. + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.md b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.md new file mode 100644 index 0000000000..36acbd2902 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.md @@ -0,0 +1,26 @@ +## Tizen.UI.WindowBorder Namespace + +| Classes | | +| :--- | :--- | +| [BorderView](Tizen.UI.WindowBorder.BorderView.md 'Tizen.UI.WindowBorder.BorderView') | The BorderView class is a view that provides a border for a window. | +| [BorderView.BorderViewModel](Tizen.UI.WindowBorder.BorderView.BorderViewModel.md 'Tizen.UI.WindowBorder.BorderView.BorderViewModel') | The BorderViewModel class provides the view model for the BorderView class. | +| [WindowExtensions](Tizen.UI.WindowBorder.WindowExtensions.md 'Tizen.UI.WindowBorder.WindowExtensions') | Provides extension methods for Window border. | + +| Interfaces | | +| :--- | :--- | +| [IWindowBorderProvider](Tizen.UI.WindowBorder.IWindowBorderProvider.md 'Tizen.UI.WindowBorder.IWindowBorderProvider') | Provides an interface for managing the border of a window. | + + + + + + + + + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityAction.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityAction.md new file mode 100644 index 0000000000..33bbef5437 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityAction.md @@ -0,0 +1,46 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityAction Enum + +Specifies the accessibility action sent from the accessibility service. + +```csharp +public enum AccessibilityAction +``` +### Fields + + + +`Activated` 0 + +The action indicates that the view is activated. + + + +`Decrement` 3 + +The action indicates that the value of the view decreases. + + + +`Escape` 1 + +The action indicates that the highlight goes out of the view. + + + +`Increment` 2 + +The action indicates that the value of the view indreases. + + + +`ScrollToChild` 4 + +The action indicates that scrolling occurs in the child of the view. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityActionReceivedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityActionReceivedEventArgs.md new file mode 100644 index 0000000000..20ec18ade3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityActionReceivedEventArgs.md @@ -0,0 +1,45 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityActionReceivedEventArgs Class + +Provides the data for the View.AccessibilityActionReceived event. + +```csharp +public class AccessibilityActionReceivedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AccessibilityActionReceivedEventArgs +### Properties + + + +## AccessibilityActionReceivedEventArgs.ActionType Property + +The [AccessibilityAction](Tizen.UI.AccessibilityAction.md 'Tizen.UI.AccessibilityAction') enum indicates what kind of action should be performed on the target view. + +```csharp +public Tizen.UI.AccessibilityAction ActionType { get; set; } +``` + +#### Property Value +[AccessibilityAction](Tizen.UI.AccessibilityAction.md 'Tizen.UI.AccessibilityAction') + + + +## AccessibilityActionReceivedEventArgs.Target Property + +The target view for the action. this is typically null and only set +when the action semantically requires a concrete child target (e.g., ScrollToChild). + +```csharp +public Tizen.UI.View Target { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityDescriptionRequestedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityDescriptionRequestedEventArgs.md new file mode 100644 index 0000000000..b405f09faa --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityDescriptionRequestedEventArgs.md @@ -0,0 +1,31 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityDescriptionRequestedEventArgs Class + +Accessibility description requested event args + +```csharp +public class AccessibilityDescriptionRequestedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AccessibilityDescriptionRequestedEventArgs +### Properties + + + +## AccessibilityDescriptionRequestedEventArgs.Description Property + +Accessibility description. + +```csharp +public string Description { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityExtensions.md new file mode 100644 index 0000000000..cb0d554c6b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityExtensions.md @@ -0,0 +1,404 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityExtensions Class + +Provides extension methods for the [View](Tizen.UI.View.md 'Tizen.UI.View') class. + +```csharp +public static class AccessibilityExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AccessibilityExtensions +### Methods + + + +## AccessibilityExtensions.AccessibilityDescription<TView>(this TView, string) Method + +Sets the accessibility description of the view. + +```csharp +public static TView AccessibilityDescription<TView>(this TView view, string description) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityDescription_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityDescription<TView>(this TView, string).TView') + +The view to set the accessibility description for. + + + +`description` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The accessibility description to set. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityDescription_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityDescription<TView>(this TView, string).TView') +The view itself. + + + +## AccessibilityExtensions.AccessibilityHidden<TView>(this TView, bool) Method + +Sets whether the view is hidden from accessibility. + +```csharp +public static TView AccessibilityHidden<TView>(this TView view, bool isHidden) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityHidden_TView_(thisTView,bool).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityHidden<TView>(this TView, bool).TView') + +The view to set the accessibility hidden property for. + + + +`isHidden` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the view is hidden from accessibility, false otherwise. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityHidden_TView_(thisTView,bool).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityHidden<TView>(this TView, bool).TView') +The view itself. + + + +## AccessibilityExtensions.AccessibilityHighlightable<TView>(this TView, bool) Method + +Sets whether the view can be highlighted by accessibility. + +```csharp +public static TView AccessibilityHighlightable<TView>(this TView view, bool isHighlightable) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityHighlightable_TView_(thisTView,bool).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityHighlightable<TView>(this TView, bool).TView') + +The view to set the accessibility highlightable property for. + + + +`isHighlightable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the view can be highlighted by accessibility, false otherwise. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityHighlightable_TView_(thisTView,bool).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityHighlightable<TView>(this TView, bool).TView') +The view itself. + + + +## AccessibilityExtensions.AccessibilityName<TView>(this TView, string) Method + +Sets the accessibility name of the view. + +```csharp +public static TView AccessibilityName<TView>(this TView view, string name) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityName_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityName<TView>(this TView, string).TView') + +The view to set the accessibility name for. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The accessibility name to set. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityName_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityName<TView>(this TView, string).TView') +The view itself. + + + +## AccessibilityExtensions.AccessibilityRole<TView>(this TView, AccessibilityRole) Method + +Sets the accessibility role of the view. + +```csharp +public static TView AccessibilityRole<TView>(this TView view, Tizen.UI.AccessibilityRole role) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityRole_TView_(thisTView,Tizen.UI.AccessibilityRole).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityRole<TView>(this TView, Tizen.UI.AccessibilityRole).TView') + +The view to set the accessibility role for. + + + +`role` [AccessibilityRole](Tizen.UI.AccessibilityRole.md 'Tizen.UI.AccessibilityRole') + +The accessibility role to set. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AccessibilityRole_TView_(thisTView,Tizen.UI.AccessibilityRole).TView 'Tizen.UI.AccessibilityExtensions.AccessibilityRole<TView>(this TView, Tizen.UI.AccessibilityRole).TView') +The view itself. + + + +## AccessibilityExtensions.AutomationId<TView>(this TView, string) Method + +Sets the automation ID of the view. + +```csharp +public static TView AutomationId<TView>(this TView view, string id) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AutomationId_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AutomationId<TView>(this TView, string).TView') + +The view to set the automation ID for. + + + +`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The automation ID to set. + +#### Returns +[TView](Tizen.UI.AccessibilityExtensions.md#Tizen.UI.AccessibilityExtensions.AutomationId_TView_(thisTView,string).TView 'Tizen.UI.AccessibilityExtensions.AutomationId<TView>(this TView, string).TView') +The view itself. + + + +## AccessibilityExtensions.GetAccessibilityIsModal(this View) Method + +Gets the AccessibilityIsModal property of the view. + +```csharp +public static bool GetAccessibilityIsModal(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the property value for. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +The value to describe whether the view is modal or not + + + +## AccessibilityExtensions.GetAccessibilityIsScrollable(this View) Method + +Gets the AccessibilityScrollable property of the view. + +```csharp +public static bool GetAccessibilityIsScrollable(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the property value for. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +The value to describe whether the view is scrollable or not + + + +## AccessibilityExtensions.GetAccessibilityStates(this View) Method + +Gets the AccessibilityStates property of the view. + +```csharp +public static Tizen.UI.AccessibilityStates GetAccessibilityStates(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the property value for. + +#### Returns +[AccessibilityStates](Tizen.UI.AccessibilityStates.md 'Tizen.UI.AccessibilityStates') +The states[AccessibilityStates](Tizen.UI.AccessibilityStates.md 'Tizen.UI.AccessibilityStates') of the view + + + +## AccessibilityExtensions.GetAccessibilityValue(this View) Method + +Gets the AccessibilityValue property of the view. + +```csharp +public static string GetAccessibilityValue(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the property value for. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The accessibility value of the view + + + +## AccessibilityExtensions.SetAccessibilityIsModal(this View, bool) Method + +Sets the AccessibilityIsModal property of the view. + +```csharp +public static void SetAccessibilityIsModal(this Tizen.UI.View view, bool modal); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the property value to. + + + +`modal` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The value to set. + + + +## AccessibilityExtensions.SetAccessibilityIsScrollable(this View, bool) Method + +Sets the AccessibilityScrollable property of the view. + +```csharp +public static void SetAccessibilityIsScrollable(this Tizen.UI.View view, bool scrollable); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the property value to. + + + +`scrollable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The value to set. + + + +## AccessibilityExtensions.SetAccessibilityStates(this View, AccessibilityStates) Method + +Sets the AccessibilityStates property of the view. + +```csharp +public static void SetAccessibilityStates(this Tizen.UI.View view, Tizen.UI.AccessibilityStates states); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the property value to. + + + +`states` [AccessibilityStates](Tizen.UI.AccessibilityStates.md 'Tizen.UI.AccessibilityStates') + +The states[AccessibilityStates](Tizen.UI.AccessibilityStates.md 'Tizen.UI.AccessibilityStates') value to set. + + + +## AccessibilityExtensions.SetAccessibilityValue(this View, string) Method + +Sets the AccessibilityValue property of the view. + +```csharp +public static void SetAccessibilityValue(this Tizen.UI.View view, string value); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the property value to. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The value to set. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityHighlightChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityHighlightChangedEventArgs.md new file mode 100644 index 0000000000..2b8e08002d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityHighlightChangedEventArgs.md @@ -0,0 +1,31 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityHighlightChangedEventArgs Class + +Provides the data for the View.AccessibilityHighlightChanged event. + +```csharp +public class AccessibilityHighlightChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AccessibilityHighlightChangedEventArgs +### Properties + + + +## AccessibilityHighlightChangedEventArgs.IsHighlighted Property + +Gets or sets a value indicating whether the target view gained accessibility highlight or not. + +```csharp +public bool IsHighlighted { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityManager.md new file mode 100644 index 0000000000..62727f191f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityManager.md @@ -0,0 +1,234 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityManager Class + +Provides accessibility features for the application. + +```csharp +public static class AccessibilityManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AccessibilityManager +### Properties + + + +## AccessibilityManager.IsAccessibilityEnabled Property + +Gets a value indicating whether accessibility is enabled. + +```csharp +public static bool IsAccessibilityEnabled { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## AccessibilityManager.IsScreenReaderEnabled Property + +Gets a value indicating whether a screen reader is enabled. + +```csharp +public static bool IsScreenReaderEnabled { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## AccessibilityManager.AnnounceAsync(string, bool) Method + +Announces the specified sentence. + +```csharp +public static System.Threading.Tasks.Task<Tizen.UI.AnnouncementState> AnnounceAsync(string sentence, bool discardable); +``` +#### Parameters + + + +`sentence` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The sentence to announce. + + + +`discardable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the announcement can be discarded by the user. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[AnnouncementState](Tizen.UI.AnnouncementState.md 'Tizen.UI.AnnouncementState')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +A task that represents the announcement operation. + + + +## AccessibilityManager.CancelAnnouncement() Method + +Cancels the current announcement. + +```csharp +public static void CancelAnnouncement(); +``` + + + +## AccessibilityManager.GetHighlighted() Method + +Gets the currently highlighted view. + +```csharp +public static Tizen.UI.View GetHighlighted(); +``` + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The currently highlighted view. + + + +## AccessibilityManager.SendChangedNameEvent(View) Method + +Sends an accessibility event indicating that the name has changed. + +```csharp +public static void SendChangedNameEvent(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The target view whose name change event will be sent. + +### Remarks +This function notifies screen-readers that the accessible name of the specified view has been updated. + + + +## AccessibilityManager.SendShowingEvent(View, bool) Method + +Sends an accessibility event indicating that the showing state of the specified view. + +```csharp +public static void SendShowingEvent(Tizen.UI.View view, bool isShowing); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The target view whose showing state change will be reported. + + + +`isShowing` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A boolean value indicating whether the view is now visible (`true`) or hidden(`false`). + +### Remarks +This function notifies screen-readers whether the target view has become visible (`true`) or hidden(`false`). + + + +## AccessibilityManager.SetHighlight(View) Method + +Sets the highlight to the specified view. + +```csharp +public static bool SetHighlight(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the highlight indicator to. If it is null, the existing highlight will be cleared and return true. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the focus is set successfully, false otherwise. + + + +## AccessibilityManager.SetHighlightIndicator(View) Method + +Sets the highlight indicator to the specified view. + +```csharp +public static void SetHighlightIndicator(Tizen.UI.View indicator); +``` +#### Parameters + + + +`indicator` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to set the highlight indicator to. + + + +## AccessibilityManager.SetReadingInfo(View, AccessibilityReadingInfo) Method + +Sets the reading information type of the specified view to name. + +```csharp +public static void SetReadingInfo(Tizen.UI.View view, Tizen.UI.AccessibilityReadingInfo readingInfo); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The target view whose reading information type will be set to name + + + +`readingInfo` [AccessibilityReadingInfo](Tizen.UI.AccessibilityReadingInfo.md 'Tizen.UI.AccessibilityReadingInfo') + +The reading information type will be set + +### Remarks +This function configures the accessibility reading behavior so that +screen readers announce the view's name when the view receives accessibility focus. +### Events + + + +## AccessibilityManager.AccessibilityStateChanged Event + +Occurs when the accessibility state changes. + +```csharp +public static event EventHandler AccessibilityStateChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## AccessibilityManager.ScreenReaderStateChanged Event + +Occurs when the screen reader state changes. + +```csharp +public static event EventHandler ScreenReaderStateChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityNameRequestedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityNameRequestedEventArgs.md new file mode 100644 index 0000000000..6aba571a0d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityNameRequestedEventArgs.md @@ -0,0 +1,31 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityNameRequestedEventArgs Class + +Accessibility name requested event args + +```csharp +public class AccessibilityNameRequestedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AccessibilityNameRequestedEventArgs +### Properties + + + +## AccessibilityNameRequestedEventArgs.Name Property + +Accessibility name. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityReadingInfo.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityReadingInfo.md new file mode 100644 index 0000000000..5d50ed4ffa --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityReadingInfo.md @@ -0,0 +1,46 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityReadingInfo Enum + +Accessibility reading information types. + +```csharp +public enum AccessibilityReadingInfo +``` +### Fields + + + +`Description` 4 + +Description trait for reading information. + + + +`Name` 1 + +Name trait for reading information. + + + +`None` 0 + +None. + + + +`Role` 2 + +Role trait for reading information. + + + +`State` 8 + +State trait for reading information. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRelation.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRelation.md new file mode 100644 index 0000000000..aa03f57a99 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRelation.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityRelation Enum + +Specifies the ralation type between accessible views. + +```csharp +public enum AccessibilityRelation +``` +### Fields + + + +`DescribedBy` 18 + +Described by. + + + +`FlowsFrom` 11 + +Flows from. + + + +`FlowsTo` 10 + +Flows to. + + + +`LabelledBy` 2 + +Labelled by. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRole.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRole.md new file mode 100644 index 0000000000..0ba10791bc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRole.md @@ -0,0 +1,172 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityRole Enum + +Specifies the role of an accessible object. + +```csharp +public enum AccessibilityRole +``` +### Fields + + + +`Adjustable` 51 + +A slider + + + +`Alert` 2 + +An alert + + + +`Button` 43 + +A Button + + + +`CheckBox` 7 + +A CheckBox + + + +`ComboBox` 11 + +A ComboBox + + + +`Dialog` 16 + +A Dialog + + + +`Entry` 80 + +An Entry + + + +`Header` 71 + +A Header + + + +`Image` 27 + +An Image + + + +`Link` 88 + +A Link + + + +`Menu` 33 + +A Menu + + + +`MenuBar` 34 + +A MenuBar + + + +`MenuItem` 35 + +A MenuItem + + + +`None` 67 + +None + + + +`PasswordText` 40 + +A PassworkText + + + +`PopupMenu` 41 + +A PopupMenu + + + +`ProgressBar` 42 + +A ProgressBar + + + +`RadioButton` 44 + +A RadioButton + + + +`ScrollBar` 48 + +A ScrollBar + + + +`SpinButton` 52 + +A SpinButton + + + +`Tab` 37 + +A Tab + + + +`TabList` 38 + +A TabList + + + +`Text` 61 + +A Text + + + +`Timer` 115 + +A Timer + + + +`ToggleButton` 62 + +A ToggleButton + + + +`Toolbar` 63 + +A Toolbar + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityState.md new file mode 100644 index 0000000000..97b29eaf49 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityState.md @@ -0,0 +1,46 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityState Enum + +AccessibilityState is an enumeration that represents the states of the view to send to assistive service. + +```csharp +public enum AccessibilityState +``` +### Fields + + + +`Busy` 8 + +Indicates whether an element is currently busy or not. + + + +`Checked` 4 + +Indicates the state of a checkable element. + + + +`Enabled` 1 + +Indicates whether the view is enabled or not. + + + +`Expanded` 16 + +Indicates whether an expandable element is currently expanded or collapsed. + + + +`Selected` 2 + +Indicates whether a selectable element is currently selected or not. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityStates.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityStates.md new file mode 100644 index 0000000000..cecf9f493c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityStates.md @@ -0,0 +1,36 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AccessibilityStates Struct + +The AccessibilityStates structure represents a set of states of the view to communicate to assistive service. + +```csharp +public struct AccessibilityStates +``` +### Properties + + + +## AccessibilityStates.this[AccessibilityState] Property + +Gets the state at the specified name + +```csharp +public bool this[Tizen.UI.AccessibilityState state] { get; set; } +``` +#### Parameters + + + +`state` [AccessibilityState](Tizen.UI.AccessibilityState.md 'Tizen.UI.AccessibilityState') + +The name of the state + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ActionButtonTitle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ActionButtonTitle.md new file mode 100644 index 0000000000..349c431041 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ActionButtonTitle.md @@ -0,0 +1,68 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ActionButtonTitle Enum + +Enumeration for the action button titles. + +```csharp +public enum ActionButtonTitle +``` +### Fields + + + +`Default` 0 + +Default action. + + + +`Done` 1 + +Done. + + + +`Go` 2 + +Go action. + + + +`Join` 3 + +Join action. + + + +`Login` 4 + +Login action. + + + +`Next` 5 + +Next action. + + + +`Search` 6 + +Search action. + + + +`Send` 7 + +Send action. + + + +`SignIn` 8 + +Sign in action. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AlphaFunction.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AlphaFunction.md new file mode 100644 index 0000000000..e6b64f5072 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AlphaFunction.md @@ -0,0 +1,105 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AlphaFunction Class + +The AlphaFunction class provides a way to define custom interpolation for animations. + +```csharp +public sealed class AlphaFunction : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AlphaFunction + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## AlphaFunction(Func<float,float>) Constructor + +Creates an AlphaFunction object with a user-defined function. + +```csharp +public AlphaFunction(System.Func<float,float> userAlpha); +``` +#### Parameters + + + +`userAlpha` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + +The user-defined function to use. + + + +## AlphaFunction(BuiltinAlphaFunctions) Constructor + +Creates an AlphaFunction object with a built-in function. + +```csharp +public AlphaFunction(Tizen.UI.BuiltinAlphaFunctions builtin); +``` +#### Parameters + + + +`builtin` [BuiltinAlphaFunctions](Tizen.UI.BuiltinAlphaFunctions.md 'Tizen.UI.BuiltinAlphaFunctions') + +The built-in function to use. + + + +## AlphaFunction(Point, Point) Constructor + +Creates a bezier curve alpha function with two control points. + +```csharp +public AlphaFunction(Tizen.UI.Point point1, Tizen.UI.Point point2); +``` +#### Parameters + + + +`point1` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The first control point. + + + +`point2` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The second control point. +### Properties + + + +## AlphaFunction.Handle Property + +Gets the handle of the AlphaFunction object. + +```csharp +public System.IntPtr Handle { get; } +``` + +#### Property Value +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') +### Methods + + + +## AlphaFunction.Dispose() Method + +Disposes of this object and releases all resources. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnchorClickedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnchorClickedEventArgs.md new file mode 100644 index 0000000000..69e7d56e12 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnchorClickedEventArgs.md @@ -0,0 +1,31 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnchorClickedEventArgs Class + +Provides data for the [AnchorClicked](Tizen.UI.InputView.md#Tizen.UI.InputView.AnchorClicked 'Tizen.UI.InputView.AnchorClicked') event. + +```csharp +public class AnchorClickedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 AnchorClickedEventArgs +### Properties + + + +## AnchorClickedEventArgs.Href Property + +Anchor href(hypertext reference). + +```csharp +public string Href { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimatablePropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimatablePropertyValue.md new file mode 100644 index 0000000000..58dad93bad --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimatablePropertyValue.md @@ -0,0 +1,372 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnimatablePropertyValue Class + +AnimatablePropertyValue is an abstract class that represents a property value that can be animated. + +```csharp +public abstract class AnimatablePropertyValue : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AnimatablePropertyValue + +Derived +↳ [BackgroundPropertyValue](Tizen.UI.BackgroundPropertyValue.md 'Tizen.UI.BackgroundPropertyValue') +↳ [CornerRadiusPropertyValue](Tizen.UI.CornerRadiusPropertyValue.md 'Tizen.UI.CornerRadiusPropertyValue') +↳ [CustomPropertyValue](Tizen.UI.CustomPropertyValue.md 'Tizen.UI.CustomPropertyValue') +↳ [OpacityPropertyValue](Tizen.UI.OpacityPropertyValue.md 'Tizen.UI.OpacityPropertyValue') +↳ [PositionPropertyValue](Tizen.UI.PositionPropertyValue.md 'Tizen.UI.PositionPropertyValue') +↳ [RotationPropertyValue](Tizen.UI.RotationPropertyValue.md 'Tizen.UI.RotationPropertyValue') +↳ [ScalePropertyValue](Tizen.UI.ScalePropertyValue.md 'Tizen.UI.ScalePropertyValue') +↳ [SizePropertyValue](Tizen.UI.SizePropertyValue.md 'Tizen.UI.SizePropertyValue') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## AnimatablePropertyValue.Value Property + +Gets the value of the property. + +```csharp +public abstract Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## AnimatablePropertyValue.CreateBackgroundColorValue(Color) Method + +Creates a new instance of the BackgroundPropertyValue class with the specified background color. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateBackgroundColorValue(Tizen.UI.Color backgroundColor); +``` +#### Parameters + + + +`backgroundColor` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The background color to set. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +A new instance of the BackgroundPropertyValue class with the specified background color. + + + +## AnimatablePropertyValue.CreateCornerRadiusValue(CornerRadius) Method + +Creates a new instance of the AnimatablePropertyValue class with the specified CornerRadius value. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateCornerRadiusValue(Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`cornerRadius` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The CornerRadius value to be used for the AnimatablePropertyValue. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +A new instance of the AnimatablePropertyValue class with the specified CornerRadius value. + + + +## AnimatablePropertyValue.CreateCustomValue(string, object) Method + +Creates a new CustomPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateCustomValue(string propertyName, object value); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the custom property. + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The value of the custom property. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new CustomPropertyValue object. + + + +## AnimatablePropertyValue.CreateCustomValue(string, PropertyValueHandle) Method + +Creates a new CustomPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateCustomValue(string propertyName, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the custom property. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The value of the custom property. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new CustomPropertyValue object. + + + +## AnimatablePropertyValue.CreateOpacityValue(float) Method + +Creates a new OpacityPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateOpacityValue(float opacity); +``` +#### Parameters + + + +`opacity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The opacity value. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new OpacityPropertyValue object. + + + +## AnimatablePropertyValue.CreatePositionValue(float, float) Method + +Creates a new PositionPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreatePositionValue(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x position. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y position. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new PositionPropertyValue object. + + + +## AnimatablePropertyValue.CreatePositionValue(Point) Method + +Creates a new PositionPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreatePositionValue(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The position. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new PositionPropertyValue object. + + + +## AnimatablePropertyValue.CreateRotationValue(float, float, float) Method + +Creates a new RotationPropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateRotationValue(float rotationX, float rotationY, float rotationZ); +``` +#### Parameters + + + +`rotationX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-axis rotation. + + + +`rotationY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-axis rotation. + + + +`rotationZ` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-axis rotation. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new RotationPropertyValue object. + + + +## AnimatablePropertyValue.CreateScaleValue(float, float) Method + +Creates a new ScalePropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateScaleValue(float scaleX, float scaleY); +``` +#### Parameters + + + +`scaleX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-axis scale. + + + +`scaleY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-axis scale. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new ScalePropertyValue object. + + + +## AnimatablePropertyValue.CreateSizeValue(float, float) Method + +Creates a new SizePropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateSizeValue(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width value. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height value. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new SizePropertyValue object. + + + +## AnimatablePropertyValue.CreateSizeValue(Size) Method + +Creates a new SizePropertyValue object. + +```csharp +public static Tizen.UI.AnimatablePropertyValue CreateSizeValue(Tizen.UI.Size size); +``` +#### Parameters + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size value. + +#### Returns +[AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') +The new SizePropertyValue object. + + + +## AnimatablePropertyValue.Dispose() Method + +Disposes the AnimatablePropertyValue object. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## AnimatablePropertyValue.GetTargetProperties(View) Method + +Gets the target properties for the given view. + +```csharp +public virtual System.Collections.Generic.IEnumerable<(Tizen.UI.NativeHandle.AnimatablePropertyHandle Property,Tizen.UI.NativeHandle.PropertyValueHandle Value)> GetTargetProperties(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the target properties for. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +An enumeration of tuples containing the target property handle and its corresponding value handle. + + + +## AnimatablePropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the animation. + +```csharp +public abstract Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property belongs. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Animation.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Animation.md new file mode 100644 index 0000000000..6395369567 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Animation.md @@ -0,0 +1,328 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Animation Class + +Animation class is used to animate the properties of a view. + +```csharp +public class Animation : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 Animation +### Constructors + + + +## Animation() Constructor + +Constructor to create an animation object. + +```csharp +public Animation(); +``` + + + +## Animation(IntPtr, bool) Constructor + +Constructor to create an animation object. + +```csharp +public Animation(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +A native handle. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +>The flag determines who is responsible for deleting the underlying native object. +### Properties + + + +## Animation.CurrentProgress Property + +Gets the current progress of the animation. + +```csharp +public float CurrentProgress { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Animation.Duration Property + +Gets or sets the duration of the animation in milliseconds. + +```csharp +public int Duration { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Animation.EndAction Property + +Gets or sets the end action of the animation that specifies the state of the animated Property when the animation ends. + +```csharp +public Tizen.UI.AnimationEndAction EndAction { get; set; } +``` + +#### Property Value +[AnimationEndAction](Tizen.UI.AnimationEndAction.md 'Tizen.UI.AnimationEndAction') + + + +## Animation.IsLoop Property + +Gets or sets whether the animation should loop or not. + +```csharp +public bool IsLoop { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Animation.ProgressReachedTarget Property + +Gets or sets the progress notification point of the animation. + +```csharp +public float ProgressReachedTarget { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Animation.State Property + +Gets the current state of the animation. + +```csharp +public Tizen.UI.AnimationState State { get; } +``` + +#### Property Value +[AnimationState](Tizen.UI.AnimationState.md 'Tizen.UI.AnimationState') +### Methods + + + +## Animation.AnimateBy(View, AnimatablePropertyValue, int, int, AlphaFunction) Method + +Animates the given property by the specified value with a specified delay and duration. + +```csharp +public void AnimateBy(Tizen.UI.View target, Tizen.UI.AnimatablePropertyValue props, int delayMs, int durationMs, Tizen.UI.AlphaFunction alpha=null); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view whose property is to be animated. + + + +`props` [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') + +The property to be animated. + + + +`delayMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The delay before the animation starts in milliseconds. + + + +`durationMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation in milliseconds. + + + +`alpha` [AlphaFunction](Tizen.UI.AlphaFunction.md 'Tizen.UI.AlphaFunction') + +The alpha function to apply to the animation. + + + +## Animation.AnimateTo(View, AnimatablePropertyValue, int, int, AlphaFunction) Method + +Animates the given property to the specified value with a specified delay and duration. + +```csharp +public void AnimateTo(Tizen.UI.View target, Tizen.UI.AnimatablePropertyValue props, int delayMs, int durationMs, Tizen.UI.AlphaFunction alpha=null); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view whose property is to be animated. + + + +`props` [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') + +The property to be animated. + + + +`delayMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The delay before the animation starts in milliseconds. + + + +`durationMs` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation in milliseconds. + + + +`alpha` [AlphaFunction](Tizen.UI.AlphaFunction.md 'Tizen.UI.AlphaFunction') + +The alpha function to apply to the animation. + + + +## Animation.Clear() Method + +Clears all animations from the animation object. + +```csharp +public void Clear(); +``` + + + +## Animation.Pause() Method + +Pauses the animation. + +```csharp +public void Pause(); +``` + + + +## Animation.Play() Method + +Plays the animation. + +```csharp +public void Play(); +``` + + + +## Animation.Play(float) Method + +Plays the animation from a specified progress. + +```csharp +public void Play(float progress); +``` +#### Parameters + + + +`progress` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The progress from which the animation should start. + + + +## Animation.Play(int) Method + +Plays the animation after a specified delay. + +```csharp +public void Play(int delayTime); +``` +#### Parameters + + + +`delayTime` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The delay before the animation starts in milliseconds. + + + +## Animation.PlayAsync() Method + +Plays the animation asynchronously. + +```csharp +public System.Threading.Tasks.Task PlayAsync(); +``` + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A Task that completes when the animation finishes. + + + +## Animation.Stop() Method + +Stops the animation. + +```csharp +public void Stop(); +``` +### Events + + + +## Animation.Finished Event + +Event triggered when the animation finishes. + +```csharp +public event EventHandler Finished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Animation.ProgressReached Event + +Event triggered when the animation reaches the progress notification point. + +```csharp +public event EventHandler ProgressReached; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationEndAction.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationEndAction.md new file mode 100644 index 0000000000..a2b611e76c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationEndAction.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnimationEndAction Enum + +```csharp +public enum AnimationEndAction +``` +### Fields + + + +`Cancel` 0 + +When the animation ends, the animated property values are saved. + + + +`Discard` 1 + +When the animation ends, the animated property values are forgotten. + + + +`StopFinal` 2 + +If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like cancel. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationExtensions.md new file mode 100644 index 0000000000..631edd01df --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationExtensions.md @@ -0,0 +1,123 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnimationExtensions Class + +Provides extension methods for the Animation class. + +```csharp +public static class AnimationExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AnimationExtensions +### Methods + + + +## AnimationExtensions.AnimateTo(this View, AnimatablePropertyValue, int) Method + +Animates the specified view to the given value. + +```csharp +public static System.Threading.Tasks.Task AnimateTo(this Tizen.UI.View view, Tizen.UI.AnimatablePropertyValue value, int duration=250); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to animate. + + + +`value` [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') + +The value to animate to. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation, in milliseconds. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A Task that completes when the animation finishes. + + + +## AnimationExtensions.MoveTo(this View, float, float, int) Method + +Animates the specified view to the given position. + +```csharp +public static System.Threading.Tasks.Task MoveTo(this Tizen.UI.View view, float x, float y, int duration=250); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to animate. + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the position to animate to. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the position to animate to. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation, in milliseconds. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A Task that completes when the animation finishes. + + + +## AnimationExtensions.RotateTo(this View, float, int) Method + +Animates the specified view to the given rotation. + +```csharp +public static System.Threading.Tasks.Task RotateTo(this Tizen.UI.View view, float rotate, int duration=250); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to animate. + + + +`rotate` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of rotation, in degrees. + + + +`duration` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The duration of the animation, in milliseconds. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A Task that completes when the animation finishes. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationState.md new file mode 100644 index 0000000000..42bc101bd5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationState.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnimationState Enum + +Enumeration for the state of an animation. + +```csharp +public enum AnimationState +``` +### Fields + + + +`Paused` 2 + +The animation is paused. + + + +`Playing` 1 + +The animation is playing. + + + +`Stopped` 0 + +The animation has stopped. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnnouncementState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnnouncementState.md new file mode 100644 index 0000000000..1ebbfd5599 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnnouncementState.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AnnouncementState Enum + +AnnouncementState is an enumeration that represents the states of an announcement. + +```csharp +public enum AnnouncementState +``` +### Fields + + + +`Cancelled` 1 + +Cancelled + + + +`Skipped` 3 + +Skipped + + + +`Stopped` 2 + +Stopped + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoCapital.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoCapital.md new file mode 100644 index 0000000000..dddabf8d88 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoCapital.md @@ -0,0 +1,38 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AutoCapital Enum + +Enumeration for auto-capitalization settings. + +```csharp +public enum AutoCapital +``` +### Fields + + + +`AllCharacter` 3 + +Autocapitalize all letters. + + + +`None` 0 + +No auto-capitalization when typing. + + + +`Sentence` 2 + +Autocapitalize the start of each sentence. + + + +`Word` 1 + +Autocapitalize each word typed. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoFontSize.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoFontSize.md new file mode 100644 index 0000000000..43f8981210 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoFontSize.md @@ -0,0 +1,66 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## AutoFontSize Struct + +The AutoFontSize struct represents a set of properties used to control the automatic font size adjustment feature. + +```csharp +public struct AutoFontSize +``` +### Properties + + + +## AutoFontSize.Enabled Property + +Gets or sets a value indicating whether the automatic font size adjustment feature is enabled or not. + +```csharp +public bool Enabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## AutoFontSize.MaximumSize Property + +Gets or sets the maximum font size allowed when the automatic font size adjustment feature is enabled. + +```csharp +public float MaximumSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AutoFontSize.MinimumSize Property + +Gets or sets the minimum font size allowed when the automatic font size adjustment feature is enabled. + +```csharp +public float MinimumSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## AutoFontSize.StepSize Property + +Gets or sets the step size used to adjust the font size when the automatic font size adjustment feature is enabled. + +```csharp +public float StepSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Background.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Background.md new file mode 100644 index 0000000000..b48cb11480 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Background.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Background Class + +The Background class is an abstract class that provides a base for background visual elements. + +```csharp +public abstract class Background +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Background + +Derived +↳ [ColorBackground](Tizen.UI.ColorBackground.md 'Tizen.UI.ColorBackground') +↳ [GradientBackground](Tizen.UI.GradientBackground.md 'Tizen.UI.GradientBackground') +↳ [ImageBackground](Tizen.UI.ImageBackground.md 'Tizen.UI.ImageBackground') +### Methods + + + +## Background.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public virtual void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundPropertyValue.md new file mode 100644 index 0000000000..15f0f942ef --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundPropertyValue.md @@ -0,0 +1,92 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BackgroundPropertyValue Class + +BackgroundPropertyValue is a class that represents the value of the background property of a View. + +```csharp +public class BackgroundPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 BackgroundPropertyValue +### Constructors + + + +## BackgroundPropertyValue(Color) Constructor + +Initializes a new instance of the BackgroundPropertyValue class with the specified color. + +```csharp +public BackgroundPropertyValue(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The color of the background. +### Properties + + + +## BackgroundPropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## BackgroundPropertyValue.GetTargetProperties(View) Method + +Gets the target properties for the given view. + +```csharp +public override System.Collections.Generic.IEnumerable<(Tizen.UI.NativeHandle.AnimatablePropertyHandle Property,Tizen.UI.NativeHandle.PropertyValueHandle Value)> GetTargetProperties(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the target properties for. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +An enumeration of tuples containing the target property handle and its corresponding value handle. + + + +## BackgroundPropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property belongs. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md new file mode 100644 index 0000000000..863a42c453 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md @@ -0,0 +1,70 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BackgroundTokenPropertyChangedEventArgs Class + +Provides data for background token property changed events. + +```csharp +public class BackgroundTokenPropertyChangedEventArgs : Tizen.UI.TokenPropertyChangedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') 🡒 BackgroundTokenPropertyChangedEventArgs + +### Remarks +Extends [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') with background information. +Uses singleton pattern for event argument instances. +### Properties + + + +## BackgroundTokenPropertyChangedEventArgs.Background Property + +Gets or sets the background value of the changed property. + +```csharp +public Tizen.UI.Background Background { get; set; } +``` + +#### Property Value +[Background](Tizen.UI.Background.md 'Tizen.UI.Background') +The new background value. +### Methods + + + +## BackgroundTokenPropertyChangedEventArgs.Create(View, string, Background) Method + +Creates a new instance of [BackgroundTokenPropertyChangedEventArgs](Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md 'Tizen.UI.BackgroundTokenPropertyChangedEventArgs'). + +```csharp +public static Tizen.UI.BackgroundTokenPropertyChangedEventArgs Create(Tizen.UI.View view, string name, Tizen.UI.Background background); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view associated with the property change. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the changed property. + + + +`background` [Background](Tizen.UI.Background.md 'Tizen.UI.Background') + +The new background value. + +#### Returns +[BackgroundTokenPropertyChangedEventArgs](Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md 'Tizen.UI.BackgroundTokenPropertyChangedEventArgs') +An initialized [BackgroundTokenPropertyChangedEventArgs](Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md 'Tizen.UI.BackgroundTokenPropertyChangedEventArgs') instance. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingExtensions.md new file mode 100644 index 0000000000..c31550e4ac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingExtensions.md @@ -0,0 +1,1041 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BindingExtensions Class + +Provides extension methods for binding properties of a view model to a view. + +```csharp +public static class BindingExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BindingExtensions +### Methods + + + +## BindingExtensions.Bind<TView,TProperty>(this TView, BindingProperty<TView,TProperty>, string) Method + +Binds the specified property of the view to the specified path in the view model. + +```csharp +public static TView Bind<TView,TProperty>(this TView view, Tizen.UI.BindingProperty<TView,TProperty> property, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TProperty` + +The type of the property. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.Bind_TView,TProperty_(thisTView,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.Bind<TView,TProperty>(this TView, Tizen.UI.BindingProperty<TView,TProperty>, string).TView') + +The view to bind the property to. + + + +`property` [Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.Bind_TView,TProperty_(thisTView,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.Bind<TView,TProperty>(this TView, Tizen.UI.BindingProperty<TView,TProperty>, string).TView')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TProperty](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.Bind_TView,TProperty_(thisTView,Tizen.UI.BindingProperty_TView,TProperty_,string).TProperty 'Tizen.UI.BindingExtensions.Bind<TView,TProperty>(this TView, Tizen.UI.BindingProperty<TView,TProperty>, string).TProperty')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + +The property to bind. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.Bind_TView,TProperty_(thisTView,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.Bind<TView,TProperty>(this TView, Tizen.UI.BindingProperty<TView,TProperty>, string).TView') +The view with the property bound to the view model. + + + +## BindingExtensions.BindBackgroundColor<TView>(this TView, string) Method + +Binds the [BackgroundColor](Tizen.UI.View.md#Tizen.UI.View.BackgroundColor 'Tizen.UI.View.BackgroundColor') property of the view to the specified path in the view model. + +```csharp +public static TView BindBackgroundColor<TView>(this TView view, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindBackgroundColor_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindBackgroundColor<TView>(this TView, string).TView') + +The view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindBackgroundColor_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindBackgroundColor<TView>(this TView, string).TView') +The view with the background color property bound to the view model. + + + +## BindingExtensions.BindFontSize<TText>(this TText, string) Method + +Binds the [FontSize](Tizen.UI.IText.md#Tizen.UI.IText.FontSize 'Tizen.UI.IText.FontSize') property of the view to the specified path in the view model. + +```csharp +public static TText BindFontSize<TText>(this TText view, string path) + where TText : Tizen.UI.View, Tizen.UI.IText; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindFontSize_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindFontSize<TText>(this TText, string).TText') + +The text view to set the font size for. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the font size property in the data context. + +#### Returns +[TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindFontSize_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindFontSize<TText>(this TText, string).TText') +The text view with the font size property bound to the view model. + + + +## BindingExtensions.BindHeight<TView>(this TView, string) Method + +Binds the [Height](Tizen.UI.View.md#Tizen.UI.View.Height 'Tizen.UI.View.Height') property of the view to the specified path in the view model. + +```csharp +public static TView BindHeight<TView>(this TView view, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindHeight_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindHeight<TView>(this TView, string).TView') + +The view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindHeight_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindHeight<TView>(this TView, string).TView') +The view with the height property bound to the view model. + + + +## BindingExtensions.BindingSession<T,TViewModel>(this T, BindingSession<TViewModel>) Method + +Sets the binding session for the specified view. + +```csharp +public static T BindingSession<T,TViewModel>(this T view, Tizen.UI.BindingSession<TViewModel> session) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view model. + + + +`TViewModel` +#### Parameters + + + +`view` [T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindingSession_T,TViewModel_(thisT,Tizen.UI.BindingSession_TViewModel_).T 'Tizen.UI.BindingExtensions.BindingSession<T,TViewModel>(this T, Tizen.UI.BindingSession<TViewModel>).T') + +The view. + + + +`session` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindingSession_T,TViewModel_(thisT,Tizen.UI.BindingSession_TViewModel_).TViewModel 'Tizen.UI.BindingExtensions.BindingSession<T,TViewModel>(this T, Tizen.UI.BindingSession<TViewModel>).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The binding session. + +#### Returns +[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindingSession_T,TViewModel_(thisT,Tizen.UI.BindingSession_TViewModel_).T 'Tizen.UI.BindingExtensions.BindingSession<T,TViewModel>(this T, Tizen.UI.BindingSession<TViewModel>).T') +The view. + + + +## BindingExtensions.BindingSession<TViewModel>(this View) Method + +Gets the binding session for the specified view. + +```csharp +public static Tizen.UI.BindingSession<TViewModel> BindingSession<TViewModel>(this Tizen.UI.View view); +``` +#### Type parameters + + + +`TViewModel` + +The type of the view model. +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view. + +#### Returns +[Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindingSession_TViewModel_(thisTizen.UI.View).TViewModel 'Tizen.UI.BindingExtensions.BindingSession<TViewModel>(this Tizen.UI.View).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') +The binding session. + + + +## BindingExtensions.BindLocalizedResource<T>(this T, Action<T,string>, string) Method + +Binds the localized resource of the given view to the specified path. + +```csharp +public static T BindLocalizedResource<T>(this T view, System.Action<T,string> setter, string path) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedResource_T_(thisT,System.Action_T,string_,string).T 'Tizen.UI.BindingExtensions.BindLocalizedResource<T>(this T, System.Action<T,string>, string).T') + +The view to bind. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedResource_T_(thisT,System.Action_T,string_,string).T 'Tizen.UI.BindingExtensions.BindLocalizedResource<T>(this T, System.Action<T,string>, string).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The setter method to set the localized resource. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the localized resource. + +#### Returns +[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedResource_T_(thisT,System.Action_T,string_,string).T 'Tizen.UI.BindingExtensions.BindLocalizedResource<T>(this T, System.Action<T,string>, string).T') +The view itself. + + + +## BindingExtensions.BindLocalizedText<T>(this T, Action<T,string>, string, ResourceManager) Method + +Binds the localized text of the given view to the specified key. + +```csharp +public static T BindLocalizedText<T>(this T view, System.Action<T,string> setter, string key, System.Resources.ResourceManager resourceManager=null) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedText_T_(thisT,System.Action_T,string_,string,System.Resources.ResourceManager).T 'Tizen.UI.BindingExtensions.BindLocalizedText<T>(this T, System.Action<T,string>, string, System.Resources.ResourceManager).T') + +The view to bind. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedText_T_(thisT,System.Action_T,string_,string,System.Resources.ResourceManager).T 'Tizen.UI.BindingExtensions.BindLocalizedText<T>(this T, System.Action<T,string>, string, System.Resources.ResourceManager).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The setter method to set the localized text. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized text. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized text. + +#### Returns +[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedText_T_(thisT,System.Action_T,string_,string,System.Resources.ResourceManager).T 'Tizen.UI.BindingExtensions.BindLocalizedText<T>(this T, System.Action<T,string>, string, System.Resources.ResourceManager).T') +The view itself. + + + +## BindingExtensions.BindLocalizedText<TText>(this TText, string, ResourceManager) Method + +Binds the localized text of the given [IText](Tizen.UI.IText.md 'Tizen.UI.IText') to the specified key. + +```csharp +public static TText BindLocalizedText<TText>(this TText view, string key, System.Resources.ResourceManager resourceManager=null) + where TText : class, Tizen.UI.IText; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedText_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.BindingExtensions.BindLocalizedText<TText>(this TText, string, System.Resources.ResourceManager).TText') + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to the localized text. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to the localized text. + +#### Returns +[TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindLocalizedText_TText_(thisTText,string,System.Resources.ResourceManager).TText 'Tizen.UI.BindingExtensions.BindLocalizedText<TText>(this TText, string, System.Resources.ResourceManager).TText') +The text view itself. + + + +## BindingExtensions.BindMultipliedColor<TImageView>(this TImageView, string) Method + +Binds the multiplied color of the given [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') to the specified path. + +```csharp +public static TImageView BindMultipliedColor<TImageView>(this TImageView imageView, string path) + where TImageView : Tizen.UI.ImageView; +``` +#### Type parameters + + + +`TImageView` + +The type of the image view. +#### Parameters + + + +`imageView` [TImageView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindMultipliedColor_TImageView_(thisTImageView,string).TImageView 'Tizen.UI.BindingExtensions.BindMultipliedColor<TImageView>(this TImageView, string).TImageView') + +The image view to bind. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the resource. + +#### Returns +[TImageView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindMultipliedColor_TImageView_(thisTImageView,string).TImageView 'Tizen.UI.BindingExtensions.BindMultipliedColor<TImageView>(this TImageView, string).TImageView') +The image view with the resource url property bound to the view model. + + + +## BindingExtensions.BindResourceUrl<TImageView>(this TImageView, string) Method + +Binds the resource URL of the given [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') to the specified path. + +```csharp +public static TImageView BindResourceUrl<TImageView>(this TImageView imageView, string path) + where TImageView : Tizen.UI.ImageView; +``` +#### Type parameters + + + +`TImageView` + +The type of the image view. +#### Parameters + + + +`imageView` [TImageView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindResourceUrl_TImageView_(thisTImageView,string).TImageView 'Tizen.UI.BindingExtensions.BindResourceUrl<TImageView>(this TImageView, string).TImageView') + +The image view to bind. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the resource. + +#### Returns +[TImageView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindResourceUrl_TImageView_(thisTImageView,string).TImageView 'Tizen.UI.BindingExtensions.BindResourceUrl<TImageView>(this TImageView, string).TImageView') +The image view with the resource url property bound to the view model. + + + +## BindingExtensions.BindText<TText>(this TText, string) Method + +Binds the [Text](Tizen.UI.IText.md#Tizen.UI.IText.Text 'Tizen.UI.IText.Text') property of the view to the specified path in the view model. + +```csharp +public static TText BindText<TText>(this TText view, string path) + where TText : Tizen.UI.View, Tizen.UI.IText; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindText_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindText<TText>(this TText, string).TText') + +The text view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindText_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindText<TText>(this TText, string).TText') +The text view with the text property bound to the view model. + + + +## BindingExtensions.BindTextColor<TText>(this TText, string) Method + +Binds the [TextColor](Tizen.UI.IText.md#Tizen.UI.IText.TextColor 'Tizen.UI.IText.TextColor') property of the view to the specified path in the view model. + +```csharp +public static TText BindTextColor<TText>(this TText view, string path) + where TText : Tizen.UI.View, Tizen.UI.IText; +``` +#### Type parameters + + + +`TText` + +The type of the view. +#### Parameters + + + +`view` [TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindTextColor_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindTextColor<TText>(this TText, string).TText') + +The view whose text color property is to be set. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the source property. + +#### Returns +[TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindTextColor_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindTextColor<TText>(this TText, string).TText') +The text view with the text color property bound to the view model. + + + +## BindingExtensions.BindTextTwoWay<TText>(this TText, string) Method + +Binds the [Text](Tizen.UI.IText.md#Tizen.UI.IText.Text 'Tizen.UI.IText.Text') property of the view to the specified path in the view model on two-way with [TextChanged](Tizen.UI.ITextEditable.md#Tizen.UI.ITextEditable.TextChanged 'Tizen.UI.ITextEditable.TextChanged') event. + +```csharp +public static TText BindTextTwoWay<TText>(this TText view, string path) + where TText : Tizen.UI.View, Tizen.UI.IText, Tizen.UI.ITextEditable; +``` +#### Type parameters + + + +`TText` + +The type of the text view. +#### Parameters + + + +`view` [TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindTextTwoWay_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindTextTwoWay<TText>(this TText, string).TText') + +The text view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TText](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindTextTwoWay_TText_(thisTText,string).TText 'Tizen.UI.BindingExtensions.BindTextTwoWay<TText>(this TText, string).TText') +The text view with the text property bound to the view model. + + + +## BindingExtensions.BindWidth<TView>(this TView, string) Method + +Binds the [Width](Tizen.UI.View.md#Tizen.UI.View.Width 'Tizen.UI.View.Width') property of the view to the specified path in the view model. + +```csharp +public static TView BindWidth<TView>(this TView view, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindWidth_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindWidth<TView>(this TView, string).TView') + +The view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindWidth_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindWidth<TView>(this TView, string).TView') +The view with the width property bound to the view model. + + + +## BindingExtensions.BindX<TView>(this TView, string) Method + +Binds the [X](Tizen.UI.View.md#Tizen.UI.View.X 'Tizen.UI.View.X') property of the view to the specified path in the view model. + +```csharp +public static TView BindX<TView>(this TView view, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindX_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindX<TView>(this TView, string).TView') + +The view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindX_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindX<TView>(this TView, string).TView') +The view with the X position property bound to the view model. + + + +## BindingExtensions.BindY<TView>(this TView, string) Method + +Binds the [Y](Tizen.UI.View.md#Tizen.UI.View.Y 'Tizen.UI.View.Y') property of the view to the specified path in the view model. + +```csharp +public static TView BindY<TView>(this TView view, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindY_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindY<TView>(this TView, string).TView') + +The view to bind the property to. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.BindY_TView_(thisTView,string).TView 'Tizen.UI.BindingExtensions.BindY<TView>(this TView, string).TView') +The view with the Y position property bound to the view model. + + + +## BindingExtensions.SetBinding<T,TView>(this TView, BindingSession<T>, Action<T,TView>, string) Method + +Sets the binding for the specified view model property. + +```csharp +public static TView SetBinding<T,TView>(this TView view, Tizen.UI.BindingSession<T> vm, System.Action<T,TView> set, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view model. + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T,TView_(thisTView,Tizen.UI.BindingSession_T_,System.Action_T,TView_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<T,TView>(this TView, Tizen.UI.BindingSession<T>, System.Action<T,TView>, string).TView') + +The view to bind to. + + + +`vm` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T,TView_(thisTView,Tizen.UI.BindingSession_T_,System.Action_T,TView_,string).T 'Tizen.UI.BindingExtensions.SetBinding<T,TView>(this TView, Tizen.UI.BindingSession<T>, System.Action<T,TView>, string).T')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The view model to bind from. + + + +`set` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T,TView_(thisTView,Tizen.UI.BindingSession_T_,System.Action_T,TView_,string).T 'Tizen.UI.BindingExtensions.SetBinding<T,TView>(this TView, Tizen.UI.BindingSession<T>, System.Action<T,TView>, string).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T,TView_(thisTView,Tizen.UI.BindingSession_T_,System.Action_T,TView_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<T,TView>(this TView, Tizen.UI.BindingSession<T>, System.Action<T,TView>, string).TView')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The action to set the view property. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T,TView_(thisTView,Tizen.UI.BindingSession_T_,System.Action_T,TView_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<T,TView>(this TView, Tizen.UI.BindingSession<T>, System.Action<T,TView>, string).TView') +The view. + + + +## BindingExtensions.SetBinding<T>(this View, BindingSession<T>, Action<T>, string) Method + +Sets the binding for the specified view model property. + +```csharp +public static Tizen.UI.View SetBinding<T>(this Tizen.UI.View view, Tizen.UI.BindingSession<T> vm, System.Action<T> set, string path); +``` +#### Type parameters + + + +`T` + +The type of the view model. +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to bind to. + + + +`vm` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T_(thisTizen.UI.View,Tizen.UI.BindingSession_T_,System.Action_T_,string).T 'Tizen.UI.BindingExtensions.SetBinding<T>(this Tizen.UI.View, Tizen.UI.BindingSession<T>, System.Action<T>, string).T')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The view model to bind from. + + + +`set` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[T](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_T_(thisTizen.UI.View,Tizen.UI.BindingSession_T_,System.Action_T_,string).T 'Tizen.UI.BindingExtensions.SetBinding<T>(this Tizen.UI.View, Tizen.UI.BindingSession<T>, System.Action<T>, string).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The action to set the view property. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The view. + + + +## BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, BindingSession<TViewModel>, BindingProperty<TView,TProperty>, string) Method + +Sets the binding for the specified view model property. + +```csharp +public static TView SetBinding<TView,TViewModel,TProperty>(this TView view, Tizen.UI.BindingSession<TViewModel> session, Tizen.UI.BindingProperty<TView,TProperty> property, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TViewModel` + +The type of the view model. + + + +`TProperty` + +The type of the view property. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.BindingProperty<TView,TProperty>, string).TView') + +The view to bind to. + + + +`session` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.BindingProperty_TView,TProperty_,string).TViewModel 'Tizen.UI.BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.BindingProperty<TView,TProperty>, string).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The binding session. + + + +`property` [Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.BindingProperty<TView,TProperty>, string).TView')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TProperty](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.BindingProperty_TView,TProperty_,string).TProperty 'Tizen.UI.BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.BindingProperty<TView,TProperty>, string).TProperty')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + +The view property. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.BindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.BindingProperty<TView,TProperty>, string).TView') +The view. + + + +## BindingExtensions.SetBinding<TViewModel>(this View, BindingSession<TViewModel>, string, string) Method + +Sets the binding for the specified view model property. + +```csharp +public static Tizen.UI.View SetBinding<TViewModel>(this Tizen.UI.View view, Tizen.UI.BindingSession<TViewModel> session, string targetPath, string srcPath); +``` +#### Type parameters + + + +`TViewModel` + +The type of the view model. +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to bind to. + + + +`session` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetBinding_TViewModel_(thisTizen.UI.View,Tizen.UI.BindingSession_TViewModel_,string,string).TViewModel 'Tizen.UI.BindingExtensions.SetBinding<TViewModel>(this Tizen.UI.View, Tizen.UI.BindingSession<TViewModel>, string, string).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The binding session. + + + +`targetPath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view property. + + + +`srcPath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The view. + + + +## BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, BindingSession<TViewModel>, TwoWayBindingProperty<TView,TProperty>, string) Method + +Sets the two-way binding for the specified view model property. + +```csharp +public static TView SetTwoWayBinding<TView,TViewModel,TProperty>(this TView view, Tizen.UI.BindingSession<TViewModel> session, Tizen.UI.TwoWayBindingProperty<TView,TProperty> property, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TViewModel` + +The type of the view model. + + + +`TProperty` + +The type of the view property. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView') + +The to. + + + +`session` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TViewModel 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The binding session. + + + +`property` [Tizen.UI.TwoWayBindingProperty<](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView')[,](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[TProperty](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TProperty 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TProperty')[>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') + +The view property. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TView,TViewModel,TProperty_(thisTView,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TView,TViewModel,TProperty>(this TView, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView') +The view. + + + +## BindingExtensions.SetTwoWayBinding<TViewModel,TProperty>(this View, BindingSession<TViewModel>, TwoWayBindingProperty<View,TProperty>, string) Method + +Sets the two-way binding for the specified view model property. + +```csharp +public static Tizen.UI.View SetTwoWayBinding<TViewModel,TProperty>(this Tizen.UI.View view, Tizen.UI.BindingSession<TViewModel> session, Tizen.UI.TwoWayBindingProperty<Tizen.UI.View,TProperty> property, string path); +``` +#### Type parameters + + + +`TViewModel` + +The type of the view model. + + + +`TProperty` + +The type of the view property. +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to bind to. + + + +`session` [Tizen.UI.BindingSession<](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>')[TViewModel](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TViewModel,TProperty_(thisTizen.UI.View,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_Tizen.UI.View,TProperty_,string).TViewModel 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TViewModel,TProperty>(this Tizen.UI.View, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<Tizen.UI.View,TProperty>, string).TViewModel')[>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') + +The binding session. + + + +`property` [Tizen.UI.TwoWayBindingProperty<](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[TProperty](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.SetTwoWayBinding_TViewModel,TProperty_(thisTizen.UI.View,Tizen.UI.BindingSession_TViewModel_,Tizen.UI.TwoWayBindingProperty_Tizen.UI.View,TProperty_,string).TProperty 'Tizen.UI.BindingExtensions.SetTwoWayBinding<TViewModel,TProperty>(this Tizen.UI.View, Tizen.UI.BindingSession<TViewModel>, Tizen.UI.TwoWayBindingProperty<Tizen.UI.View,TProperty>, string).TProperty')[>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') + +The view property. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the view model property. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The view. + + + +## BindingExtensions.TwoWayBind<TView,TProperty>(this TView, TwoWayBindingProperty<TView,TProperty>, string) Method + +Binds the specified two-way property of the view to the specified path in the view model. + +```csharp +public static TView TwoWayBind<TView,TProperty>(this TView view, Tizen.UI.TwoWayBindingProperty<TView,TProperty> property, string path) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TProperty` + +The type of the property. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.TwoWayBind_TView,TProperty_(thisTView,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.TwoWayBind<TView,TProperty>(this TView, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView') + +The view to bind the property to. + + + +`property` [Tizen.UI.TwoWayBindingProperty<](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.TwoWayBind_TView,TProperty_(thisTView,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.TwoWayBind<TView,TProperty>(this TView, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView')[,](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[TProperty](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.TwoWayBind_TView,TProperty_(thisTView,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TProperty 'Tizen.UI.BindingExtensions.TwoWayBind<TView,TProperty>(this TView, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TProperty')[>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') + +The property to bind. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the property in the view model. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.TwoWayBind_TView,TProperty_(thisTView,Tizen.UI.TwoWayBindingProperty_TView,TProperty_,string).TView 'Tizen.UI.BindingExtensions.TwoWayBind<TView,TProperty>(this TView, Tizen.UI.TwoWayBindingProperty<TView,TProperty>, string).TView') +The view with the property bound to the view model. + + + +## BindingExtensions.ViewModel<TView>(this TView, object) Method + +Sets the view model for the specified view. + +```csharp +public static TView ViewModel<TView>(this TView view, object viewModel) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.ViewModel_TView_(thisTView,object).TView 'Tizen.UI.BindingExtensions.ViewModel<TView>(this TView, object).TView') + +The view to set the view model for. + + + +`viewModel` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The view model to set. + +#### Returns +[TView](Tizen.UI.BindingExtensions.md#Tizen.UI.BindingExtensions.ViewModel_TView_(thisTView,object).TView 'Tizen.UI.BindingExtensions.ViewModel<TView>(this TView, object).TView') +The view with the view model set. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingProperty_TView,TValue_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingProperty_TView,TValue_.md new file mode 100644 index 0000000000..7e7a0a8d4b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingProperty_TView,TValue_.md @@ -0,0 +1,47 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BindingProperty<TView,TValue> Class + +The BindingProperty class represents a binding property for a view. + +```csharp +public class BindingProperty<TView,TValue> +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TValue` + +The type of the value. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BindingProperty<TView,TValue> + +Derived +↳ [TwoWayBindingProperty<TView,TValue>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') +### Properties + + + +## BindingProperty<TView,TValue>.Setter Property + +Gets or sets the setter action for the binding property. + +```csharp +public System.Action<TView,TValue> Setter { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.BindingProperty_TView,TValue_.md#Tizen.UI.BindingProperty_TView,TValue_.TView 'Tizen.UI.BindingProperty<TView,TValue>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TValue](Tizen.UI.BindingProperty_TView,TValue_.md#Tizen.UI.BindingProperty_TView,TValue_.TValue 'Tizen.UI.BindingProperty<TView,TValue>.TValue')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingSession_TViewModel_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingSession_TViewModel_.md new file mode 100644 index 0000000000..d6670c16db --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingSession_TViewModel_.md @@ -0,0 +1,223 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BindingSession<TViewModel> Class + +BindingSession class provides a mechanism for binding properties of a view model to a view. + +```csharp +public class BindingSession<TViewModel> : +System.ComponentModel.INotifyPropertyChanged, +System.IDisposable +``` +#### Type parameters + + + +`TViewModel` + +The type of the view model. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 BindingSession<TViewModel> + +Implements [System.ComponentModel.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System.ComponentModel.INotifyPropertyChanged'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## BindingSession<TViewModel>.ViewModel Property + +Gets or sets the view model. + +```csharp +public TViewModel ViewModel { get; set; } +``` + +#### Property Value +[TViewModel](Tizen.UI.BindingSession_TViewModel_.md#Tizen.UI.BindingSession_TViewModel_.TViewModel 'Tizen.UI.BindingSession<TViewModel>.TViewModel') +### Methods + + + +## BindingSession<TViewModel>.AddBinding(Action<TViewModel>, string) Method + +Adds a binding between a property of the view model and a property of the view. + +```csharp +public void AddBinding(System.Action<TViewModel> setter, string path); +``` +#### Parameters + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[TViewModel](Tizen.UI.BindingSession_TViewModel_.md#Tizen.UI.BindingSession_TViewModel_.TViewModel 'Tizen.UI.BindingSession<TViewModel>.TViewModel')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The setter method of the view. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the property to bind. + + + +## BindingSession<TViewModel>.AddTwoWayBinding<T>(Action<Action>, Action<Action>, Action<TViewModel>, Func<T>, string) Method + +Adds a two-way binding between a property of the view model and a property of the view. + +```csharp +public void AddTwoWayBinding<T>(System.Action<System.Action> register, System.Action<System.Action> unregister, System.Action<TViewModel> setter, System.Func<T> getter, string path); +``` +#### Type parameters + + + +`T` + +The type of the property to bind. +#### Parameters + + + +`register` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The registration method of the observer. + + + +`unregister` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The unregistration method of the observer. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[TViewModel](Tizen.UI.BindingSession_TViewModel_.md#Tizen.UI.BindingSession_TViewModel_.TViewModel 'Tizen.UI.BindingSession<TViewModel>.TViewModel')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The setter method of the view. + + + +`getter` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[T](Tizen.UI.BindingSession_TViewModel_.md#Tizen.UI.BindingSession_TViewModel_.AddTwoWayBinding_T_(System.Action_System.Action_,System.Action_System.Action_,System.Action_TViewModel_,System.Func_T_,string).T 'Tizen.UI.BindingSession<TViewModel>.AddTwoWayBinding<T>(System.Action<System.Action>, System.Action<System.Action>, System.Action<TViewModel>, System.Func<T>, string).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The getter method of the view. + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path of the property to bind. + + + +## BindingSession<TViewModel>.ClearBinding() Method + +Clears all bindings. + +```csharp +public void ClearBinding(); +``` + + + +## BindingSession<TViewModel>.Dispose() Method + +Releases all resources used by the current instance of the BindingSession class. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## BindingSession<TViewModel>.GetValue(string) Method + +Gets the value of a property of the view model. + +```csharp +public object GetValue(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property. + +#### Returns +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') +The value of the property. + + + +## BindingSession<TViewModel>.SetValue(object, string) Method + +Sets the value of a property of the view model. + +```csharp +public void SetValue(object obj, string name); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The value to set. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property. + + + +## BindingSession<TViewModel>.UpdateViewModel() Method + +Updates the view model. + +```csharp +public void UpdateViewModel(); +``` + + + +## BindingSession<TViewModel>.UpdateViewModel(TViewModel) Method + +Updates the view model. + +```csharp +public void UpdateViewModel(TViewModel vm); +``` +#### Parameters + + + +`vm` [TViewModel](Tizen.UI.BindingSession_TViewModel_.md#Tizen.UI.BindingSession_TViewModel_.TViewModel 'Tizen.UI.BindingSession<TViewModel>.TViewModel') + +The view model to update. +### Events + + + +## BindingSession<TViewModel>.PropertyChanged Event + +Represents an event that is raised when a property value changes. + +```csharp +public event PropertyChangedEventHandler PropertyChanged; +``` + +Implements [PropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged.PropertyChanged 'System.ComponentModel.INotifyPropertyChanged.PropertyChanged') + +#### Event Type +[System.ComponentModel.PropertyChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.PropertyChangedEventHandler 'System.ComponentModel.PropertyChangedEventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BrokenImageType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BrokenImageType.md new file mode 100644 index 0000000000..733e6ba8a9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BrokenImageType.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BrokenImageType Enum + +The BrokenImageType enum represents the different sizes of broken images that can be displayed when an image fails to load. + +```csharp +public enum BrokenImageType +``` +### Fields + + + +`Large` 2 + +Represents a large broken image. + + + +`Normal` 1 + +Represents a normal-sized broken image. + + + +`Small` 0 + +Represents a small broken image. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BuiltinAlphaFunctions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BuiltinAlphaFunctions.md new file mode 100644 index 0000000000..a82268f238 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BuiltinAlphaFunctions.md @@ -0,0 +1,88 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## BuiltinAlphaFunctions Enum + +Built-in alpha functions for animations. + +```csharp +public enum BuiltinAlphaFunctions +``` +### Fields + + + +`Default` 0 + +Linear. + + + +`EaseIn` 5 + +Speeds up and comes to a sudden stop (cubic). + + + +`EaseInOut` 7 + +Speeds up and slows to a gradual stop (cubic). + + + +`EaseInOutSine` 10 + +Speeds up and slows to a gradual stop (sinusoidal). + + + +`EaseInSine` 8 + +Speeds up and comes to a sudden stop (sinusoidal). + + + +`EaseInSquare` 3 + +Speeds up and comes to a sudden stop (square). + + + +`EaseOut` 6 + +Sudden start and slows to a gradual stop (cubic). + + + +`EaseOutBack` 13 + +Sudden start, exceed end position and return to a gradual stop. + + + +`EaseOutSine` 9 + +Sudden start and slows to a gradual stop (sinusoidal). + + + +`EaseOutSquare` 4 + +Sudden start and slows to a gradual stop (square). + + + +`Linear` 1 + +No transformation. + + + +`Reverse` 2 + +Reverse linear. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ClippingMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ClippingMode.md new file mode 100644 index 0000000000..1a7cfa6b95 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ClippingMode.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ClippingMode Enum + +Enumeration for ClippingMode. + +```csharp +public enum ClippingMode +``` +### Fields + + + +`ClipChildren` 1 + +This actor will clip all children to within its boundaries (the actor will also be visible itself). + + + +`ClipToBoundingBox` 2 + +This Actor will clip all children within a screen-aligned rectangle encompassing its boundaries (the actor will also be visible itself). + + + +`Disabled` 0 + +This actor will not clip its children. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Color.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Color.md new file mode 100644 index 0000000000..e7099c3690 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Color.md @@ -0,0 +1,891 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Color Struct + +Defines a color with red, green, blue, and alpha components. + +```csharp +public struct Color : +Tizen.UI.IToken, +System.IEquatable<Tizen.UI.Color> +``` + +Implements [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken'), [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## Color(float) Constructor + +Initializes a new instance of the [Color](Tizen.UI.Color.md 'Tizen.UI.Color') struct. + +```csharp +public Color(float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value of the red, green, and blue components. + + + +## Color(float, float, float) Constructor + +Initializes a new instance of the [Color](Tizen.UI.Color.md 'Tizen.UI.Color') struct. + +```csharp +public Color(float r, float g, float b); +``` +#### Parameters + + + +`r` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The red component. + + + +`g` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The green component. + + + +`b` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The blue component. + + + +## Color(float, float, float, float) Constructor + +Initializes a new instance of the [Color](Tizen.UI.Color.md 'Tizen.UI.Color') struct. + +```csharp +public Color(float r, float g, float b, float a); +``` +#### Parameters + + + +`r` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The red component. + + + +`g` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The green component. + + + +`b` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The blue component. + + + +`a` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The alpha component. + + + +## Color(uint, float) Constructor + +Initializes a new instance of the [Color](Tizen.UI.Color.md 'Tizen.UI.Color') struct. + +```csharp +public Color(uint value, float alpha); +``` +#### Parameters + + + +`value` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The value of 0xRRGGBB format. + + + +`alpha` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The alpha value between 0.0 and 1.0. +### Properties + + + +## Color.A Property + +Gets the alpha component of the color. + +```csharp +public float A { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.B Property + +Gets the blue component of the color. + +```csharp +public float B { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.Default Property + +The default color. + +```csharp +public static Tizen.UI.Color Default { get; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## Color.G Property + +Gets the green component of the color. + +```csharp +public float G { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.Hue Property + +Gets the hue component of the color. + +```csharp +public float Hue { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.Id Property + +Gets the unique identifier of the token. + +```csharp +public string Id { get; } +``` + +Implements [Id](Tizen.UI.IToken.md#Tizen.UI.IToken.Id 'Tizen.UI.IToken.Id') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Color.IsToken Property + +Whether this is token. + +```csharp +public readonly bool IsToken { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Color.Luminosity Property + +Gets the luminosity component of the color. + +```csharp +public float Luminosity { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.R Property + +Gets the red component of the color. + +```csharp +public float R { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Color.Saturation Property + +Gets the saturation component of the color. + +```csharp +public float Saturation { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Color.AddLuminosity(float) Method + +Adds the specified delta to the luminosity component of the color. + +```csharp +public Tizen.UI.Color AddLuminosity(float delta); +``` +#### Parameters + + + +`delta` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to add to the luminosity component. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color. + + + +## Color.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if obj and this instance are the same type and represent the same value; otherwise, false. + + + +## Color.Equals(Color) Method + +Indicates whether the current object is equal to another object of the same type. + +```csharp +public bool Equals(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The color to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if obj and this instance are the same type and represent the same value; otherwise, false. + + + +## Color.FromHex(string) Method + +Converts a hexadecimal string to a Color object. + +```csharp +public static Tizen.UI.Color FromHex(string hex); +``` +#### Parameters + + + +`hex` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The hexadecimal string to convert. The string can be in the formats #rgb, #argb, #rrggbb, or #aarrggbb. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A Color object representing the hexadecimal string. + + + +## Color.FromHsla(float, float, float, float) Method + +Creates a new Color object from hue, saturation, lightness, and alpha values. + +```csharp +public static Tizen.UI.Color FromHsla(float h, float s, float l, float a=1f); +``` +#### Parameters + + + +`h` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The hue value of the color. + + + +`s` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The saturation value of the color. + + + +`l` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The lightness value of the color. + + + +`a` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The alpha value of the color. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified hue, saturation, lightness, and alpha values. + + + +## Color.FromHsv(float, float, float) Method + +Creates a new Color object from the specified HSV values. + +```csharp +public static Tizen.UI.Color FromHsv(float h, float s, float v); +``` +#### Parameters + + + +`h` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The hue component of the color, ranging from 0 to 1. + + + +`s` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The saturation component of the color, ranging from 0 to 1. + + + +`v` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value component of the color, ranging from 0 to 1. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified HSV values. + + + +## Color.FromHsv(int, int, int) Method + +Creates a new Color object from the specified HSV values. + +```csharp +public static Tizen.UI.Color FromHsv(int h, int s, int v); +``` +#### Parameters + + + +`h` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The hue component of the color, ranging from 0 to 360. + + + +`s` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The saturation component of the color, ranging from 0 to 100. + + + +`v` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value component of the color, ranging from 0 to 100. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified HSV values. + + + +## Color.FromHsva(float, float, float, float) Method + +Creates a new Color object from the specified HSVA values. + +```csharp +public static Tizen.UI.Color FromHsva(float h, float s, float v, float a); +``` +#### Parameters + + + +`h` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The hue component of the color, in the range [0, 1]. + + + +`s` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The saturation component of the color, in the range [0, 1]. + + + +`v` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value component of the color, in the range [0, 1]. + + + +`a` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The alpha component of the color, in the range [0, 1]. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified HSVA values. + + + +## Color.FromHsva(int, int, int, int) Method + +Creates a new Color object from the specified HSVA values. + +```csharp +public static Tizen.UI.Color FromHsva(int h, int s, int v, int a); +``` +#### Parameters + + + +`h` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The hue component of the color, ranging from 0 to 360. + + + +`s` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The saturation component of the color, ranging from 0 to 100. + + + +`v` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value component of the color, ranging from 0 to 100. + + + +`a` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The alpha component of the color, ranging from 0 to 100. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified HSVA values. + + + +## Color.FromRgb(float, float, float) Method + +Creates a new Color object from red, green, and blue values. + +```csharp +public static Tizen.UI.Color FromRgb(float r, float g, float b); +``` +#### Parameters + + + +`r` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The red value of the color. + + + +`g` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The green value of the color. + + + +`b` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The blue value of the color. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified red, green, and blue values. + + + +## Color.FromRgb(int, int, int) Method + +Creates a new Color object from red, green, and blue values. + +```csharp +public static Tizen.UI.Color FromRgb(int r, int g, int b); +``` +#### Parameters + + + +`r` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The red value of the color. + + + +`g` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The green value of the color. + + + +`b` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The blue value of the color. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified red, green, and blue values. + + + +## Color.FromRgba(float, float, float, float) Method + +Creates a new Color object from red, green, blue, and alpha values. + +```csharp +public static Tizen.UI.Color FromRgba(float r, float g, float b, float a); +``` +#### Parameters + + + +`r` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The red value of the color. + + + +`g` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The green value of the color. + + + +`b` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The blue value of the color. + + + +`a` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The alpha value of the color. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified red, green, blue, and alpha values. + + + +## Color.FromRgba(int, int, int, int) Method + +Creates a new Color object from red, green, blue, and alpha values. + +```csharp +public static Tizen.UI.Color FromRgba(int r, int g, int b, int a); +``` +#### Parameters + + + +`r` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The red value of the color. + + + +`g` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The green value of the color. + + + +`b` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The blue value of the color. + + + +`a` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The alpha value of the color. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified red, green, blue, and alpha values. + + + +## Color.GetHashCode() Method + +Returns a hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + +## Color.MultiplyAlpha(float) Method + +Multiplies the alpha component of the color by the specified value. + +```csharp +public Tizen.UI.Color MultiplyAlpha(float alpha); +``` +#### Parameters + + + +`alpha` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to multiply the alpha component by. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color. + + + +## Color.ToHex() Method + +Converts the color to a hexadecimal string representation. + +```csharp +public string ToHex(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The hexadecimal string representation of the color. + + + +## Color.Token(string) Method + +Creates a new color from the token table. + +```csharp +public static Tizen.UI.Color Token(string id); +``` +#### Parameters + + + +`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The unique identifier of the token. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## Color.ToString() Method + +Returns a string that represents the current object. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +A string that represents the current object. + + + +## Color.WithAlpha(float) Method + +Returns a new Color object with the specified alpha value. + +```csharp +public Tizen.UI.Color WithAlpha(float alpha); +``` +#### Parameters + + + +`alpha` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The new alpha value. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new Color object with the specified alpha value. + + + +## Color.WithHue(float) Method + +Sets the hue component of the color. + +```csharp +public Tizen.UI.Color WithHue(float hue); +``` +#### Parameters + + + +`hue` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The new hue component. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color. + + + +## Color.WithLuminosity(float) Method + +Sets the luminosity component of the color. + +```csharp +public Tizen.UI.Color WithLuminosity(float luminosity); +``` +#### Parameters + + + +`luminosity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The new luminosity component. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color. + + + +## Color.WithSaturation(float) Method + +Sets the saturation component of the color. + +```csharp +public Tizen.UI.Color WithSaturation(float saturation); +``` +#### Parameters + + + +`saturation` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The new saturation component. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color. +### Operators + + + +## Color.operator ==(Color, Color) Operator + +Compares two Color objects for equality. + +```csharp +public static bool operator ==(Tizen.UI.Color color1, Tizen.UI.Color color2); +``` +#### Parameters + + + +`color1` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The first Color object to compare. + + + +`color2` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The second Color object to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both objects are equal, otherwise false. + + + +## Color.operator !=(Color, Color) Operator + +Compares two Color objects for inequality. + +```csharp +public static bool operator !=(Tizen.UI.Color color1, Tizen.UI.Color color2); +``` +#### Parameters + + + +`color1` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The first Color object to compare. + + + +`color2` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The second Color object to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both objects are not equal, otherwise false. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorBackground.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorBackground.md new file mode 100644 index 0000000000..75d34a9a20 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorBackground.md @@ -0,0 +1,49 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ColorBackground Class + +The ColorBackground class is used to display a solid color on the screen. + +```csharp +public class ColorBackground : Tizen.UI.Background +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Background](Tizen.UI.Background.md 'Tizen.UI.Background') 🡒 ColorBackground +### Properties + + + +## ColorBackground.Color Property + +Gets or sets the color of the visual. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +### Methods + + + +## ColorBackground.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public override void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorTokenPropertyChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorTokenPropertyChangedEventArgs.md new file mode 100644 index 0000000000..0a282ba0b3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorTokenPropertyChangedEventArgs.md @@ -0,0 +1,74 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ColorTokenPropertyChangedEventArgs Class + +Provides data for color token property changed events. + +```csharp +public class ColorTokenPropertyChangedEventArgs : Tizen.UI.TokenPropertyChangedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') 🡒 ColorTokenPropertyChangedEventArgs + +Derived +↳ [InnerShadowTokenPropertyChangedEventArgs](Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.InnerShadowTokenPropertyChangedEventArgs') +↳ [ShadowTokenPropertyChangedEventArgs](Tizen.UI.ShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.ShadowTokenPropertyChangedEventArgs') + +### Remarks +Extends [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') with color information. +Uses singleton pattern for event argument instances. +### Properties + + + +## ColorTokenPropertyChangedEventArgs.Color Property + +Gets or sets the color value of the changed property. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The new color value. +### Methods + + + +## ColorTokenPropertyChangedEventArgs.Create(View, string, Color) Method + +Creates a new instance of [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs'). + +```csharp +public static Tizen.UI.ColorTokenPropertyChangedEventArgs Create(Tizen.UI.View view, string name, Tizen.UI.Color color); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view associated with the property change. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the changed property. + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The new color value. + +#### Returns +[ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') +An initialized [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') instance. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ContentView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ContentView.md new file mode 100644 index 0000000000..507cbd8af5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ContentView.md @@ -0,0 +1,59 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ContentView Class + +ContentView is a view that displays body view as its content. + +```csharp +public class ContentView : Tizen.UI.View, +Tizen.UI.IParentObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 ContentView + +Implements [IParentObject](Tizen.UI.IParentObject.md 'Tizen.UI.IParentObject') +### Constructors + + + +## ContentView() Constructor + +Creates an instance of a ContentView. + +```csharp +public ContentView(); +``` +### Methods + + + +## ContentView.Measure(float, float) Method + +Measures the size requirements of the view for the given constraints. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The measured size requirements of the view. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadius.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadius.md new file mode 100644 index 0000000000..b5b8966a8c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadius.md @@ -0,0 +1,281 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## CornerRadius Struct + +Struct representing the radius of each corner of a rectangle. + +```csharp +public struct CornerRadius +``` +### Constructors + + + +## CornerRadius(float) Constructor + +Initializes a new instance of the [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') struct with the specified uniform radius. + +```csharp +public CornerRadius(float uniformRadius); +``` +#### Parameters + + + +`uniformRadius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform radius of all four corners. + + + +## CornerRadius(float, float, float, float) Constructor + +Initializes a new instance of the [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') struct with the specified radii for each corner. + +```csharp +public CornerRadius(float topLeft, float topRight, float bottomLeft, float bottomRight); +``` +#### Parameters + + + +`topLeft` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the top left corner. + + + +`topRight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the top right corner. + + + +`bottomLeft` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the bottom left corner. + + + +`bottomRight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The radius of the bottom right corner. +### Fields + + + +## CornerRadius.Zero Field + +The CornerRadius at {0,0,0,0}. + +```csharp +public static readonly CornerRadius Zero; +``` + +#### Field Value +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') +### Properties + + + +## CornerRadius.BottomLeft Property + +The radius of the bottom left corner of the rectangle. + +```csharp +public readonly float BottomLeft { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CornerRadius.BottomRight Property + +The radius of the bottom right corner of the rectangle. + +```csharp +public readonly float BottomRight { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CornerRadius.IsNaN Property + +Gets a value indicating whether any value has a width of NaN. + +```csharp +public bool IsNaN { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## CornerRadius.IsRelative Property + +Gets whether a value is relative. + +```csharp +public readonly bool IsRelative { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## CornerRadius.IsZero Property + +Whether both TopLeft, TopRight, BottomLeft and BottomRight are 0. + +```csharp +public bool IsZero { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if both TopLeft, TopRight, BottomLeft and BottomRight are 0.0. + + + +## CornerRadius.TopLeft Property + +The radius of the top left corner of the rectangle. + +```csharp +public readonly float TopLeft { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## CornerRadius.TopRight Property + +The radius of the top right corner of the rectangle. + +```csharp +public readonly float TopRight { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## CornerRadius.Deconstruct(float, float, float, float) Method + +Deconstructs the CornerRadius struct into its individual values. + +```csharp +public void Deconstruct(out float topLeft, out float topRight, out float bottomLeft, out float bottomRight); +``` +#### Parameters + + + +`topLeft` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top left corner radius. + + + +`topRight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top right corner radius. + + + +`bottomLeft` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom left corner radius. + + + +`bottomRight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom right corner radius. + + + +## CornerRadius.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.CornerRadius.md#Tizen.UI.CornerRadius.Equals(object).obj 'Tizen.UI.CornerRadius.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## CornerRadius.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## CornerRadius.ToString() Method + +Returns a string that represents the current object. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +A string that represents the current object. +### Operators + + + +## CornerRadius.implicit operator CornerRadius(float) Operator + +Implicitly converts a [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') value to a [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') instance with the specified uniform radius. + +```csharp +public static Tizen.UI.CornerRadius implicit operator CornerRadius(float uniformRadius); +``` +#### Parameters + + + +`uniformRadius` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform radius of all four corners. + +#### Returns +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadiusPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadiusPropertyValue.md new file mode 100644 index 0000000000..798c61d654 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadiusPropertyValue.md @@ -0,0 +1,105 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## CornerRadiusPropertyValue Class + +The CornerRadiusPropertyValue class represents a property value of CornerRadius type. + +```csharp +public class CornerRadiusPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 CornerRadiusPropertyValue +### Constructors + + + +## CornerRadiusPropertyValue(CornerRadius) Constructor + +Initializes a new instance of the CornerRadiusPropertyValue class with the specified CornerRadius value. + +```csharp +public CornerRadiusPropertyValue(Tizen.UI.CornerRadius cornerRadius); +``` +#### Parameters + + + +`cornerRadius` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The CornerRadius value to set. +### Properties + + + +## CornerRadiusPropertyValue.CornerRadius Property + +Gets the CornerRadius value of the property. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; } +``` + +#### Property Value +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + + + +## CornerRadiusPropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## CornerRadiusPropertyValue.GetTargetProperties(View) Method + +Gets the target properties for the given view. + +```csharp +public override System.Collections.Generic.IEnumerable<(Tizen.UI.NativeHandle.AnimatablePropertyHandle Property,Tizen.UI.NativeHandle.PropertyValueHandle Value)> GetTargetProperties(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the target properties for. + +#### Returns +[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +An enumeration of tuples containing the target property handle and its corresponding value handle. + + + +## CornerRadiusPropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property belongs. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CustomPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CustomPropertyValue.md new file mode 100644 index 0000000000..44050eab17 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CustomPropertyValue.md @@ -0,0 +1,77 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## CustomPropertyValue Class + +Represents a custom property value that can be animated. + +```csharp +public class CustomPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 CustomPropertyValue +### Constructors + + + +## CustomPropertyValue(string, PropertyValueHandle) Constructor + +Initializes a new instance of the [CustomPropertyValue](Tizen.UI.CustomPropertyValue.md 'Tizen.UI.CustomPropertyValue') class. + +```csharp +public CustomPropertyValue(string propertyName, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the property. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The value of the property. +### Properties + + + +## CustomPropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## CustomPropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the specified view. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DisplayMetrics.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DisplayMetrics.md new file mode 100644 index 0000000000..e07ac6d7ab --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DisplayMetrics.md @@ -0,0 +1,129 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## DisplayMetrics Class + +Provides methods for converting between display units and pixels. + +```csharp +public static class DisplayMetrics +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DisplayMetrics +### Properties + + + +## DisplayMetrics.DPI Property + +Gets the dots per inch (DPI) of the device screen. + +```csharp +public static int DPI { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## DisplayMetrics.Scale Property + +Gets or sets the scale factor. + +```csharp +public static float Scale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## DisplayMetrics.ScreenHeight Property + +Gets the height of the device screen in pixels. + +```csharp +public static int ScreenHeight { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## DisplayMetrics.ScreenWidth Property + +Gets the width of the device screen in pixels. + +```csharp +public static int ScreenWidth { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## DisplayMetrics.SetDensityBasedScaleFactor(float, int) Method + +Sets the scale factor based on density. + +```csharp +public static void SetDensityBasedScaleFactor(float userScale=1f, int baseDPI=160); +``` +#### Parameters + + + +`userScale` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The user-defined scale factor. + + + +`baseDPI` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The base DPI value. + + + +## DisplayMetrics.ToPoint(this float) Method + +Converts the specified pixel value to point value. + +```csharp +public static float ToPoint(this float pixel); +``` +#### Parameters + + + +`pixel` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The pixel value to be converted. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The converted point value. +### Events + + + +## DisplayMetrics.ScaleUpdated Event + +Occurs when the scale factors are updated. + +```csharp +public static event EventHandler ScaleUpdated; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DpExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DpExtensions.md new file mode 100644 index 0000000000..fb9187442a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DpExtensions.md @@ -0,0 +1,144 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## DpExtensions Class + +Provides extension methods for representing the the device-independent pixels (dp), point (pt) and pixel (px). + +```csharp +public static class DpExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DpExtensions +### Methods + + + +## DpExtensions.Dp(this float) Method + +Represents the specified device-independent pixels (dp). + +```csharp +public static Tizen.UI.UnitValue Dp(this float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to dp. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the dp. + + + +## DpExtensions.Dp(this int) Method + +Represents the specified device-independent pixels (dp). + +```csharp +public static Tizen.UI.UnitValue Dp(this int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value to dp. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the dp. + + + +## DpExtensions.Pt(this float) Method + +Represents the specified value to points (pt). + +```csharp +public static Tizen.UI.UnitValue Pt(this float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The point value. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the point value. + + + +## DpExtensions.Px(this int) Method + +Represents the specified pixel value. + +```csharp +public static Tizen.UI.UnitValue Px(this int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The pixel value. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the pixel value. + + + +## DpExtensions.Spx(this float) Method + +Represents the scaled pixels (Spx). + +```csharp +public static Tizen.UI.UnitValue Spx(this float value); +``` +#### Parameters + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to spx. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the spx. + + + +## DpExtensions.Spx(this int) Method + +Represents the scaled pixels (Spx). + +```csharp +public static Tizen.UI.UnitValue Spx(this int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value to spx. + +#### Returns +[UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') +A [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') object representing the spx. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DragEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DragEventArgs.md new file mode 100644 index 0000000000..e203769ab9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DragEventArgs.md @@ -0,0 +1,76 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## DragEventArgs Class + +The event arguments of drag. + +```csharp +public class DragEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 DragEventArgs +### Constructors + + + +## DragEventArgs() Constructor + +Create drag evnet arguments. + +```csharp +public DragEventArgs(); +``` + + + +## DragEventArgs(Point, Point) Constructor + +Create drag event arguments with initial values. + +```csharp +public DragEventArgs(Tizen.UI.Point touchPosition, Tizen.UI.Point displacement); +``` +#### Parameters + + + +`touchPosition` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The drag touch screen position. + + + +`displacement` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The drag displacement. +### Properties + + + +## DragEventArgs.Displacement Property + +The displacement of the drag. + +```csharp +public Tizen.UI.Point Displacement { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## DragEventArgs.TouchPosition Property + +The screen position of the drag touch. + +```csharp +public Tizen.UI.Point TouchPosition { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EditableTextBindings_T_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EditableTextBindings_T_.md new file mode 100644 index 0000000000..a642bb0474 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EditableTextBindings_T_.md @@ -0,0 +1,37 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## EditableTextBindings<T> Class + +Provides a set of static properties that represent the data-binding capabilities of the [IText](Tizen.UI.IText.md 'Tizen.UI.IText') and [ITextEditable](Tizen.UI.ITextEditable.md 'Tizen.UI.ITextEditable') interface. + +```csharp +public static class EditableTextBindings<T> + where T : Tizen.UI.View, Tizen.UI.IText, Tizen.UI.ITextEditable +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 EditableTextBindings<T> +### Properties + + + +## EditableTextBindings<T>.TextProperty Property + +The TextProperty is a two-way bindable property that indicates the text displayed in the Itext control. + +```csharp +public static Tizen.UI.TwoWayBindingProperty<T,string> TextProperty { get; } +``` + +#### Property Value +[Tizen.UI.TwoWayBindingProperty<](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[T](Tizen.UI.EditableTextBindings_T_.md#Tizen.UI.EditableTextBindings_T_.T 'Tizen.UI.EditableTextBindings<T>.T')[,](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EventHandlerHelper.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EventHandlerHelper.md new file mode 100644 index 0000000000..3b41955373 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EventHandlerHelper.md @@ -0,0 +1,82 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## EventHandlerHelper Class + +EventHandlerHelper class provides a helper method to set and get event handlers using actions. + +```csharp +public static class EventHandlerHelper +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 EventHandlerHelper +### Methods + + + +## EventHandlerHelper.Get<TEventHandler>(Action) Method + +Gets the event handler associated with the given action and removes the association. + +```csharp +public static TEventHandler Get<TEventHandler>(System.Action action) + where TEventHandler : System.Delegate; +``` +#### Type parameters + + + +`TEventHandler` + +The type of the event handler. +#### Parameters + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to get the event handler for. + +#### Returns +[TEventHandler](Tizen.UI.EventHandlerHelper.md#Tizen.UI.EventHandlerHelper.Get_TEventHandler_(System.Action).TEventHandler 'Tizen.UI.EventHandlerHelper.Get<TEventHandler>(System.Action).TEventHandler') +The event handler associated with the given action, or null if no association exists. + + + +## EventHandlerHelper.Set<TEventHandler>(TEventHandler, Action) Method + +Sets the event handler for the given action. + +```csharp +public static TEventHandler Set<TEventHandler>(TEventHandler handler, System.Action action) + where TEventHandler : System.Delegate; +``` +#### Type parameters + + + +`TEventHandler` + +The type of the event handler. +#### Parameters + + + +`handler` [TEventHandler](Tizen.UI.EventHandlerHelper.md#Tizen.UI.EventHandlerHelper.Set_TEventHandler_(TEventHandler,System.Action).TEventHandler 'Tizen.UI.EventHandlerHelper.Set<TEventHandler>(TEventHandler, System.Action).TEventHandler') + +The event handler to set. + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to associate with the event handler. + +#### Returns +[TEventHandler](Tizen.UI.EventHandlerHelper.md#Tizen.UI.EventHandlerHelper.Set_TEventHandler_(TEventHandler,System.Action).TEventHandler 'Tizen.UI.EventHandlerHelper.Set<TEventHandler>(TEventHandler, System.Action).TEventHandler') +The event handler that was set. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ExceptionHelper.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ExceptionHelper.md new file mode 100644 index 0000000000..f86e56e81d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ExceptionHelper.md @@ -0,0 +1,17 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ExceptionHelper Class + +Including methods that helps to throw exceptions. + +```csharp +public static class ExceptionHelper +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ExceptionHelper + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FittingMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FittingMode.md new file mode 100644 index 0000000000..0f87a03b02 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FittingMode.md @@ -0,0 +1,52 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FittingMode Enum + +Enumeration for FittingMode. + +```csharp +public enum FittingMode +``` +### Fields + + + +`Center` 3 + +Center the image in the view without scaling. + + + +`Fill` 1 + +Fill the entire available space by stretching the image regardless of the aspect ratio. + + + +`FitHeight` 4 + +Scale the image to fit the height of the available space while maintaining its aspect ratio. + + + +`FitWidth` 5 + +Scale the image to fit the width of the available space while maintaining its aspect ratio. + + + +`ScaleToFill` 2 + +Scale the image to fill the view. Some parts may be clipped in order to fill the view. + + + +`ScaleToFit` 0 + +Scale the image to fit within the available space without changing its aspect ratio. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusChangedEventArgs.md new file mode 100644 index 0000000000..e7a0296bec --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusChangedEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FocusChangedEventArgs Class + +Provides data for the [FocusChanged](Tizen.UI.FocusManager.md#Tizen.UI.FocusManager.FocusChanged 'Tizen.UI.FocusManager.FocusChanged') event. + +```csharp +public class FocusChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 FocusChangedEventArgs +### Properties + + + +## FocusChangedEventArgs.FocusedView Property + +Gets or sets the view that currently has focus. + +```csharp +public Tizen.UI.View FocusedView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## FocusChangedEventArgs.PreviousFocusedView Property + +Gets or sets the view that previously had focus. + +```csharp +public Tizen.UI.View PreviousFocusedView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusDirection.md new file mode 100644 index 0000000000..e448836f0a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusDirection.md @@ -0,0 +1,76 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FocusDirection Enum + +The FocusDirection enum represents the direction of focus movement within a view. + +```csharp +public enum FocusDirection +``` +### Fields + + + +`Backward` 7 + +Move keyboard focus towards the backward direction. + + + +`Clockwise` 8 + +Move focus towards the Clockwise direction by rotary wheel. + + + +`CounterClockwise` 9 + +Move focus towards the CounterClockwise direction by rotary wheel. + + + +`Down` 3 + +Move keyboard focus towards the down direction. + + + +`Forward` 6 + +Move keyboard focus towards the forward direction. + + + +`Left` 0 + +Move keyboard focus towards the left direction. + + + +`PageDown` 5 + +Move keyboard focus towards the next page direction. + + + +`PageUp` 4 + +Move keyboard focus towards the previous page direction. + + + +`Right` 1 + +Move keyboard focus towards the right direction. + + + +`Up` 2 + +Move keyboard focus towards the up direction. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusManager.md new file mode 100644 index 0000000000..9f2c0ea5ea --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusManager.md @@ -0,0 +1,225 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FocusManager Class + +The FocusManager class is used to manage the focus between views. + +```csharp +public class FocusManager : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 FocusManager +### Properties + + + +## FocusManager.Instance Property + +Gets the singleton instance of the FocusManager. + +```csharp +public static Tizen.UI.FocusManager Instance { get; } +``` + +#### Property Value +[FocusManager](Tizen.UI.FocusManager.md 'Tizen.UI.FocusManager') +### Methods + + + +## FocusManager.ClearFocus() Method + +Clears the focus from the currently focused view. + +```csharp +public void ClearFocus(); +``` + + + +## FocusManager.EnableDefaultFocusAlgorithm(bool) Method + +Enables or disables the default focus algorithm. + +```csharp +public void EnableDefaultFocusAlgorithm(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to enable the default algorithm, false to disable it. + + + +## FocusManager.EnableFocusIndicator(bool) Method + +Enables or disables the focus indicator. + +```csharp +public void EnableFocusIndicator(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to enable the focus indicator, false to disable it. + + + +## FocusManager.GetFocused() Method + +Gets the currently focused view. + +```csharp +public Tizen.UI.View GetFocused(); +``` + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The currently focused view. + + + +## FocusManager.GetNearestFocusableView(View, View, FocusDirection) Method + +Gets the nearest focusable view within the specified view hierarchy. + +```csharp +public Tizen.UI.View GetNearestFocusableView(Tizen.UI.View rootView, Tizen.UI.View currentView, Tizen.UI.FocusDirection direction); +``` +#### Parameters + + + +`rootView` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The root view of the view hierarchy. + + + +`currentView` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The current focused view. + + + +`direction` [FocusDirection](Tizen.UI.FocusDirection.md 'Tizen.UI.FocusDirection') + +The direction of focus movement. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The nearest focusable view in the specified direction. + + + +## FocusManager.GetNearestFocusableViewOverride(View, View, FocusDirection) Method + +Gets the nearest focusable view within the specified view hierarchy, using the custom focus algorithm if set. + +```csharp +public Tizen.UI.View GetNearestFocusableViewOverride(Tizen.UI.View rootView, Tizen.UI.View currentView, Tizen.UI.FocusDirection direction); +``` +#### Parameters + + + +`rootView` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The root view of the view hierarchy. + + + +`currentView` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The current focused view. + + + +`direction` [FocusDirection](Tizen.UI.FocusDirection.md 'Tizen.UI.FocusDirection') + +The direction of focus movement. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The nearest focusable view in the specified direction. + + + +## FocusManager.SetCustomFocusAlgorithm(IFocusAlgorithm) Method + +Sets the custom focus algorithm to be used for finding the nearest focusable view. + +```csharp +public void SetCustomFocusAlgorithm(Tizen.UI.IFocusAlgorithm focusAlgorithm); +``` +#### Parameters + + + +`focusAlgorithm` [IFocusAlgorithm](Tizen.UI.IFocusAlgorithm.md 'Tizen.UI.IFocusAlgorithm') + +The custom focus algorithm to set. + + + +## FocusManager.SetFocus(View) Method + +Sets the focus to the specified view. + +```csharp +public bool SetFocus(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to receive focus. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the focus is set successfully, false otherwise. + + + +## FocusManager.SetFocusIndicator(View) Method + +Sets the focus indicator actor to be used when moving the focus. + +```csharp +public void SetFocusIndicator(Tizen.UI.View indicator); +``` +#### Parameters + + + +`indicator` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The focus indicator actor to set. +### Events + + + +## FocusManager.FocusChanged Event + +Occurs when the focused view changes. + +```csharp +public event EventHandler<FocusChangedEventArgs> FocusChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[FocusChangedEventArgs](Tizen.UI.FocusChangedEventArgs.md 'Tizen.UI.FocusChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontClient.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontClient.md new file mode 100644 index 0000000000..7f9956d2ba --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontClient.md @@ -0,0 +1,131 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontClient Class + +```csharp +public class FontClient : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 FontClient +### Properties + + + +## FontClient.Instance Property + +Gets the singleton instance of the FontClient. + +```csharp +public static Tizen.UI.FontClient Instance { get; } +``` + +#### Property Value +[FontClient](Tizen.UI.FontClient.md 'Tizen.UI.FontClient') +### Methods + + + +## FontClient.AddCustomFontDirectory(string) Method + +Adds custom fonts directory. + +```csharp +public bool AddCustomFontDirectory(string path); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +Path to the fonts directory. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the fonts can be added. + + + +## FontClient.FontPreLoad(IEnumerable<string>, IEnumerable<string>, bool, bool) Method + +This is used to pre-load FreeType font face in order to improve the runtime performance of the application. +> The fonts in the fontPathList perform FT_New_Face during pre-loading, which can provide some performace benefits.
+> The fonts in the memoryFontPathList read the font file and cache the buffer in memory during pre-load.
+> This enables the use of FT_New_Memory_Face during runtime and provides a performance boost.
+> It requires memory equivalent to the size of each font file. + +```csharp +public static void FontPreLoad(System.Collections.Generic.IEnumerable<string> fontPathList, System.Collections.Generic.IEnumerable<string> memoryFontPathList, bool useThread, bool syncCreation=true); +``` +#### Parameters + + + +`fontPathList` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +A list of font paths to be pre-loaded. + + + +`memoryFontPathList` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +A list of memory font paths to be pre-loaded. + + + +`useThread` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the font client should create thread and perform font pre-loading, false otherwise. + + + +`syncCreation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if thread creation guarantees syncronization with the main thread, false async creation. Optional, the default value is true. + + + +## FontClient.PreCache(IEnumerable<string>, IEnumerable<string>, string, bool, bool) Method + +This is used to pre-cache FontConfig in order to improve the runtime performance of the application. + +```csharp +public static void PreCache(System.Collections.Generic.IEnumerable<string> fallbackFamilyList, System.Collections.Generic.IEnumerable<string> extraFamilyList, string localeFamily, bool useThread, bool syncCreation=true); +``` +#### Parameters + + + +`fallbackFamilyList` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +A list of fallback font families to be pre-cached. + + + +`extraFamilyList` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') + +A list of additional font families to be pre-cached. + + + +`localeFamily` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A locale font family to be pre-cached. + + + +`useThread` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the font client should create thread and perform pre-caching, false otherwise. + + + +`syncCreation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if thread creation guarantees syncronization with the main thread, false async creation. Optional, the default value is true. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontInfo.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontInfo.md new file mode 100644 index 0000000000..efc05480a6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontInfo.md @@ -0,0 +1,170 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontInfo Struct + +A struct to pass data of FontInfo PropertyMap. + +```csharp +public struct FontInfo : +System.IEquatable<Tizen.UI.FontInfo> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Properties + + + +## FontInfo.Family Property + +The FontFamily of the font. + +```csharp +public string Family { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## FontInfo.Path Property + +The FontPath of the font. + +```csharp +public string Path { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## FontInfo.Style Property + +The FontStyle of the font. + +```csharp +public Tizen.UI.FontStyle Style { get; set; } +``` + +#### Property Value +[FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') +### Methods + + + +## FontInfo.Equals(object) Method + +Determines whether the specified object is equal to the current object. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if equal FontInfo, else false. + + + +## FontInfo.Equals(FontInfo) Method + +Determines whether the specified object is equal to the current object. + +```csharp +public bool Equals(Tizen.UI.FontInfo other); +``` +#### Parameters + + + +`other` [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') + +The FontInfo to compare with the current FontInfo. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if equal FontInfo, else false. + + + +## FontInfo.GetHashCode() Method + +Gets the hash code of this FontInfo. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The hash code. +### Operators + + + +## FontInfo.operator ==(FontInfo, FontInfo) Operator + +The == operator. + +```csharp +public static bool operator ==(Tizen.UI.FontInfo lhsFontInfo, Tizen.UI.FontInfo rhsFontInfo); +``` +#### Parameters + + + +`lhsFontInfo` [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') + +FontInfo to compare + + + +`rhsFontInfo` [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') + +FontInfo to be compared + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if FontInfos are equal + + + +## FontInfo.operator !=(FontInfo, FontInfo) Operator + +The != operator. + +```csharp +public static bool operator !=(Tizen.UI.FontInfo lhsFontInfo, Tizen.UI.FontInfo rhsFontInfo); +``` +#### Parameters + + + +`lhsFontInfo` [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') + +FontInfo to compare + + + +`rhsFontInfo` [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') + +FontInfo to be compared + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if FontInfos are not equal + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontSlant.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontSlant.md new file mode 100644 index 0000000000..86aa781685 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontSlant.md @@ -0,0 +1,46 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontSlant Enum + +Enumeration type for the font's slant. + +```csharp +public enum FontSlant +``` +### Fields + + + +`Italic` 2 + +Italic. + + + +`None` 0 + +None. + + + +`Normal` 1 + +Normal. + + + +`Oblique` 3 + +Oblique. + + + +`Roman` 1 + +Roman. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontStyle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontStyle.md new file mode 100644 index 0000000000..b9a66abe2d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontStyle.md @@ -0,0 +1,173 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontStyle Struct + +A struct to pass data of FontStyle PropertyMap.
+ +```csharp +public struct FontStyle : +System.IEquatable<Tizen.UI.FontStyle> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') + +### Remarks +The FontStyle struct is used as an argument to SetFontStyle and GetFontStyle methods.
+### Properties + + + +## FontStyle.Slant Property + +The Slant defines whether to use italics. + +```csharp +public Tizen.UI.FontSlant Slant { get; set; } +``` + +#### Property Value +[FontSlant](Tizen.UI.FontSlant.md 'Tizen.UI.FontSlant') + + + +## FontStyle.Weight Property + +The Weight defines the thickness or darkness of the glyphs. + +```csharp +public Tizen.UI.FontWeight Weight { get; set; } +``` + +#### Property Value +[FontWeight](Tizen.UI.FontWeight.md 'Tizen.UI.FontWeight') + + + +## FontStyle.Width Property + +The Width defines occupied by each glyph. + +```csharp +public Tizen.UI.FontWidth Width { get; set; } +``` + +#### Property Value +[FontWidth](Tizen.UI.FontWidth.md 'Tizen.UI.FontWidth') +### Methods + + + +## FontStyle.Equals(object) Method + +Determines whether the specified object is equal to the current object. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if equal FontStyle, else false. + + + +## FontStyle.Equals(FontStyle) Method + +Determines whether the specified object is equal to the current object. + +```csharp +public bool Equals(Tizen.UI.FontStyle other); +``` +#### Parameters + + + +`other` [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') + +The FontStyle to compare with the current FontStyle. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if equal FontStyle, else false. + + + +## FontStyle.GetHashCode() Method + +Gets the hash code of this FontStyle. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The hash code. +### Operators + + + +## FontStyle.operator ==(FontStyle, FontStyle) Operator + +The == operator. + +```csharp +public static bool operator ==(Tizen.UI.FontStyle lhsFontStyle, Tizen.UI.FontStyle rhsFontStyle); +``` +#### Parameters + + + +`lhsFontStyle` [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') + +FontStyle to compare + + + +`rhsFontStyle` [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') + +FontStyle to be compared + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if FontStyles are equal + + + +## FontStyle.operator !=(FontStyle, FontStyle) Operator + +The != operator. + +```csharp +public static bool operator !=(Tizen.UI.FontStyle lhsFontStyle, Tizen.UI.FontStyle rhsFontStyle); +``` +#### Parameters + + + +`lhsFontStyle` [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') + +FontStyle to compare + + + +`rhsFontStyle` [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') + +FontStyle to be compared + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if FontStyles are not equal + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWeight.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWeight.md new file mode 100644 index 0000000000..8e321b8832 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWeight.md @@ -0,0 +1,130 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontWeight Enum + +Enumeration type for the font's weight. + +```csharp +public enum FontWeight +``` +### Fields + + + +`Black` 16 + +Black. + + + +`Bold` 13 + +Bold. + + + +`Book` 7 + +Book. + + + +`DemiBold` 11 + +DemiBold. + + + +`DemiLight` 5 + +DemiLight. + + + +`ExtraBlack` 18 + +ExtraBlack. + + + +`ExtraBold` 15 + +ExtraBold. + + + +`ExtraLight` 3 + +ExtraLight. + + + +`Heavy` 17 + +Heavy. + + + +`Light` 4 + +Light. + + + +`Medium` 10 + +Medium. + + + +`None` 0 + +None. + + + +`Normal` 8 + +Normal. + + + +`Regular` 9 + +Regular. + + + +`SemiBold` 12 + +SemiBold. + + + +`SemiLight` 6 + +SemiLight. + + + +`Thin` 1 + +Thin. + + + +`UltraBold` 14 + +UltraBold. + + + +`UltraLight` 2 + +UltraLight. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWidth.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWidth.md new file mode 100644 index 0000000000..b5a096ef27 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWidth.md @@ -0,0 +1,76 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontWidth Enum + +Enumeration type for the font's width. + +```csharp +public enum FontWidth +``` +### Fields + + + +`Condensed` 3 + +Condensed. + + + +`Expanded` 7 + +Expanded. + + + +`ExtraCondensed` 2 + +ExtraCondensed. + + + +`ExtraExpanded` 8 + +ExtraExpanded. + + + +`None` 0 + +None. + + + +`Normal` 5 + +Normal. + + + +`SemiCondensed` 4 + +SemiCondensed. + + + +`SemiExpanded` 6 + +SemiExpanded. + + + +`UltraCondensed` 1 + +UltraCondensed. + + + +`UltraExpanded` 9 + +UltraExpanded. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FrameUpdateCallback.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FrameUpdateCallback.md new file mode 100644 index 0000000000..bb71e276be --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FrameUpdateCallback.md @@ -0,0 +1,77 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## FontWidth Enum + +Enumeration type for the font's width. + +```csharp +public enum FontWidth +``` +### Fields + + + +`Condensed` 3 + +Condensed. + + + +`Expanded` 7 + +Expanded. + + + +`ExtraCondensed` 2 + +ExtraCondensed. + + + +`ExtraExpanded` 8 + +ExtraExpanded. + + + +`None` 0 + +None. + + + +`Normal` 5 + +Normal. + + + +`SemiCondensed` 4 + +SemiCondensed. + + + +`SemiExpanded` 6 + +SemiExpanded. + + + +`UltraCondensed` 1 + +UltraCondensed. + + + +`UltraExpanded` 9 + +UltraExpanded. + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Gesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Gesture.md new file mode 100644 index 0000000000..153c68f0bb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Gesture.md @@ -0,0 +1,77 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Gesture Class + +The Gesture class is an abstract class that represents a gesture detected by the system. + +```csharp +public abstract class Gesture : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 Gesture + +Derived +↳ [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') +↳ [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') +↳ [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') +↳ [RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') +↳ [TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') +### Properties + + + +## Gesture.Source Property + +Gets the source of the gesture. + +```csharp +public Tizen.UI.GestureSource Source { get; } +``` + +#### Property Value +[GestureSource](Tizen.UI.GestureSource.md 'Tizen.UI.GestureSource') + + + +## Gesture.SourceData Property + +Gets the source data of the gesture. + +```csharp +public Tizen.UI.GestureSourceData SourceData { get; } +``` + +#### Property Value +[GestureSourceData](Tizen.UI.GestureSourceData.md 'Tizen.UI.GestureSourceData') + + + +## Gesture.State Property + +Gets the state of the gesture. + +```csharp +public Tizen.UI.GestureState State { get; } +``` + +#### Property Value +[GestureState](Tizen.UI.GestureState.md 'Tizen.UI.GestureState') + + + +## Gesture.Time Property + +Gets the time when the gesture was detected. + +```csharp +public uint Time { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetectedEventArgs.md new file mode 100644 index 0000000000..dc81744730 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetectedEventArgs.md @@ -0,0 +1,52 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GestureDetectedEventArgs Class + +A base event arguments for gesture events. + +```csharp +public abstract class GestureDetectedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 GestureDetectedEventArgs + +Derived +↳ [LongPressGestureDetectedEventArgs](Tizen.UI.LongPressGestureDetectedEventArgs.md 'Tizen.UI.LongPressGestureDetectedEventArgs') +↳ [PanGestureDetectedEventArgs](Tizen.UI.PanGestureDetectedEventArgs.md 'Tizen.UI.PanGestureDetectedEventArgs') +↳ [PinchGestureDetectedEventArgs](Tizen.UI.PinchGestureDetectedEventArgs.md 'Tizen.UI.PinchGestureDetectedEventArgs') +↳ [RotationGestureDetectedEventArgs](Tizen.UI.RotationGestureDetectedEventArgs.md 'Tizen.UI.RotationGestureDetectedEventArgs') +↳ [TapGestureDetectedEventArgs](Tizen.UI.TapGestureDetectedEventArgs.md 'Tizen.UI.TapGestureDetectedEventArgs') +### Properties + + + +## GestureDetectedEventArgs.Handled Property + +Gets or sets a value indicating whether the gesture has been handled by the view. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the gesture has been handled, false otherwise. + + + +## GestureDetectedEventArgs.View Property + +Gets the [View](Tizen.UI.GestureDetectedEventArgs.md#Tizen.UI.GestureDetectedEventArgs.View 'Tizen.UI.GestureDetectedEventArgs.View') that detected the gesture. + +```csharp +public Tizen.UI.View View { get; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetector.md new file mode 100644 index 0000000000..78a49a6d55 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetector.md @@ -0,0 +1,68 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GestureDetector Class + +The GestureDetector class is an abstract class that detects gestures on a View. + +```csharp +public abstract class GestureDetector : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 GestureDetector + +Derived +↳ [LongPressGestureDetector](Tizen.UI.LongPressGestureDetector.md 'Tizen.UI.LongPressGestureDetector') +↳ [PanGestureDetector](Tizen.UI.PanGestureDetector.md 'Tizen.UI.PanGestureDetector') +↳ [PinchGestureDetector](Tizen.UI.PinchGestureDetector.md 'Tizen.UI.PinchGestureDetector') +↳ [RotationGestureDetector](Tizen.UI.RotationGestureDetector.md 'Tizen.UI.RotationGestureDetector') +↳ [TapGestureDetector](Tizen.UI.TapGestureDetector.md 'Tizen.UI.TapGestureDetector') +### Methods + + + +## GestureDetector.Attach(View) Method + +Attaches the gesture detector to the specified view. + +```csharp +public void Attach(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to attach the gesture detector to. + + + +## GestureDetector.Detach(View) Method + +Detaches the gesture detector from the specified view. + +```csharp +public void Detach(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to detach the gesture detector from. + + + +## GestureDetector.DetachAll() Method + +Detaches all attached views from the gesture detector. + +```csharp +public void DetachAll(); +``` + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSource.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSource.md new file mode 100644 index 0000000000..cb65f43098 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSource.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GestureSource Enum + +Enumeration for gesture source. + +```csharp +public enum GestureSource +``` +### Fields + + + +`Mouse` 1 + +Mouse. + + + +`Touch` 2 + +Touch. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSourceData.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSourceData.md new file mode 100644 index 0000000000..5cf3e7eacf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSourceData.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GestureSourceData Enum + +Enumeration for gesture source data. + +```csharp +public enum GestureSourceData +``` +### Fields + + + +`MousePrimary` 1 + +Mouse primary button. + + + +`MouseSecondary` 3 + +Mouse secondary button. + + + +`MouseTertiary` 2 + +Mouse tertiary button. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureState.md new file mode 100644 index 0000000000..7f315e7212 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureState.md @@ -0,0 +1,52 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GestureState Enum + +The GestureState enum represents the possible states of a gesture. + +```csharp +public enum GestureState +``` +### Fields + + + +`Cancelled` 4 + +The gesture has been cancelled. + + + +`Clear` 0 + +There is no state associated with this gesture. + + + +`Continuing` 2 + +The gesture is continuing. + + + +`Finished` 3 + +The user has lifted a finger or touched an additional point on the screen. + + + +`Possible` 5 + +A gesture is possible. + + + +`Started` 1 + +The touched points on the screen have moved enough to be considered a gesture. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientBackground.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientBackground.md new file mode 100644 index 0000000000..20739ae9a9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientBackground.md @@ -0,0 +1,66 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GradientBackground Class + +GradientBackground is a base class for visuals that have a gradient effect. + +```csharp +public abstract class GradientBackground : Tizen.UI.Background +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Background](Tizen.UI.Background.md 'Tizen.UI.Background') 🡒 GradientBackground + +Derived +↳ [LinearGradientBackground](Tizen.UI.LinearGradientBackground.md 'Tizen.UI.LinearGradientBackground') +↳ [RadialGradientBackground](Tizen.UI.RadialGradientBackground.md 'Tizen.UI.RadialGradientBackground') +### Properties + + + +## GradientBackground.GradientStops Property + +Gets the list of gradient stops. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.GradientStop> GradientStops { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[GradientStop](Tizen.UI.GradientStop.md 'Tizen.UI.GradientStop')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## GradientBackground.GradientVisualSpreadMethod Property + +Gets or sets the spread method of the gradient. + +```csharp +public System.Nullable<Tizen.UI.GradientVisualSpreadMethod> GradientVisualSpreadMethod { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[GradientVisualSpreadMethod](Tizen.UI.GradientVisualSpreadMethod.md 'Tizen.UI.GradientVisualSpreadMethod')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') +### Methods + + + +## GradientBackground.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public override void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientStop.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientStop.md new file mode 100644 index 0000000000..c1d2e31bac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientStop.md @@ -0,0 +1,66 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GradientStop Struct + +The GradientStop structure represents a color and its position along the gradient line. + +```csharp +public struct GradientStop +``` +### Constructors + + + +## GradientStop(Color, float) Constructor + +Initializes a new instance of the GradientStop class with the specified color and offset. + +```csharp +public GradientStop(Tizen.UI.Color color, float offset); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The color of the gradient stop. + + + +`offset` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The position of the gradient stop along the gradient line, ranging from 0 to 1. +### Properties + + + +## GradientStop.Color Property + +Gets or sets the color of the gradient stop. + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## GradientStop.Offset Property + +Gets or sets the position of the gradient stop along the gradient line, ranging from 0 to 1. + +```csharp +public float Offset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientVisualSpreadMethod.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientVisualSpreadMethod.md new file mode 100644 index 0000000000..30622d5e06 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientVisualSpreadMethod.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## GradientVisualSpreadMethod Enum + +Specifies the method used to spread the gradient colors across the area being painted. + +```csharp +public enum GradientVisualSpreadMethod +``` +### Fields + + + +`Pad` 0 + +Uses the terminal colors of the gradient to fill the remainder of the quad. + + + +`Reflect` 1 + +Reflects the gradient pattern start-to-end, end-to-start, start-to-end, etc. until the quad is filled. + + + +`Repeat` 2 + +Repeats the gradient pattern start-to-end, start-to-end, start-to-end, etc. until the quad is filled. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputMode.md new file mode 100644 index 0000000000..c94943c2ff --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputMode.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## HiddenInputMode Enum + +Enumeration for hidden input mode. + +```csharp +public enum HiddenInputMode +``` +### Fields + + + +`All` 1 + +Hide all the input text. + + + +`HideCount` 2 + +Hide n characters from start. + + + +`None` 0 + +Don't hide text. + + + +`ShowCount` 3 + +Show n characters from start. + + + +`ShowLastCharacter` 4 + +Show last character for the duration (use ShowLastCharacterDuration property to modify duration). + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputSetting.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputSetting.md new file mode 100644 index 0000000000..8719f087cd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputSetting.md @@ -0,0 +1,66 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## HiddenInputSetting Struct + +The HiddenInputSetting struct is used to configure the hidden input settings of a text input control. + +```csharp +public struct HiddenInputSetting +``` +### Properties + + + +## HiddenInputSetting.Count Property + +Gets or sets the count of characters to show when the hidden input mode is set to HiddenInputMode.ShowLastCharacter. + +```csharp +public System.Nullable<int> Count { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## HiddenInputSetting.HiddenCharacter Property + +Gets or sets the character to use when hiding input characters. + +```csharp +public System.Nullable<char> HiddenCharacter { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## HiddenInputSetting.Mode Property + +Gets or sets the hidden input mode. + +```csharp +public Tizen.UI.HiddenInputMode Mode { get; set; } +``` + +#### Property Value +[HiddenInputMode](Tizen.UI.HiddenInputMode.md 'Tizen.UI.HiddenInputMode') + + + +## HiddenInputSetting.ShowLastCharacterDuration Property + +Gets or sets the duration in milliseconds to show the last character when the hidden input mode is set to HiddenInputMode.ShowLastCharacter. + +```csharp +public System.Nullable<int> ShowLastCharacterDuration { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Hover.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Hover.md new file mode 100644 index 0000000000..66f718233b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Hover.md @@ -0,0 +1,83 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Hover Class + +The Hover class. + +```csharp +public class Hover +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Hover +### Properties + + + +## Hover.DeviceId Property + +Gets the device ID of the hover. + +```csharp +public int DeviceId { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Hover.HitView Property + +Gets the view that was hit by the hover. + +```csharp +public Tizen.UI.View HitView { get; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## Hover.Position Property + +Gets the local position of the hover. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Hover.ScreenPosition Property + +Gets the screen position of the hover. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Hover.State Property + +Gets the state of the hover. + +```csharp +public Tizen.UI.TouchState State { get; } +``` + +#### Property Value +[TouchState](Tizen.UI.TouchState.md 'Tizen.UI.TouchState') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEvent.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEvent.md new file mode 100644 index 0000000000..aa9a879779 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEvent.md @@ -0,0 +1,98 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## HoverEvent Class + +The HoverEvent class represents a hover event that contains information about the hover points. + +```csharp +public class HoverEvent : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 HoverEvent +### Constructors + + + +## HoverEvent() Constructor + +Initializes a new instance of the HoverEvent class + +```csharp +public HoverEvent(); +``` + + + +## HoverEvent(IntPtr, bool) Constructor + +Initializes a new instance of the HoverEvent class with the specified handle and ownership flag. + +```csharp +public HoverEvent(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the hover event. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the object takes ownership of the handle, false otherwise. +### Properties + + + +## HoverEvent.Count Property + +Gets the number of hover points in the hover event. + +```csharp +public int Count { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## HoverEvent.this[int] Property + +Gets the hover point at the specified index. + +```csharp +public Tizen.UI.Hover this[int i] { get; } +``` +#### Parameters + + + +`i` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the hover point to get. + +#### Property Value +[Hover](Tizen.UI.Hover.md 'Tizen.UI.Hover') + + + +## HoverEvent.Time Property + +Gets the time when the hover event occurred. + +```csharp +public uint Time { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEventArgs.md new file mode 100644 index 0000000000..affd66d7a0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## HoverEventArgs Class + +Event arguments for [HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') event. + +```csharp +public class HoverEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 HoverEventArgs +### Properties + + + +## HoverEventArgs.Handled Property + +Gets or sets a value indicating whether the event has been handled. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## HoverEventArgs.Hover Property + +Gets or sets the hover event that occurred. + +```csharp +public Tizen.UI.HoverEvent Hover { get; set; } +``` + +#### Property Value +[HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HtmlWebViewSource.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HtmlWebViewSource.md new file mode 100644 index 0000000000..8ebcae3645 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HtmlWebViewSource.md @@ -0,0 +1,42 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## HtmlWebViewSource Class + +A [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') bound to an HTML-formatted string. + +```csharp +public class HtmlWebViewSource : Tizen.UI.WebViewSource +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [WebViewSource](Tizen.UI.WebViewSource.md 'Tizen.UI.WebViewSource') 🡒 HtmlWebViewSource +### Properties + + + +## HtmlWebViewSource.BaseUrl Property + +Gets the base URL for the source HTML document. + +```csharp +public string BaseUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## HtmlWebViewSource.Html Property + +Gets the HTML content. + +```csharp +public string Html { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IBindableView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IBindableView.md new file mode 100644 index 0000000000..144dcf0c5b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IBindableView.md @@ -0,0 +1,29 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IBindableView Interface + +The IBindableView interface provides a mechanism for binding data to a view. + +```csharp +public interface IBindableView +``` +### Properties + + + +## IBindableView.BindingContext Property + +Gets or sets the binding context for the view. + +```csharp +object BindingContext { get; set; } +``` + +#### Property Value +[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantFocusObserver.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantFocusObserver.md new file mode 100644 index 0000000000..0140129707 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantFocusObserver.md @@ -0,0 +1,33 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IDescendantFocusObserver Interface + +The IDescendantFocusObserver interface defines a contract for classes that wish to receive notifications when a descendant view receives focus. + +```csharp +public interface IDescendantFocusObserver +``` +### Methods + + + +## IDescendantFocusObserver.OnDescendantFocused(View) Method + +Called when a descendant view receives focus. + +```csharp +void OnDescendantFocused(Tizen.UI.View descendant); +``` +#### Parameters + + + +`descendant` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The descendant view that received focus. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantUnfocusObserver.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantUnfocusObserver.md new file mode 100644 index 0000000000..33c1631c83 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantUnfocusObserver.md @@ -0,0 +1,33 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IDescendantUnfocusObserver Interface + +The IDescendantUnfocusObserver interface defines a contract for classes that wish to receive notifications when a descendant view loses focus. + +```csharp +public interface IDescendantUnfocusObserver +``` +### Methods + + + +## IDescendantUnfocusObserver.OnDescendantUnfocused(View) Method + +Called when a descendant view loses focus. + +```csharp +void OnDescendantUnfocused(Tizen.UI.View descendant); +``` +#### Parameters + + + +`descendant` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The descendant view that lost focus. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IFocusAlgorithm.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IFocusAlgorithm.md new file mode 100644 index 0000000000..1e70badb89 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IFocusAlgorithm.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IFocusAlgorithm Interface + +The IFocusAlgorithm interface defines the methods required for a focus algorithm to be used by the FocusManager. + +```csharp +public interface IFocusAlgorithm +``` +### Methods + + + +## IFocusAlgorithm.GetNextFocusableView(View, View, FocusDirection, string) Method + +Gets the next focusable view based on the current view and the focus direction. + +```csharp +Tizen.UI.View GetNextFocusableView(Tizen.UI.View current, Tizen.UI.View proposed, Tizen.UI.FocusDirection direction, string deviceName); +``` +#### Parameters + + + +`current` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The current view. + + + +`proposed` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The proposed view. + + + +`direction` [FocusDirection](Tizen.UI.FocusDirection.md 'Tizen.UI.FocusDirection') + +The focus direction. + + + +`deviceName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the device that is requesting the focus. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The next focusable view. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IImage.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IImage.md new file mode 100644 index 0000000000..2f7d8ce633 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IImage.md @@ -0,0 +1,84 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IImage Interface + +The IImage interface provides a common set of properties and methods for image objects. + +```csharp +public interface IImage +``` + +Derived +↳ [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') +### Properties + + + +## IImage.Border Property + +Gets or sets the border of the image. + +```csharp +Tizen.UI.Thickness Border { get; set; } +``` + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## IImage.CropToMask Property + +Gets or sets whether the image should be cropped to its mask. + +```csharp +bool CropToMask { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IImage.FittingMode Property + +Gets or sets the fitting mode used to scale the image to fit the control. + +```csharp +Tizen.UI.FittingMode FittingMode { get; set; } +``` + +#### Property Value +[FittingMode](Tizen.UI.FittingMode.md 'Tizen.UI.FittingMode') + + + +## IImage.IsNinePatchImage Property + +Gets or sets whether the image is a nine-patch image. + +```csharp +bool IsNinePatchImage { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IImage.ResourceUrl Property + +Gets or sets the resource url of image. + +```csharp +string ResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IParentObject.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IParentObject.md new file mode 100644 index 0000000000..31d47a46c2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IParentObject.md @@ -0,0 +1,38 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IParentObject Interface + +Represents an interface for managing parent-child relationships between views. + +```csharp +public interface IParentObject +``` + +Derived +↳ [ContentView](Tizen.UI.ContentView.md 'Tizen.UI.ContentView') +↳ [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') +↳ [ViewGroup](Tizen.UI.ViewGroup.md 'Tizen.UI.ViewGroup') +### Methods + + + +## IParentObject.Remove(View) Method + +Removes the specified view from its parent. + +```csharp +void Remove(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to unparent. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollBar.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollBar.md new file mode 100644 index 0000000000..faad1525d6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollBar.md @@ -0,0 +1,114 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IScrollBar Interface + +Defines the interface for a scroll bar, which is responsible for displaying and controlling the scrolling of a target view. + +```csharp +public interface IScrollBar : +System.IDisposable +``` + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## IScrollBar.HorizontalScrollBarVisibility Property + +Gets or sets the visibility of the horizontal scroll bar. + +```csharp +Tizen.UI.ScrollBarVisibility HorizontalScrollBarVisibility { get; set; } +``` + +#### Property Value +[ScrollBarVisibility](Tizen.UI.ScrollBarVisibility.md 'Tizen.UI.ScrollBarVisibility') + + + +## IScrollBar.Target Property + +Gets the target view for which the scroll bar is responsible. + +```csharp +Tizen.UI.View Target { get; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## IScrollBar.VerticalScrollBarVisibility Property + +Gets or sets the visibility of the vertical scroll bar. + +```csharp +Tizen.UI.ScrollBarVisibility VerticalScrollBarVisibility { get; set; } +``` + +#### Property Value +[ScrollBarVisibility](Tizen.UI.ScrollBarVisibility.md 'Tizen.UI.ScrollBarVisibility') +### Methods + + + +## IScrollBar.OnAttachedToScrollable(IScrollable) Method + +Call when [IScrollable](Tizen.UI.IScrollable.md 'Tizen.UI.IScrollable') is attached to the ScrollBar. + +```csharp +void OnAttachedToScrollable(Tizen.UI.IScrollable scrollable); +``` +#### Parameters + + + +`scrollable` [IScrollable](Tizen.UI.IScrollable.md 'Tizen.UI.IScrollable') + +The scrollable. + + + +## IScrollBar.UpdateBarSize(Size, Size) Method + +Updates the size of the scroll bar based on the given scroll area and viewport size. + +```csharp +void UpdateBarSize(Tizen.UI.Size scrollArea, Tizen.UI.Size viewportSize); +``` +#### Parameters + + + +`scrollArea` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the scrollable area. + + + +`viewportSize` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the view port. + + + +## IScrollBar.UpdateScrollPosition(Point) Method + +Updates the scroll position of the scroll bar based on the given position. + +```csharp +void UpdateScrollPosition(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The new scroll position. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollable.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollable.md new file mode 100644 index 0000000000..57c2aaedfb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollable.md @@ -0,0 +1,235 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IScrollable Interface + +An interface describes the functionality of a scrollable component. + +```csharp +public interface IScrollable +``` +### Properties + + + +## IScrollable.CanScrollHorizontally Property + +Gets whether this view can scroll horizontally. + +```csharp +bool CanScrollHorizontally { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IScrollable.CanScrollVertically Property + +Gets whether this view can scroll vertically. + +```csharp +bool CanScrollVertically { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IScrollable.IsScrolledToEnd Property + +Gets a value indicating whether the scrollable content has reached the end position. + +```csharp +bool IsScrolledToEnd { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IScrollable.IsScrolledToStart Property + +Gets a value indicating whether the scrollable content has been scrolled to the start position. + +```csharp +bool IsScrolledToStart { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IScrollable.IsScrolling Property + +Gets a value indicating whether the scroll is currently in progress. + +```csharp +bool IsScrolling { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## IScrollable.ViewPort Property + +Gets the scroll bounds of the scrollable content. + +```csharp +Tizen.UI.Rect ViewPort { get; } +``` + +#### Property Value +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +### Methods + + + +## IScrollable.ScrollBy(float, float, bool) Method + +Scrolls the scrollable content by the specified offset in the x and y directions. + +```csharp +System.Threading.Tasks.Task ScrollBy(float dx, float dy, bool animated); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x distance offset of the content will be scrolled. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y distance offset of the content will be scrolled. + + + +`animated` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') + + + +## IScrollable.ScrollTo(float, float, bool) Method + +Scrolls the content to the specified position. + +```csharp +System.Threading.Tasks.Task ScrollTo(float x, float y, bool animation); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x position to which the content will be scrolled. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y position to which the content will be scrolled. + + + +`animation` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to play an animation while scrolling. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +A task that represents the asynchronous operation. +### Events + + + +## IScrollable.DragFinished Event + +Event that is triggered when the dragging of the scrollable content finished. + +```csharp +event EventHandler<DragEventArgs> DragFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[DragEventArgs](Tizen.UI.DragEventArgs.md 'Tizen.UI.DragEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## IScrollable.Dragging Event + +Event handler for the dragging state of the scrollable component. + +```csharp +event EventHandler<DragEventArgs> Dragging; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[DragEventArgs](Tizen.UI.DragEventArgs.md 'Tizen.UI.DragEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## IScrollable.DragStarted Event + +Event handler for the drag started event. + +```csharp +event EventHandler<DragEventArgs> DragStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[DragEventArgs](Tizen.UI.DragEventArgs.md 'Tizen.UI.DragEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## IScrollable.ScrollFinished Event + +Occurs when the scroll finishes. + +```csharp +event EventHandler<ScrollEventArgs> ScrollFinished; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[ScrollEventArgs](Tizen.UI.ScrollEventArgs.md 'Tizen.UI.ScrollEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## IScrollable.Scrolling Event + +Occurs while scrolling. + +```csharp +event EventHandler<ScrollEventArgs> Scrolling; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[ScrollEventArgs](Tizen.UI.ScrollEventArgs.md 'Tizen.UI.ScrollEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## IScrollable.ScrollStarted Event + +Occurs when the scroll starts. + +```csharp +event EventHandler<ScrollEventArgs> ScrollStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[ScrollEventArgs](Tizen.UI.ScrollEventArgs.md 'Tizen.UI.ScrollEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IText.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IText.md new file mode 100644 index 0000000000..a85601f659 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IText.md @@ -0,0 +1,72 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IText Interface + +The IText interface provides a common set of properties and methods for text-based objects. + +```csharp +public interface IText +``` + +Derived +↳ [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') +↳ [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') +### Properties + + + +## IText.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +string FontFamily { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IText.FontSize Property + +Gets or sets the font size of the text. + +```csharp +float FontSize { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## IText.Text Property + +Gets or sets the text content of the object. + +```csharp +string Text { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## IText.TextColor Property + +Gets or sets the color of the text. + +```csharp +Tizen.UI.Color TextColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextAlignment.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextAlignment.md new file mode 100644 index 0000000000..fdd5e39b5a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextAlignment.md @@ -0,0 +1,46 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ITextAlignment Interface + +The ITextAlignment interface provides functionality to be able to align Text. + +```csharp +public interface ITextAlignment +``` + +Derived +↳ [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') +↳ [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') +### Properties + + + +## ITextAlignment.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + + + +## ITextAlignment.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextEditable.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextEditable.md new file mode 100644 index 0000000000..9836daab99 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextEditable.md @@ -0,0 +1,72 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ITextEditable Interface + +The ITextEditable interface provides a common set of properties and methods for editable text-based objects. + +```csharp +public interface ITextEditable +``` + +Derived +↳ [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') +### Properties + + + +## ITextEditable.InputMethodContext Property + +Gets the input method context. + +```csharp +Tizen.UI.InputMethodContext InputMethodContext { get; } +``` + +#### Property Value +[InputMethodContext](Tizen.UI.InputMethodContext.md 'Tizen.UI.InputMethodContext') + + + +## ITextEditable.IsEditable Property + +Gets or sets a value indicating whether the text can be editable. + +```csharp +bool IsEditable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ITextEditable.PlaceholderText Property + +Gets or sets the placeholder text for the editable text. + +```csharp +string PlaceholderText { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Events + + + +## ITextEditable.TextChanged Event + +Occurs when the Text property changes. + +```csharp +event EventHandler TextChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextFormatting.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextFormatting.md new file mode 100644 index 0000000000..38fef550de --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextFormatting.md @@ -0,0 +1,45 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ITextFormatting Interface + +The ITextFormatting interface provides a method for setting the text formatting. + +```csharp +public interface ITextFormatting +``` + +Derived +↳ [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') +### Properties + + + +## ITextFormatting.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +bool IsMultiline { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ITextFormatting.TextOverflow Property + +Gets or sets whether the text should be ellipsized when it overflows its layout bounds. + +```csharp +Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +[TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextPadding.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextPadding.md new file mode 100644 index 0000000000..5738033a3a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextPadding.md @@ -0,0 +1,37 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ITextPadding Interface + +The ITextPadding interface provides a method for setting the text padding. + +```csharp +public interface ITextPadding +``` + +Derived +↳ [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') +↳ [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') +### Methods + + + +## ITextPadding.SetTextPadding(Thickness) Method + +Sets the text padding. + +```csharp +void SetTextPadding(Tizen.UI.Thickness padding); +``` +#### Parameters + + + +`padding` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The padding value. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IToken.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IToken.md new file mode 100644 index 0000000000..fed29fb6db --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IToken.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## IToken Interface + +Interface for token. + +```csharp +public interface IToken +``` + +Derived +↳ [Color](Tizen.UI.Color.md 'Tizen.UI.Color') +### Properties + + + +## IToken.Id Property + +The unique identifier of the token. + +```csharp +string Id { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITokenTable_T_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITokenTable_T_.md new file mode 100644 index 0000000000..ad1569b99a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITokenTable_T_.md @@ -0,0 +1,152 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ITokenTable<T> Interface + +The interface for a token table. + +```csharp +public interface ITokenTable<T> +``` +#### Type parameters + + + +`T` +### Methods + + + +## ITokenTable<T>.Bind(View, string, Action<object,T>, IToken) Method + +The method to bind target with token. +When table is updated, binded view will be updated. + +```csharp +void Bind(Tizen.UI.View target, string name, System.Action<object,T> setter, Tizen.UI.IToken token); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.ITokenTable_T_.md#Tizen.UI.ITokenTable_T_.T 'Tizen.UI.ITokenTable<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +`token` [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken') + + + +## ITokenTable<T>.TryGetToken(View, string, IToken) Method + +The method to get binded token to the view. + +```csharp +bool TryGetToken(Tizen.UI.View target, string propertyName, out Tizen.UI.IToken token); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The target view. + + + +`propertyName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The property name of the target view. + + + +`token` [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken') + +The binded token. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the token is found, otherwise false. + + + +## ITokenTable<T>.TryGetValue(string, T) Method + +The method to get the value from the resource table. + +```csharp +bool TryGetValue(string id, out T result); +``` +#### Parameters + + + +`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +`result` [T](Tizen.UI.ITokenTable_T_.md#Tizen.UI.ITokenTable_T_.T 'Tizen.UI.ITokenTable<T>.T') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ITokenTable<T>.Unbind(View, string) Method + +The method to unbind the binded token from the target. + +```csharp +void Unbind(Tizen.UI.View target, string name); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ITokenTable<T>.Update(IDictionary<string,T>) Method + +The method to update the resource table. + +```csharp +void Update(System.Collections.Generic.IDictionary<string,T> table); +``` +#### Parameters + + + +`table` [System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[T](Tizen.UI.ITokenTable_T_.md#Tizen.UI.ITokenTable_T_.T 'Tizen.UI.ITokenTable<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') +### Events + + + +## ITokenTable<T>.Updated Event + +The event which is invoked when the resource table is updated. + +```csharp +event EventHandler Updated; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackground.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackground.md new file mode 100644 index 0000000000..1e80ff7426 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackground.md @@ -0,0 +1,118 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageBackground Class + +ImageBackground is a visual representation of an image resource. + +```csharp +public class ImageBackground : Tizen.UI.Background +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Background](Tizen.UI.Background.md 'Tizen.UI.Background') 🡒 ImageBackground +### Properties + + + +## ImageBackground.PixelArea Property + +Gets or sets the image area to be displayed. +It is a rectangular area. +The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively. +If not specified, the default value is Rect (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image. +For normal quad images only. + +```csharp +public System.Nullable<Tizen.UI.Rect> PixelArea { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## ImageBackground.ReleasePolicy Property + +Gets or sets the release policy for the ImageBackground. + +```csharp +public System.Nullable<Tizen.UI.ImageReleasePolicy> ReleasePolicy { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[ImageReleasePolicy](Tizen.UI.ImageReleasePolicy.md 'Tizen.UI.ImageReleasePolicy')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## ImageBackground.SynchronousLoading Property + +Gets or sets whether the image should be loaded synchronously. + +```csharp +public System.Nullable<bool> SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## ImageBackground.Url Property + +The URL of the image resource. + +```csharp +public string Url { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageBackground.WrapModeU Property + +Gets or sets the horizontal wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeU { get; set; } +``` + +#### Property Value +[ImageWrapMode](Tizen.UI.ImageWrapMode.md 'Tizen.UI.ImageWrapMode') + + + +## ImageBackground.WrapModeV Property + +Gets or sets the vertical wrap mode of the image. + +```csharp +public Tizen.UI.ImageWrapMode WrapModeV { get; set; } +``` + +#### Property Value +[ImageWrapMode](Tizen.UI.ImageWrapMode.md 'Tizen.UI.ImageWrapMode') +### Methods + + + +## ImageBackground.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public override void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackgroundExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackgroundExtensions.md new file mode 100644 index 0000000000..f4de426bca --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackgroundExtensions.md @@ -0,0 +1,53 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageBackgroundExtensions Class + +Provides a series of extension methods that support configuring [ImageBackground](Tizen.UI.ImageBackground.md 'Tizen.UI.ImageBackground'). + +```csharp +public static class ImageBackgroundExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImageBackgroundExtensions +### Methods + + + +## ImageBackgroundExtensions.Url<TView>(this TView, string) Method + +Sets the URL of the image to display in the ImageBackground. + +```csharp +public static TView Url<TView>(this TView view, string url) + where TView : Tizen.UI.ImageBackground; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ImageBackgroundExtensions.md#Tizen.UI.ImageBackgroundExtensions.Url_TView_(thisTView,string).TView 'Tizen.UI.ImageBackgroundExtensions.Url<TView>(this TView, string).TView') + +The view to which the extension method is applied. + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the image to display. + +#### Returns +[TView](Tizen.UI.ImageBackgroundExtensions.md#Tizen.UI.ImageBackgroundExtensions.Url_TView_(thisTView,string).TView 'Tizen.UI.ImageBackgroundExtensions.Url<TView>(this TView, string).TView') +The view itself, to allow for method chaining. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageExtensions.md new file mode 100644 index 0000000000..ee1573f503 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageExtensions.md @@ -0,0 +1,281 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageExtensions Class + +Provides a series of extension methods that support configuring [IImage](Tizen.UI.IImage.md 'Tizen.UI.IImage'). + +```csharp +public static class ImageExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImageExtensions +### Methods + + + +## ImageExtensions.Border<TView>(this TView, Thickness) Method + +Sets the border of the image. + +```csharp +public static TView Border<TView>(this TView view, Tizen.UI.Thickness value) + where TView : Tizen.UI.IImage; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.Border_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.ImageExtensions.Border<TView>(this TView, Tizen.UI.Thickness).TView') + +The view instance. + + + +`value` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The border of image. + +#### Returns +[TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.Border_TView_(thisTView,Tizen.UI.Thickness).TView 'Tizen.UI.ImageExtensions.Border<TView>(this TView, Tizen.UI.Thickness).TView') +The view instance. + + + +## ImageExtensions.CropToMask<TView>(this TView, bool) Method + +Sets whether the image should be cropped to its mask + +```csharp +public static TView CropToMask<TView>(this TView view, bool value) + where TView : Tizen.UI.IImage; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.CropToMask_TView_(thisTView,bool).TView 'Tizen.UI.ImageExtensions.CropToMask<TView>(this TView, bool).TView') + +The view instance. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The value indicating whether the image should be cropped to its mask. + +#### Returns +[TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.CropToMask_TView_(thisTView,bool).TView 'Tizen.UI.ImageExtensions.CropToMask<TView>(this TView, bool).TView') +The view instance. + + + +## ImageExtensions.FittingMode<TView>(this TView, FittingMode) Method + +Sets the fitting mode used to scale the image to fit the control. + +```csharp +public static TView FittingMode<TView>(this TView view, Tizen.UI.FittingMode value) + where TView : Tizen.UI.IImage; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.FittingMode_TView_(thisTView,Tizen.UI.FittingMode).TView 'Tizen.UI.ImageExtensions.FittingMode<TView>(this TView, Tizen.UI.FittingMode).TView') + +The view instance. + + + +`value` [FittingMode](Tizen.UI.FittingMode.md 'Tizen.UI.FittingMode') + +The fitting mode. + +#### Returns +[TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.FittingMode_TView_(thisTView,Tizen.UI.FittingMode).TView 'Tizen.UI.ImageExtensions.FittingMode<TView>(this TView, Tizen.UI.FittingMode).TView') +The view instance. + + + +## ImageExtensions.ImagePadding<T>(this T, float) Method + +Sets the image padding for the given image view. + +```csharp +public static T ImagePadding<T>(this T view, float uniformSize) + where T : Tizen.UI.ImageView; +``` +#### Type parameters + + + +`T` + +The type of the image view. +#### Parameters + + + +`view` [T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,float).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, float).T') + +The image view to set the image padding for. + + + +`uniformSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform size of the image padding. + +#### Returns +[T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,float).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, float).T') +The image view itself. + + + +## ImageExtensions.ImagePadding<T>(this T, float, float, float, float) Method + +Sets the padding for the image within the image view. + +```csharp +public static T ImagePadding<T>(this T view, float left, float top, float right, float bottom) + where T : Tizen.UI.ImageView; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,float,float,float,float).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, float, float, float, float).T') + +The image view to set the image padding. + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The left padding in pixels. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top padding in pixels. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The right padding in pixels. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom padding in pixels. + +#### Returns +[T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,float,float,float,float).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, float, float, float, float).T') +The image view itself. + + + +## ImageExtensions.ImagePadding<T>(this T, Thickness) Method + +Sets the image padding for the given image view. + +```csharp +public static T ImagePadding<T>(this T view, Tizen.UI.Thickness padding) + where T : Tizen.UI.ImageView; +``` +#### Type parameters + + + +`T` + +The type of the image view. +#### Parameters + + + +`view` [T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,Tizen.UI.Thickness).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, Tizen.UI.Thickness).T') + +The image view to set the image padding. + + + +`padding` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The padding value to set. + +#### Returns +[T](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ImagePadding_T_(thisT,Tizen.UI.Thickness).T 'Tizen.UI.ImageExtensions.ImagePadding<T>(this T, Tizen.UI.Thickness).T') +The image view itself. + + + +## ImageExtensions.ResourceUrl<TView>(this TView, string) Method + +Sets the [ResourceUrl](Tizen.UI.ImageView.md#Tizen.UI.ImageView.ResourceUrl 'Tizen.UI.ImageView.ResourceUrl') property on an ImageView + +```csharp +public static TView ResourceUrl<TView>(this TView view, string resourceUrl) + where TView : Tizen.UI.IImage; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ResourceUrl_TView_(thisTView,string).TView 'Tizen.UI.ImageExtensions.ResourceUrl<TView>(this TView, string).TView') + +The view instance. + + + +`resourceUrl` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The resource URL to set. + +#### Returns +[TView](Tizen.UI.ImageExtensions.md#Tizen.UI.ImageExtensions.ResourceUrl_TView_(thisTView,string).TView 'Tizen.UI.ImageExtensions.ResourceUrl<TView>(this TView, string).TView') +The view instance with the specified resource URL. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoader.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoader.md new file mode 100644 index 0000000000..fc4264c66a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoader.md @@ -0,0 +1,130 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageLoader Class + +Provides a set of methods for loading images and getting their original sizes. + +```csharp +public static class ImageLoader +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImageLoader +### Methods + + + +## ImageLoader.GetOriginalImageSize(string, bool) Method + +Gets the original image size of the specified file. + +```csharp +public static Tizen.UI.Size GetOriginalImageSize(string filename, bool orientationCorretion=true); +``` +#### Parameters + + + +`filename` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path to the image file. + + + +`orientationCorretion` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether to correct the orientation based on Exif data. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The original image size as a Size struct. + + + +## ImageLoader.LoadImage(Stream) Method + +Loads an image from the specified stream into a PixelBuffer object. + +```csharp +public static Tizen.UI.PixelBuffer LoadImage(System.IO.Stream stream); +``` +#### Parameters + + + +`stream` [System.IO.Stream](https://docs.microsoft.com/en-us/dotnet/api/System.IO.Stream 'System.IO.Stream') + +The stream containing the image data. + +#### Returns +[PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') +A PixelBuffer object containing the image data. + + + +## ImageLoader.LoadImageFromFile(string) Method + +Loads an image from the file into a PixelBuffer object. + +```csharp +public static Tizen.UI.PixelBuffer LoadImageFromFile(string url); +``` +#### Parameters + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The image file url. + +#### Returns +[PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') + + + +## ImageLoader.LoadImageFromFile(string, Size, ImageLoaderFittingMode, ImageLoaderSamplingMode, bool) Method + +Loads an image from the file with specific size into a PixelBuffer object. + +```csharp +public static Tizen.UI.PixelBuffer LoadImageFromFile(string url, Tizen.UI.Size size, Tizen.UI.ImageLoaderFittingMode fittingMode, Tizen.UI.ImageLoaderSamplingMode samplingMode, bool orientationCorrection); +``` +#### Parameters + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The image file url. + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the image. + + + +`fittingMode` [ImageLoaderFittingMode](Tizen.UI.ImageLoaderFittingMode.md 'Tizen.UI.ImageLoaderFittingMode') + +The fitting mode of image. + + + +`samplingMode` [ImageLoaderSamplingMode](Tizen.UI.ImageLoaderSamplingMode.md 'Tizen.UI.ImageLoaderSamplingMode') + +The sampling mode of image. + + + +`orientationCorrection` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether to correct the image orientation + +#### Returns +[PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderFittingMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderFittingMode.md new file mode 100644 index 0000000000..c2d87d1316 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderFittingMode.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageLoaderFittingMode Enum + +Enumeration for [ImageLoader](Tizen.UI.ImageLoader.md 'Tizen.UI.ImageLoader') fitting mode. + +```csharp +public enum ImageLoaderFittingMode +``` +### Fields + + + +`Center` 4 + +Image displayed in its original size (no scaling) using the Center mode. + + + +`Fill` 5 + +Image stretched to fill the desired area (aspect ratio could be changed) using the Fill mode. + + + +`FitHeight` 3 + +Image fills whole height. Width is scaled proportionately to maintain aspect ratio. + + + +`FitWidth` 2 + +Image fills whole width. Height is scaled proportionately to maintain aspect ratio. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderSamplingMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderSamplingMode.md new file mode 100644 index 0000000000..4f3ddaf78c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderSamplingMode.md @@ -0,0 +1,60 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageLoaderSamplingMode Enum + +Enumeration for [ImageLoader](Tizen.UI.ImageLoader.md 'Tizen.UI.ImageLoader') sampling mode. + +```csharp +public enum ImageLoaderSamplingMode +``` +### Fields + + + +`Box` 0 + +Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size.
+This is the default. + + + +`BoxThenLinear` 4 + +Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average. + + + +`BoxThenNearest` 3 + +Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size,
+then for each output pixel, read one pixel from the last level of box filtering.
+ + + +`DontCare` 6 + +For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image. + + + +`Linear` 2 + +For each output pixel, read a quad of four input pixels and write a weighted average of them. + + + +`Nearest` 1 + +For each output pixel, read one input pixel. + + + +`NoFilter` 5 + +No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoadingStatus.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoadingStatus.md new file mode 100644 index 0000000000..47a2228bc7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoadingStatus.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageLoadingStatus Enum + +Enumeration for the image loading status. + +```csharp +public enum ImageLoadingStatus +``` +### Fields + + + +`Failed` 2 + +Loading failed status. + + + +`Preparing` 0 + +Loading preparing status. + + + +`Ready` 1 + +Loading ready status. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageMaskingMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageMaskingMode.md new file mode 100644 index 0000000000..71ce2be1be --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageMaskingMode.md @@ -0,0 +1,26 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageMaskingMode Enum + +```csharp +public enum ImageMaskingMode +``` +### Fields + + + +`Loading` 1 + +Applies alpha masking on loading time. (CPU) + + + +`Rendering` 0 + +Applies alpha masking on rendering time. (GPU) + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageReleasePolicy.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageReleasePolicy.md new file mode 100644 index 0000000000..148ee6a4a0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageReleasePolicy.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageReleasePolicy Enum + +Enumeration for ImageReleasePolicy. + +```csharp +public enum ImageReleasePolicy +``` +### Fields + + + +`Destroyed` 1 + +The image is released when the view is destroyed. + + + +`Detached` 0 + +The image is released when the view is detached from the window. + + + +`Never` 2 + +The image is never released. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageUrl.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageUrl.md new file mode 100644 index 0000000000..25b005bdb6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageUrl.md @@ -0,0 +1,56 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageUrl Class + +The ImageUrl class represents an internally loaded image resource by its URI. + +```csharp +public class ImageUrl : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 ImageUrl +### Constructors + + + +## ImageUrl(IntPtr, bool) Constructor + +Initializes a new instance of the ImageUrl class with the specified handle to the native image URL object. + +```csharp +public ImageUrl(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle to the native image URL object. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the new instance owns the handle. +### Methods + + + +## ImageUrl.ToString() Method + +Gets the URL of the image. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The URL of the image. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageView.md new file mode 100644 index 0000000000..7147ab08d8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageView.md @@ -0,0 +1,311 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageView Class + +ImageView is a control for displaying an image resource. + +```csharp +public class ImageView : Tizen.UI.View, +Tizen.UI.IImage, +Tizen.UI.Internal.IResourceReadySignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 ImageView + +Derived +↳ [LottieAnimationView](Tizen.UI.LottieAnimationView.md 'Tizen.UI.LottieAnimationView') + +Implements [IImage](Tizen.UI.IImage.md 'Tizen.UI.IImage'), Tizen.UI.Internal.IResourceReadySignalHandle +### Constructors + + + +## ImageView() Constructor + +Creates an instance of an ImageView. + +```csharp +public ImageView(); +``` +### Properties + + + +## ImageView.AlphaMaskUrl Property + +Gets or sets the URL of the alpha mask image to apply to the image. + +```csharp +public string AlphaMaskUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageView.Border Property + +Gets or sets the border of the image. + +```csharp +public Tizen.UI.Thickness Border { get; set; } +``` + +Implements [Border](Tizen.UI.IImage.md#Tizen.UI.IImage.Border 'Tizen.UI.IImage.Border') + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## ImageView.CropToMask Property + +Gets or sets whether the image should be cropped to its mask. + +```csharp +public bool CropToMask { get; set; } +``` + +Implements [CropToMask](Tizen.UI.IImage.md#Tizen.UI.IImage.CropToMask 'Tizen.UI.IImage.CropToMask') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageView.FittingMode Property + +Gets or sets the fitting mode used to scale the image to fit the control. + +```csharp +public Tizen.UI.FittingMode FittingMode { get; set; } +``` + +Implements [FittingMode](Tizen.UI.IImage.md#Tizen.UI.IImage.FittingMode 'Tizen.UI.IImage.FittingMode') + +#### Property Value +[FittingMode](Tizen.UI.FittingMode.md 'Tizen.UI.FittingMode') + + + +## ImageView.ImageMultipliedColor Property + +Gets or sets the color of the view, which is multiplied by the image view's alpha value. + +```csharp +public Tizen.UI.Color ImageMultipliedColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## ImageView.IsNinePatchImage Property + +Gets or sets whether the image is a nine-patch image. + +```csharp +public bool IsNinePatchImage { get; set; } +``` + +Implements [IsNinePatchImage](Tizen.UI.IImage.md#Tizen.UI.IImage.IsNinePatchImage 'Tizen.UI.IImage.IsNinePatchImage') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageView.IsResourceReady Property + +Gets a value indicating whether the image is ready to be displayed. + +```csharp +public bool IsResourceReady { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageView.LoadingPlaceholderUrl Property + +The LoadingPlaceholderUrl property specifies the URL of the image to display while the main image is being loaded. + +```csharp +public string LoadingPlaceholderUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageView.LoadingStatus Property + +Gets the loading status of the image. + +```csharp +public Tizen.UI.ImageLoadingStatus LoadingStatus { get; } +``` + +#### Property Value +[ImageLoadingStatus](Tizen.UI.ImageLoadingStatus.md 'Tizen.UI.ImageLoadingStatus') + + + +## ImageView.PreMultipliedAlpha Property + +Gets or sets whether the image should be pre-multiplied by its alpha channel. + +```csharp +public bool PreMultipliedAlpha { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageView.ResourceUrl Property + +Gets or sets the URL of the image to display. + +```csharp +public virtual string ResourceUrl { get; set; } +``` + +Implements [ResourceUrl](Tizen.UI.IImage.md#Tizen.UI.IImage.ResourceUrl 'Tizen.UI.IImage.ResourceUrl') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageView.SynchronousLoading Property + +Gets or sets whether the image should be loaded synchronously. + +```csharp +public bool SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## ImageView.Measure(float, float) Method + +Measures the view based on the available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The measured size of the view. + + + +## ImageView.Pause() Method + +Pauses the animated image. + +```csharp +public virtual void Pause(); +``` + + + +## ImageView.Play() Method + +Plays the animated image. + +```csharp +public virtual void Play(); +``` + + + +## ImageView.Reload() Method + +Reloads the image. + +```csharp +public virtual void Reload(); +``` + + + +## ImageView.SetImagePadding(Thickness) Method + +Sets the padding for the image. + +```csharp +public void SetImagePadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The thickness of the padding. + + + +## ImageView.Stop() Method + +Stops the animated image. + +```csharp +public virtual void Stop(); +``` + + + +## ImageView.Update() Method + +The Update method updates the image map and clears the need update map. + +```csharp +public void Update(); +``` +### Events + + + +## ImageView.ResourcesLoaded Event + +Occurs when the resources of the view are loaded. + +```csharp +public event EventHandler ResourcesLoaded; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageViewBindings.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageViewBindings.md new file mode 100644 index 0000000000..d5c7a69696 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageViewBindings.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageViewBindings Class + +Provides a set of static properties that represent the bindable properties of the [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') class. + +```csharp +public static class ImageViewBindings +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImageViewBindings +### Properties + + + +## ImageViewBindings.ImageMultipliedColorProperty Property + +Represents the bindable property for the [Image.MultipliedColor](https://docs.microsoft.com/en-us/dotnet/api/Image.MultipliedColor 'Image.MultipliedColor') property. + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.ImageView,Tizen.UI.Color> ImageMultipliedColorProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## ImageViewBindings.ResourceUrlProperty Property + +Represents the bindable property for the [ResourceUrl](Tizen.UI.ImageView.md#Tizen.UI.ImageView.ResourceUrl 'Tizen.UI.ImageView.ResourceUrl') property. + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.ImageView,string> ResourceUrlProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageWrapMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageWrapMode.md new file mode 100644 index 0000000000..620ceee2a7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageWrapMode.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ImageWrapMode Enum + +Enumeration for image wrap mode. + +```csharp +public enum ImageWrapMode +``` +### Fields + + + +`ClampToEdge` 1 + +Clamps the image to the edge. + + + +`Default` 0 + +The default wrap mode. + + + +`MirroredRepeat` 3 + +Mirrored repeats the image. + + + +`Repeat` 2 + +Repeats the image. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadow.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadow.md new file mode 100644 index 0000000000..2a417bd993 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadow.md @@ -0,0 +1,53 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InnerShadow Struct + +The InnerShadow struct represents a inner shadow effect applied to a view. + +```csharp +public struct InnerShadow +``` +### Properties + + + +## InnerShadow.BlurRadius Property + +Gets or sets the blur radius of the shadow. + +```csharp +public float BlurRadius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InnerShadow.Color Property + +Gets or sets the color of + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## InnerShadow.Inset Property + +Gets or sets the inset for the inner shadow + +```csharp +public Tizen.UI.Thickness Inset { get; set; } +``` + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md new file mode 100644 index 0000000000..0692eccaac --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md @@ -0,0 +1,70 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InnerShadowTokenPropertyChangedEventArgs Class + +Provides data for inner shadow token property changed events. + +```csharp +public class InnerShadowTokenPropertyChangedEventArgs : Tizen.UI.ColorTokenPropertyChangedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') 🡒 [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') 🡒 InnerShadowTokenPropertyChangedEventArgs + +### Remarks +Extends [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') with inner shadow information. +Uses singleton pattern for event argument instances. +### Properties + + + +## InnerShadowTokenPropertyChangedEventArgs.Shadow Property + +Gets or sets the inner shadow value of the changed property. + +```csharp +public Tizen.UI.InnerShadow Shadow { get; set; } +``` + +#### Property Value +[InnerShadow](Tizen.UI.InnerShadow.md 'Tizen.UI.InnerShadow') +The new inner shadow value. +### Methods + + + +## InnerShadowTokenPropertyChangedEventArgs.Create(View, string, InnerShadow) Method + +Creates a new instance of [InnerShadowTokenPropertyChangedEventArgs](Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.InnerShadowTokenPropertyChangedEventArgs'). + +```csharp +public static Tizen.UI.InnerShadowTokenPropertyChangedEventArgs Create(Tizen.UI.View view, string name, Tizen.UI.InnerShadow shadow); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view associated with the property change. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the changed property. + + + +`shadow` [InnerShadow](Tizen.UI.InnerShadow.md 'Tizen.UI.InnerShadow') + +The new inner shadow value. + +#### Returns +[InnerShadowTokenPropertyChangedEventArgs](Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.InnerShadowTokenPropertyChangedEventArgs') +An initialized [InnerShadowTokenPropertyChangedEventArgs](Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.InnerShadowTokenPropertyChangedEventArgs') instance. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodContext.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodContext.md new file mode 100644 index 0000000000..f5f4521d4b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodContext.md @@ -0,0 +1,233 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputMethodContext Class + +The InputMethodContext class provides functions to control the input method framework. + +```csharp +public class InputMethodContext : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 InputMethodContext +### Properties + + + +## InputMethodContext.InputMethodArea Property + +Gets the input method area. + +```csharp +public Tizen.UI.Rect InputMethodArea { get; } +``` + +#### Property Value +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + + + +## InputMethodContext.InputPanelState Property + +Gets the current input panel state. + +```csharp +public Tizen.UI.InputPanelState InputPanelState { get; } +``` + +#### Property Value +[InputPanelState](Tizen.UI.InputPanelState.md 'Tizen.UI.InputPanelState') + + + +## InputMethodContext.TextPrediction Property + +Gets or sets whether text prediction is allowed. + +```csharp +public bool TextPrediction { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## InputMethodContext.Activate() Method + +Activates the input method context. + +```csharp +public void Activate(); +``` + + + +## InputMethodContext.AutoEnableInputPanel(bool) Method + +Sets whether the input panel is automatically enabled. + +```csharp +public void AutoEnableInputPanel(bool enabled); +``` +#### Parameters + + + +`enabled` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to enable the input panel automatically, false otherwise. + + + +## InputMethodContext.Deactivate() Method + +Deactivates the input method context. + +```csharp +public void Deactivate(); +``` + + + +## InputMethodContext.HideInputPanel() Method + +Hides the input panel. + +```csharp +public void HideInputPanel(); +``` + + + +## InputMethodContext.NotifyTextInputMultiLine(bool) Method + +Notifies whether the text input is multi-line. + +```csharp +public void NotifyTextInputMultiLine(bool multiLine); +``` +#### Parameters + + + +`multiLine` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the text input is multi-line, false otherwise. + + + +## InputMethodContext.SetInputPanelLanguage(InputPanelLanguage) Method + +Sets the language of the input panel. + +```csharp +public void SetInputPanelLanguage(Tizen.UI.InputPanelLanguage language); +``` +#### Parameters + + + +`language` [InputPanelLanguage](Tizen.UI.InputPanelLanguage.md 'Tizen.UI.InputPanelLanguage') + +The language to be set to the input panel + + + +## InputMethodContext.SetInputPanelPosition(uint, uint) Method + +Sets the input panel position. + +```csharp +public void SetInputPanelPosition(uint x, uint y); +``` +#### Parameters + + + +`x` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The x coordinate of the input panel. + + + +`y` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The y coordinate of the input panel. + + + +## InputMethodContext.SetInputPanelUserData(string) Method + +Sets the input panel user data. + +```csharp +public void SetInputPanelUserData(string text); +``` +#### Parameters + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to set. + + + +## InputMethodContext.SetReturnKeyState(bool) Method + +Sets the return key state. + +```csharp +public void SetReturnKeyState(bool visible); +``` +#### Parameters + + + +`visible` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to show the return key, false otherwise. + + + +## InputMethodContext.ShowInputPanel() Method + +Shows the input panel. + +```csharp +public void ShowInputPanel(); +``` +### Events + + + +## InputMethodContext.InputPanelStateChanged Event + +Occurs when the input panel state is changed. + +```csharp +public event EventHandler InputPanelStateChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputMethodContext.Resized Event + +Occurs when the keyboard is resized. + +```csharp +public event EventHandler Resized; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodSetting.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodSetting.md new file mode 100644 index 0000000000..0a81b4d988 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodSetting.md @@ -0,0 +1,53 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputMethodSetting Struct + +The InputMethodSetting struct is used to set the input method settings for a text input control. + +```csharp +public struct InputMethodSetting +``` +### Properties + + + +## InputMethodSetting.ActionButton Property + +Gets or sets the action button title for the text input control. + +```csharp +public System.Nullable<Tizen.UI.ActionButtonTitle> ActionButton { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[ActionButtonTitle](Tizen.UI.ActionButtonTitle.md 'Tizen.UI.ActionButtonTitle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputMethodSetting.AutoCapital Property + +Gets or sets the auto-capitalization mode for the text input control. + +```csharp +public System.Nullable<Tizen.UI.AutoCapital> AutoCapital { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[AutoCapital](Tizen.UI.AutoCapital.md 'Tizen.UI.AutoCapital')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## InputMethodSetting.PanelLayout Property + +Gets or sets the panel layout for the text input control. + +```csharp +public System.Nullable<Tizen.UI.PanelLayout> PanelLayout { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[PanelLayout](Tizen.UI.PanelLayout.md 'Tizen.UI.PanelLayout')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelLanguage.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelLanguage.md new file mode 100644 index 0000000000..52120c86cf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelLanguage.md @@ -0,0 +1,29 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputPanelLanguage Enum + +Enumeration for the language mode of the input panel. + +```csharp +public enum InputPanelLanguage +``` +### Fields + + + +`Alphabet` 1 + +Latin alphabet. (default) +This value can be changed according to OSD(On Screen Display) language. + + + +`Automatic` 0 + +IME Language is automatically set depending on the system display. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelState.md new file mode 100644 index 0000000000..b1ea961695 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelState.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputPanelState Enum + +Enumeration for the states of the input panel. + +```csharp +public enum InputPanelState +``` +### Fields + + + +`Default` 0 + +Unknown state. + + + +`Hide` 2 + +Input panel is hidden. + + + +`Show` 1 + +Input panel is shown. + + + +`WillShow` 3 + +Input panel is in the process of being shown. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputView.md new file mode 100644 index 0000000000..4f9d8e5f7e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputView.md @@ -0,0 +1,357 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputView Class + +InputView is a base class for text input controls. It provides common properties and events for text input controls. + +```csharp +public abstract class InputView : Tizen.UI.View, +Tizen.UI.IText, +Tizen.UI.ITextPadding, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextEditable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 InputView + +Derived +↳ [TextEditor](Tizen.UI.TextEditor.md 'Tizen.UI.TextEditor') +↳ [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') + +Implements [IText](Tizen.UI.IText.md 'Tizen.UI.IText'), [ITextPadding](Tizen.UI.ITextPadding.md 'Tizen.UI.ITextPadding'), [ITextAlignment](Tizen.UI.ITextAlignment.md 'Tizen.UI.ITextAlignment'), [ITextEditable](Tizen.UI.ITextEditable.md 'Tizen.UI.ITextEditable') +### Properties + + + +## InputView.CursorWidth Property + +Gets or sets the width of the cursor. + +```csharp +public int CursorWidth { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputView.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements [FontFamily](Tizen.UI.IText.md#Tizen.UI.IText.FontFamily 'Tizen.UI.IText.FontFamily') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputView.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements [FontSize](Tizen.UI.IText.md#Tizen.UI.IText.FontSize 'Tizen.UI.IText.FontSize') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputView.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements [HorizontalAlignment](Tizen.UI.ITextAlignment.md#Tizen.UI.ITextAlignment.HorizontalAlignment 'Tizen.UI.ITextAlignment.HorizontalAlignment') + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + + + +## InputView.InputMethodContext Property + +Gets the InputMethodContext object associated with the InputView. + +```csharp +public Tizen.UI.InputMethodContext InputMethodContext { get; } +``` + +Implements [InputMethodContext](Tizen.UI.ITextEditable.md#Tizen.UI.ITextEditable.InputMethodContext 'Tizen.UI.ITextEditable.InputMethodContext') + +#### Property Value +[InputMethodContext](Tizen.UI.InputMethodContext.md 'Tizen.UI.InputMethodContext') + + + +## InputView.IsMarkupEnabled Property + +Gets or sets a value indicating whether the input view enables markup. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputView.IsReadOnly Property + +Gets or sets a value indicating whether the input view is read-only. + +```csharp +public bool IsReadOnly { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputView.MaxLength Property + +Gets or sets the maximum length of the text input. + +```csharp +public int MaxLength { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputView.PlaceholderText Property + +Gets or sets the placeholder text of the input view. + +```csharp +public string PlaceholderText { get; set; } +``` + +Implements [PlaceholderText](Tizen.UI.ITextEditable.md#Tizen.UI.ITextEditable.PlaceholderText 'Tizen.UI.ITextEditable.PlaceholderText') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputView.PlaceholderTextColor Property + +Gets or sets the color of the placeholder text. + +```csharp +public Tizen.UI.Color PlaceholderTextColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## InputView.PrimaryCursorColor Property + +Gets or sets the color of the primary cursor. + +```csharp +public Tizen.UI.Color PrimaryCursorColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## InputView.PrimaryCursorPosition Property + +Gets or sets the position of the primary cursor. + +```csharp +public int PrimaryCursorPosition { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## InputView.ScaledFontSize Property + +Gets the scaled font size of the text. + +```csharp +public float ScaledFontSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## InputView.SystemFontScaleEnabled Property + +Gets or sets a value indicating whether the system font scale is enabled. + +```csharp +public bool SystemFontScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## InputView.Text Property + +Gets or sets the text of the input view. + +```csharp +public string Text { get; set; } +``` + +Implements [Text](Tizen.UI.IText.md#Tizen.UI.IText.Text 'Tizen.UI.IText.Text') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## InputView.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements [TextColor](Tizen.UI.IText.md#Tizen.UI.IText.TextColor 'Tizen.UI.IText.TextColor') + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## InputView.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements [VerticalAlignment](Tizen.UI.ITextAlignment.md#Tizen.UI.ITextAlignment.VerticalAlignment 'Tizen.UI.ITextAlignment.VerticalAlignment') + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') +### Methods + + + +## InputView.SetInputMethodSetting(InputMethodSetting) Method + +Sets the input method settings of the input view. + +```csharp +public abstract void SetInputMethodSetting(Tizen.UI.InputMethodSetting inputMethod); +``` +#### Parameters + + + +`inputMethod` [InputMethodSetting](Tizen.UI.InputMethodSetting.md 'Tizen.UI.InputMethodSetting') + +The input method settings. + + + +## InputView.SetTextPadding(Thickness) Method + +Sets the padding of the text. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The padding thickness. + +Implements [SetTextPadding(Thickness)](Tizen.UI.ITextPadding.md#Tizen.UI.ITextPadding.SetTextPadding(Tizen.UI.Thickness) 'Tizen.UI.ITextPadding.SetTextPadding(Tizen.UI.Thickness)') +### Events + + + +## InputView.AnchorClicked Event + +Occurs when the the anchor is clicked. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[AnchorClickedEventArgs](Tizen.UI.AnchorClickedEventArgs.md 'Tizen.UI.AnchorClickedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## InputView.MaxLengthReached Event + +Occurs when the maximum length of the text input is reached. + +```csharp +public event EventHandler MaxLengthReached; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## InputView.TextChanged Event + +Occurs when the Text property changes. + +```csharp +public event EventHandler TextChanged; +``` + +Implements [TextChanged](Tizen.UI.ITextEditable.md#Tizen.UI.ITextEditable.TextChanged 'Tizen.UI.ITextEditable.TextChanged') + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') +### Explicit Interface Implementations + + + +## InputView.Tizen.UI.ITextEditable.IsEditable Property + +Gets or sets a value indicating whether the text can be editable. + +```csharp +bool Tizen.UI.ITextEditable.IsEditable { get; set; } +``` + +Implements [IsEditable](Tizen.UI.ITextEditable.md#Tizen.UI.ITextEditable.IsEditable 'Tizen.UI.ITextEditable.IsEditable') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputViewExtensions.md new file mode 100644 index 0000000000..69945ca728 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputViewExtensions.md @@ -0,0 +1,542 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## InputViewExtensions Class + +Provides a set of extension methods for the InputView class. + +```csharp +public static class InputViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 InputViewExtensions +### Methods + + + +## InputViewExtensions.CursorWidth<TView>(this TView, int) Method + +Sets the cursor width of the InputView. + +```csharp +public static TView CursorWidth<TView>(this TView view, int width) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.CursorWidth_TView_(thisTView,int).TView 'Tizen.UI.InputViewExtensions.CursorWidth<TView>(this TView, int).TView') + +The InputView instance. + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The cursor width to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.CursorWidth_TView_(thisTView,int).TView 'Tizen.UI.InputViewExtensions.CursorWidth<TView>(this TView, int).TView') +The InputView instance with the cursor width set. + + + +## InputViewExtensions.FontFamily<TView>(this TView, string) Method + +Sets the font family of the InputView. + +```csharp +public static TView FontFamily<TView>(this TView view, string fontFamily) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.FontFamily_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.FontFamily<TView>(this TView, string).TView') + +The InputView instance. + + + +`fontFamily` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The font family to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.FontFamily_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.FontFamily<TView>(this TView, string).TView') +The InputView instance with the font family set. + + + +## InputViewExtensions.FontSize<TView>(this TView, float) Method + +Sets the font size of the InputView. + +```csharp +public static TView FontSize<TView>(this TView view, float fontSize) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.FontSize_TView_(thisTView,float).TView 'Tizen.UI.InputViewExtensions.FontSize<TView>(this TView, float).TView') + +The InputView instance. + + + +`fontSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The font size to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.FontSize_TView_(thisTView,float).TView 'Tizen.UI.InputViewExtensions.FontSize<TView>(this TView, float).TView') +The InputView instance with the font size set. + + + +## InputViewExtensions.HorizontalAlignment<TView>(this TView, TextAlignment) Method + +Sets the horizontal alignment of the text in the InputView. + +```csharp +public static TView HorizontalAlignment<TView>(this TView view, Tizen.UI.TextAlignment alignment) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.HorizontalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.InputViewExtensions.HorizontalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') + +The InputView instance. + + + +`alignment` [TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + +The horizontal alignment to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.HorizontalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.InputViewExtensions.HorizontalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') +The InputView instance with the horizontal alignment set. + + + +## InputViewExtensions.IsMarkupEnabled<TView>(this TView, bool) Method + +Sets whether markup is enabled in the InputView. + +```csharp +public static TView IsMarkupEnabled<TView>(this TView view, bool enable) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.IsMarkupEnabled_TView_(thisTView,bool).TView 'Tizen.UI.InputViewExtensions.IsMarkupEnabled<TView>(this TView, bool).TView') + +The InputView instance. + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to enable markup, false otherwise. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.IsMarkupEnabled_TView_(thisTView,bool).TView 'Tizen.UI.InputViewExtensions.IsMarkupEnabled<TView>(this TView, bool).TView') +The InputView instance with markup enabled or disabled. + + + +## InputViewExtensions.IsReadOnly<TView>(this TView, bool) Method + +Sets whether the InputView is read-only. + +```csharp +public static TView IsReadOnly<TView>(this TView view, bool isReadOnly) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.IsReadOnly_TView_(thisTView,bool).TView 'Tizen.UI.InputViewExtensions.IsReadOnly<TView>(this TView, bool).TView') + +The InputView instance. + + + +`isReadOnly` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the InputView is read-only, false otherwise. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.IsReadOnly_TView_(thisTView,bool).TView 'Tizen.UI.InputViewExtensions.IsReadOnly<TView>(this TView, bool).TView') +The InputView instance with read-only mode enabled or disabled. + + + +## InputViewExtensions.MaxLength<TView>(this TView, int) Method + +Sets the maximum length of the text in the InputView. + +```csharp +public static TView MaxLength<TView>(this TView view, int length) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.MaxLength_TView_(thisTView,int).TView 'Tizen.UI.InputViewExtensions.MaxLength<TView>(this TView, int).TView') + +The InputView instance. + + + +`length` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The maximum length to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.MaxLength_TView_(thisTView,int).TView 'Tizen.UI.InputViewExtensions.MaxLength<TView>(this TView, int).TView') +The InputView instance with the maximum length set. + + + +## InputViewExtensions.PlaceholderText<TView>(this TView, string) Method + +Sets the placeholder text of the InputView. + +```csharp +public static TView PlaceholderText<TView>(this TView view, string text) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderText_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.PlaceholderText<TView>(this TView, string).TView') + +The InputView instance. + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The placeholder text to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderText_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.PlaceholderText<TView>(this TView, string).TView') +The InputView instance with the placeholder text set. + + + +## InputViewExtensions.PlaceholderTextColor<TView>(this TView, Color) Method + +Sets the placeholder text color of the InputView. + +```csharp +public static TView PlaceholderTextColor<TView>(this TView view, Tizen.UI.Color color) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderTextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.PlaceholderTextColor<TView>(this TView, Tizen.UI.Color).TView') + +The InputView instance. + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The placeholder text color to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderTextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.PlaceholderTextColor<TView>(this TView, Tizen.UI.Color).TView') +The InputView instance with the placeholder text color set. + + + +## InputViewExtensions.PlaceholderTextColorFromHex<TView>(this TView, string) Method + +Sets the placeholder text color of the InputView using a hexadecimal color string. + +```csharp +public static TView PlaceholderTextColorFromHex<TView>(this TView view, string color) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderTextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.PlaceholderTextColorFromHex<TView>(this TView, string).TView') + +The InputView instance. + + + +`color` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The placeholder text color to set in hexadecimal format. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PlaceholderTextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.PlaceholderTextColorFromHex<TView>(this TView, string).TView') +The InputView instance with the placeholder text color set. + + + +## InputViewExtensions.PrimaryCursorColor<TView>(this TView, Color) Method + +Sets the primary cursor color of the InputView. + +```csharp +public static TView PrimaryCursorColor<TView>(this TView view, Tizen.UI.Color color) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PrimaryCursorColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.PrimaryCursorColor<TView>(this TView, Tizen.UI.Color).TView') + +The InputView instance. + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The primary cursor color to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.PrimaryCursorColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.PrimaryCursorColor<TView>(this TView, Tizen.UI.Color).TView') +The InputView instance with the primary cursor color set. + + + +## InputViewExtensions.Text<TView>(this TView, string) Method + +Sets the text of the InputView. + +```csharp +public static TView Text<TView>(this TView view, string text) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.Text_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.Text<TView>(this TView, string).TView') + +The InputView instance. + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.Text_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.Text<TView>(this TView, string).TView') +The InputView instance with the text set. + + + +## InputViewExtensions.TextColor<TView>(this TView, Color) Method + +Sets the text color of the InputView. + +```csharp +public static TView TextColor<TView>(this TView view, Tizen.UI.Color textColor) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.TextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.TextColor<TView>(this TView, Tizen.UI.Color).TView') + +The InputView instance. + + + +`textColor` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The text color to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.TextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.InputViewExtensions.TextColor<TView>(this TView, Tizen.UI.Color).TView') +The InputView instance with the text color set. + + + +## InputViewExtensions.TextColorFromHex<TView>(this TView, string) Method + +Sets the text color of the InputView using a hexadecimal color string. + +```csharp +public static TView TextColorFromHex<TView>(this TView view, string textColor) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.TextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.TextColorFromHex<TView>(this TView, string).TView') + +The InputView instance. + + + +`textColor` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text color to set in hexadecimal format. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.TextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.InputViewExtensions.TextColorFromHex<TView>(this TView, string).TView') +The InputView instance with the text color set. + + + +## InputViewExtensions.VerticalAlignment<TView>(this TView, TextAlignment) Method + +Sets the vertical alignment of the text in the InputView. + +```csharp +public static TView VerticalAlignment<TView>(this TView view, Tizen.UI.TextAlignment alignment) + where TView : Tizen.UI.InputView; +``` +#### Type parameters + + + +`TView` + +The type of the InputView. +#### Parameters + + + +`view` [TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.VerticalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.InputViewExtensions.VerticalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') + +The InputView instance. + + + +`alignment` [TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + +The vertical alignment to set. + +#### Returns +[TView](Tizen.UI.InputViewExtensions.md#Tizen.UI.InputViewExtensions.VerticalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.InputViewExtensions.VerticalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') +The InputView instance with the vertical alignment set. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendEquationType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendEquationType.md new file mode 100644 index 0000000000..23c8a55113 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendEquationType.md @@ -0,0 +1,44 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## BlendEquationType Enum + +Enumeration for blend equation. + +```csharp +public enum BlendEquationType +``` +### Fields + + + +`Add` 32774 + +The source and destination colors are added to each other. + + + +`Max` 32776 + +Use maximum value of the source and the destination. + + + +`Min` 32775 + +Use minimum value of the source and the destination. + + + +`ReverseSubtract` 32779 + +Subtracts the source from the destination. + + + +`Subtract` 32778 + +Subtracts the destination from the source. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendFactorType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendFactorType.md new file mode 100644 index 0000000000..9d072627dc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendFactorType.md @@ -0,0 +1,104 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## BlendFactorType Enum + +Enumeration for blend factor. + +```csharp +public enum BlendFactorType +``` +### Fields + + + +`ConstantAlpha` 32771 + +Match as GL_CONSTANT_ALPHA + + + +`ConstantColor` 32769 + +Match as GL_CONSTANT_COLOR + + + +`DstAlpha` 772 + +Match as GL_DST_ALPHA + + + +`DstColor` 774 + +Match as GL_DST_COLOR + + + +`One` 1 + +Match as GL_ONE + + + +`OneMinusConstantAlpha` 32772 + +Match as GL_ONE_MINUS_CONSTANT_ALPHA + + + +`OneMinusConstantColor` 32770 + +Match as GL_ONE_MINUS_CONSTANT_COLOR + + + +`OneMinusDstAlpha` 773 + +Match as GL_ONE_MINUS_DST_ALPHA + + + +`OneMinusDstColor` 775 + +Match as GL_ONE_MINUS_DST_COLOR + + + +`OneMinusSrcAlpha` 771 + +Match as GL_ONE_MINUS_SRC_ALPHA + + + +`OneMinusSrcColor` 769 + +Match as GL_ONE_MINUS_SRC_COLOR + + + +`SrcAlpha` 770 + +Match as GL_SRC_ALPHA + + + +`SrcAlphaSaturate` 776 + +Match as GL_SRC_ALPHA_SATURATE + + + +`SrcColor` 768 + +Match as GL_SRC_COLOR + + + +`Zero` 0 + +Match as GL_ZERO + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendModeType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendModeType.md new file mode 100644 index 0000000000..3eaf7650be --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendModeType.md @@ -0,0 +1,44 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## BlendModeType Enum + +Enumeration for blend mode. + +```csharp +public enum BlendModeType +``` +### Fields + + + +`Auto` 1 + +Blending is enabled if there is alpha channel. This is the default mode. + + + +`Off` 0 + +Blending is disabled. + + + +`On` 2 + +Blending is enabled. + + + +`OnWithoutCull` 3 + +Blending is enabled, and don't cull the renderer. + + + +`UseActorOpacity` 4 + +Blending is enabled when the actor is not opaque + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliProperty.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliProperty.md new file mode 100644 index 0000000000..68509130f6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliProperty.md @@ -0,0 +1,716 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## DaliProperty Class + +Provides a set of extension methods for the View class. + +```csharp +public static class DaliProperty +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DaliProperty +### Methods + + + +## DaliProperty.Get(this NObject, int, bool) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out bool value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The property value. + + + +## DaliProperty.Get(this NObject, int, float) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out float value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The property value. + + + +## DaliProperty.Get(this NObject, int, float, float, float) Method + +Gets the float value of the specified property. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out float v1, out float v2, out float v3); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key of the property. + + + +`v1` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The first float value. + + + +`v2` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The second float value. + + + +`v3` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The third float value. + + + +## DaliProperty.Get(this NObject, int, int) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out int value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property value. + + + +## DaliProperty.Get(this NObject, int, int, int) Method + +Retrieves an integer property of a visual at the specified index on the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int visualIndex, int key, out int value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object on which the visual is applied. + + + +`visualIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the visual to retrieve the property from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key identifying the property to retrieve. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The retrieved integer value of the specified property. + + + +## DaliProperty.Get(this NObject, int, int, Color) Method + +Retrieves the specified visual property of a given visual index on the view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int visualIndex, int key, out Tizen.UI.Color value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object to retrieve the visual property from. + + + +`visualIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the visual whose property is being retrieved. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key identifying the property to be retrieved. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The output color value of the specified visual property. + + + +## DaliProperty.Get(this NObject, int, int, CornerRadius) Method + +Retrieves the CornerRadius property of a visual on the specified view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int visualIndex, int key, out Tizen.UI.CornerRadius value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object to retrieve the property from. + + + +`visualIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the visual to retrieve the property from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key identifying the property to retrieve. + + + +`value` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The output CornerRadius value retrieved from the visual property. + + + +## DaliProperty.Get(this NObject, int, string) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out string value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The property value. + + + +## DaliProperty.Get(this NObject, int, Color) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out Tizen.UI.Color value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The property value. + + + +## DaliProperty.Get(this NObject, int, CornerRadius) Method + +Gets the specified corner radius for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out Tizen.UI.CornerRadius value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The property value. + + + +## DaliProperty.Get(this NObject, int, PropertyMapHandle) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map. + + + +## DaliProperty.Get(this NObject, int, PropertyValueHandle) Method + +Gets the specified property value for the given view. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to get the property value from. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The property value. + + + +## DaliProperty.Get(this NObject, int, Point) Method + +Gets the value of the specified property. + +```csharp +public static void Get(this Tizen.UI.NObject view, int key, out Tizen.UI.Point value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key of the property. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The output value of the property. + + + +## DaliProperty.GetCurrent(this NObject, int, Point) Method + +Gets the current value of the specified property. + +```csharp +public static void GetCurrent(this Tizen.UI.NObject view, int key, out Tizen.UI.Point value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key of the property. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The output value of the property. + + + +## DaliProperty.GetCurrent(this NObject, int, Size) Method + +Gets the current value of the specified property. + +```csharp +public static void GetCurrent(this Tizen.UI.NObject view, int key, out Tizen.UI.Size value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view object. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key of the property. + + + +`value` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The output value of the property. + + + +## DaliProperty.Register(this NObject, string, PropertyValueHandle) Method + +Registers the specified property value for the given NObject. + +```csharp +public static int Register(this Tizen.UI.NObject obj, string name, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`obj` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The NObject to register the property value for. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The property name. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The property value. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## DaliProperty.Set(this NObject, int, bool) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, bool value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The property value. + + + +## DaliProperty.Set(this NObject, int, float) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, float value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The property value. + + + +## DaliProperty.Set(this NObject, int, int) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, int value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property value. + + + +## DaliProperty.Set(this NObject, int, Color) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, Tizen.UI.Color value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The property value. + + + +## DaliProperty.Set(this NObject, int, PropertyValueHandle) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The property value. + + + +## DaliProperty.Set(this NObject, int, Vector4Handle) Method + +Sets the specified property value for the given view. + +```csharp +public static void Set(this Tizen.UI.NObject view, int key, Tizen.UI.NativeHandle.Vector4Handle value); +``` +#### Parameters + + + +`view` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The view to set the property value for. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The property key. + + + +`value` [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') + +The property value. + + + +## DaliProperty.Set(this NObject, string, PropertyValueHandle) Method + +Sets the specified property value for the given NObject. + +```csharp +public static void Set(this Tizen.UI.NObject obj, string name, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`obj` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The NObject to set the property value for. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The property name. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The property value. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliPropertyType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliPropertyType.md new file mode 100644 index 0000000000..2ab656caf3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliPropertyType.md @@ -0,0 +1,105 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## DaliPropertyType Enum + +This specifies all the property types.
+Enumeration for the property types supported. + +```csharp +public enum DaliPropertyType +``` +### Fields + + + +`Array` 12 + +An array of PropertyValue. + + + +`Boolean` 1 + +A boolean type. + + + +`Extents` 14 + +An extents type. + + + +`Float` 2 + +A float type. + + + +`Integer` 3 + +An integer type. + + + +`Map` 13 + +A string key to PropertyValue mapping. + + + +`Matrix` 8 + +A 4x4 matrix. + + + +`Matrix3` 7 + +A 3x3 matrix. + + + +`None` 0 + +No type. + + + +`Rectangle` 9 + +An integer array of size=4. + + + +`Rotation` 10 + +Either a quaternion or an axis angle rotation. + + + +`String` 11 + +A string type. + + + +`Vector2` 4 + +A vector array of size=2 with float precision. + + + +`Vector3` 5 + +A vector array of size=3 with float precision. + + + +`Vector4` 6 + +A vector array of size=4 with float precision. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthFunctionType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthFunctionType.md new file mode 100644 index 0000000000..136bc6053a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthFunctionType.md @@ -0,0 +1,62 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## DepthFunctionType Enum + +Enumeration for depth functions. + +```csharp +public enum DepthFunctionType +``` +### Fields + + + +`Always` 1 + +Depth test always passes + + + +`Equal` 4 + +Depth test passes if the incoming depth value is equal to the stored depth value + + + +`Greater` 3 + +Depth test passes if the incoming depth value is greater than the stored depth value + + + +`GreaterEqual` 7 + +Depth test passes if the incoming depth value is greater than or equal to the stored depth value + + + +`Less` 2 + +Depth test passes if the incoming depth value is less than the stored depth value + + + +`LessEqual` 6 + +Depth test passes if the incoming depth value is less than or equal to the stored depth value + + + +`Never` 0 + +Depth test never passes + + + +`NotEqual` 5 + +Depth test passes if the incoming depth value is not equal to the stored depth value + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthTestModeType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthTestModeType.md new file mode 100644 index 0000000000..1a308987b4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthTestModeType.md @@ -0,0 +1,32 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## DepthTestModeType Enum + +Enumeration for depth buffer test (read) modes. + +```csharp +public enum DepthTestModeType +``` +### Fields + + + +`Auto` 1 + +Renderer only reads from the depth buffer if in a 3D layer + + + +`Off` 0 + +Renderer does not read from the depth buffer + + + +`On` 2 + +Renderer reads from the depth buffer based on the DepthFunction + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthWriteModeType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthWriteModeType.md new file mode 100644 index 0000000000..e41f84cbcb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthWriteModeType.md @@ -0,0 +1,32 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## DepthWriteModeType Enum + +Enumeration for depth buffer write modes. + +```csharp +public enum DepthWriteModeType +``` +### Fields + + + +`Auto` 1 + +Renderer only writes to the depth buffer if it's opaque + + + +`Off` 0 + +Renderer doesn't write to the depth buffer + + + +`On` 2 + +Renderer writes to the depth buffer + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FaceCullingModeType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FaceCullingModeType.md new file mode 100644 index 0000000000..ba3c16e407 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FaceCullingModeType.md @@ -0,0 +1,38 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## FaceCullingModeType Enum + +Enumeration for face culling mode. + +```csharp +public enum FaceCullingModeType +``` +### Fields + + + +`Back` 2 + +Cull back face, back faces should never be shown + + + +`Front` 1 + +Cull front face, front faces should never be shown + + + +`FrontAndBack` 3 + +Cull front and back faces; if the geometry is composed of triangles none of the faces will be shown + + + +`None` 0 + +None of the faces should be culled + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FilterMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FilterMode.md new file mode 100644 index 0000000000..705acae165 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FilterMode.md @@ -0,0 +1,62 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## FilterMode Enum + +The filter mode type. + +```csharp +public enum FilterMode +``` +### Fields + + + +`DEFAULT` 1 + +Use Dali defaults (minification LINEAR, magnification LINEAR). + + + +`LINEAR` 3 + +Filter linear. + + + +`LINEAR_MIPMAP_LINEAR` 7 + +Filter linear mipmap linear. + + + +`LINEAR_MIPMAP_NEAREST` 5 + +Filter linear mipmap nearest. + + + +`NEAREST` 2 + +Filter nearest. + + + +`NEAREST_MIPMAP_LINEAR` 6 + +Filter nearest mipmap linear. + + + +`NEAREST_MIPMAP_NEAREST` 4 + +Filter nearest mipmap nearest. + + + +`NONE` 0 + +Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR). + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.GeometryType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.GeometryType.md new file mode 100644 index 0000000000..2cc6a89fb1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.GeometryType.md @@ -0,0 +1,57 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## GeometryType Enum + +Enumeration for the description of the type of geometry, +used to determine how the coordinates will be used. + +```csharp +public enum GeometryType +``` +### Fields + + + +`LINE_LOOP` 2 + +A strip of lines (made of 1 point each) which also joins the first and last point. + + + +`LINE_STRIP` 3 + +A strip of lines (made of 1 point each). + + + +`LINES` 1 + +Individual lines (made of 2 points each). + + + +`POINTS` 0 + +Individual points. + + + +`TRIANGLE_FAN` 5 + +A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point). + + + +`TRIANGLE_STRIP` 6 + +A strip of triangles (after the first triangle, following triangles need only 1 point). + + + +`TRIANGLES` 4 + +Individual triangles (made of 3 points each). + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ImageVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ImageVisualMap.md new file mode 100644 index 0000000000..b5061f0ad3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ImageVisualMap.md @@ -0,0 +1,322 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## ImageVisualMap Class + +ImageVisualMap is a class that represents a property map for the image visual. + +```csharp +public class ImageVisualMap : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImageVisualMap + +Derived +↳ [LottieVisualMap](Tizen.UI.Internal.LottieVisualMap.md 'Tizen.UI.Internal.LottieVisualMap') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## ImageVisualMap() Constructor + +Initializes a new instance of the ImageVisualMap class. + +```csharp +public ImageVisualMap(); +``` +### Properties + + + +## ImageVisualMap.AlphaMaskUrl Property + +Gets or sets the URL of the alpha mask image resource. + +```csharp +public string AlphaMaskUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisualMap.Border Property + +Gets or sets the border of the image. + +```csharp +public Tizen.UI.Thickness Border { get; set; } +``` + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## ImageVisualMap.BorderOnly Property + +Gets or sets a value indicating whether to draw only the border. + +```csharp +public bool BorderOnly { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.CropToMask Property + +Gets or sets a value indicating whether to crop the image to the mask. + +```csharp +public bool CropToMask { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.FittingMode Property + +Gets or sets the fitting mode of the image. + +```csharp +public Tizen.UI.FittingMode FittingMode { get; set; } +``` + +#### Property Value +[FittingMode](Tizen.UI.FittingMode.md 'Tizen.UI.FittingMode') + + + +## ImageVisualMap.Handle Property + +Gets the handle of the property map. + +```csharp +public Tizen.UI.NativeHandle.PropertyMapHandle Handle { get; set; } +``` + +#### Property Value +[PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + + + +## ImageVisualMap.IsNinePatchImage Property + +Gets or sets a value indicating whether the image is a nine-patch image. + +```csharp +public bool IsNinePatchImage { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.MultipliedColor Property + +Gets or sets the multiplied color of the image + +```csharp +public Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## ImageVisualMap.OrientationCorrection Property + +Gets or sets a value indicating whether to correct the image orientation. + +```csharp +public bool OrientationCorrection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ImageVisualMap.ResourceUrl Property + +Gets or sets the URL of the image resource. + +```csharp +public string ResourceUrl { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## ImageVisualMap.SynchronousLoading Property + +Gets or sets a value indicating whether to load the image synchronously. + +```csharp +public bool SynchronousLoading { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +### Methods + + + +## ImageVisualMap.Dispose() Method + +Disposes the ImageVisualMap object. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## ImageVisualMap.SetDirty() Method + +Sets the map as dirty. + +```csharp +public void SetDirty(); +``` + + + +## ImageVisualMap.SetFastTrackUploading(bool) Method + +Sets whether to apply fast track uploading or not.
+ +```csharp +public void SetFastTrackUploading(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +### Remarks +If we use fast track uploading feature, It can upload texture without event-thead dependency. But also,
+ - Texture size is invalid until ResourceReady signal comes.
+ - Texture cannot be cached (We always try to load new image).
+ - Seamless visual change didn't supported.
+ - Alpha masking didn't supported. If you try, It will load as normal case.
+ - Synchronous loading didn't supported. If you try, It will load as normal case.
+ - Reload action didn't supported. If you try, It will load as normal case.
+ - Atlas loading didn't supported. If you try, It will load as normal case.
+ - Custom shader didn't supported. If you try, It will load as normal case. + + + +## ImageVisualMap.SetMaskingMode(ImageMaskingMode) Method + +Sets the masking mode for the ImageVisual. + +```csharp +public void SetMaskingMode(Tizen.UI.ImageMaskingMode mode); +``` +#### Parameters + + + +`mode` [ImageMaskingMode](Tizen.UI.ImageMaskingMode.md 'Tizen.UI.ImageMaskingMode') + +The masking mode to use. + + + +## ImageVisualMap.SetPixelArea(Rect) Method + +Sets the image area to be displayed. +It is a rectangular area. +The first two elements indicate the top-left position of the area, and the last two elements are the areas of the width and the height respectively. +If not specified, the default value is Rect (0.0, 0.0, 1.0, 1.0), i.e., the entire area of the image. +For normal quad images only. + +```csharp +public void SetPixelArea(Tizen.UI.Rect area); +``` +#### Parameters + + + +`area` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + + + +## ImageVisualMap.SetReleasePolicy(ImageReleasePolicy) Method + +Sets the release policy for the ImageVisual. + +```csharp +public void SetReleasePolicy(Tizen.UI.ImageReleasePolicy releasePolicy); +``` +#### Parameters + + + +`releasePolicy` [ImageReleasePolicy](Tizen.UI.ImageReleasePolicy.md 'Tizen.UI.ImageReleasePolicy') + +The release policy to be used by the ImageVisual. + + + +## ImageVisualMap.SetWrapModeU(ImageWrapMode) Method + +Gets or sets the horizontal wrap mode of the image. + +```csharp +public void SetWrapModeU(Tizen.UI.ImageWrapMode mode); +``` +#### Parameters + + + +`mode` [ImageWrapMode](Tizen.UI.ImageWrapMode.md 'Tizen.UI.ImageWrapMode') + + + +## ImageVisualMap.SetWrapModeV(ImageWrapMode) Method + +Sets the vertical wrap mode of the image. + +```csharp +public void SetWrapModeV(Tizen.UI.ImageWrapMode mode); +``` +#### Parameters + + + +`mode` [ImageWrapMode](Tizen.UI.ImageWrapMode.md 'Tizen.UI.ImageWrapMode') +### Events + + + +## ImageVisualMap.UpdateRequired Event + +Occurs when the update is required. + +```csharp +public event EventHandler UpdateRequired; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.LottieVisualMap.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.LottieVisualMap.md new file mode 100644 index 0000000000..dc6959ec43 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.LottieVisualMap.md @@ -0,0 +1,26 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## LottieVisualMap Class + +LottieVisualMap is a class that represents a visual map for Lottie animation. + +```csharp +public class LottieVisualMap : Tizen.UI.Internal.ImageVisualMap +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [ImageVisualMap](Tizen.UI.Internal.ImageVisualMap.md 'Tizen.UI.Internal.ImageVisualMap') 🡒 LottieVisualMap +### Constructors + + + +## LottieVisualMap() Constructor + +Constructor. + +```csharp +public LottieVisualMap(); +``` + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.NativeImageSource.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.NativeImageSource.md new file mode 100644 index 0000000000..f58bc3d081 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.NativeImageSource.md @@ -0,0 +1,98 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## NativeImageSource Class + +Represents a native image source that can be used for rendering. + +```csharp +public class NativeImageSource : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 NativeImageSource + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## NativeImageSource(int, int) Constructor + +Initializes a new instance of the NativeImageSource class with the specified width and height. + +```csharp +public NativeImageSource(int width, int height); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the image source. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The height of the image source. +### Methods + + + +## NativeImageSource.AccquiredBuffer(int, int, int) Method + +Acquires a buffer from the native image source. + +```csharp +public System.IntPtr AccquiredBuffer(out int width, out int height, out int stride); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the acquired buffer. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The height of the acquired buffer. + + + +`stride` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The stride of the acquired buffer. + +#### Returns +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') +A pointer to the acquired buffer. + + + +## NativeImageSource.Dispose() Method + +Releases all resources used by the NativeImageSource object. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## NativeImageSource.ReleaseBuffer() Method + +Releases the acquired buffer from the native image source. + +```csharp +public void ReleaseBuffer(); +``` + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool.md new file mode 100644 index 0000000000..80703b8abe --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool.md @@ -0,0 +1,157 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## ObjectPool Class + +Provides a set of static methods for creating new object pools. + +```csharp +public static class ObjectPool +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ObjectPool +### Methods + + + +## ObjectPool.NewVector2() Method + +Creates a new object pool for Vector2Handle objects. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector2Handle> NewVector2(); +``` + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + +## ObjectPool.NewVector2(float, float) Method + +Creates a new object pool for Vector2Handle objects with the specified values. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector2Handle> NewVector2(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the vector. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the vector. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + +## ObjectPool.NewVector3() Method + +Creates a new object pool for Vector3Handle objects. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector3Handle> NewVector3(); +``` + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + +## ObjectPool.NewVector3(float, float, float) Method + +Creates a new object pool for Vector3Handle objects with the specified values. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector3Handle> NewVector3(float x, float y, float z); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the vector. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the vector. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the vector. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + +## ObjectPool.NewVector4() Method + +Creates a new object pool for Vector4Handle objects. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> NewVector4(); +``` + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + +## ObjectPool.NewVector4(float, float, float, float) Method + +Creates a new object pool for Vector4Handle objects with the specified values. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> NewVector4(float x, float y, float z, float w); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the vector. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the vector. + + + +`z` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The z-coordinate of the vector. + + + +`w` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The w-coordinate of the vector. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object pool. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool_T_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool_T_.md new file mode 100644 index 0000000000..b2dc9582a7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool_T_.md @@ -0,0 +1,118 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## ObjectPool<T> Class + +Provides a pool of objects that can be reused to improve performance and reduce memory usage. + +```csharp +public class ObjectPool<T> : +System.IDisposable +``` +#### Type parameters + + + +`T` + +The type of object to pool. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ObjectPool<T> + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors + + + +## ObjectPool(T) Constructor + +Initializes a new instance of the [ObjectPool<T>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') class. + +```csharp +public ObjectPool(T value); +``` +#### Parameters + + + +`value` [T](Tizen.UI.Internal.ObjectPool_T_.md#Tizen.UI.Internal.ObjectPool_T_.T 'Tizen.UI.Internal.ObjectPool<T>.T') + +The initial value of the object. +### Properties + + + +## ObjectPool<T>.Count Property + +Gets the number of objects currently in the pool. + +```csharp +public static int Count { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ObjectPool<T>.Value Property + +Gets the current value of the object. + +```csharp +public T Value { get; } +``` + +#### Property Value +[T](Tizen.UI.Internal.ObjectPool_T_.md#Tizen.UI.Internal.ObjectPool_T_.T 'Tizen.UI.Internal.ObjectPool<T>.T') +### Methods + + + +## ObjectPool<T>.Dispose() Method + +Releases the object back into the pool. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## ObjectPool<T>.New() Method + +Creates a new object from the pool or creates a new instance if the pool is empty. + +```csharp +public static Tizen.UI.Internal.ObjectPool<T> New(); +``` + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[T](Tizen.UI.Internal.ObjectPool_T_.md#Tizen.UI.Internal.ObjectPool_T_.T 'Tizen.UI.Internal.ObjectPool<T>.T')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new object from the pool or a new instance if the pool is empty. +### Operators + + + +## ObjectPool<T>.implicit operator T(ObjectPool<T>) Operator + +Implicitly converts the object pool to its underlying value. + +```csharp +public static T implicit operator T(Tizen.UI.Internal.ObjectPool<T> obj); +``` +#### Parameters + + + +`obj` [Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[T](Tizen.UI.Internal.ObjectPool_T_.md#Tizen.UI.Internal.ObjectPool_T_.T 'Tizen.UI.Internal.ObjectPool<T>.T')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') + +The object pool to convert. + +#### Returns +[T](Tizen.UI.Internal.ObjectPool_T_.md#Tizen.UI.Internal.ObjectPool_T_.T 'Tizen.UI.Internal.ObjectPool<T>.T') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderModeType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderModeType.md new file mode 100644 index 0000000000..01771360f5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderModeType.md @@ -0,0 +1,44 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## RenderModeType Enum + +Enumeration for the controls of how this renderer uses its stencil properties and writes to the color buffer. + +```csharp +public enum RenderModeType +``` +### Fields + + + +`Auto` 1 + +Managed by the View Clipping API. This is the default. + + + +`Color` 2 + +Ingore stencil properties. Write to the color buffer. + + + +`ColorStencil` 4 + +Use the stencil properties AND Write to the color buffer. + + + +`None` 0 + +Do not write to either color or stencil buffer (But will potentially render to depth buffer). + + + +`Stencil` 3 + +Use the stencil properties. Do not write to the color buffer. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderingBehavior.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderingBehavior.md new file mode 100644 index 0000000000..ecd3f673a4 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderingBehavior.md @@ -0,0 +1,26 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## RenderingBehavior Enum + +Enumeration for Setting the rendering behavior of a Window. + +```csharp +public enum RenderingBehavior +``` +### Fields + + + +`Continuously` 1 + +Renders continuously. + + + +`IfRequired` 0 + +Default. Only renders if required. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ResourceManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ResourceManager.md new file mode 100644 index 0000000000..68db12fb83 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ResourceManager.md @@ -0,0 +1,72 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## ResourceManager Class + +Provides a method to get the path of a resource file. + +```csharp +public static class ResourceManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ResourceManager +### Properties + + + +## ResourceManager.ResourceDirectory Property + +Gets the application resource directory. + +```csharp +public static string ResourceDirectory { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## ResourceManager.GetCommonPath(string) Method + +Gets the common path of the specified resource. + +```csharp +public static string GetCommonPath(string res); +``` +#### Parameters + + + +`res` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the resource. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The path of the resource. + + + +## ResourceManager.GetPath(string) Method + +Gets the path of the specified resource. + +```csharp +public static string GetPath(string res); +``` +#### Parameters + + + +`res` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the resource. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The path of the resource. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ShaderHint.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ShaderHint.md new file mode 100644 index 0000000000..58b013bb79 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ShaderHint.md @@ -0,0 +1,30 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## ShaderHint Enum + +```csharp +public enum ShaderHint +``` +### Fields + + + +`MODIFIES_GEOMETRY` 2 + +Might change position of vertices, this option disables any culling optimizations + + + +`NONE` 0 + +No hints. + + + +`OUTPUT_IS_TRANSPARENT` 1 + +Might generate transparent alpha from opaque inputs + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilFunctionType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilFunctionType.md new file mode 100644 index 0000000000..a58bb510e0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilFunctionType.md @@ -0,0 +1,62 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## StencilFunctionType Enum + +Enumeration for the comparison function used on the stencil buffer. + +```csharp +public enum StencilFunctionType +``` +### Fields + + + +`Always` 7 + +Always passes + + + +`Equal` 2 + +Passes if ( reference & mask ) = ( stencil & mask ) + + + +`Greater` 4 + +Passes if ( reference & mask ) > ( stencil & mask ) + + + +`GreaterEqual` 6 + +Passes if ( reference & mask ) >= ( stencil & mask ) + + + +`Less` 1 + +Passes if ( reference & mask ) < ( stencil & mask ) + + + +`LessEqual` 3 + +Passes if ( reference & mask ) <= ( stencil & mask ) + + + +`Never` 0 + +Always fails + + + +`NotEqual` 5 + +Passes if ( reference & mask ) != ( stencil & mask ) + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilOperationType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilOperationType.md new file mode 100644 index 0000000000..465a7cfcb1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilOperationType.md @@ -0,0 +1,64 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## StencilOperationType Enum + +Enumeration for specifying the action to take when the stencil (or depth) test fails during stencil test. + +```csharp +public enum StencilOperationType +``` +### Fields + + + +`Decrement` 4 + +Decrements the current stencil buffer value. Clamps to 0 + + + +`DecrementWrap` 7 + +Decrements the current stencil buffer value. +Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero + + + +`Increment` 3 + +Increments the current stencil buffer value. Clamps to the maximum representable unsigned value + + + +`IncrementWrap` 6 + +Increments the current stencil buffer value. +Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value + + + +`Invert` 5 + +Bitwise inverts the current stencil buffer value + + + +`Keep` 1 + +Keeps the current value + + + +`Replace` 2 + +Sets the stencil buffer value to ref, as specified by glStencilFunc + + + +`Zero` 0 + +Sets the stencil buffer value to 0 + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.TextureType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.TextureType.md new file mode 100644 index 0000000000..76e7197541 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.TextureType.md @@ -0,0 +1,26 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## TextureType Enum + +The texture type. + +```csharp +public enum TextureType +``` +### Fields + + + +`TEXTURE_2D` 0 + +One 2D image + + + +`TEXTURE_CUBE` 1 + +Six 2D images arranged in a cube-shape + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.WindowExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.WindowExtensions.md new file mode 100644 index 0000000000..7ac7bd524b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.WindowExtensions.md @@ -0,0 +1,46 @@ +### [Tizen.UI.Internal](Tizen.UI.Internal.md 'Tizen.UI.Internal') + +## WindowExtensions Class + +```csharp +public static class WindowExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 WindowExtensions +### Methods + + + +## WindowExtensions.AddFrameRenderedCallback(this Window, Action<int>, int) Method + +Adds a callback function that will be invoked when the frame is rendered. + +```csharp +public static void AddFrameRenderedCallback(this Tizen.UI.Window window, System.Action<int> callback, int id); +``` +#### Parameters + + + +`window` [Window](Tizen.UI.Window.md 'Tizen.UI.Window') + +The window instance. + + + +`callback` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The callback function to be invoked. + + + +`id` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +A unique identifier for the callback. + +### Remarks +A callback is invoked on UI thread(Main thread) and it only called once + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.md new file mode 100644 index 0000000000..6dd64ced48 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.md @@ -0,0 +1,37 @@ + +## Tizen.UI.Internal Namespace + +| Classes | | +| :--- | :--- | +| [DaliProperty](Tizen.UI.Internal.DaliProperty.md 'Tizen.UI.Internal.DaliProperty') | Provides a set of extension methods for the View class. | +| [ImageVisualMap](Tizen.UI.Internal.ImageVisualMap.md 'Tizen.UI.Internal.ImageVisualMap') | ImageVisualMap is a class that represents a property map for the image visual. | +| [LottieVisualMap](Tizen.UI.Internal.LottieVisualMap.md 'Tizen.UI.Internal.LottieVisualMap') | LottieVisualMap is a class that represents a visual map for Lottie animation. | +| [NativeImageSource](Tizen.UI.Internal.NativeImageSource.md 'Tizen.UI.Internal.NativeImageSource') | Represents a native image source that can be used for rendering. | +| [ObjectPool](Tizen.UI.Internal.ObjectPool.md 'Tizen.UI.Internal.ObjectPool') | Provides a set of static methods for creating new object pools. | +| [ObjectPool<T>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') | Provides a pool of objects that can be reused to improve performance and reduce memory usage. | +| [ResourceManager](Tizen.UI.Internal.ResourceManager.md 'Tizen.UI.Internal.ResourceManager') | Provides a method to get the path of a resource file. | +| [WindowExtensions](Tizen.UI.Internal.WindowExtensions.md 'Tizen.UI.Internal.WindowExtensions') | | + +| Enums | | +| :--- | :--- | +| [BlendEquationType](Tizen.UI.Internal.BlendEquationType.md 'Tizen.UI.Internal.BlendEquationType') | Enumeration for blend equation. | +| [BlendFactorType](Tizen.UI.Internal.BlendFactorType.md 'Tizen.UI.Internal.BlendFactorType') | Enumeration for blend factor. | +| [BlendModeType](Tizen.UI.Internal.BlendModeType.md 'Tizen.UI.Internal.BlendModeType') | Enumeration for blend mode. | +| [DaliPropertyType](Tizen.UI.Internal.DaliPropertyType.md 'Tizen.UI.Internal.DaliPropertyType') | This specifies all the property types.

Enumeration for the property types supported. | +| [DepthFunctionType](Tizen.UI.Internal.DepthFunctionType.md 'Tizen.UI.Internal.DepthFunctionType') | Enumeration for depth functions. | +| [DepthTestModeType](Tizen.UI.Internal.DepthTestModeType.md 'Tizen.UI.Internal.DepthTestModeType') | Enumeration for depth buffer test (read) modes. | +| [DepthWriteModeType](Tizen.UI.Internal.DepthWriteModeType.md 'Tizen.UI.Internal.DepthWriteModeType') | Enumeration for depth buffer write modes. | +| [FaceCullingModeType](Tizen.UI.Internal.FaceCullingModeType.md 'Tizen.UI.Internal.FaceCullingModeType') | Enumeration for face culling mode. | +| [FilterMode](Tizen.UI.Internal.FilterMode.md 'Tizen.UI.Internal.FilterMode') | The filter mode type. | +| [GeometryType](Tizen.UI.Internal.GeometryType.md 'Tizen.UI.Internal.GeometryType') | Enumeration for the description of the type of geometry,
used to determine how the coordinates will be used. | +| [RenderingBehavior](Tizen.UI.Internal.RenderingBehavior.md 'Tizen.UI.Internal.RenderingBehavior') | Enumeration for Setting the rendering behavior of a Window. | +| [RenderModeType](Tizen.UI.Internal.RenderModeType.md 'Tizen.UI.Internal.RenderModeType') | Enumeration for the controls of how this renderer uses its stencil properties and writes to the color buffer. | +| [ShaderHint](Tizen.UI.Internal.ShaderHint.md 'Tizen.UI.Internal.ShaderHint') | | +| [StencilFunctionType](Tizen.UI.Internal.StencilFunctionType.md 'Tizen.UI.Internal.StencilFunctionType') | Enumeration for the comparison function used on the stencil buffer. | +| [StencilOperationType](Tizen.UI.Internal.StencilOperationType.md 'Tizen.UI.Internal.StencilOperationType') | Enumeration for specifying the action to take when the stencil (or depth) test fails during stencil test. | +| [TextureType](Tizen.UI.Internal.TextureType.md 'Tizen.UI.Internal.TextureType') | The texture type. | + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceClass.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceClass.md new file mode 100644 index 0000000000..f3e71f8791 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceClass.md @@ -0,0 +1,64 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyDeviceClass Enum + +The KeyDeviceClass enum represents the class of a key device. + +```csharp +public enum KeyDeviceClass +``` +### Fields + + + +`Gamepad` 7 + +A gamepad controller or joystick. + + + +`Keyboard` 2 + +A regular keyboard, numberpad or attached buttons. + + + +`Mouse` 3 + +A mouse, trackball or touchpad relative motion device. + + + +`None` 0 + +Not a device. + + + +`Pen` 5 + +A special pen device. + + + +`Pointer` 6 + +A pointing device based on laser, infrared or similar technology. + + + +`Seat` 1 + +The user/seat (the user themselves). + + + +`Touch` 4 + +A touchscreen with fingers or stylus. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceSubClass.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceSubClass.md new file mode 100644 index 0000000000..d387dfb101 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceSubClass.md @@ -0,0 +1,94 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyDeviceSubClass Enum + +The KeyDeviceSubClass enum represents the sub-class of a key device. + +```csharp +public enum KeyDeviceSubClass +``` +### Fields + + + +`Finger` 1 + +The normal flat of your finger + + + +`Fingernail` 2 + +A fingernail + + + +`HandFlat` 6 + +The flat of your hand + + + +`HandSide` 5 + +The side of your hand + + + +`Knuckle` 3 + +A Knuckle + + + +`None` 0 + +Not a device + + + +`Palm` 4 + +The palm of a users hand + + + +`PenTip` 7 + +The tip of a pen + + + +`Remocon` 11 + +A remote controller + + + +`Trackball` 10 + +A trackball style mouse + + + +`Trackpad` 8 + +A trackpad style mouse + + + +`Trackpoint` 9 + +A trackpoint style mouse + + + +`VirtualKeyboard` 12 + +A virtual keyboard + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEvent.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEvent.md new file mode 100644 index 0000000000..bdd6969fe7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEvent.md @@ -0,0 +1,208 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyEvent Class + +KeyEvent is a class that represents a key event. + +```csharp +public class KeyEvent : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 KeyEvent +### Constructors + + + +## KeyEvent() Constructor + +Initializes a new instance of the KeyEvent class. + +```csharp +public KeyEvent(); +``` + + + +## KeyEvent(IntPtr, bool) Constructor + +Initializes a new instance of the KeyEvent class with specified handle and ownership. + +```csharp +public KeyEvent(System.IntPtr handle, bool hasOwnership); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the key event. + + + +`hasOwnership` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether this instance owns the handle or not. +### Properties + + + +## KeyEvent.DeviceClass Property + +Gets the device class of the key event. + +```csharp +public Tizen.UI.KeyDeviceClass DeviceClass { get; } +``` + +#### Property Value +[KeyDeviceClass](Tizen.UI.KeyDeviceClass.md 'Tizen.UI.KeyDeviceClass') + + + +## KeyEvent.DeviceName Property + +Gets the device name of the key event. + +```csharp +public string DeviceName { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## KeyEvent.DeviceSubClass Property + +Gets the device sub class of the key event. + +```csharp +public Tizen.UI.KeyDeviceSubClass DeviceSubClass { get; } +``` + +#### Property Value +[KeyDeviceSubClass](Tizen.UI.KeyDeviceSubClass.md 'Tizen.UI.KeyDeviceSubClass') + + + +## KeyEvent.IsAltModifier Property + +Gets whether the alt modifier is on or not. + +```csharp +public bool IsAltModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## KeyEvent.IsCtrlModifier Property + +Gets whether the ctrl modifier is on or not. + +```csharp +public bool IsCtrlModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## KeyEvent.IsShiftModifier Property + +Gets whether the shift modifier is on or not. + +```csharp +public bool IsShiftModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## KeyEvent.KeyCode Property + +Gets or sets the key code of the key event. + +```csharp +public int KeyCode { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## KeyEvent.KeyModifier Property + +Gets or sets the key modifier of the key event. + +```csharp +public int KeyModifier { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## KeyEvent.KeyPressedName Property + +Gets or sets the key pressed name of the key event. + +```csharp +public string KeyPressedName { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## KeyEvent.LogicalKey Property + +Gets the logical key of the key event. + +```csharp +public string LogicalKey { get; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## KeyEvent.State Property + +Gets or sets the state of the key event. + +```csharp +public Tizen.UI.KeyState State { get; set; } +``` + +#### Property Value +[KeyState](Tizen.UI.KeyState.md 'Tizen.UI.KeyState') + + + +## KeyEvent.Time Property + +Gets or sets the time of the key event. + +```csharp +public uint Time { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEventArgs.md new file mode 100644 index 0000000000..20ed34a0cf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyEventArgs Class + +Event arguments for [KeyEvent](Tizen.UI.KeyEventArgs.md#Tizen.UI.KeyEventArgs.KeyEvent 'Tizen.UI.KeyEventArgs.KeyEvent') event. + +```csharp +public class KeyEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 KeyEventArgs +### Properties + + + +## KeyEventArgs.Handled Property + +Gets or sets a value indicating whether the event has been handled. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## KeyEventArgs.KeyEvent Property + +Gets or sets the key event data. + +```csharp +public Tizen.UI.KeyEvent KeyEvent { get; set; } +``` + +#### Property Value +[KeyEvent](Tizen.UI.KeyEvent.md 'Tizen.UI.KeyEvent') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyGrabMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyGrabMode.md new file mode 100644 index 0000000000..29bda9d13e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyGrabMode.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyGrabMode Enum + +Enumeration for the key grab mode for platform-level APIs. + +```csharp +public enum KeyGrabMode +``` +### Fields + + + +`Exclusive` 3 + +Grabs a key exclusively regardless of the grabbing-window's position on the window stack mode. + + + +`OverrideExclusive` 2 + +Grabs a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode. + + + +`Shared` 1 + +Grabs a key together with the other client window(s) mode. + + + +`Topmost` 0 + +Grabs a key only when on the top of the grabbing-window stack mode. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyState.md new file mode 100644 index 0000000000..353890a4a9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyState.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## KeyState Enum + +The KeyState enum represents the state of a key on the keyboard. + +```csharp +public enum KeyState +``` +### Fields + + + +`Down` 0 + +Key Down. + + + +`Up` 1 + +Key Up. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Layer.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Layer.md new file mode 100644 index 0000000000..e299790ed5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Layer.md @@ -0,0 +1,220 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Layer Class + +Layer is a container for views. It provides a way to group views together and manipulate them as a single entity. + +```csharp +public class Layer : Tizen.UI.NObject, +Tizen.UI.IParentObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 Layer + +Implements [IParentObject](Tizen.UI.IParentObject.md 'Tizen.UI.IParentObject') +### Constructors + + + +## Layer() Constructor + +Creates a new Layer object. + +```csharp +public Layer(); +``` +### Properties + + + +## Layer.Children Property + +Gets the list of children views in the Layer. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## Layer.Count Property + +Gets the count of children views in the Layer. + +```csharp +public int Count { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Layer.HeightResizePolicy Property + +Gets or sets the height resize policy for the Layer. + +```csharp +public Tizen.UI.ResizePolicy HeightResizePolicy { get; set; } +``` + +#### Property Value +[ResizePolicy](Tizen.UI.ResizePolicy.md 'Tizen.UI.ResizePolicy') + + + +## Layer.InheritLayoutDirection Property + +Gets or sets a value indicating whether the layer inherits its layout direction from its parent. +If [LayoutDirection](Tizen.UI.Layer.md#Tizen.UI.Layer.LayoutDirection 'Tizen.UI.Layer.LayoutDirection') is set, [InheritLayoutDirection](Tizen.UI.Layer.md#Tizen.UI.Layer.InheritLayoutDirection 'Tizen.UI.Layer.InheritLayoutDirection') is set to false. + +```csharp +public bool InheritLayoutDirection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Layer.IsVisible Property + +Gets or sets a value indicating whether the layer is visible or not. + +```csharp +public bool IsVisible { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Layer.LayoutDirection Property + +Gets or sets the layout direction of the layer. +If [LayoutDirection](Tizen.UI.Layer.md#Tizen.UI.Layer.LayoutDirection 'Tizen.UI.Layer.LayoutDirection') is set, [InheritLayoutDirection](Tizen.UI.Layer.md#Tizen.UI.Layer.InheritLayoutDirection 'Tizen.UI.Layer.InheritLayoutDirection') is set to false. + +```csharp +public Tizen.UI.LayoutDirection LayoutDirection { get; set; } +``` + +#### Property Value +[LayoutDirection](Tizen.UI.LayoutDirection.md 'Tizen.UI.LayoutDirection') + + + +## Layer.Name Property + +Gets or sets the name of the layer. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Layer.this[int] Property + +Gets or sets the child view at the specified index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## Layer.WidthResizePolicy Property + +Gets or sets the width resize policy for the Layer. + +```csharp +public Tizen.UI.ResizePolicy WidthResizePolicy { get; set; } +``` + +#### Property Value +[ResizePolicy](Tizen.UI.ResizePolicy.md 'Tizen.UI.ResizePolicy') +### Methods + + + +## Layer.Add(View) Method + +Adds a child view to the Layer. + +```csharp +public void Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to add. + + + +## Layer.Remove(View) Method + +Removes a child view from the Layer. + +```csharp +public bool Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to remove. + +Implements [Remove(View)](Tizen.UI.IParentObject.md#Tizen.UI.IParentObject.Remove(Tizen.UI.View) 'Tizen.UI.IParentObject.Remove(Tizen.UI.View)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the child view was removed, false otherwise. + + + +## Layer.SetSize(float, float) Method + +Sets the size of the Layer. + +```csharp +public void SetSize(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the Layer. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the Layer. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LayoutDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LayoutDirection.md new file mode 100644 index 0000000000..7b4cdfd097 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LayoutDirection.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LayoutDirection Enum + +The `LayoutDirection` enum is used to specify the direction of the UI elements. + +```csharp +public enum LayoutDirection +``` +### Fields + + + +`LeftToRight` 0 + +The direction is left to right. + + + +`RightToLeft` 1 + +The direction is right to left. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LineBreakMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LineBreakMode.md new file mode 100644 index 0000000000..3d2cac14e9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LineBreakMode.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LineBreakMode Enum + +Enumeration for line break modes. + +```csharp +public enum LineBreakMode +``` +### Fields + + + +`Character` 1 + +Character-wrapping mode. Lines are broken at character boundaries. + + + +`Hyphenation` 2 + +Hyphenation mode. Words that cannot fit on a line are broken by inserting hyphens. + + + +`Mixed` 3 + +Mixed mode. A combination of word-wrapping and character-wrapping. + + + +`Word` 0 + +Word-wrapping mode. Lines are broken at word boundaries. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LinearGradientBackground.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LinearGradientBackground.md new file mode 100644 index 0000000000..6835807121 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LinearGradientBackground.md @@ -0,0 +1,62 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LinearGradientBackground Class + +The LinearGradientBackground class is a visual that renders a linear gradient. + +```csharp +public class LinearGradientBackground : Tizen.UI.GradientBackground +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Background](Tizen.UI.Background.md 'Tizen.UI.Background') 🡒 [GradientBackground](Tizen.UI.GradientBackground.md 'Tizen.UI.GradientBackground') 🡒 LinearGradientBackground +### Properties + + + +## LinearGradientBackground.EndPoint Property + +Gets or sets the end point of the linear gradient. + +```csharp +public Tizen.UI.Point EndPoint { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## LinearGradientBackground.StartPoint Property + +Gets or sets the start point of the linear gradient. + +```csharp +public Tizen.UI.Point StartPoint { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +### Methods + + + +## LinearGradientBackground.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public override void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Log.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Log.md new file mode 100644 index 0000000000..e0fcc5f965 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Log.md @@ -0,0 +1,170 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Log Class + +Provides methods for logging messages with different levels of importance. + +```csharp +public static class Log +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Log +### Properties + + + +## Log.Tag Property + +Gets or sets the tag used for logging. + +```csharp +public static string Tag { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +### Methods + + + +## Log.Debug(string, string, string, int) Method + +Writes a debug message to the log. + +```csharp +public static void Debug(string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The message to write. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file name where the method is called. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The method name where the method is called. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number in the source file where the method is called. + + + +## Log.Error(string, string, string, int) Method + +Writes an error message to the log. + +```csharp +public static void Error(string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The message to write. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file name where the method is called. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The method name where the method is called. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number in the source file where the method is called. + + + +## Log.Info(string, string, string, int) Method + +Writes an informational message to the log. + +```csharp +public static void Info(string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The message to write. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file name where the method is called. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The method name where the method is called. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Log.Warn(string, string, string, int) Method + +Writes a warning message to the log. + +```csharp +public static void Warn(string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The message to write. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file name where the method is called. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The method name where the method is called. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number in the source file where the method is called. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGesture.md new file mode 100644 index 0000000000..6e779b6cca --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGesture.md @@ -0,0 +1,81 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LongPressGesture Class + +The LongPressGesture class represents a long press gesture. + +```csharp +public class LongPressGesture : Tizen.UI.Gesture +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') 🡒 LongPressGesture +### Constructors + + + +## LongPressGesture(IntPtr, bool) Constructor + +Initializes a new instance of the LongPressGesture class with the specified handle and whether it owns the handle or not. + +```csharp +public LongPressGesture(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the long press gesture. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the handle is owned by the new instance or not. +### Properties + + + +## LongPressGesture.NumberOfTouches Property + +Gets the number of touches associated with the long press gesture. + +```csharp +public int NumberOfTouches { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LongPressGesture.Position Property + +Gets the local position of the long press gesture. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## LongPressGesture.ScreenPosition Property + +Gets the screen position of the long press gesture. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetectedEventArgs.md new file mode 100644 index 0000000000..f31be4a6be --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetectedEventArgs.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LongPressGestureDetectedEventArgs Class + +Event arguments for [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') event. + +```csharp +public class LongPressGestureDetectedEventArgs : Tizen.UI.GestureDetectedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') 🡒 LongPressGestureDetectedEventArgs +### Constructors + + + +## LongPressGestureDetectedEventArgs(View, LongPressGesture) Constructor + +Initializes a new instance of the [LongPressGestureDetectedEventArgs](Tizen.UI.LongPressGestureDetectedEventArgs.md 'Tizen.UI.LongPressGestureDetectedEventArgs') class. + +```csharp +public LongPressGestureDetectedEventArgs(Tizen.UI.View view, Tizen.UI.LongPressGesture gesture); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The [View](Tizen.UI.View.md 'Tizen.UI.View') that detected the [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture'). + + + +`gesture` [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') + +The [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') object that contains information about the detected gesture. +### Properties + + + +## LongPressGestureDetectedEventArgs.Gesture Property + +Gets the [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') object that contains information about the detected gesture. + +```csharp +public Tizen.UI.LongPressGesture Gesture { get; } +``` + +#### Property Value +[LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetector.md new file mode 100644 index 0000000000..f2c439f907 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetector.md @@ -0,0 +1,83 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LongPressGestureDetector Class + +The LongPressGestureDetector class is used to detect long press gestures on a View. + +```csharp +public class LongPressGestureDetector : Tizen.UI.GestureDetector +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') 🡒 LongPressGestureDetector +### Constructors + + + +## LongPressGestureDetector() Constructor + +Creates a new LongPressGestureDetector. + +```csharp +public LongPressGestureDetector(); +``` +### Methods + + + +## LongPressGestureDetector.SetTouchesRequired(int) Method + +Sets the number of touches required for the gesture to be recognized. + +```csharp +public void SetTouchesRequired(int touches); +``` +#### Parameters + + + +`touches` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of touches required. + + + +## LongPressGestureDetector.SetTouchesRequired(int, int) Method + +Sets the minimum and maximum number of touches required for the gesture to be recognized. + +```csharp +public void SetTouchesRequired(int min, int max); +``` +#### Parameters + + + +`min` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The minimum number of touches required. + + + +`max` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The maximum number of touches required. +### Events + + + +## LongPressGestureDetector.Detected Event + +Event triggered when a long press gesture is detected on the attached View. + +```csharp +public event EventHandler<LongPressGestureDetectedEventArgs> Detected; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[LongPressGestureDetectedEventArgs](Tizen.UI.LongPressGestureDetectedEventArgs.md 'Tizen.UI.LongPressGestureDetectedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LottieAnimationView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LottieAnimationView.md new file mode 100644 index 0000000000..6fea5bd61c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LottieAnimationView.md @@ -0,0 +1,203 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## LottieAnimationView Class + +LottieAnimationView is a control for displaying Lottie animations. + +```csharp +public class LottieAnimationView : Tizen.UI.ImageView +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') 🡒 LottieAnimationView +### Constructors + + + +## LottieAnimationView() Constructor + +Creates a LottieAnimationView. + +```csharp +public LottieAnimationView(); +``` +### Properties + + + +## LottieAnimationView.CurrentFrame Property + +Gets or sets the current frame of the animation. + +```csharp +public int CurrentFrame { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieAnimationView.Loop Property + +Gets or sets whether the animation should loop. + +```csharp +public bool Loop { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## LottieAnimationView.PlayState Property + +Gets the current play state of the animation. + +```csharp +public Tizen.UI.AnimationState PlayState { get; } +``` + +#### Property Value +[AnimationState](Tizen.UI.AnimationState.md 'Tizen.UI.AnimationState') + + + +## LottieAnimationView.RepeatCount Property + +Gets or sets the number of times the animation should repeat. + +```csharp +public int RepeatCount { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## LottieAnimationView.RepeatMode Property + +Gets or sets the mode of animation repetition. + +```csharp +public Tizen.UI.AnimationRepeatMode RepeatMode { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationRepeatMode + + + +## LottieAnimationView.StopBehavior Property + +Gets or sets the behavior of the animation when it stops. + +```csharp +public Tizen.UI.AnimationStopBehavior StopBehavior { get; set; } +``` + +#### Property Value +Tizen.UI.AnimationStopBehavior + + + +## LottieAnimationView.TotalFrame Property + +Gets the total number of frames in the animation. + +```csharp +public int TotalFrame { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## LottieAnimationView.GetContentInfo() Method + +Gets the content information of the animation. + +```csharp +public System.Collections.Generic.IList<(string,int,int)> GetContentInfo(); +``` + +#### Returns +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[<](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[,](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ValueTuple 'System.ValueTuple')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') +of tuples containing the marker name, start frame, and end frame. + + + +## LottieAnimationView.Pause() Method + +Pauses the animation. + +```csharp +public override void Pause(); +``` + + + +## LottieAnimationView.Play() Method + +Plays the animation. + +```csharp +public override void Play(); +``` + + + +## LottieAnimationView.Play(int, int) Method + +Plays the animation with range. + +```csharp +public void Play(int startFrame, int endFrame=int.MaxValue); +``` +#### Parameters + + + +`startFrame` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The starting frame. + + + +`endFrame` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The ending frame. + + + +## LottieAnimationView.Stop() Method + +Stops the animation. + +```csharp +public override void Stop(); +``` +### Events + + + +## LottieAnimationView.Finished Event + +Event triggered when the animation finishes. + +```csharp +public event EventHandler Finished; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.MouseButton.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.MouseButton.md new file mode 100644 index 0000000000..00f696f9dc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.MouseButton.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## MouseButton Enum + +The MouseButton enum represents the different mouse buttons that can be pressed. + +```csharp +public enum MouseButton +``` +### Fields + + + +`Primary` 1 + +Primary(Left) mouse button. + + + +`Secondary` 3 + +Secondary(Right) mouse button. + + + +`Tertiary` 2 + +Center(Wheel) mouse button. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NObject.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NObject.md new file mode 100644 index 0000000000..cfd4fdd184 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NObject.md @@ -0,0 +1,135 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## NObject Class + +NObject is a base class for all objects in UI. + +```csharp +public abstract class NObject : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 NObject + +Derived +↳ [Animation](Tizen.UI.Animation.md 'Tizen.UI.Animation') +↳ [FocusManager](Tizen.UI.FocusManager.md 'Tizen.UI.FocusManager') +↳ [FontClient](Tizen.UI.FontClient.md 'Tizen.UI.FontClient') +↳ [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') +↳ [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') +↳ [HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') +↳ [ImageUrl](Tizen.UI.ImageUrl.md 'Tizen.UI.ImageUrl') +↳ [InputMethodContext](Tizen.UI.InputMethodContext.md 'Tizen.UI.InputMethodContext') +↳ [KeyEvent](Tizen.UI.KeyEvent.md 'Tizen.UI.KeyEvent') +↳ [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') +↳ [PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') +↳ [PixelData](Tizen.UI.PixelData.md 'Tizen.UI.PixelData') +↳ [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') +↳ [TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent') +↳ [TouchPoint](Tizen.UI.TouchPoint.md 'Tizen.UI.TouchPoint') +↳ [View](Tizen.UI.View.md 'Tizen.UI.View') +↳ [WheelEvent](Tizen.UI.WheelEvent.md 'Tizen.UI.WheelEvent') +↳ [Window](Tizen.UI.Window.md 'Tizen.UI.Window') + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties + + + +## NObject.Handle Property + +Gets the native object handle. + +```csharp +public System.IntPtr Handle { get; } +``` + +#### Property Value +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + + + +## NObject.HasOwnership Property + +Gets or sets a flag indicating whether the object owns the native handle. + +```csharp +public bool HasOwnership { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## NObject.IsDisposed Property + +Gets a value indicating whether the object has been disposed. + +```csharp +public bool IsDisposed { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the object has been disposed, otherwise false. +### Methods + + + +## NObject.Dispose() Method + +Disposes the object and releases all resources associated with it. + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + + + +## NObject.GetObjectFromNativeObject(IntPtr) Method + +Gets the managed object corresponding to the specified native object handle. + +```csharp +public static Tizen.UI.NObject GetObjectFromNativeObject(System.IntPtr nativeObj); +``` +#### Parameters + + + +`nativeObj` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The native object handle. + +#### Returns +[NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') +The managed object corresponding to the specified native object handle, or null if no managed object corresponds to the native object handle +### Operators + + + +## NObject.implicit operator IntPtr(NObject) Operator + +Provides an implicit conversion between [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') and [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr'). + +```csharp +public static System.IntPtr implicit operator IntPtr(Tizen.UI.NObject obj); +``` +#### Parameters + + + +`obj` [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + +The [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') instance to convert. + +#### Returns +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') +The [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') representation of the [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') instance. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ActorHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ActorHandle.md new file mode 100644 index 0000000000..65bd2e987a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ActorHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## ActorHandle Class + +Provides a handle to an actor object. + +```csharp +public class ActorHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 ActorHandle +### Constructors + + + +## ActorHandle() Constructor + +Initializes a new instance of the [ActorHandle](Tizen.UI.NativeHandle.ActorHandle.md 'Tizen.UI.NativeHandle.ActorHandle') class. + +```csharp +public ActorHandle(); +``` +### Properties + + + +## ActorHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.AnimatablePropertyHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.AnimatablePropertyHandle.md new file mode 100644 index 0000000000..f8a35020d1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.AnimatablePropertyHandle.md @@ -0,0 +1,41 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## AnimatablePropertyHandle Class + +AnimatablePropertyHandle is a wrapper class for a native AnimatableProperty handle. +It represents a handle to an AnimatableProperty object and provides methods to manage it. + +```csharp +public class AnimatablePropertyHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 AnimatablePropertyHandle +### Constructors + + + +## AnimatablePropertyHandle() Constructor + +Initializes a new instance of the AnimatablePropertyHandle class. + +```csharp +public AnimatablePropertyHandle(); +``` +### Properties + + + +## AnimatablePropertyHandle.IsInvalid Property + +Gets a value indicating whether the handle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ByteVectorHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ByteVectorHandle.md new file mode 100644 index 0000000000..3e725cccbe --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ByteVectorHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## ByteVectorHandle Class + +The ByteVectorHandle class represents a handle to a native ByteVector object. + +```csharp +public class ByteVectorHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 ByteVectorHandle +### Constructors + + + +## ByteVectorHandle() Constructor + +Initializes a new instance of the ByteVectorHandle class. + +```csharp +public ByteVectorHandle(); +``` +### Properties + + + +## ByteVectorHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.DegreeHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.DegreeHandle.md new file mode 100644 index 0000000000..1685eb063c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.DegreeHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## DegreeHandle Class + +Represents a handle to a native Degree object. + +```csharp +public class DegreeHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 DegreeHandle +### Constructors + + + +## DegreeHandle() Constructor + +Initializes a new instance of the [DegreeHandle](Tizen.UI.NativeHandle.DegreeHandle.md 'Tizen.UI.NativeHandle.DegreeHandle') class. + +```csharp +public DegreeHandle(); +``` +### Properties + + + +## DegreeHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ExtentsHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ExtentsHandle.md new file mode 100644 index 0000000000..363c05094a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ExtentsHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## ExtentsHandle Class + +The ExtentsHandle class represents a handle to a native Extents object. + +```csharp +public class ExtentsHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 ExtentsHandle +### Constructors + + + +## ExtentsHandle() Constructor + +Initializes a new instance of the ExtentsHandle class. + +```csharp +public ExtentsHandle(); +``` +### Properties + + + +## ExtentsHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.GeometryHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.GeometryHandle.md new file mode 100644 index 0000000000..a8b02b7e3e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.GeometryHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## GeometryHandle Class + +Provides a managed wrapper for the native Geometry object. + +```csharp +public class GeometryHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 GeometryHandle +### Constructors + + + +## GeometryHandle() Constructor + +Initializes a new instance of the GeometryHandle class. + +```csharp +public GeometryHandle(); +``` +### Properties + + + +## GeometryHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.KeyFramesHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.KeyFramesHandle.md new file mode 100644 index 0000000000..3595a7e2e8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.KeyFramesHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## KeyFramesHandle Class + +The KeyFramesHandle class represents a handle to a native KeyFrames object. + +```csharp +public class KeyFramesHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 KeyFramesHandle +### Constructors + + + +## KeyFramesHandle() Constructor + +Initializes a new instance of the KeyFramesHandle class. + +```csharp +public KeyFramesHandle(); +``` +### Properties + + + +## KeyFramesHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeBaseHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeBaseHandle.md new file mode 100644 index 0000000000..456e253d98 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeBaseHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## NativeBaseHandle Class + +NativeBaseHandle is a base class for managing native resources. + +```csharp +public class NativeBaseHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 NativeBaseHandle +### Constructors + + + +## NativeBaseHandle() Constructor + +Initializes a new instance of the NativeBaseHandle class. + +```csharp +public NativeBaseHandle(); +``` +### Properties + + + +## NativeBaseHandle.IsInvalid Property + +Gets a value indicating whether the handle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeHandleExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeHandleExtensions.md new file mode 100644 index 0000000000..3307181548 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeHandleExtensions.md @@ -0,0 +1,438 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## NativeHandleExtensions Class + +Provides extension methods for converting between native types and their managed equivalents. + +```csharp +public static class NativeHandleExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 NativeHandleExtensions +### Methods + + + +## NativeHandleExtensions.CheckException() Method + +Extension method for NativeHandle class to check for pending exceptions. + +```csharp +public static void CheckException(); +``` + + + +## NativeHandleExtensions.CheckException<T>(this T) Method + +Extension method for NativeHandle class to check for pending exceptions. + +```csharp +public static T CheckException<T>(this T v); +``` +#### Type parameters + + + +`T` + +The type of the object. +#### Parameters + + + +`v` [T](Tizen.UI.NativeHandle.NativeHandleExtensions.md#Tizen.UI.NativeHandle.NativeHandleExtensions.CheckException_T_(thisT).T 'Tizen.UI.NativeHandle.NativeHandleExtensions.CheckException<T>(this T).T') + +The object to check for pending exceptions. + +#### Returns +[T](Tizen.UI.NativeHandle.NativeHandleExtensions.md#Tizen.UI.NativeHandle.NativeHandleExtensions.CheckException_T_(thisT).T 'Tizen.UI.NativeHandle.NativeHandleExtensions.CheckException<T>(this T).T') +The original object. + + + +## NativeHandleExtensions.DegreeToRadian(this float) Method + +Converts the specified angle in degrees to radians. + +```csharp +public static Tizen.UI.NativeHandle.RadianHandle DegreeToRadian(this float degree); +``` +#### Parameters + + + +`degree` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle in degrees to convert. + +#### Returns +[RadianHandle](Tizen.UI.NativeHandle.RadianHandle.md 'Tizen.UI.NativeHandle.RadianHandle') +The angle in radians. + + + +## NativeHandleExtensions.RadianToDegree(this float) Method + +Converts the specified angle in radians to degrees. + +```csharp +public static float RadianToDegree(this float radians); +``` +#### Parameters + + + +`radians` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle in radians to convert. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The angle in degrees. + + + +## NativeHandleExtensions.ToColor(this ObjectPool<Vector4Handle>) Method + +Converts the specified [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object to a [Color](Tizen.UI.Color.md 'Tizen.UI.Color') value. + +```csharp +public static Tizen.UI.Color ToColor(this Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> vector); +``` +#### Parameters + + + +`vector` [Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') + +The vector to convert. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new [Color](Tizen.UI.Color.md 'Tizen.UI.Color') object containing the converted values. + + + +## NativeHandleExtensions.ToColor(this Vector4Handle) Method + +Converts the specified [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object to a [Color](Tizen.UI.Color.md 'Tizen.UI.Color') value. + +```csharp +public static Tizen.UI.Color ToColor(this Tizen.UI.NativeHandle.Vector4Handle vector); +``` +#### Parameters + + + +`vector` [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') + +The vector to convert. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +A new [Color](Tizen.UI.Color.md 'Tizen.UI.Color') object containing the converted values. + + + +## NativeHandleExtensions.ToCornerRadius(this ObjectPool<Vector4Handle>) Method + +Converts a Vector4Handle object from an ObjectPool to a CornerRadius. + +```csharp +public static Tizen.UI.CornerRadius ToCornerRadius(this Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> vector); +``` +#### Parameters + + + +`vector` [Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') + +The Vector4Handle object from the ObjectPool. + +#### Returns +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') +A CornerRadius object representing the corner radius values. + + + +## NativeHandleExtensions.ToCornerRadius(this Vector4Handle) Method + +Converts a Vector4Handle to a CornerRadius object. + +```csharp +public static Tizen.UI.CornerRadius ToCornerRadius(this Tizen.UI.NativeHandle.Vector4Handle vector); +``` +#### Parameters + + + +`vector` [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') + +The Vector4Handle to convert. + +#### Returns +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') +A CornerRadius object initialized with the values from the Vector4Handle. + + + +## NativeHandleExtensions.ToNative(this float) Method + +Creates a new [DegreeHandle](Tizen.UI.NativeHandle.DegreeHandle.md 'Tizen.UI.NativeHandle.DegreeHandle') object from the specified float value. + +```csharp +public static Tizen.UI.NativeHandle.DegreeHandle ToNative(this float degree); +``` +#### Parameters + + + +`degree` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle in degrees to convert. + +#### Returns +[DegreeHandle](Tizen.UI.NativeHandle.DegreeHandle.md 'Tizen.UI.NativeHandle.DegreeHandle') +A new [DegreeHandle](Tizen.UI.NativeHandle.DegreeHandle.md 'Tizen.UI.NativeHandle.DegreeHandle') object containing the float values. + + + +## NativeHandleExtensions.ToNative(this Color) Method + +Creates a new [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object from the specified [Color](Tizen.UI.Color.md 'Tizen.UI.Color') value. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> ToNative(this Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The color to convert. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object containing the color values. + + + +## NativeHandleExtensions.ToNative(this Color, Vector4Handle) Method + +Sets the values of the specified [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object from the given [Color](Tizen.UI.Color.md 'Tizen.UI.Color') value. + +```csharp +public static Tizen.UI.NativeHandle.Vector4Handle ToNative(this Tizen.UI.Color color, Tizen.UI.NativeHandle.Vector4Handle vector); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The color to convert. + + + +`vector` [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') + +The vector to set the values of. + +#### Returns +[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') +The specified [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object with its values set. + + + +## NativeHandleExtensions.ToNative(this CornerRadius) Method + +Creates a new [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object from the specified [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') value. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector4Handle> ToNative(this Tizen.UI.CornerRadius value); +``` +#### Parameters + + + +`value` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The corner radius to convert. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object containing the corner radius values. + + + +## NativeHandleExtensions.ToNative(this Point) Method + +Creates a new [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') object from the specified [Point](Tizen.UI.Point.md 'Tizen.UI.Point') value. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector2Handle> ToNative(this Tizen.UI.Point value); +``` +#### Parameters + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The point to convert. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') object containing the point values. + + + +## NativeHandleExtensions.ToNative(this Size) Method + +Creates a new [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') object from the specified [Size](Tizen.UI.Size.md 'Tizen.UI.Size') value. + +```csharp +public static Tizen.UI.Internal.ObjectPool<Tizen.UI.NativeHandle.Vector2Handle> ToNative(this Tizen.UI.Size value); +``` +#### Parameters + + + +`value` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size to convert. + +#### Returns +[Tizen.UI.Internal.ObjectPool<](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>')[Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle')[>](Tizen.UI.Internal.ObjectPool_T_.md 'Tizen.UI.Internal.ObjectPool<T>') +A new [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') object containing the size values. + + + +## NativeHandleExtensions.ToNativeRectangle(this Rect) Method + +Creates a new [RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') object from the specified [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') value. + +```csharp +public static Tizen.UI.NativeHandle.RectangleHandle ToNativeRectangle(this Tizen.UI.Rect rect); +``` +#### Parameters + + + +`rect` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The rect to convert. + +#### Returns +[RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') +A new [RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') object containing the rect values. + + + +## NativeHandleExtensions.ToNativeRectangle(this Thickness) Method + +Creates a new [RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') object from the specified [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') value. + +```csharp +public static Tizen.UI.NativeHandle.RectangleHandle ToNativeRectangle(this Tizen.UI.Thickness rect); +``` +#### Parameters + + + +`rect` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The thickness to convert. + +#### Returns +[RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') +A new [RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') object containing the thickness values. + + + +## NativeHandleExtensions.ToPoint(this Vector2Handle) Method + +Converts the specified [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') object to a [Point](Tizen.UI.Point.md 'Tizen.UI.Point') value. + +```csharp +public static Tizen.UI.Point ToPoint(this Tizen.UI.NativeHandle.Vector2Handle value); +``` +#### Parameters + + + +`value` [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') + +convert. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new [Point](Tizen.UI.Point.md 'Tizen.UI.Point') object containing the converted values. + + + +## NativeHandleExtensions.ToPoint(this Vector3Handle) Method + +Converts the specified [Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle') object to a [Point](Tizen.UI.Point.md 'Tizen.UI.Point') value. + +```csharp +public static Tizen.UI.Point ToPoint(this Tizen.UI.NativeHandle.Vector3Handle value); +``` +#### Parameters + + + +`value` [Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle') + +convert. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new [Point](Tizen.UI.Point.md 'Tizen.UI.Point') object containing the converted values. + + + +## NativeHandleExtensions.ToRect(this Vector4Handle) Method + +Converts the specified [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') object to a [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') value. + +```csharp +public static Tizen.UI.Rect ToRect(this Tizen.UI.NativeHandle.Vector4Handle vector); +``` +#### Parameters + + + +`vector` [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') + +The vector to convert. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') object containing the converted values. + + + +## NativeHandleExtensions.ToSize(this Vector3Handle) Method + +Converts the specified [Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle') object to a [Size](Tizen.UI.Size.md 'Tizen.UI.Size') value. + +```csharp +public static Tizen.UI.Size ToSize(this Tizen.UI.NativeHandle.Vector3Handle vector); +``` +#### Parameters + + + +`vector` [Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle') + +The vector to convert. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +A new [Size](Tizen.UI.Size.md 'Tizen.UI.Size') object containing the converted values. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md new file mode 100644 index 0000000000..da978cc1d2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## NativeImageSourceWrapperHandle Class + +Provides a handle to an NativeImageSourceWrapper object. + +```csharp +public class NativeImageSourceWrapperHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 NativeImageSourceWrapperHandle +### Constructors + + + +## NativeImageSourceWrapperHandle() Constructor + +Initializes a new instance of the [NativeImageSourceWrapperHandle](Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md 'Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle') class. + +```csharp +public NativeImageSourceWrapperHandle(); +``` +### Properties + + + +## NativeImageSourceWrapperHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayExtensions.md new file mode 100644 index 0000000000..2056b458ed --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayExtensions.md @@ -0,0 +1,66 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyArrayExtensions Class + +Extension methods for the PropertyArrayHandle class. + +```csharp +public static class PropertyArrayExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PropertyArrayExtensions +### Methods + + + +## PropertyArrayExtensions.Add(this PropertyArrayHandle, PropertyValueHandle) Method + +Adds a new property value to the end of the array. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyArrayHandle handle, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`handle` [PropertyArrayHandle](Tizen.UI.NativeHandle.PropertyArrayHandle.md 'Tizen.UI.NativeHandle.PropertyArrayHandle') + +The PropertyArrayHandle instance. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle instance to add. + + + +## PropertyArrayExtensions.GetAt(this PropertyArrayHandle, int) Method + +Gets the property value at the specified index. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle GetAt(this Tizen.UI.NativeHandle.PropertyArrayHandle handle, int index); +``` +#### Parameters + + + +`handle` [PropertyArrayHandle](Tizen.UI.NativeHandle.PropertyArrayHandle.md 'Tizen.UI.NativeHandle.PropertyArrayHandle') + +The PropertyArrayHandle instance. + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the property value to get. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +The PropertyValueHandle instance at the specified index. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayHandle.md new file mode 100644 index 0000000000..641911d2d7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyArrayHandle Class + +Provides a safe handle for a property array. + +```csharp +public class PropertyArrayHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 PropertyArrayHandle +### Constructors + + + +## PropertyArrayHandle() Constructor + +Initializes a new instance of the [PropertyArrayHandle](Tizen.UI.NativeHandle.PropertyArrayHandle.md 'Tizen.UI.NativeHandle.PropertyArrayHandle') class. + +```csharp +public PropertyArrayHandle(); +``` +### Properties + + + +## PropertyArrayHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyKeyHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyKeyHandle.md new file mode 100644 index 0000000000..f19079a34a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyKeyHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyKeyHandle Class + +Represents a handle to a native PropertyKey object. + +```csharp +public class PropertyKeyHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 PropertyKeyHandle +### Constructors + + + +## PropertyKeyHandle() Constructor + +Initializes a new instance of the PropertyKeyHandle class. + +```csharp +public PropertyKeyHandle(); +``` +### Properties + + + +## PropertyKeyHandle.IsInvalid Property + +Gets a value indicating whether the PropertyKeyHandle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandle.md new file mode 100644 index 0000000000..360ed08a53 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyMapHandle Class + +Represents a handle to a native PropertyMap object. + +```csharp +public class PropertyMapHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 PropertyMapHandle +### Constructors + + + +## PropertyMapHandle() Constructor + +Initializes a new instance of the [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') class. + +```csharp +public PropertyMapHandle(); +``` +### Properties + + + +## PropertyMapHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md new file mode 100644 index 0000000000..66ad4a64e1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md @@ -0,0 +1,986 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyMapHandleExtensions Class + +Provides a set of extension methods for the [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') class. + +```csharp +public static class PropertyMapHandleExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PropertyMapHandleExtensions +### Methods + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, bool) Method + +Adds a boolean key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, bool value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, float) Method + +Adds a float key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, float value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, int) Method + +Adds an integer key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, int value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, string) Method + +Adds a string key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, string value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, Color) Method + +Adds a color key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Color value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, PropertyMapHandle) Method + +Sets an integer key-value pair in the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.NativeHandle.PropertyMapHandle value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, PropertyValueHandle) Method + +Adds a property map key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, Point) Method + +Adds a point key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Point value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, int, Size) Method + +Adds a size key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Size value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, string, bool) Method + +Adds a boolean key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, bool value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, string, float) Method + +Adds a float key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, float value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, string, int) Method + +Adds a int key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, int value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, string, Color) Method + +Adds a color key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, Tizen.UI.Color value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The value. + + + +## PropertyMapHandleExtensions.Add(this PropertyMapHandle, string, Point) Method + +Adds a point key-value pair to the property map. + +```csharp +public static void Add(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, Tizen.UI.Point value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The value. + + + +## PropertyMapHandleExtensions.Find(this PropertyMapHandle, int) Method + +Finds the property value with the specified key in the given property map. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle Find(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key of the property value to find. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +The property value handle if found, otherwise null. + + + +## PropertyMapHandleExtensions.Find(this PropertyMapHandle, string) Method + +Finds the property value with the specified key in the given property map. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle Find(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key of the property value to find. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +The property value handle if found, otherwise null. + + + +## PropertyMapHandleExtensions.Remove(this PropertyMapHandle, int) Method + +Removes the specified key and its associated value from the property map. + +```csharp +public static void Remove(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to remove. + + + +## PropertyMapHandleExtensions.Remove(this PropertyMapHandle, string) Method + +Removes the specified key and its value from the property map. + +```csharp +public static void Remove(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to be removed. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, bool) Method + +Sets a boolean value with the specified key in the map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, bool value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to associate the value with. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The boolean value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, float) Method + +Sets a float value with the specified key in the given property map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, float value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to associate the float value with. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The float value to set in the property map. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, int) Method + +Sets an extent key-value pair in the property map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, int value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The value. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, string) Method + +Sets the value of the specified key in. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, string value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, Color) Method + +Sets the specified key-value pair in the given property map handle. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Color value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, CornerRadius) Method + +Sets the value of the specified key in the map to a corner radius value. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.CornerRadius value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set the value for. + + + +`value` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The corner radius value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, PropertyMapHandle) Method + +Sets an integer key-value pair in the property map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.NativeHandle.PropertyMapHandle value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key. + + + +`value` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The value. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, PropertyValueHandle) Method + +Sets the property value for the specified key in the given property map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.NativeHandle.PropertyValueHandle value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set the value for. + + + +`value` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The property value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, Point) Method + +Sets the value of the specified key in the map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Point value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, Rect) Method + +Sets the value of the specified key in the map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Rect value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set. + + + +`value` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, int, Thickness) Method + +Sets the value of the specified property. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, int key, Tizen.UI.Thickness value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key to set. + + + +`value` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, string, bool) Method + +Sets a boolean value with the specified key in the map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, bool value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to associate the value with. + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The boolean value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, string, float) Method + +Sets the float value for the specified key in the map. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, float value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to set the value for. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The float value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, string, string) Method + +Sets the value of the specified key as a string. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, string value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to set. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, string, Color) Method + +Sets the specified key-value pair in the given property map handle. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, Tizen.UI.Color value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to set. + + + +`value` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The value to set. + + + +## PropertyMapHandleExtensions.Set(this PropertyMapHandle, string, Point) Method + +Sets the value of the specified key in the map to the given point value. + +```csharp +public static void Set(this Tizen.UI.NativeHandle.PropertyMapHandle handle, string key, Tizen.UI.Point value); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap handle. + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key to set the value for. + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The point value to set. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandle.md new file mode 100644 index 0000000000..99d4b77341 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandle.md @@ -0,0 +1,63 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyValueHandle Class + +Represents a handle to a property value. + +```csharp +public class PropertyValueHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 PropertyValueHandle +### Constructors + + + +## PropertyValueHandle() Constructor + +Initializes a new instance of the [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') class. + +```csharp +public PropertyValueHandle(); +``` + + + +## PropertyValueHandle(IntPtr, bool) Constructor + +Initializes a new instance of the [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') class with the specified handle and ownership. + +```csharp +public PropertyValueHandle(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle to the property value. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the handle is owned by this instance. +### Properties + + + +## PropertyValueHandle.IsInvalid Property + +Gets a value indicating whether the handle is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md new file mode 100644 index 0000000000..a52c8c8fa2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md @@ -0,0 +1,576 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## PropertyValueHandleExtensions Class + +Provides extension methods for converting objects to PropertyValue types. + +```csharp +public static class PropertyValueHandleExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PropertyValueHandleExtensions +### Methods + + + +## PropertyValueHandleExtensions.ToColor(this PropertyValueHandle) Method + +Extension method for converting a PropertyValueHandle to a Color. + +```csharp +public static Tizen.UI.Color ToColor(this Tizen.UI.NativeHandle.PropertyValueHandle handle); +``` +#### Parameters + + + +`handle` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle object to convert. + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') +The Color representation of the PropertyValueHandle. + + + +## PropertyValueHandleExtensions.ToCornerRadius(this PropertyValueHandle) Method + +Extension method for converting a PropertyValueHandle to a CornerRadius. + +```csharp +public static Tizen.UI.CornerRadius ToCornerRadius(this Tizen.UI.NativeHandle.PropertyValueHandle handle); +``` +#### Parameters + + + +`handle` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle object to convert. + +#### Returns +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') +The CornerRadius representation of the PropertyValueHandle. + + + +## PropertyValueHandleExtensions.ToFloat(this PropertyValueHandle) Method + +Extension method for converting a PropertyValueHandle object to a float value. + +```csharp +public static float ToFloat(this Tizen.UI.NativeHandle.PropertyValueHandle handle); +``` +#### Parameters + + + +`handle` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle object to convert. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The float value represented by the PropertyValueHandle object. + + + +## PropertyValueHandleExtensions.ToInt(this PropertyValueHandle) Method + +Extension method for converting a PropertyValueHandle to an integer value. + +```csharp +public static int ToInt(this Tizen.UI.NativeHandle.PropertyValueHandle handle); +``` +#### Parameters + + + +`handle` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle object to convert. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The integer value represented by the PropertyValueHandle. + + + +## PropertyValueHandleExtensions.ToRectangleValue(this Thickness) Method + +Extension method for converting a Thickness struct into a PropertyValueHandle (Rect). + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToRectangleValue(this Tizen.UI.Thickness value); +``` +#### Parameters + + + +`value` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The Thickness struct to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle (Rect) containing the converted Thickness struct. + + + +## PropertyValueHandleExtensions.ToStr(this PropertyValueHandle) Method + +Extension method for converting a PropertyValueHandle to a string. + +```csharp +public static string ToStr(this Tizen.UI.NativeHandle.PropertyValueHandle handle); +``` +#### Parameters + + + +`handle` [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + +The PropertyValueHandle object to convert. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The string representation of the PropertyValueHandle. + + + +## PropertyValueHandleExtensions.ToValue(this bool) Method + +Creates a new PropertyValue handle from the given boolean value. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this bool value); +``` +#### Parameters + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +The boolean value to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValue handle representing the boolean value. + + + +## PropertyValueHandleExtensions.ToValue(this int) Method + +Extension method for converting an integer value to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this int value); +``` +#### Parameters + + + +`value` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The integer value to be converted. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle object containing the integer value. + + + +## PropertyValueHandleExtensions.ToValue(this object, bool) Method + +Converts an object to a PropertyValueHandle. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this object value, bool useVector3=false); +``` +#### Parameters + + + +`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to convert. + + + +`useVector3` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle containing the converted value. + + + +## PropertyValueHandleExtensions.ToValue(this AutoFontSize) Method + +Converts an AutoFontSize to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.AutoFontSize autoSize); +``` +#### Parameters + + + +`autoSize` [AutoFontSize](Tizen.UI.AutoFontSize.md 'Tizen.UI.AutoFontSize') + +The AutoFontSize to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the AutoFontSize. + + + +## PropertyValueHandleExtensions.ToValue(this Background) Method + +Converts a Background to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Background background); +``` +#### Parameters + + + +`background` [Background](Tizen.UI.Background.md 'Tizen.UI.Background') + +The Background to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the Background. + + + +## PropertyValueHandleExtensions.ToValue(this Color) Method + +Extension method for converting a Color object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The Color object to be converted. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle object representing the given Color. + + + +## PropertyValueHandleExtensions.ToValue(this Color, bool) Method + +Extension method for converting a Color object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Color color, bool useVector3); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The Color object to be converted. + + + +`useVector3` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle object representing the given Color. + + + +## PropertyValueHandleExtensions.ToValue(this CornerRadius) Method + +Converts a [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') struct into a [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.CornerRadius value); +``` +#### Parameters + + + +`value` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') struct to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') object representing the given [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') struct. + + + +## PropertyValueHandleExtensions.ToValue(this HiddenInputSetting) Method + +Converts a HiddenInputSetting to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.HiddenInputSetting setting); +``` +#### Parameters + + + +`setting` [HiddenInputSetting](Tizen.UI.HiddenInputSetting.md 'Tizen.UI.HiddenInputSetting') + +The HiddenInputSetting to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the HiddenInputSetting. + + + +## PropertyValueHandleExtensions.ToValue(this InputMethodSetting) Method + +Converts an InputMethodSetting to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.InputMethodSetting setting); +``` +#### Parameters + + + +`setting` [InputMethodSetting](Tizen.UI.InputMethodSetting.md 'Tizen.UI.InputMethodSetting') + +The InputMethodSetting to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the InputMethodSetting. + + + +## PropertyValueHandleExtensions.ToValue(this PropertyArrayHandle) Method + +Converts a PropertyArray to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.NativeHandle.PropertyArrayHandle handle); +``` +#### Parameters + + + +`handle` [PropertyArrayHandle](Tizen.UI.NativeHandle.PropertyArrayHandle.md 'Tizen.UI.NativeHandle.PropertyArrayHandle') + +The PropertyArray to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the PropertyArray. + + + +## PropertyValueHandleExtensions.ToValue(this PropertyMapHandle) Method + +Converts a PropertyMap to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.NativeHandle.PropertyMapHandle handle); +``` +#### Parameters + + + +`handle` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The PropertyMap to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the PropertyMap. + + + +## PropertyValueHandleExtensions.ToValue(this Outline) Method + +Converts an Outline to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Outline outline); +``` +#### Parameters + + + +`outline` [Outline](Tizen.UI.Outline.md 'Tizen.UI.Outline') + +The Outline to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the Outline. + + + +## PropertyValueHandleExtensions.ToValue(this Point, bool) Method + +Extension method for converting a Point object to a PropertyValueHandle object. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Point value, bool useVector3=false); +``` +#### Parameters + + + +`value` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The Position object to be converted. + + + +`useVector3` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Indicates whether to use Vector3 or not. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle object representing the given Position object. + + + +## PropertyValueHandleExtensions.ToValue(this Rect) Method + +Extension method for converting a Rect struct into a PropertyValueHandle. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Rect value); +``` +#### Parameters + + + +`value` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The Rect struct to be converted. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle containing the converted data. + + + +## PropertyValueHandleExtensions.ToValue(this Shadow) Method + +Converts a Shadow to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Shadow shadow); +``` +#### Parameters + + + +`shadow` [Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') + +The Shadow to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the Shadow. + + + +## PropertyValueHandleExtensions.ToValue(this Size) Method + +Extension method for converting a Size struct to a PropertyValueHandle. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Size value); +``` +#### Parameters + + + +`value` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The Size struct to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle containing the converted value. + + + +## PropertyValueHandleExtensions.ToValue(this TextShadow) Method + +Converts a TextShadow to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.TextShadow shadow); +``` +#### Parameters + + + +`shadow` [TextShadow](Tizen.UI.TextShadow.md 'Tizen.UI.TextShadow') + +The TextShadow to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the TextShadow. + + + +## PropertyValueHandleExtensions.ToValue(this Thickness) Method + +Extension method for converting a Thickness struct into a PropertyValueHandle (Vector4). + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Thickness value); +``` +#### Parameters + + + +`value` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The Thickness struct to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A new PropertyValueHandle (Vector4) containing the converted Thickness struct. + + + +## PropertyValueHandleExtensions.ToValue(this Underline) Method + +Converts an Underline to a PropertyValue. + +```csharp +public static Tizen.UI.NativeHandle.PropertyValueHandle ToValue(this Tizen.UI.Underline underline); +``` +#### Parameters + + + +`underline` [Underline](Tizen.UI.Underline.md 'Tizen.UI.Underline') + +The Underline to convert. + +#### Returns +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +A PropertyValue containing the same data as the Underline. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RadianHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RadianHandle.md new file mode 100644 index 0000000000..08b01e3d08 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RadianHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## RadianHandle Class + +Represents a handle to a native Radian object. + +```csharp +public class RadianHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 RadianHandle +### Constructors + + + +## RadianHandle() Constructor + +Initializes a new instance of the [RadianHandle](Tizen.UI.NativeHandle.RadianHandle.md 'Tizen.UI.NativeHandle.RadianHandle') class. + +```csharp +public RadianHandle(); +``` +### Properties + + + +## RadianHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RectangleHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RectangleHandle.md new file mode 100644 index 0000000000..f91ec25a82 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RectangleHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## RectangleHandle Class + +The RectangleHandle class represents a native handle for a rectangle object. + +```csharp +public class RectangleHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 RectangleHandle +### Constructors + + + +## RectangleHandle() Constructor + +Initializes a new instance of the RectangleHandle class. + +```csharp +public RectangleHandle(); +``` +### Properties + + + +## RectangleHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RendererHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RendererHandle.md new file mode 100644 index 0000000000..9ac162cbaf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RendererHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## RendererHandle Class + +RendererHandle is a class that represents a handle to a native renderer object. + +```csharp +public class RendererHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 RendererHandle +### Constructors + + + +## RendererHandle() Constructor + +Initializes a new instance of the RendererHandle class. + +```csharp +public RendererHandle(); +``` +### Properties + + + +## RendererHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RotationHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RotationHandle.md new file mode 100644 index 0000000000..ea2892ccd0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RotationHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## RotationHandle Class + +The RotationHandle class provides a handle for rotating a view. + +```csharp +public class RotationHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 RotationHandle +### Constructors + + + +## RotationHandle() Constructor + +Initializes a new instance of the RotationHandle class. + +```csharp +public RotationHandle(); +``` +### Properties + + + +## RotationHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.StyleManagerHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.StyleManagerHandle.md new file mode 100644 index 0000000000..f0bb08d5d3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.StyleManagerHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## StyleManagerHandle Class + +StyleManagerHandle is a class that represents a handle to the StyleManager. + +```csharp +public class StyleManagerHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 StyleManagerHandle +### Constructors + + + +## StyleManagerHandle() Constructor + +Initializes a new instance of the StyleManagerHandle class. + +```csharp +public StyleManagerHandle(); +``` +### Properties + + + +## StyleManagerHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.TimePeriodHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.TimePeriodHandle.md new file mode 100644 index 0000000000..a32a735bb9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.TimePeriodHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## TimePeriodHandle Class + +TimePeriodHandle is a class that represents a native handle for time period. + +```csharp +public class TimePeriodHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 TimePeriodHandle +### Constructors + + + +## TimePeriodHandle() Constructor + +Initializes a new instance of the TimePeriodHandle class. + +```csharp +public TimePeriodHandle(); +``` +### Properties + + + +## TimePeriodHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector2Handle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector2Handle.md new file mode 100644 index 0000000000..3d27b5b586 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector2Handle.md @@ -0,0 +1,63 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## Vector2Handle Class + +The Vector2Handle class represents a handle to a native vector2 object. + +```csharp +public class Vector2Handle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 Vector2Handle +### Constructors + + + +## Vector2Handle() Constructor + +Initializes a new instance of the Vector2Handle class. + +```csharp +public Vector2Handle(); +``` + + + +## Vector2Handle(IntPtr, bool) Constructor + +Initializes a new instance of the [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') class. + +```csharp +public Vector2Handle(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The pointer to the native handle. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the handle is owned by the current instance. +### Properties + + + +## Vector2Handle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector3Handle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector3Handle.md new file mode 100644 index 0000000000..68f8690c63 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector3Handle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## Vector3Handle Class + +The Vector3Handle class represents a handle to a native Vector3 object. + +```csharp +public class Vector3Handle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 Vector3Handle +### Constructors + + + +## Vector3Handle() Constructor + +Initializes a new instance of the Vector3Handle class. + +```csharp +public Vector3Handle(); +``` +### Properties + + + +## Vector3Handle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector4Handle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector4Handle.md new file mode 100644 index 0000000000..950a2c4d1a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector4Handle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## Vector4Handle Class + +The Vector4Handle class represents a handle to a native Vector4 object. + +```csharp +public class Vector4Handle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 Vector4Handle +### Constructors + + + +## Vector4Handle() Constructor + +Initializes a new instance of the Vector4Handle class. + +```csharp +public Vector4Handle(); +``` +### Properties + + + +## Vector4Handle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.WindowBlurHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.WindowBlurHandle.md new file mode 100644 index 0000000000..bf907e12bd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.WindowBlurHandle.md @@ -0,0 +1,40 @@ +### [Tizen.UI.NativeHandle](Tizen.UI.NativeHandle.md 'Tizen.UI.NativeHandle') + +## WindowBlurHandle Class + +The WindowBlurHandle class represents a native handle for a WindowBlur object. + +```csharp +public class WindowBlurHandle : System.Runtime.InteropServices.SafeHandle +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Runtime.ConstrainedExecution.CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.ConstrainedExecution.CriticalFinalizerObject 'System.Runtime.ConstrainedExecution.CriticalFinalizerObject') 🡒 [System.Runtime.InteropServices.SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.SafeHandle 'System.Runtime.InteropServices.SafeHandle') 🡒 WindowBlurHandle +### Constructors + + + +## WindowBlurHandle() Constructor + +Initializes a new instance of the WindowBlurHandle class. + +```csharp +public WindowBlurHandle(); +``` +### Properties + + + +## WindowBlurHandle.IsInvalid Property + +Gets a value indicating whether this instance is invalid. + +```csharp +public override bool IsInvalid { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.md new file mode 100644 index 0000000000..cd46382564 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.md @@ -0,0 +1,37 @@ + +## Tizen.UI.NativeHandle Namespace + +| Classes | | +| :--- | :--- | +| [ActorHandle](Tizen.UI.NativeHandle.ActorHandle.md 'Tizen.UI.NativeHandle.ActorHandle') | Provides a handle to an actor object. | +| [AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') | AnimatablePropertyHandle is a wrapper class for a native AnimatableProperty handle.
It represents a handle to an AnimatableProperty object and provides methods to manage it. | +| [ByteVectorHandle](Tizen.UI.NativeHandle.ByteVectorHandle.md 'Tizen.UI.NativeHandle.ByteVectorHandle') | The ByteVectorHandle class represents a handle to a native ByteVector object. | +| [DegreeHandle](Tizen.UI.NativeHandle.DegreeHandle.md 'Tizen.UI.NativeHandle.DegreeHandle') | Represents a handle to a native Degree object. | +| [ExtentsHandle](Tizen.UI.NativeHandle.ExtentsHandle.md 'Tizen.UI.NativeHandle.ExtentsHandle') | The ExtentsHandle class represents a handle to a native Extents object. | +| [GeometryHandle](Tizen.UI.NativeHandle.GeometryHandle.md 'Tizen.UI.NativeHandle.GeometryHandle') | Provides a managed wrapper for the native Geometry object. | +| [KeyFramesHandle](Tizen.UI.NativeHandle.KeyFramesHandle.md 'Tizen.UI.NativeHandle.KeyFramesHandle') | The KeyFramesHandle class represents a handle to a native KeyFrames object. | +| [NativeBaseHandle](Tizen.UI.NativeHandle.NativeBaseHandle.md 'Tizen.UI.NativeHandle.NativeBaseHandle') | NativeBaseHandle is a base class for managing native resources. | +| [NativeHandleExtensions](Tizen.UI.NativeHandle.NativeHandleExtensions.md 'Tizen.UI.NativeHandle.NativeHandleExtensions') | Provides extension methods for converting between native types and their managed equivalents. | +| [NativeImageSourceWrapperHandle](Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md 'Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle') | Provides a handle to an NativeImageSourceWrapper object. | +| [PropertyArrayExtensions](Tizen.UI.NativeHandle.PropertyArrayExtensions.md 'Tizen.UI.NativeHandle.PropertyArrayExtensions') | Extension methods for the PropertyArrayHandle class. | +| [PropertyArrayHandle](Tizen.UI.NativeHandle.PropertyArrayHandle.md 'Tizen.UI.NativeHandle.PropertyArrayHandle') | Provides a safe handle for a property array. | +| [PropertyKeyHandle](Tizen.UI.NativeHandle.PropertyKeyHandle.md 'Tizen.UI.NativeHandle.PropertyKeyHandle') | Represents a handle to a native PropertyKey object. | +| [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') | Represents a handle to a native PropertyMap object. | +| [PropertyMapHandleExtensions](Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md 'Tizen.UI.NativeHandle.PropertyMapHandleExtensions') | Provides a set of extension methods for the [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') class. | +| [PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') | Represents a handle to a property value. | +| [PropertyValueHandleExtensions](Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md 'Tizen.UI.NativeHandle.PropertyValueHandleExtensions') | Provides extension methods for converting objects to PropertyValue types. | +| [RadianHandle](Tizen.UI.NativeHandle.RadianHandle.md 'Tizen.UI.NativeHandle.RadianHandle') | Represents a handle to a native Radian object. | +| [RectangleHandle](Tizen.UI.NativeHandle.RectangleHandle.md 'Tizen.UI.NativeHandle.RectangleHandle') | The RectangleHandle class represents a native handle for a rectangle object. | +| [RendererHandle](Tizen.UI.NativeHandle.RendererHandle.md 'Tizen.UI.NativeHandle.RendererHandle') | RendererHandle is a class that represents a handle to a native renderer object. | +| [RotationHandle](Tizen.UI.NativeHandle.RotationHandle.md 'Tizen.UI.NativeHandle.RotationHandle') | The RotationHandle class provides a handle for rotating a view. | +| [StyleManagerHandle](Tizen.UI.NativeHandle.StyleManagerHandle.md 'Tizen.UI.NativeHandle.StyleManagerHandle') | StyleManagerHandle is a class that represents a handle to the StyleManager. | +| [TimePeriodHandle](Tizen.UI.NativeHandle.TimePeriodHandle.md 'Tizen.UI.NativeHandle.TimePeriodHandle') | TimePeriodHandle is a class that represents a native handle for time period. | +| [Vector2Handle](Tizen.UI.NativeHandle.Vector2Handle.md 'Tizen.UI.NativeHandle.Vector2Handle') | The Vector2Handle class represents a handle to a native vector2 object. | +| [Vector3Handle](Tizen.UI.NativeHandle.Vector3Handle.md 'Tizen.UI.NativeHandle.Vector3Handle') | The Vector3Handle class represents a handle to a native Vector3 object. | +| [Vector4Handle](Tizen.UI.NativeHandle.Vector4Handle.md 'Tizen.UI.NativeHandle.Vector4Handle') | The Vector4Handle class represents a handle to a native Vector4 object. | +| [WindowBlurHandle](Tizen.UI.NativeHandle.WindowBlurHandle.md 'Tizen.UI.NativeHandle.WindowBlurHandle') | The WindowBlurHandle class represents a native handle for a WindowBlur object. | + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OpacityPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OpacityPropertyValue.md new file mode 100644 index 0000000000..a9761691e8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OpacityPropertyValue.md @@ -0,0 +1,84 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## OpacityPropertyValue Class + +OpacityPropertyValue is a class that represents the opacity property value for an AnimatableProperty. + +```csharp +public class OpacityPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 OpacityPropertyValue +### Constructors + + + +## OpacityPropertyValue(float) Constructor + +Initializes a new instance of the OpacityPropertyValue class. + +```csharp +public OpacityPropertyValue(float opacity); +``` +#### Parameters + + + +`opacity` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The opacity value. +### Properties + + + +## OpacityPropertyValue.Opacity Property + +Gets the opacity value. + +```csharp +public float Opacity { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## OpacityPropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## OpacityPropertyValue.GetTargetProperty(View) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to animate. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The AnimatablePropertyHandle for the target property. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OriginPoint.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OriginPoint.md new file mode 100644 index 0000000000..a17329e8d5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OriginPoint.md @@ -0,0 +1,135 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## OriginPoint Class + +Provides a set of predefined points for the origin position of an object. + +```csharp +public static class OriginPoint +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 OriginPoint +### Properties + + + +## OriginPoint.BottomCenter Property + +Gets the point representing the bottom center of an object. + +```csharp +public static Tizen.UI.Point BottomCenter { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.BottomLeft Property + +Gets the point representing the bottom left corner of an object. + +```csharp +public static Tizen.UI.Point BottomLeft { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.BottomRight Property + +Gets the point representing the bottom right corner of an object. + +```csharp +public static Tizen.UI.Point BottomRight { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.Center Property + +Gets the point representing the center of an object. + +```csharp +public static Tizen.UI.Point Center { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.CenterLeft Property + +Gets the point representing the center left of an object. + +```csharp +public static Tizen.UI.Point CenterLeft { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.CenterRight Property + +Gets the point representing the center right of an object. + +```csharp +public static Tizen.UI.Point CenterRight { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.TopCenter Property + +Gets the point representing the top center of an object. + +```csharp +public static Tizen.UI.Point TopCenter { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.TopLeft Property + +Gets the point representing the top left corner of an object. + +```csharp +public static Tizen.UI.Point TopLeft { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## OriginPoint.TopRight Property + +Gets the point representing the top right corner of an object. + +```csharp +public static Tizen.UI.Point TopRight { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Outline.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Outline.md new file mode 100644 index 0000000000..bd6d2a4366 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Outline.md @@ -0,0 +1,66 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Outline Struct + +The Outline struct represents the outline property of a view. + +```csharp +public struct Outline +``` +### Properties + + + +## Outline.BlurRadius Property + +Gets or sets the blur radius of the outline. + +```csharp +public System.Nullable<float> BlurRadius { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Outline.Color Property + +Gets or sets the color of the outline. + +```csharp +public System.Nullable<Tizen.UI.Color> Color { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Outline.Offset Property + +Gets or sets the offsetWidth of the outline. + +```csharp +public System.Nullable<Tizen.UI.Point> Offset { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Point](Tizen.UI.Point.md 'Tizen.UI.Point')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Outline.Width Property + +Gets or sets the width of the outline. + +```csharp +public System.Nullable<float> Width { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGesture.md new file mode 100644 index 0000000000..225fbebbf3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGesture.md @@ -0,0 +1,133 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PanGesture Class + +The PanGesture class represents a pan gesture event. + +```csharp +public class PanGesture : Tizen.UI.Gesture +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') 🡒 PanGesture +### Constructors + + + +## PanGesture(IntPtr, bool) Constructor + +Initializes a new instance of the PanGesture class. + +```csharp +public PanGesture(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the native pan gesture. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the handle is owned by the new instance. +### Properties + + + +## PanGesture.Displacement Property + +Gets the displacement of the pan gesture. + +```csharp +public Tizen.UI.Point Displacement { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PanGesture.NumberOfTouches Property + +Gets the number of touches of the pan gesture. + +```csharp +public int NumberOfTouches { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PanGesture.Position Property + +Gets the position of the pan gesture. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PanGesture.ScreenDisplacement Property + +Gets the screen displacement of the pan gesture. + +```csharp +public Tizen.UI.Point ScreenDisplacement { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PanGesture.ScreenPosition Property + +Gets the screen position of the pan gesture. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PanGesture.ScreenVelocity Property + +Gets the screen velocity of the pan gesture. + +```csharp +public Tizen.UI.Point ScreenVelocity { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PanGesture.Velocity Property + +Gets the velocity of the pan gesture. + +```csharp +public Tizen.UI.Point Velocity { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetectedEventArgs.md new file mode 100644 index 0000000000..59e51bb5ce --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetectedEventArgs.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PanGestureDetectedEventArgs Class + +Event arguments for [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') event. + +```csharp +public class PanGestureDetectedEventArgs : Tizen.UI.GestureDetectedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') 🡒 PanGestureDetectedEventArgs +### Constructors + + + +## PanGestureDetectedEventArgs(View, PanGesture) Constructor + +Initializes a new instance of the [PanGestureDetectedEventArgs](Tizen.UI.PanGestureDetectedEventArgs.md 'Tizen.UI.PanGestureDetectedEventArgs') class. + +```csharp +public PanGestureDetectedEventArgs(Tizen.UI.View view, Tizen.UI.PanGesture gesture); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view that detected the [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture'). + + + +`gesture` [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') + +The [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') object that contains information about the detected gesture. +### Properties + + + +## PanGestureDetectedEventArgs.Gesture Property + +Gets the [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') object that contains information about the detected gesture. + +```csharp +public Tizen.UI.PanGesture Gesture { get; } +``` + +#### Property Value +[PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetector.md new file mode 100644 index 0000000000..38b378c8d3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetector.md @@ -0,0 +1,82 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PanGestureDetector Class + +The PanGestureDetector class is used to detect panning gestures on a View. + +```csharp +public class PanGestureDetector : Tizen.UI.GestureDetector +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') 🡒 PanGestureDetector +### Constructors + + + +## PanGestureDetector() Constructor + +Creates a new PanGestureDetector. + +```csharp +public PanGestureDetector(); +``` +### Properties + + + +## PanGestureDetector.Direction Property + +Gets or sets the direction of the pan gesture to detect. + +```csharp +public Tizen.UI.PanGestureDirection Direction { get; set; } +``` + +#### Property Value +[PanGestureDirection](Tizen.UI.PanGestureDirection.md 'Tizen.UI.PanGestureDirection') + + + +## PanGestureDetector.MaximumTouchesRequired Property + +Gets or sets the maximum number of touches required to recognize a pan gesture. + +```csharp +public int MaximumTouchesRequired { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PanGestureDetector.MinimumTouchesRequired Property + +Gets or sets the minimum number of touches required to recognize a pan gesture. + +```csharp +public int MinimumTouchesRequired { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## PanGestureDetector.Detected Event + +Event triggered when a pan gesture is detected on the attached View. + +```csharp +public event EventHandler<PanGestureDetectedEventArgs> Detected; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[PanGestureDetectedEventArgs](Tizen.UI.PanGestureDetectedEventArgs.md 'Tizen.UI.PanGestureDetectedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDirection.md new file mode 100644 index 0000000000..0bc7f306df --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDirection.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PanGestureDirection Enum + +Enumeration for the direction of a pan gesture. + +```csharp +public enum PanGestureDirection +``` +### Fields + + + +`Any` 0 + +Any direction. + + + +`Horizontal` 2 + +Horizontal direction. + + + +`Vertical` 1 + +Vertical direction. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanelLayout.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanelLayout.md new file mode 100644 index 0000000000..d72393106f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanelLayout.md @@ -0,0 +1,92 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PanelLayout Enum + +Enumeration for input method panel layout types. + +```csharp +public enum PanelLayout +``` +### Fields + + + +`Datetime` 11 + +Date and time layout. + + + +`Email` 2 + +Email layout. + + + +`Emoticon` 12 + +Emoticon layout. + + + +`HEX` 8 + +Hexadecimal layout. + + + +`IP` 5 + +IP layout. + + + +`Month` 6 + +Month layout. + + + +`Normal` 0 + +Default layout. + + + +`Number` 1 + +Number layout. + + + +`NumberOnly` 7 + +Number layout. + + + +`Password` 10 + +Like normal, but no auto-correct, no auto-capitalization etc. + + + +`PhoneNumber` 4 + +Phone number layout. + + + +`Terminal` 9 + +Command-line terminal layout including Esc, Alt, Ctrl key, and so on (no auto-correct, no auto-capitalization). + + + +`URL` 3 + +URL layout. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGesture.md new file mode 100644 index 0000000000..6e2aa18570 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGesture.md @@ -0,0 +1,94 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PinchGesture Class + +The PinchGesture class represents a pinch gesture event. + +```csharp +public class PinchGesture : Tizen.UI.Gesture +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') 🡒 PinchGesture +### Constructors + + + +## PinchGesture(IntPtr, bool) Constructor + +Initializes a new instance of the PinchGesture class with the specified native handle and ownership flag. + +```csharp +public PinchGesture(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +handle of the pinch gesture. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the new instance takes ownership of the native handle. +### Properties + + + +## PinchGesture.Center Property + +Gets the local center point of the pinch gesture. + +```csharp +public Tizen.UI.Point Center { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PinchGesture.Scale Property + +Gets the scale factor of the pinch gesture. + +```csharp +public float Scale { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PinchGesture.ScreenCenter Property + +Gets the screen center point of the pinch gesture. + +```csharp +public Tizen.UI.Point ScreenCenter { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## PinchGesture.Speed Property + +Gets the speed of the pinch gesture. + +```csharp +public float Speed { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetectedEventArgs.md new file mode 100644 index 0000000000..86c0351d8c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetectedEventArgs.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PinchGestureDetectedEventArgs Class + +Event arguments for [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') event. + +```csharp +public class PinchGestureDetectedEventArgs : Tizen.UI.GestureDetectedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') 🡒 PinchGestureDetectedEventArgs +### Constructors + + + +## PinchGestureDetectedEventArgs(View, PinchGesture) Constructor + +Initializes a new instance of the [PinchGestureDetectedEventArgs](Tizen.UI.PinchGestureDetectedEventArgs.md 'Tizen.UI.PinchGestureDetectedEventArgs') class. + +```csharp +public PinchGestureDetectedEventArgs(Tizen.UI.View view, Tizen.UI.PinchGesture gesture); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The [View](Tizen.UI.View.md 'Tizen.UI.View') that detected the [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture'). + + + +`gesture` [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') + +The [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') object that contains information about the detected gesture. +### Properties + + + +## PinchGestureDetectedEventArgs.Gesture Property + +Gets the [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') object that contains information about the detected gesture. + +```csharp +public Tizen.UI.PinchGesture Gesture { get; } +``` + +#### Property Value +[PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetector.md new file mode 100644 index 0000000000..7277696533 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetector.md @@ -0,0 +1,42 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PinchGestureDetector Class + +The PinchGestureDetector class is used to detect pinch gestures on a View. + +```csharp +public class PinchGestureDetector : Tizen.UI.GestureDetector +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') 🡒 PinchGestureDetector +### Constructors + + + +## PinchGestureDetector() Constructor + +Creates a new PinchGestureDetector. + +```csharp +public PinchGestureDetector(); +``` +### Events + + + +## PinchGestureDetector.Detected Event + +Occurs when a pinch gesture is detected on the attached View. + +```csharp +public event EventHandler<PinchGestureDetectedEventArgs> Detected; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[PinchGestureDetectedEventArgs](Tizen.UI.PinchGestureDetectedEventArgs.md 'Tizen.UI.PinchGestureDetectedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelBuffer.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelBuffer.md new file mode 100644 index 0000000000..734ca631c2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelBuffer.md @@ -0,0 +1,187 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PixelBuffer Class + +PixelBuffer is a class that represents a buffer of pixels. + +```csharp +public class PixelBuffer : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 PixelBuffer +### Constructors + + + +## PixelBuffer(int, int, PixelFormat) Constructor + +Initializes a new instance of the PixelBuffer class with the specified width, height, and pixel format. + +```csharp +public PixelBuffer(int width, int height, Tizen.UI.PixelFormat pixelFormat); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the pixel buffer. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The height of the pixel buffer. + + + +`pixelFormat` [PixelFormat](Tizen.UI.PixelFormat.md 'Tizen.UI.PixelFormat') + +The pixel format of the pixel buffer. + + + +## PixelBuffer(IntPtr, bool) Constructor + +Initializes a new instance of the PixelBuffer class with the specified handle and whether it owns the handle or not. + +```csharp +public PixelBuffer(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the pixel buffer. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the pixel buffer owns the handle or not. +### Properties + + + +## PixelBuffer.Height Property + +Gets the height of the pixel buffer in pixels. + +```csharp +public int Height { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## PixelBuffer.PixelFormat Property + +Gets the pixel format of the pixel buffer. + +```csharp +public Tizen.UI.PixelFormat PixelFormat { get; } +``` + +#### Property Value +[PixelFormat](Tizen.UI.PixelFormat.md 'Tizen.UI.PixelFormat') + + + +## PixelBuffer.Width Property + +Gets the width of the pixel buffer in pixels. + +```csharp +public int Width { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Methods + + + +## PixelBuffer.Convert(PixelBuffer) Method + +Converts the pixel buffer to a pixel data and releases the object of the pixel buffer. +This handle is left empty. Any other handles that keep a reference to this object will be left with no buffer. Trying to access it will return null. + +```csharp +public static Tizen.UI.PixelData Convert(Tizen.UI.PixelBuffer pixelBuffer); +``` +#### Parameters + + + +`pixelBuffer` [PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') + +A pixel buffer. + +#### Returns +[PixelData](Tizen.UI.PixelData.md 'Tizen.UI.PixelData') +A new PixelData that takes ownership of the buffer of the pixelBuffer. + +### Remarks +Buffer ownership was transfer to PixelData + + + +## PixelBuffer.Export() Method + +Copies the data from this pixel buffer into a new PixelData object, which could be used for uploading to a texture. + +```csharp +public Tizen.UI.PixelData Export(); +``` + +#### Returns +[PixelData](Tizen.UI.PixelData.md 'Tizen.UI.PixelData') +The pixel data. + + + +## PixelBuffer.GetBuffer() Method + +Gets the buffer of the pixel buffer. + +```csharp +public System.IntPtr GetBuffer(); +``` + +#### Returns +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') +The buffer of the pixel buffer. + + + +## PixelBuffer.Resize(int, int) Method + +Resizes the buffer to the given dimensions. + +```csharp +public void Resize(int width, int height); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The new width. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The new height. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelData.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelData.md new file mode 100644 index 0000000000..1a9b183477 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelData.md @@ -0,0 +1,131 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PixelData Class + +The PixelData class provides a way to manage pixel data. + +```csharp +public class PixelData : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 PixelData +### Constructors + + + +## PixelData(byte[], int, int, PixelFormat) Constructor + +Initializes a new instance of the PixelData class with the specified buffer, width, height, and pixel format. + +```csharp +public PixelData(byte[] buffer, int width, int height, Tizen.UI.PixelFormat pixelFormat); +``` +#### Parameters + + + +`buffer` [System.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System.Byte')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The pixel data buffer. + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the pixel data. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The height of the pixel data. + + + +`pixelFormat` [PixelFormat](Tizen.UI.PixelFormat.md 'Tizen.UI.PixelFormat') + +The pixel format of the pixel data. + + + +## PixelData(IntPtr, bool) Constructor + +Initializes a new instance of the PixelData class with the specified handle and whether the handle is owned by the instance. + +```csharp +public PixelData(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The native handle of the pixel data. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the instance owns the handle. +### Properties + + + +## PixelData.Height Property + +Gets the width of the buffer in pixels. + +```csharp +public uint Height { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## PixelData.PixelFormat Property + +Gets the pixel format. + +```csharp +public Tizen.UI.PixelFormat PixelFormat { get; } +``` + +#### Property Value +[PixelFormat](Tizen.UI.PixelFormat.md 'Tizen.UI.PixelFormat') + + + +## PixelData.Width Property + +Gets the height of the buffer in pixels. + +```csharp +public uint Width { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') +### Methods + + + +## PixelData.GenerateUrl() Method + +Generates an ImageUrl object from the pixel data. + +```csharp +public Tizen.UI.ImageUrl GenerateUrl(); +``` + +#### Returns +[ImageUrl](Tizen.UI.ImageUrl.md 'Tizen.UI.ImageUrl') +The generated ImageUrl object. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelFormat.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelFormat.md new file mode 100644 index 0000000000..060feeb602 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelFormat.md @@ -0,0 +1,101 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PixelFormat Enum + +Enumeration for Pixel formats.
+Pixel format, default color depth is RGBA 32 bit with alpha. + +```csharp +public enum PixelFormat +``` +### Fields + + + +`A8` 1 + +color depth 8-bit, alpha. + + + +`BGR565` 5 + +color depth 16 bit, 5-6-5 + + + +`BGR8888` 12 + +color depth 32 bit, alpha is reserved but not used, 8-8-8-8# + + + +`BGRA4444` 7 + +color depth 16 bit with alpha, 4-4-4-4 + + + +`BGRA5551` 9 + +color depth 16 bit with alpha, 5-5-5-1 + + + +`BGRA8888` 14 + +color depth 32 bit with alpha, 8-8-8-8 + + + +`L8` 2 + +color depth 8-bit, luminance + + + +`LA88` 3 + +color depth 16-bit, luminance with 8 bit alpha + + + +`RGB565` 4 + +color depth 16 bit, 5-6-5 + + + +`RGB888` 10 + +color depth 24 bit, 8-8-8 + + + +`RGB8888` 11 + +color depth 32 bit, alpha is reserved but not used, 8-8-8-8# + + + +`RGBA4444` 6 + +color depth 16 bit with alpha, 4-4-4-4 + + + +`RGBA5551` 8 + +color depth 16 bit with alpha, 5-5-5-1 + + + +`RGBA8888` 13 + +color depth 32 bit with alpha, 8-8-8-8 + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Point.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Point.md new file mode 100644 index 0000000000..2b9b1926e5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Point.md @@ -0,0 +1,403 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Point Struct + +Struct defining a 2-D point as a pair of floats. + +```csharp +public struct Point +``` +### Constructors + + + +## Point(float, float) Constructor + +Creates a new Point object that represents the point (x,y). + +```csharp +public Point(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal coordinate. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical coordinate. + + + +## Point(Size) Constructor + +Creates a new Point object that has coordinates that are specified by the width and height of sz, in that order. + +```csharp +public Point(Tizen.UI.Size sz); +``` +#### Parameters + + + +`sz` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +Size that specifies a Point that has the coordinates (Width, Height). +### Fields + + + +## Point.Zero Field + +The Point at {0,0}. + +```csharp +public static Point Zero; +``` + +#### Field Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +### Properties + + + +## Point.IsEmpty Property + +Whether both X and Y are 0. + +```csharp +public bool IsEmpty { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if both X and Y are 0.0. + + + +## Point.X Property + +Location along the horizontal axis. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Point.Y Property + +Location along the vertical axis. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Point.Deconstruct(float, float) Method + +Deconstructs the Point object into its individual components (X and Y). + +```csharp +public void Deconstruct(out float x, out float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X component of the Point. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y component of the Point. + + + +## Point.Distance(Point) Method + +Calculates the distance between two points. + +```csharp +public double Distance(Tizen.UI.Point other); +``` +#### Parameters + + + +`other` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The Point to which the distance is calculated. + +#### Returns +[System.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System.Double') +The distance between this and the other. + + + +## Point.Equals(object) Method + +Returns true if the X and Y values of this are exactly equal to those in the argument. + +```csharp +public override bool Equals(object o); +``` +#### Parameters + + + +`o` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +Another Point. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if the X and Y values are equal to those in o. Returns false if o is not a Point. + + + +## Point.GetHashCode() Method + +Returns a hash value for the Point. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A value intended for efficient insertion and lookup in hashtable-based data structures. + + + +## Point.Offset(float, float) Method + +Returns a new Point that translates the current Point by dx and dy. + +```csharp +public Tizen.UI.Point Offset(float dx, float dy); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to add along the X axis. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to add along the Y axis. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new Point at [this.X + dx, this.Y + dy]. + + + +## Point.Round() Method + +Returns a new Point whose X and Y have been rounded to the nearest integral value. + +```csharp +public Tizen.UI.Point Round(); +``` + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new Point whose X and Y have been rounded to the nearest integral value, per the behavior of Math.Round(Double). + + + +## Point.ToString() Method + +Returns a string that represents the current [Point](Tizen.UI.Point.md 'Tizen.UI.Point') structure. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +A string that represents the current [Point](Tizen.UI.Point.md 'Tizen.UI.Point') structure. +### Operators + + + +## Point.operator +(Point, Point) Operator + +Adds two Points. + +```csharp +public static Tizen.UI.Point operator +(Tizen.UI.Point p1, Tizen.UI.Point p2); +``` +#### Parameters + + + +`p1` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The first point value. + + + +`p2` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The second point value. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +The sum of `p1` and `p2`. + + + +## Point.operator +(Point, Size) Operator + +Returns a new Point by adding a Size to a Point. + +```csharp +public static Tizen.UI.Point operator +(Tizen.UI.Point pt, Tizen.UI.Size sz); +``` +#### Parameters + + + +`pt` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The Point to which sz is being added. + + + +`sz` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The values to add to pt. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new Point at [pt.X + sz.Width, pt.Y + sz.Height]. + + + +## Point.explicit operator Size(Point) Operator + +Returns a new Size whose Width and Height and equivalent to the pt's X and Y properties. + +```csharp +public static Tizen.UI.Size explicit operator Size(Tizen.UI.Point pt); +``` +#### Parameters + + + +`pt` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The Point to be translated as a Size. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +A new Size based on the pt. + + + +## Point.operator !=(Point, Point) Operator + +Compares two points to determine if they are not equal. + +```csharp +public static bool operator !=(Tizen.UI.Point ptA, Tizen.UI.Point ptB); +``` +#### Parameters + + + +`ptA` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The first point to compare. + + + +`ptB` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The second point to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the points are not equal, false otherwise. + + + +## Point.operator -(Point, Point) Operator + +Subtracts one from another. + +```csharp +public static Tizen.UI.Point operator -(Tizen.UI.Point p1, Tizen.UI.Point p2); +``` +#### Parameters + + + +`p1` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The point from which `p2` is substracted. + + + +`p2` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The point to substract from `p1`. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +The difference between them. + + + +## Point.operator -(Point, Size) Operator + +Returns a new Point by subtracting a Size from a Point. + +```csharp +public static Tizen.UI.Point operator -(Tizen.UI.Point pt, Tizen.UI.Size sz); +``` +#### Parameters + + + +`pt` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The Point from which sz is to be subtracted. + + + +`sz` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The Size whose Width and Height will be subtracted from pt's X and Y. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A new Point at [pt.X - sz.Width, pt.Y - sz.Height]. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PositionPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PositionPropertyValue.md new file mode 100644 index 0000000000..8e540c5327 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PositionPropertyValue.md @@ -0,0 +1,103 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## PositionPropertyValue Class + +Represents a property value for position animation. + +```csharp +public class PositionPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 PositionPropertyValue +### Constructors + + + +## PositionPropertyValue(float, float) Constructor + +Initializes a new instance of the [PositionPropertyValue](Tizen.UI.PositionPropertyValue.md 'Tizen.UI.PositionPropertyValue') class. + +```csharp +public PositionPropertyValue(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the position. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the position. +### Properties + + + +## PositionPropertyValue.Value Property + +Gets the native value of the position property value. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') + + + +## PositionPropertyValue.X Property + +Gets the x-coordinate of the position. + +```csharp +public float X { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## PositionPropertyValue.Y Property + +Gets the y-coordinate of the position. + +```csharp +public float Y { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## PositionPropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the position animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property value is applied. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RadialGradientBackground.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RadialGradientBackground.md new file mode 100644 index 0000000000..52b4f492b7 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RadialGradientBackground.md @@ -0,0 +1,62 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RadialGradientBackground Class + +The RadialGradientBackground class is a visual which renders a radial gradient. + +```csharp +public class RadialGradientBackground : Tizen.UI.GradientBackground +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Background](Tizen.UI.Background.md 'Tizen.UI.Background') 🡒 [GradientBackground](Tizen.UI.GradientBackground.md 'Tizen.UI.GradientBackground') 🡒 RadialGradientBackground +### Properties + + + +## RadialGradientBackground.Center Property + +Gets or sets the center point of the radial gradient. + +```csharp +public Tizen.UI.Point Center { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## RadialGradientBackground.Radius Property + +Gets or sets the radius of the radial gradient. + +```csharp +public float Radius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## RadialGradientBackground.BuildPropertyMap(PropertyMapHandle) Method + +Builds the property map for the visual element. + +```csharp +public override void BuildPropertyMap(Tizen.UI.NativeHandle.PropertyMapHandle map); +``` +#### Parameters + + + +`map` [PropertyMapHandle](Tizen.UI.NativeHandle.PropertyMapHandle.md 'Tizen.UI.NativeHandle.PropertyMapHandle') + +The property map handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Rect.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Rect.md new file mode 100644 index 0000000000..909ac1b760 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Rect.md @@ -0,0 +1,741 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Rect Struct + +Represents a rectangular area by defining its position and size. + +```csharp +public struct Rect +``` +### Constructors + + + +## Rect(float, float, float, float) Constructor + +Initializes a new instance of the [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') struct. + +```csharp +public Rect(float x, float y, float width, float height); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the rectangle. + + + +## Rect(Point, Size) Constructor + +Initializes a new instance of the [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') struct. + +```csharp +public Rect(Tizen.UI.Point loc, Tizen.UI.Size sz); +``` +#### Parameters + + + +`loc` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The location of the upper-left corner of the rectangle. + + + +`sz` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the rectangle. +### Fields + + + +## Rect.Zero Field + +Gets a [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure with all coordinates and sizes set to zero. + +```csharp +public static Rect Zero; +``` + +#### Field Value +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +### Properties + + + +## Rect.Bottom Property + +Gets the y-coordinate of the bottom edge of the rectangle. + +```csharp +public float Bottom { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.Center Property + +Gets the center point of the rectangle. + +```csharp +public Tizen.UI.Point Center { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Rect.Height Property + +Gets or sets the height of the rectangle. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.IsEmpty Property + +Gets a value indicating whether this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') is empty. + +```csharp +public bool IsEmpty { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Rect.Left Property + +Gets the x-coordinate of the left edge of the rectangle. + +```csharp +public float Left { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.Location Property + +Gets or sets the location of the upper-left corner of the rectangle. + +```csharp +public Tizen.UI.Point Location { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Rect.Right Property + +Gets the x-coordinate of the right edge of the rectangle. + +```csharp +public float Right { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.Size Property + +Gets or sets the size of the rectangle. + +```csharp +public Tizen.UI.Size Size { get; set; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## Rect.Top Property + +Gets the y-coordinate of the top edge of the rectangle. + +```csharp +public float Top { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.Width Property + +Gets or sets the width of the rectangle. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.X Property + +Gets or sets the x-coordinate of the upper-left corner of the rectangle. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Rect.Y Property + +Gets or sets the y-coordinate of the upper-left corner of the rectangle. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Rect.Contains(float, float) Method + +Indicates whether the specified point is contained within the rectangular region defined by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure. + +```csharp +public bool Contains(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the point to test. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the point to test. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [x](Tizen.UI.Rect.md#Tizen.UI.Rect.Contains(float,float).x 'Tizen.UI.Rect.Contains(float, float).x') and [y](Tizen.UI.Rect.md#Tizen.UI.Rect.Contains(float,float).y 'Tizen.UI.Rect.Contains(float, float).y') are contained within the rectangular region defined by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure; otherwise, false. + + + +## Rect.Contains(Point) Method + +Indicates whether the specified point is contained within the rectangular region defined by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure. + +```csharp +public bool Contains(Tizen.UI.Point pt); +``` +#### Parameters + + + +`pt` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The point to test. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [pt](Tizen.UI.Rect.md#Tizen.UI.Rect.Contains(Tizen.UI.Point).pt 'Tizen.UI.Rect.Contains(Tizen.UI.Point).pt') is contained within the rectangular region defined by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure; otherwise, false. + + + +## Rect.Contains(Rect) Method + +Checks if the specified rectangle is completely inside this rectangle. + +```csharp +public bool Contains(Tizen.UI.Rect rect); +``` +#### Parameters + + + +`rect` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The rectangle to check. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the specified rectangle is completely inside this rectangle, otherwise false. + + + +## Rect.Deconstruct(float, float, float, float) Method + +Deconstructs the Rect object into its individual components (X, Y, Width, Height). + +```csharp +public void Deconstruct(out float x, out float y, out float width, out float height); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X coordinate of the rectangle. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y coordinate of the rectangle. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the rectangle. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the rectangle. + + + +## Rect.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [obj](Tizen.UI.Rect.md#Tizen.UI.Rect.Equals(object).obj 'Tizen.UI.Rect.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, false. + + + +## Rect.Equals(Rect) Method + +Indicates whether this instance and another specified [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure are equal. + +```csharp +public bool Equals(Tizen.UI.Rect other); +``` +#### Parameters + + + +`other` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [other](Tizen.UI.Rect.md#Tizen.UI.Rect.Equals(Tizen.UI.Rect).other 'Tizen.UI.Rect.Equals(Tizen.UI.Rect).other') and this instance are equal; otherwise, false. + + + +## Rect.FromLTRB(float, float, float, float) Method + +Creates a new [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure with the specified values. + +```csharp +public static Tizen.UI.Rect FromLTRB(float left, float top, float right, float bottom); +``` +#### Parameters + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the upper-left corner of the rectangle. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the upper-left corner of the rectangle. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the lower-right corner of the rectangle. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the lower-right corner of the rectangle. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure with the specified values. + + + +## Rect.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. + + + +## Rect.Inflate(float, float) Method + +Inflates the current rectangle by the specified width and height. + +```csharp +public Tizen.UI.Rect Inflate(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to inflate the rectangle horizontally. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The amount to inflate the rectangle vertically. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle that represents the inflated version of the current rectangle. + + + +## Rect.Inflate(Size) Method + +Returns a new [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure that has been inflated by the specified amount. + +```csharp +public Tizen.UI.Rect Inflate(Tizen.UI.Size sz); +``` +#### Parameters + + + +`sz` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the inflation. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure that represents the inflated rectangle. + + + +## Rect.Intersect(Rect) Method + +Returns a new rectangle that represents the intersection of the current rectangle and the specified rectangle. + +```csharp +public Tizen.UI.Rect Intersect(Tizen.UI.Rect r); +``` +#### Parameters + + + +`r` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The rectangle to intersect with the current rectangle. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle that represents the intersection of the current rectangle specified rectangle. + + + +## Rect.Intersect(Rect, Rect) Method + +Returns a new rectangle that represents the intersection of two given rectangles. + +```csharp +public static Tizen.UI.Rect Intersect(Tizen.UI.Rect r1, Tizen.UI.Rect r2); +``` +#### Parameters + + + +`r1` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The first rectangle. + + + +`r2` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The second rectangle. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle representing the intersection of the two given rectangles. + + + +## Rect.IntersectsWith(Rect) Method + +Indicates whether the rectangular region represented by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') intersects with the rectangular region represented by the specified [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure. + +```csharp +public bool IntersectsWith(Tizen.UI.Rect r); +``` +#### Parameters + + + +`r` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to test for intersection. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if the rectangular region represented by this [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') intersects with the rectangular region represented by [r](Tizen.UI.Rect.md#Tizen.UI.Rect.IntersectsWith(Tizen.UI.Rect).r 'Tizen.UI.Rect.IntersectsWith(Tizen.UI.Rect).r'); otherwise, false. + + + +## Rect.Offset(float, float) Method + +Returns a new rectangle that is offset by the specified amount. + +```csharp +public Tizen.UI.Rect Offset(float dx, float dy); +``` +#### Parameters + + + +`dx` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal offset. + + + +`dy` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical offset. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle with the offset applied. + + + +## Rect.Offset(Point) Method + +Returns a new Rect that has been offset by the specified distance. + +```csharp +public Tizen.UI.Rect Offset(Tizen.UI.Point dr); +``` +#### Parameters + + + +`dr` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The distance to offset the Rect. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new Rect that has been offset by the specified distance. + + + +## Rect.Round() Method + +Rounds the values of the X, Y, Width, and Height properties of the current Rect object to the nearest whole number. + +```csharp +public Tizen.UI.Rect Round(); +``` + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new Rect object with the rounded values. + + + +## Rect.ToString() Method + +Returns a string that represents the current object. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +A string that represents the current object. + + + +## Rect.Union(Rect) Method + +Returns a rectangle that represents the union of the current rectangle and the specified rectangle. + +```csharp +public Tizen.UI.Rect Union(Tizen.UI.Rect r); +``` +#### Parameters + + + +`r` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The rectangle to combine with the current rectangle. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle that represents the union of the current rectangle and the specified rectangle. + + + +## Rect.Union(Rect, Rect) Method + +Returns a rectangle that represents the union of the two given rectangles. + +```csharp +public static Tizen.UI.Rect Union(Tizen.UI.Rect r1, Tizen.UI.Rect r2); +``` +#### Parameters + + + +`r1` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The first rectangle. + + + +`r2` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The second rectangle. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A new rectangle that represents the union of the two given rectangles. +### Operators + + + +## Rect.operator ==(Rect, Rect) Operator + +Compares two [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structures for equality. + +```csharp +public static bool operator ==(Tizen.UI.Rect r1, Tizen.UI.Rect r2); +``` +#### Parameters + + + +`r1` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The first [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to compare. + + + +`r2` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The second [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [r1](Tizen.UI.Rect.md#Tizen.UI.Rect.op_Equality(Tizen.UI.Rect,Tizen.UI.Rect).r1 'Tizen.UI.Rect.op_Equality(Tizen.UI.Rect, Tizen.UI.Rect).r1') and [r2](Tizen.UI.Rect.md#Tizen.UI.Rect.op_Equality(Tizen.UI.Rect,Tizen.UI.Rect).r2 'Tizen.UI.Rect.op_Equality(Tizen.UI.Rect, Tizen.UI.Rect).r2') are equal; otherwise, false. + + + +## Rect.operator !=(Rect, Rect) Operator + +Compares two [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structures for inequality. + +```csharp +public static bool operator !=(Tizen.UI.Rect r1, Tizen.UI.Rect r2); +``` +#### Parameters + + + +`r1` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The first [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to compare. + + + +`r2` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The second [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') structure to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [r1](Tizen.UI.Rect.md#Tizen.UI.Rect.op_Inequality(Tizen.UI.Rect,Tizen.UI.Rect).r1 'Tizen.UI.Rect.op_Inequality(Tizen.UI.Rect, Tizen.UI.Rect).r1') and [r2](Tizen.UI.Rect.md#Tizen.UI.Rect.op_Inequality(Tizen.UI.Rect,Tizen.UI.Rect).r2 'Tizen.UI.Rect.op_Inequality(Tizen.UI.Rect, Tizen.UI.Rect).r2') are not equal; otherwise, false. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RenderNotificationKey.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RenderNotificationKey.md new file mode 100644 index 0000000000..a3659000ab --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RenderNotificationKey.md @@ -0,0 +1,52 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RenderNotificationKey Enum + +The RenderNotificationKey enum defines the keys used for notifications related to rendering. + +```csharp +public enum RenderNotificationKey +``` +### Fields + + + +`Opacity` 5 + +The key for notifications related to opacity changes. + + + +`Position` 1 + +The key for notifications related to position changes. + + + +`Scale` 3 + +The key for notifications related to scale changes. + + + +`ScreenPosition` 2 + +The key for notifications related to screen position changes. + + + +`Size` 0 + +The key for notifications related to size changes. + + + +`WorldScale` 4 + +The key for notifications related to world scale changes. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResizePolicy.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResizePolicy.md new file mode 100644 index 0000000000..c13fe624f2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResizePolicy.md @@ -0,0 +1,64 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ResizePolicy Enum + +The ResizePolicy enum represents the possible resize policies for a view. + +```csharp +public enum ResizePolicy +``` +### Fields + + + +`DimensionDependency` 6 + +One dimension is dependent on the other. + + + +`FillToParent` 2 + +Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. + + + +`FitToChildren` 5 + +The size will adjust to wrap around all children. + + + +`Fixed` 0 + +Size is fixed as set by SetSize. + + + +`SizeFixedOffsetFromParent` 4 + +The actors size will be ( ParentSize + SizeRelativeToParentFactor ). + + + +`SizeRelativeToParent` 3 + +The actors size will be ( ParentSize * SizeRelativeToParentFactor ). + + + +`UseAssignedSize` 7 + +The size will be assigned to the actor. + + + +`UseNaturalSize` 1 + +Size is to use the actor's natural size. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResourceLocalizer.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResourceLocalizer.md new file mode 100644 index 0000000000..586497b6b1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResourceLocalizer.md @@ -0,0 +1,319 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ResourceLocalizer Class + +Provides a mechanism for localizing strings and resources. + +```csharp +public static class ResourceLocalizer +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ResourceLocalizer +### Properties + + + +## ResourceLocalizer.EffectiveResourceManager Property + +Gets the currently effective resource manager for localization. +This returns the most recently pushed resource manager from the stack, +or falls back to the default ResourceManager if the stack is empty. + +```csharp +public static System.Resources.ResourceManager EffectiveResourceManager { get; } +``` + +#### Property Value +[System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +### Remarks +This property is used to determine which ResourceManager should be used +for localization in the current context. When multiple ResourceManagers +are pushed onto the stack (using PushEffectiveResourceManager), this will +return the most recent one. If no ResourceManagers have been pushed, +it returns the default ResourceManager. + + + +## ResourceLocalizer.ResourceManager Property + +Gets or sets the [ResourceManager](Tizen.UI.ResourceLocalizer.md#Tizen.UI.ResourceLocalizer.ResourceManager 'Tizen.UI.ResourceLocalizer.ResourceManager') used for localization. + +```csharp +public static System.Resources.ResourceManager ResourceManager { get; set; } +``` + +#### Property Value +[System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') +### Methods + + + +## ResourceLocalizer.BindingLocalized<T>(T, Action<T,string>, string, ResourceManager) Method + +Binds the specified tag to the specified property on the target object. + +```csharp +public static void BindingLocalized<T>(T target, System.Action<T,string> setter, string tag, System.Resources.ResourceManager resourceManager=null) + where T : class; +``` +#### Type parameters + + + +`T` + +The type of the target object. +#### Parameters + + + +`target` [T](Tizen.UI.ResourceLocalizer.md#Tizen.UI.ResourceLocalizer.BindingLocalized_T_(T,System.Action_T,string_,string,System.Resources.ResourceManager).T 'Tizen.UI.ResourceLocalizer.BindingLocalized<T>(T, System.Action<T,string>, string, System.Resources.ResourceManager).T') + +The target object. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.ResourceLocalizer.md#Tizen.UI.ResourceLocalizer.BindingLocalized_T_(T,System.Action_T,string_,string,System.Resources.ResourceManager).T 'Tizen.UI.ResourceLocalizer.BindingLocalized<T>(T, System.Action<T,string>, string, System.Resources.ResourceManager).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The setter method for the property to bind to. + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag to bind to. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + + + +## ResourceLocalizer.BindingLocalizedResource<T>(T, Action<T,string>, string) Method + +Binds the specified tag to the specified property on the target object, using localized resources. + +```csharp +public static void BindingLocalizedResource<T>(T target, System.Action<T,string> setter, string tag) + where T : class; +``` +#### Type parameters + + + +`T` + +The type of the target object. +#### Parameters + + + +`target` [T](Tizen.UI.ResourceLocalizer.md#Tizen.UI.ResourceLocalizer.BindingLocalizedResource_T_(T,System.Action_T,string_,string).T 'Tizen.UI.ResourceLocalizer.BindingLocalizedResource<T>(T, System.Action<T,string>, string).T') + +The target object. + + + +`setter` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[T](Tizen.UI.ResourceLocalizer.md#Tizen.UI.ResourceLocalizer.BindingLocalizedResource_T_(T,System.Action_T,string_,string).T 'Tizen.UI.ResourceLocalizer.BindingLocalizedResource<T>(T, System.Action<T,string>, string).T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + +The setter method for the property to bind to. + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag to bind to. + + + +## ResourceLocalizer.ClearBinding(View) Method + +Clears the binding for the specified target object. + +```csharp +public static void ClearBinding(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The target object. + + + +## ResourceLocalizer.LoadResourceManager(string, Assembly) Method + +Loads the specified resource manager for localization. + +```csharp +public static void LoadResourceManager(string baseName, System.Reflection.Assembly assembly); +``` +#### Parameters + + + +`baseName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The base name of the resource to load. + + + +`assembly` [System.Reflection.Assembly](https://docs.microsoft.com/en-us/dotnet/api/System.Reflection.Assembly 'System.Reflection.Assembly') + +The assembly containing the resource. + + + +## ResourceLocalizer.LocalizedResource(string) Method + +Returns the localized resource for the specified path. + +```csharp +public static string LocalizedResource(string path); +``` +#### Parameters + + + +`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The path for the localized resource. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The localized resource, or `null` if not found. + + + +## ResourceLocalizer.LocalizedString(string) Method + +Returns the localized string for the specified key. + +```csharp +public static string LocalizedString(string key); +``` +#### Parameters + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key for the localized string. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The localized string, or `null` if not found. + + + +## ResourceLocalizer.LocalizedString(string, ResourceManager) Method + +Returns the localized string for the specified key. + +```csharp +public static string LocalizedString(string key, System.Resources.ResourceManager resourceManager); +``` +#### Parameters + + + +`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The key for the localized string. + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager for the localized string. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The localized string, or `null` if not found. + + + +## ResourceLocalizer.PopEffectiveResourceManager() Method + +Pops the current effective resource manager from the stack, +restoring the previous resource manager (if any). + +```csharp +public static void PopEffectiveResourceManager(); +``` + +### Remarks +This should be called to undo a previous PushEffectiveResourceManager call, +typically when leaving a scope where a specific resource manager was needed. +If no resource managers have been pushed, this will throw an exception. + + + +## ResourceLocalizer.PushEffectiveResourceManager(ResourceManager) Method + +Pushes a new resource manager onto the effective resource manager stack, +making it the current effective resource manager for localization. + +```csharp +public static void PushEffectiveResourceManager(System.Resources.ResourceManager manager); +``` +#### Parameters + + + +`manager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The ResourceManager to push onto the stack + +### Remarks +Use this method when you need to temporarily override the resource manager +for a specific scope or context. The pushed manager will be used for all +subsequent localization operations until it is popped from the stack. +Remember to call PopEffectiveResourceManager when done to restore the +previous resource manager. + + + +## ResourceLocalizer.SetDefaultCulture(CultureInfo) Method + +Sets the default culture for the application and updates all resource bindings to use the new culture. + +```csharp +public static void SetDefaultCulture(System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`culture` [System.Globalization.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System.Globalization.CultureInfo') + +The [System.Globalization.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System.Globalization.CultureInfo') object representing the culture to set as default. If null, CultureInfo.CurrentUICulture is used + + + +## ResourceLocalizer.SetLocalizeBypass(bool) Method + +Sets the LocalizeBypass mode state. + +```csharp +public static void SetLocalizeBypass(bool value); +``` +#### Parameters + + + +`value` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +true to enable LocalizeBypass mode, false to disable + +### Remarks +When enabled, LocalizeBypass mode skips localization processing and passes resource IDs through without translation, primarily for test automation. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ReturnType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ReturnType.md new file mode 100644 index 0000000000..962e26d33a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ReturnType.md @@ -0,0 +1,70 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ReturnType Enum + +Enumeration for the return type of a function. + +```csharp +public enum ReturnType +``` +### Fields + + + +`Default` 0 + +Default action. + + + +`Done` 1 + +Done. + + + +`Go` 2 + +Go action. + + + +`Join` 3 + +Join action. + + + +`Login` 4 + +Login action. + + + +`Next` 5 + +Next action. + + + +`Search` 6 + +Search action. + + + +`Send` 7 + +Send action. + + + +`SignIn` 8 + +Sign in action. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGesture.md new file mode 100644 index 0000000000..4c8148e59a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGesture.md @@ -0,0 +1,81 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RotationGesture Class + +The RotationGesture class represents a rotation gesture. + +```csharp +public class RotationGesture : Tizen.UI.Gesture +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') 🡒 RotationGesture +### Constructors + + + +## RotationGesture(IntPtr, bool) Constructor + +Initializes a new instance of the RotationGesture class with the specified handle and whether it owns the handle or not. + +```csharp +public RotationGesture(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the native gesture object. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the handle is owned by the new instance or not. +### Properties + + + +## RotationGesture.Center Property + +Gets the center point of the gesture in local coordinates. + +```csharp +public Tizen.UI.Point Center { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## RotationGesture.Rotation Property + +Gets the rotation angle of the gesture in degrees. + +```csharp +public float Rotation { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RotationGesture.ScreenCenter Property + +Gets the center point of the gesture in screen coordinates. + +```csharp +public Tizen.UI.Point ScreenCenter { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetectedEventArgs.md new file mode 100644 index 0000000000..206bdba879 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetectedEventArgs.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RotationGestureDetectedEventArgs Class + +Event arguments for [RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') event. + +```csharp +public class RotationGestureDetectedEventArgs : Tizen.UI.GestureDetectedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') 🡒 RotationGestureDetectedEventArgs +### Constructors + + + +## RotationGestureDetectedEventArgs(View, RotationGesture) Constructor + +Initializes a new instance of the [RotationGestureDetectedEventArgs](Tizen.UI.RotationGestureDetectedEventArgs.md 'Tizen.UI.RotationGestureDetectedEventArgs') class. + +```csharp +public RotationGestureDetectedEventArgs(Tizen.UI.View view, Tizen.UI.RotationGesture gesture); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view that the rotation gesture was detected on. + + + +`gesture` [RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') + +The rotation gesture that was detected. +### Properties + + + +## RotationGestureDetectedEventArgs.Gesture Property + +Gets the rotation gesture that was detected. + +```csharp +public Tizen.UI.RotationGesture Gesture { get; } +``` + +#### Property Value +[RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetector.md new file mode 100644 index 0000000000..1441bf9e72 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetector.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RotationGestureDetector Class + +The RotationGestureDetector class is used to detect rotation gestures on a View. + +```csharp +public class RotationGestureDetector : Tizen.UI.GestureDetector +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') 🡒 RotationGestureDetector +### Constructors + + + +## RotationGestureDetector() Constructor + +Creates a new RotationGestureDetector. + +```csharp +public RotationGestureDetector(); +``` + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationPropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationPropertyValue.md new file mode 100644 index 0000000000..b4bc251331 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationPropertyValue.md @@ -0,0 +1,122 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## RotationPropertyValue Class + +Represents a property value that represents a rotation in three dimensions. + +```csharp +public class RotationPropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 RotationPropertyValue +### Constructors + + + +## RotationPropertyValue(float, float, float) Constructor + +Initializes a new instance of the [RotationPropertyValue](Tizen.UI.RotationPropertyValue.md 'Tizen.UI.RotationPropertyValue') class. + +```csharp +public RotationPropertyValue(float rotationX, float rotationY, float rotationZ); +``` +#### Parameters + + + +`rotationX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of rotation around the X-axis, in degrees. + + + +`rotationY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of rotation around the Y-axis, in degrees. + + + +`rotationZ` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The angle of rotation around the Z-axis, in degrees. +### Properties + + + +## RotationPropertyValue.RotationX Property + +Gets the angle of rotation around the X-axis, in degrees. + +```csharp +public float RotationX { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RotationPropertyValue.RotationY Property + +Gets the angle of rotation around the Y-axis, in degrees. + +```csharp +public float RotationY { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RotationPropertyValue.RotationZ Property + +Gets the angle of rotation around the Z-axis, in degrees. + +```csharp +public float RotationZ { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## RotationPropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## RotationPropertyValue.GetTargetProperty(View) Method + +Gets the target property for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property value will be applied. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The handle of the target property. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScalePropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScalePropertyValue.md new file mode 100644 index 0000000000..1a3e23a4ba --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScalePropertyValue.md @@ -0,0 +1,90 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScalePropertyValue Class + +Represents a property value that represents the scale of a view. + +```csharp +public class ScalePropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 ScalePropertyValue +### Constructors + + + +## ScalePropertyValue(float, float) Constructor + +Initializes a new instance of the [ScalePropertyValue](Tizen.UI.ScalePropertyValue.md 'Tizen.UI.ScalePropertyValue') class. + +```csharp +public ScalePropertyValue(float x, float y); +``` +#### Parameters + + + +`x` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The x-coordinate of the scale. + + + +`y` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The y-coordinate of the scale. +### Properties + + + +## ScalePropertyValue.Scale Property + +Gets the scale of the property value. + +```csharp +public Tizen.UI.Size Scale { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## ScalePropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## ScalePropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property belongs. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScopedResourceManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScopedResourceManager.md new file mode 100644 index 0000000000..b7571adb4a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScopedResourceManager.md @@ -0,0 +1,100 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScopedResourceManager Class + +Provides a scoped mechanism for managing effective resource managers. +This class implements IDisposable to automatically handle pushing and popping +resource managers based on scope boundaries. + +```csharp +public sealed class ScopedResourceManager : +System.IDisposable +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ScopedResourceManager + +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') + +### Remarks +This class is designed to work with ResourceLocalizer's effective resource manager stack, +allowing you to temporarily set a resource manager that will be automatically +reverted when the scope ends (typically when leaving a using block). + +Example usage: + +```csharp +{ + using var scope = ScopedResourceManager.Scoped(myResourceManager); + // myResourceManager is now the effective resource manager + // ... localization operations ... +} // myResourceManager is automatically popped when scope is disposed +``` +### Constructors + + + +## ScopedResourceManager(ResourceManager) Constructor + +Initializes a new instance of the ScopedResourceManager class, +pushing the specified resource manager onto the effective resource manager stack. + +```csharp +public ScopedResourceManager(System.Resources.ResourceManager manager); +``` +#### Parameters + + + +`manager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to make effective for this scope +### Methods + + + +## ScopedResourceManager.Dispose() Method + +Pops the resource manager from the effective resource manager stack, +restoring the previous resource manager (if any). + +```csharp +public void Dispose(); +``` + +Implements [Dispose()](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable.Dispose 'System.IDisposable.Dispose') + +### Remarks +This method is automatically called when the scope ends (in Dispose pattern). +It ensures proper cleanup of the resource manager stack even if exceptions occur. + + + +## ScopedResourceManager.Scoped(ResourceManager) Method + +Creates a new scoped resource manager instance. + +```csharp +public static Tizen.UI.ScopedResourceManager Scoped(System.Resources.ResourceManager resourceManager); +``` +#### Parameters + + + +`resourceManager` [System.Resources.ResourceManager](https://docs.microsoft.com/en-us/dotnet/api/System.Resources.ResourceManager 'System.Resources.ResourceManager') + +The resource manager to push onto the stack + +#### Returns +[ScopedResourceManager](Tizen.UI.ScopedResourceManager.md 'Tizen.UI.ScopedResourceManager') +A new ScopedResourceManager instance + +### Remarks +This factory method provides a more fluent way to create scoped resource managers. +The created instance will push the specified resource manager onto the effective +resource manager stack and automatically pop it when disposed. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollBarVisibility.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollBarVisibility.md new file mode 100644 index 0000000000..4aa575a010 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollBarVisibility.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScrollBarVisibility Enum + +Enumerates conditions under which scroll bars will be visible. + +```csharp +public enum ScrollBarVisibility +``` +### Fields + + + +`Always` 1 + +The scollbar will be visible, regardless of the content or orientation. + + + +`Auto` 0 + +The visibility of the scrollbar will be determined automatically. + + + +`Never` 2 + +The scrollbar will not be visible, regardless of the content or orientation. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollDirection.md new file mode 100644 index 0000000000..1792c78f8b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollDirection.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScrollDirection Enum + +Enumeration for the direction of scrolling. + +```csharp +public enum ScrollDirection +``` +### Fields + + + +`Both` 2 + +Specifies scrolling in both vertical and horizontal directions. + + + +`Horizontal` 1 + +Specifies horizontal scrolling. + + + +`Vertical` 0 + +Specifies vertical scrolling. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollEventArgs.md new file mode 100644 index 0000000000..0fb7664c5b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollEventArgs.md @@ -0,0 +1,76 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScrollEventArgs Class + +The event arguments of scroll. + +```csharp +public class ScrollEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 ScrollEventArgs +### Constructors + + + +## ScrollEventArgs() Constructor + +Create scroll evnet arguments. + +```csharp +public ScrollEventArgs(); +``` + + + +## ScrollEventArgs(Point, Point) Constructor + +Create scroll event arguments with initial values. + +```csharp +public ScrollEventArgs(Tizen.UI.Point scrollPosition, Tizen.UI.Point displacement); +``` +#### Parameters + + + +`scrollPosition` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The scroll position. + + + +`displacement` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The scroll displacement. +### Properties + + + +## ScrollEventArgs.Displacement Property + +The displacement of the scroll. + +```csharp +public Tizen.UI.Point Displacement { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## ScrollEventArgs.ScrollPosition Property + +The position of the scroll. + +```csharp +public Tizen.UI.Point ScrollPosition { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollToPosition.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollToPosition.md new file mode 100644 index 0000000000..e60cde2cb0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollToPosition.md @@ -0,0 +1,38 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ScrollToPosition Enum + +Enumeration for the position to scroll to. + +```csharp +public enum ScrollToPosition +``` +### Fields + + + +`Center` 2 + +Scrolls to the center of the specified view. + + + +`End` 3 + +Scrolls to the end of the specified view. + + + +`MakeVisible` 0 + +Scrolls to the position where the specified view is completely visible. + + + +`Start` 1 + +Scrolls to the start of the specified view. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Shadow.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Shadow.md new file mode 100644 index 0000000000..9e250d948b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Shadow.md @@ -0,0 +1,79 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Shadow Struct + +The Shadow struct represents a shadow effect applied to a view. + +```csharp +public struct Shadow +``` +### Properties + + + +## Shadow.BlurRadius Property + +Gets or sets the blur radius of the shadow. + +```csharp +public float BlurRadius { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Shadow.Color Property + +Gets or sets the color of + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## Shadow.CutoutPolicy Property + +Gets or sets the cutout policy + +```csharp +public Tizen.UI.VisualCutoutPolicy CutoutPolicy { get; set; } +``` + +#### Property Value +[VisualCutoutPolicy](Tizen.UI.VisualCutoutPolicy.md 'Tizen.UI.VisualCutoutPolicy') + + + +## Shadow.Extends Property + +Gets or sets the size of the shadow. + +```csharp +public Tizen.UI.Size Extends { get; set; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## Shadow.Offset Property + +Gets or sets the offset of the shadow. + +```csharp +public Tizen.UI.Point Offset { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ShadowTokenPropertyChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ShadowTokenPropertyChangedEventArgs.md new file mode 100644 index 0000000000..8eedcc40eb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ShadowTokenPropertyChangedEventArgs.md @@ -0,0 +1,70 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ShadowTokenPropertyChangedEventArgs Class + +Provides data for shadow token property changed events. + +```csharp +public class ShadowTokenPropertyChangedEventArgs : Tizen.UI.ColorTokenPropertyChangedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') 🡒 [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') 🡒 ShadowTokenPropertyChangedEventArgs + +### Remarks +Extends [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') with shadow information. +Uses singleton pattern for event argument instances. +### Properties + + + +## ShadowTokenPropertyChangedEventArgs.Shadow Property + +Gets or sets the shadow value of the changed property. + +```csharp +public Tizen.UI.Shadow Shadow { get; set; } +``` + +#### Property Value +[Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') +The new shadow value. +### Methods + + + +## ShadowTokenPropertyChangedEventArgs.Create(View, string, Shadow) Method + +Creates a new instance of [ShadowTokenPropertyChangedEventArgs](Tizen.UI.ShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.ShadowTokenPropertyChangedEventArgs'). + +```csharp +public static Tizen.UI.ShadowTokenPropertyChangedEventArgs Create(Tizen.UI.View view, string name, Tizen.UI.Shadow shadow); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view associated with the property change. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the changed property. + + + +`shadow` [Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') + +The new shadow value. + +#### Returns +[ShadowTokenPropertyChangedEventArgs](Tizen.UI.ShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.ShadowTokenPropertyChangedEventArgs') +An initialized [ShadowTokenPropertyChangedEventArgs](Tizen.UI.ShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.ShadowTokenPropertyChangedEventArgs') instance. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Size.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Size.md new file mode 100644 index 0000000000..031f02a97d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Size.md @@ -0,0 +1,347 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Size Struct + +Struct defining height and width as a pair of floats. + +```csharp +public struct Size : +System.IEquatable<Tizen.UI.Size> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[Size](Tizen.UI.Size.md 'Tizen.UI.Size')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## Size(float, float) Constructor + +Creates a new Size object with width and height. + +```csharp +public Size(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the new size. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the new size. +### Fields + + + +## Size.Zero Field + +The Size whose values for height and width are 0.0. + +```csharp +public static readonly Size Zero; +``` + +#### Field Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +### Properties + + + +## Size.Height Property + +Magnitude along the vertical axis, in platform-specific units. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Size.IsZero Property + +Whether the Size has Height and Width of 0.0. + +```csharp +public bool IsZero { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Size.Width Property + +Magnitude along the horizontal axis, in platform-defined units. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Size.Deconstruct(float, float) Method + +Deconstructs the Size object into its individual components (width and height). + +```csharp +public void Deconstruct(out float width, out float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width component of the Size object. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height component of the Size object. + + + +## Size.Equals(object) Method + +Whether thisSize is equivalent to obj. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to which this is being compared. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if obj is a Size whose values are identical to thisSize's Height and Width. + + + +## Size.Equals(Size) Method + +Whether thisSize is equivalent to other. + +```csharp +public bool Equals(Tizen.UI.Size other); +``` +#### Parameters + + + +`other` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The Size to which this is being compared. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if other's values are identical to thisSize's Height and Width. + + + +## Size.GetHashCode() Method + +Returns a hash value for the Size. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A value intended for efficient insertion and lookup in hashtable-based data structures. + + + +## Size.ToString() Method + +Returns a human-readable representation of the Size. + +```csharp +public override string ToString(); +``` + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The format has the pattern "\{Width=\{0} Height=\{1}}". +### Operators + + + +## Size.operator +(Size, Size) Operator + +Returns a new Size whose Height and Width are the sum of the component's height and width. + +```csharp +public static Tizen.UI.Size operator +(Tizen.UI.Size s1, Tizen.UI.Size s2); +``` +#### Parameters + + + +`s1` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size to be added. + + + +`s2` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size to be added. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +A Size whose Width is equal to s1.Width + s2.Width and whose Height is equal to sz1.Height + sz2.Height. + + + +## Size.operator ==(Size, Size) Operator + +Whether two Sizes have equal values. + +```csharp +public static bool operator ==(Tizen.UI.Size s1, Tizen.UI.Size s2); +``` +#### Parameters + + + +`s1` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size to be compared. + + + +`s2` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size to be compared. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if s1 and s2 have equal values for Height and Width. + + + +## Size.explicit operator Point(Size) Operator + +Returns a new Point based on a Size. + +```csharp +public static Tizen.UI.Point explicit operator Point(Tizen.UI.Size size); +``` +#### Parameters + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The Size to be converted to a Point. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +A Point whose X and Y are equal to size's Width and Height, respectively. + + + +## Size.operator !=(Size, Size) Operator + +Whether two Sizes have unequal values. + +```csharp +public static bool operator !=(Tizen.UI.Size s1, Tizen.UI.Size s2); +``` +#### Parameters + + + +`s1` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The first Size to compare. + + + +`s2` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The second Size to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if s1 and s2 have unequal values for either Height or Width. + + + +## Size.operator *(Size, float) Operator + +Scales both Width and Height. + +```csharp +public static Tizen.UI.Size operator *(Tizen.UI.Size s1, float value); +``` +#### Parameters + + + +`s1` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size to be scaled. + + + +`value` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +A factor by which to multiple s1's Width and Height values. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +A new Size whose Width and Height have been scaled by value. + + + +## Size.operator -(Size, Size) Operator + +Returns a new Size whose Height and Width are s1's height and width minus the values in s2. + +```csharp +public static Tizen.UI.Size operator -(Tizen.UI.Size s1, Tizen.UI.Size s2); +``` +#### Parameters + + + +`s1` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +A Size from whose values a size will be subtracted. + + + +`s2` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The Size to subtract from s1. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +A Size whose Width is equal to s1.Width - s2.Width and whose Height is equal to sz1.Height - sz2.Height. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SizePropertyValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SizePropertyValue.md new file mode 100644 index 0000000000..ded93d4e6b --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SizePropertyValue.md @@ -0,0 +1,107 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## SizePropertyValue Class + +Represents a property value that represents the size of a view. + +```csharp +public class SizePropertyValue : Tizen.UI.AnimatablePropertyValue +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') 🡒 SizePropertyValue +### Constructors + + + +## SizePropertyValue(float, float) Constructor + +Initializes a new instance of the [SizePropertyValue](Tizen.UI.SizePropertyValue.md 'Tizen.UI.SizePropertyValue') class. + +```csharp +public SizePropertyValue(float width, float height); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the size. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The height of the size. + + + +## SizePropertyValue(Size) Constructor + +Initializes a new instance of the [SizePropertyValue](Tizen.UI.SizePropertyValue.md 'Tizen.UI.SizePropertyValue') class. + +```csharp +public SizePropertyValue(Tizen.UI.Size size); +``` +#### Parameters + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size to use. +### Properties + + + +## SizePropertyValue.Size Property + +Gets the size represented by this property value. + +```csharp +public Tizen.UI.Size Size { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## SizePropertyValue.Value Property + +Gets the value of the property. + +```csharp +public override Tizen.UI.NativeHandle.PropertyValueHandle Value { get; } +``` + +#### Property Value +[PropertyValueHandle](Tizen.UI.NativeHandle.PropertyValueHandle.md 'Tizen.UI.NativeHandle.PropertyValueHandle') +### Methods + + + +## SizePropertyValue.GetTargetProperty(View) Method + +Gets the target property handle for the animation. + +```csharp +public override Tizen.UI.NativeHandle.AnimatablePropertyHandle GetTargetProperty(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to which the property belongs. + +#### Returns +[AnimatablePropertyHandle](Tizen.UI.NativeHandle.AnimatablePropertyHandle.md 'Tizen.UI.NativeHandle.AnimatablePropertyHandle') +The target property handle. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Strikethrough.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Strikethrough.md new file mode 100644 index 0000000000..2f31894e59 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Strikethrough.md @@ -0,0 +1,54 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Strikethrough Struct + +A struct to express text strikethrough. + +```csharp +public struct Strikethrough +``` +### Fields + + + +## Strikethrough.None Field + +A predefined struct for no strikethrough. + +```csharp +public static readonly Strikethrough None; +``` + +#### Field Value +[Strikethrough](Tizen.UI.Strikethrough.md 'Tizen.UI.Strikethrough') +### Properties + + + +## Strikethrough.Color Property + +Gets or sets the color of + +```csharp +public Tizen.UI.Color Color { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## Strikethrough.Thickness Property + +Gets or sets the blur radius of the shadow. + +```csharp +public float Thickness { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SystemFontSizeManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SystemFontSizeManager.md new file mode 100644 index 0000000000..2ba87c4354 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SystemFontSizeManager.md @@ -0,0 +1,109 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## SystemFontSizeManager Class + +Provides a system-wide font size manager. + +```csharp +public static class SystemFontSizeManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SystemFontSizeManager +### Properties + + + +## SystemFontSizeManager.CurrentFontScale Property + +Gets the current font scale. + +```csharp +public static float CurrentFontScale { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## SystemFontSizeManager.IsSupportSystemFontSize Property + +Gets a value indicating whether the system supports changing the font size. + +```csharp +public static bool IsSupportSystemFontSize { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## SystemFontSizeManager.SystemFontSize Property + +Provides a static property to get the current system font size. + +```csharp +public static SystemSettingsFontSize SystemFontSize { get; } +``` + +#### Property Value +Tizen.System.SystemSettingsFontSize +### Methods + + + +## SystemFontSizeManager.GetScale(SystemSettingsFontSize) Method + +Gets the font scale for the specified system settings font size. + +```csharp +public static float GetScale(SystemSettingsFontSize settingSize); +``` +#### Parameters + + + +`settingSize` Tizen.System.SystemSettingsFontSize + +The system settings font size. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The font scale for the specified system settings font size. + + + +## SystemFontSizeManager.UpdateScaleTable(IDictionary<SystemSettingsFontSize,float>) Method + +Updates the scale table with the specified values. + +```csharp +public static void UpdateScaleTable(System.Collections.Generic.IDictionary<SystemSettingsFontSize,float> table); +``` +#### Parameters + + + +`table` [System.Collections.Generic.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')Tizen.System.SystemSettingsFontSize[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2') + +The dictionary containing the new scale values. +### Events + + + +## SystemFontSizeManager.FontScaleChanged Event + +Occurs when the system font size changes. + +```csharp +public static event EventHandler FontScaleChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGesture.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGesture.md new file mode 100644 index 0000000000..462577eeb8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGesture.md @@ -0,0 +1,81 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TapGesture Class + +The TapGesture class represents a gesture that recognizes a single tap on the screen. + +```csharp +public class TapGesture : Tizen.UI.Gesture +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') 🡒 TapGesture +### Constructors + + + +## TapGesture(IntPtr, bool) Constructor + +Initializes a new instance of the TapGesture class with the specified handle and ownership flag. + +```csharp +public TapGesture(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the native Tap gesture. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the handle is owned by the new instance. +### Properties + + + +## TapGesture.NumberOfTaps Property + +Gets the number of taps recognized by the gesture. + +```csharp +public int NumberOfTaps { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## TapGesture.Position Property + +Gets the local position of the tap gesture. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## TapGesture.ScreenPosition Property + +Gets the screen position of the tap gesture. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetectedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetectedEventArgs.md new file mode 100644 index 0000000000..de9e5d66d9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetectedEventArgs.md @@ -0,0 +1,55 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TapGestureDetectedEventArgs Class + +Event arguments for [TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') event. + +```csharp +public class TapGestureDetectedEventArgs : Tizen.UI.GestureDetectedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') 🡒 TapGestureDetectedEventArgs +### Constructors + + + +## TapGestureDetectedEventArgs(View, TapGesture) Constructor + +Initializes a new instance of the [TapGestureDetectedEventArgs](Tizen.UI.TapGestureDetectedEventArgs.md 'Tizen.UI.TapGestureDetectedEventArgs') class. + +```csharp +public TapGestureDetectedEventArgs(Tizen.UI.View view, Tizen.UI.TapGesture tapGesture); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view that the tap gesture was detected on. + + + +`tapGesture` [TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') + +The tap gesture that was detected. +### Properties + + + +## TapGestureDetectedEventArgs.Gesture Property + +Gets the tap gesture that was detected. + +```csharp +public Tizen.UI.TapGesture Gesture { get; } +``` + +#### Property Value +[TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetector.md new file mode 100644 index 0000000000..cd42d4172e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetector.md @@ -0,0 +1,86 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TapGestureDetector Class + +The TapGestureDetector class is used to detect when the user performs a tap gesture on a view. + +```csharp +public class TapGestureDetector : Tizen.UI.GestureDetector +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') 🡒 TapGestureDetector +### Constructors + + + +## TapGestureDetector() Constructor + +Creates a new TapGestureDetector. + +```csharp +public TapGestureDetector(); +``` + + + +## TapGestureDetector(int) Constructor + +Creates a new TapGestureDetector with the specified number of taps required. + +```csharp +public TapGestureDetector(int tapsRequired); +``` +#### Parameters + + + +`tapsRequired` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of taps required for the gesture to be recognized. +### Properties + + + +## TapGestureDetector.MaximumTapsRequired Property + +Gets or sets the maximum number of taps required for the gesture to be recognized. + +```csharp +public int MaximumTapsRequired { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## TapGestureDetector.MinimumTapsRequired Property + +Gets or sets the minimum number of taps required for the gesture to be recognized. + +```csharp +public int MinimumTapsRequired { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Events + + + +## TapGestureDetector.Detected Event + +Occurs when the user performs a tap gesture on the view. + +```csharp +public event EventHandler<TapGestureDetectedEventArgs> Detected; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TapGestureDetectedEventArgs](Tizen.UI.TapGestureDetectedEventArgs.md 'Tizen.UI.TapGestureDetectedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TbmSurfaceView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TbmSurfaceView.md new file mode 100644 index 0000000000..5b2ea75168 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TbmSurfaceView.md @@ -0,0 +1,84 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TbmSurfaceView Class + +The TbmSurfaceView class represents a view that renders a texture using a TBM (Tizen Buffer Manager) surface. + +```csharp +public class TbmSurfaceView : Tizen.UI.View +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 TbmSurfaceView +### Constructors + + + +## TbmSurfaceView() Constructor + +Initializes a new instance of the TbmSurfaceView class with the specified width and height. + +```csharp +public TbmSurfaceView(); +``` +### Methods + + + +## TbmSurfaceView.SetSource(IntPtr) Method + +```csharp +public void SetSource(System.IntPtr tbmSurface); +``` +#### Parameters + + + +`tbmSurface` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +### Remarks +It must be called on the UI thread. + + + +## TbmSurfaceView.SetSource(NativeImageSource) Method + +Sets the source of the TbmSurfaceView. + +```csharp +public void SetSource(Tizen.UI.Internal.NativeImageSource source); +``` +#### Parameters + + + +`source` [NativeImageSource](Tizen.UI.Internal.NativeImageSource.md 'Tizen.UI.Internal.NativeImageSource') + +The NativeImageSource object to set as the source. + +### Remarks +It must be called on the UI thread. + + + +## TbmSurfaceView.SetSource(Texture) Method + +Sets the source texture for the TbmSurfaceView. + +```csharp +public void SetSource(Tizen.UI.Internal.Texture texture); +``` +#### Parameters + + + +`texture` Tizen.UI.Internal.Texture + +The new texture to set as the source. + +### Remarks +It must be called on the UI thread. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Template_T_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Template_T_.md new file mode 100644 index 0000000000..018719dc1f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Template_T_.md @@ -0,0 +1,100 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Template<T> Class + +A generic template class that provides a way to create and setup instances of a specified type. + +```csharp +public class Template<T> + where T : class +``` +#### Type parameters + + + +`T` + +The type of the object to create and setup. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Template<T> + +Derived +↳ [ViewTemplate](Tizen.UI.ViewTemplate.md 'Tizen.UI.ViewTemplate') +### Constructors + + + +## Template(Func<T>) Constructor + +Initializes a new instance of the Template class using a specified load template function. + +```csharp +public Template(System.Func<T> loadTemplate); +``` +#### Parameters + + + +`loadTemplate` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[T](Tizen.UI.Template_T_.md#Tizen.UI.Template_T_.T 'Tizen.UI.Template<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The function to load the template. + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if loadTemplate is null. + + + +## Template(Type) Constructor + +Initializes a new instance of the Template class using a specified type. + +```csharp +public Template(System.Type type); +``` +#### Parameters + + + +`type` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') + +The type to instantiate. + +#### Exceptions + +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +Thrown if type is null. +### Properties + + + +## Template<T>.LoadTemplate Property + +Gets the [LoadTemplate](Tizen.UI.Template_T_.md#Tizen.UI.Template_T_.LoadTemplate 'Tizen.UI.Template<T>.LoadTemplate') function used to create the obejct from the template. + +```csharp +public System.Func<T> LoadTemplate { get; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[T](Tizen.UI.Template_T_.md#Tizen.UI.Template_T_.T 'Tizen.UI.Template<T>.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') +### Methods + + + +## Template<T>.CreateContent() Method + +Creates an instance of the object from the template and sets it up. + +```csharp +public T CreateContent(); +``` + +#### Returns +[T](Tizen.UI.Template_T_.md#Tizen.UI.Template_T_.T 'Tizen.UI.Template<T>.T') +The created instance. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextAlignment.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextAlignment.md new file mode 100644 index 0000000000..30e1efcc78 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextAlignment.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextAlignment Enum + +Enumeration for text alignment options. + +```csharp +public enum TextAlignment +``` +### Fields + + + +`Center` 1 + +Aligns the text to the center of the line. + + + +`End` 2 + +Aligns the text to the end of the line. + + + +`Start` 0 + +Aligns the text to the start of the line. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextBindings_T_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextBindings_T_.md new file mode 100644 index 0000000000..cf8594f42c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextBindings_T_.md @@ -0,0 +1,63 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextBindings<T> Class + +Provides a set of static properties that represent the data-binding capabilities of the [Itext](https://docs.microsoft.com/en-us/dotnet/api/Itext 'Itext') interface. + +```csharp +public static class TextBindings<T> + where T : Tizen.UI.View, Tizen.UI.IText +``` +#### Type parameters + + + +`T` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextBindings<T> +### Properties + + + +## TextBindings<T>.FontSizeProperty Property + +Gets the binding property for the [Itext.FontSize](https://docs.microsoft.com/en-us/dotnet/api/Itext.FontSize 'Itext.FontSize') property. + +```csharp +public static Tizen.UI.BindingProperty<T,float> FontSizeProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[T](Tizen.UI.TextBindings_T_.md#Tizen.UI.TextBindings_T_.T 'Tizen.UI.TextBindings<T>.T')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## TextBindings<T>.TextColorProperty Property + +Gets the binding property for the [Itext.TextColor](https://docs.microsoft.com/en-us/dotnet/api/Itext.TextColor 'Itext.TextColor') property. + +```csharp +public static Tizen.UI.BindingProperty<T,Tizen.UI.Color> TextColorProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[T](Tizen.UI.TextBindings_T_.md#Tizen.UI.TextBindings_T_.T 'Tizen.UI.TextBindings<T>.T')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## TextBindings<T>.TextProperty Property + +Gets the binding property for the [Itext.Text](https://docs.microsoft.com/en-us/dotnet/api/Itext.Text 'Itext.Text') property. + +```csharp +public static Tizen.UI.BindingProperty<T,string> TextProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[T](Tizen.UI.TextBindings_T_.md#Tizen.UI.TextBindings_T_.T 'Tizen.UI.TextBindings<T>.T')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditor.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditor.md new file mode 100644 index 0000000000..67fd458d2f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditor.md @@ -0,0 +1,88 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextEditor Class + +A TextEditor is a multi-line text input control that supports various text editing features. + +```csharp +public class TextEditor : Tizen.UI.InputView, +Tizen.UI.Internal.ITextEditorSignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') 🡒 TextEditor + +Implements Tizen.UI.Internal.ITextEditorSignalHandler +### Constructors + + + +## TextEditor() Constructor + +Creates a new TextEditor. + +```csharp +public TextEditor(); +``` +### Properties + + + +## TextEditor.IsAbsoluteLineHeight Property + +Gets or sets whether the line height is absolute or relative. Default is false. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextEditor.LineHeight Property + +Gets or sets the line height of the text. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextEditor.TextOverflow Property + +Gets or sets the TextOverflow of the text. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +[TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') +### Methods + + + +## TextEditor.SetInputMethodSetting(InputMethodSetting) Method + +Sets the input method settings. + +```csharp +public override void SetInputMethodSetting(Tizen.UI.InputMethodSetting inputMethod); +``` +#### Parameters + + + +`inputMethod` [InputMethodSetting](Tizen.UI.InputMethodSetting.md 'Tizen.UI.InputMethodSetting') + +The input method settings. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditorExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditorExtensions.md new file mode 100644 index 0000000000..4d506d44d6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditorExtensions.md @@ -0,0 +1,87 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextEditorExtensions Class + +Provides a set of extension methods for the [TextEditor](Tizen.UI.TextEditor.md 'Tizen.UI.TextEditor') class. + +```csharp +public static class TextEditorExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextEditorExtensions +### Methods + + + +## TextEditorExtensions.IsAbsoluteLineHeight<TView>(this TView, bool) Method + +Sets whether the line height is absolute or relative. + +```csharp +public static TView IsAbsoluteLineHeight<TView>(this TView view, bool isAbsoluteLineHeight) + where TView : Tizen.UI.TextEditor; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextEditorExtensions.md#Tizen.UI.TextEditorExtensions.IsAbsoluteLineHeight_TView_(thisTView,bool).TView 'Tizen.UI.TextEditorExtensions.IsAbsoluteLineHeight<TView>(this TView, bool).TView') + +The TextEditor instance. + + + +`isAbsoluteLineHeight` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the value of line height is absolute value, false otherwise. + +#### Returns +[TView](Tizen.UI.TextEditorExtensions.md#Tizen.UI.TextEditorExtensions.IsAbsoluteLineHeight_TView_(thisTView,bool).TView 'Tizen.UI.TextEditorExtensions.IsAbsoluteLineHeight<TView>(this TView, bool).TView') +The TextEditor instance. + + + +## TextEditorExtensions.LineHeight<TView>(this TView, float) Method + +Sets the line height of the TextEditor. + +```csharp +public static TView LineHeight<TView>(this TView view, float height) + where TView : Tizen.UI.TextEditor; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextEditorExtensions.md#Tizen.UI.TextEditorExtensions.LineHeight_TView_(thisTView,float).TView 'Tizen.UI.TextEditorExtensions.LineHeight<TView>(this TView, float).TView') + +The TextEditor instance. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative line height. + +#### Returns +[TView](Tizen.UI.TextEditorExtensions.md#Tizen.UI.TextEditorExtensions.LineHeight_TView_(thisTView,float).TView 'Tizen.UI.TextEditorExtensions.LineHeight<TView>(this TView, float).TView') +The TextEditor instance with the specified relative line height. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextExtensions.md new file mode 100644 index 0000000000..69a585eb50 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextExtensions.md @@ -0,0 +1,680 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextExtensions Class + +Provides a series of extension methods that support configuring a Text. + +```csharp +public static class TextExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextExtensions +### Methods + + + +## TextExtensions.FontFamily<TView>(this TView, string) Method + +Sets the font family of the text in the TextView. + +```csharp +public static TView FontFamily<TView>(this TView view, string fontFamily) + where TView : Tizen.UI.IText; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.FontFamily_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.FontFamily<TView>(this TView, string).TView') + +The view instance. + + + +`fontFamily` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The font family of the text. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.FontFamily_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.FontFamily<TView>(this TView, string).TView') +The view instance with the specified font family. + + + +## TextExtensions.FontSize<TView>(this TView, float) Method + +Sets the font size of the view. + +```csharp +public static TView FontSize<TView>(this TView view, float fontSize) + where TView : Tizen.UI.IText; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.FontSize_TView_(thisTView,float).TView 'Tizen.UI.TextExtensions.FontSize<TView>(this TView, float).TView') + +The view instance. + + + +`fontSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The font size to set. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.FontSize_TView_(thisTView,float).TView 'Tizen.UI.TextExtensions.FontSize<TView>(this TView, float).TView') +The view instance. + + + +## TextExtensions.HorizontalAlignment<TView>(this TView, TextAlignment) Method + +Sets the horizontal alignment of the text in the TextView. + +```csharp +public static TView HorizontalAlignment<TView>(this TView view, Tizen.UI.TextAlignment alignment) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.HorizontalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.TextExtensions.HorizontalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') + +The View instance. + + + +`alignment` [TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + +The horizontal alignment of the text. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.HorizontalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.TextExtensions.HorizontalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') +The View instance with the specified horizontal alignment. + + + +## TextExtensions.MultiLine<TView>(this TView, bool) Method + +Sets whether the view should be multi-line or not. + +```csharp +public static TView MultiLine<TView>(this TView view, bool multiLine) + where TView : Tizen.UI.ITextFormatting; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.MultiLine_TView_(thisTView,bool).TView 'Tizen.UI.TextExtensions.MultiLine<TView>(this TView, bool).TView') + +The view instance. + + + +`multiLine` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the view should be multi-line, false otherwise. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.MultiLine_TView_(thisTView,bool).TView 'Tizen.UI.TextExtensions.MultiLine<TView>(this TView, bool).TView') +The view instance. + + + +## TextExtensions.Text<TView>(this TView, string) Method + +Sets the text of the view. + +```csharp +public static TView Text<TView>(this TView view, string text) + where TView : Tizen.UI.IText; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.Text_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.Text<TView>(this TView, string).TView') + +The view instance. + + + +`text` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text to set. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.Text_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.Text<TView>(this TView, string).TView') +The view instance. + + + +## TextExtensions.TextCenter<TView>(this TView) Method + +Sets the horizontal and vertical alignment of the text in the view to center. + +```csharp +public static TView TextCenter<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenter_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenter<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenter_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenter<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextCenterHorizontal<TView>(this TView) Method + +Sets the horizontal alignment of the text in the view to center. + +```csharp +public static TView TextCenterHorizontal<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenterHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenterHorizontal<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenterHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenterHorizontal<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextCenterVertical<TView>(this TView) Method + +Sets the vertical alignment of the text in the view to center. + +```csharp +public static TView TextCenterVertical<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenterVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenterVertical<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextCenterVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextCenterVertical<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextColor<TView>(this TView, Color) Method + +Sets the text color of the view. + +```csharp +public static TView TextColor<TView>(this TView view, Tizen.UI.Color textColor) + where TView : Tizen.UI.IText; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.TextExtensions.TextColor<TView>(this TView, Tizen.UI.Color).TView') + +The view instance. + + + +`textColor` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The text color to set. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.TextExtensions.TextColor<TView>(this TView, Tizen.UI.Color).TView') +The view instance. + + + +## TextExtensions.TextColorFromHex<TView>(this TView, string) Method + +Sets the text color of the view from a hexadecimal string. + +```csharp +public static TView TextColorFromHex<TView>(this TView view, string textColor) + where TView : Tizen.UI.IText; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.TextColorFromHex<TView>(this TView, string).TView') + +The view instance. + + + +`textColor` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The text color to set, in hexadecimal format. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.TextExtensions.TextColorFromHex<TView>(this TView, string).TView') +The view instance. + + + +## TextExtensions.TextEnd<TView>(this TView) Method + +Sets the horizontal and vertical alignment of the text in the view to end. + +```csharp +public static TView TextEnd<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEnd_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEnd<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEnd_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEnd<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextEndHorizontal<TView>(this TView) Method + +Sets the horizontal alignment of the text in the view to end. + +```csharp +public static TView TextEndHorizontal<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEndHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEndHorizontal<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEndHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEndHorizontal<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextEndVertical<TView>(this TView) Method + +Sets the vertical alignment of the text in the view to end. + +```csharp +public static TView TextEndVertical<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEndVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEndVertical<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextEndVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextEndVertical<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextOverflow<TView>(this TView, TextOverflow) Method + +Sets whether the text in the TextView should be truncated with an ellipsis when it does not fit within its bounds. + +```csharp +public static TView TextOverflow<TView>(this TView view, Tizen.UI.TextOverflow textOverflow) + where TView : Tizen.UI.ITextFormatting; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextOverflow_TView_(thisTView,Tizen.UI.TextOverflow).TView 'Tizen.UI.TextExtensions.TextOverflow<TView>(this TView, Tizen.UI.TextOverflow).TView') + +The View instance. + + + +`textOverflow` [TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') + +Text overflow behavior. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextOverflow_TView_(thisTView,Tizen.UI.TextOverflow).TView 'Tizen.UI.TextExtensions.TextOverflow<TView>(this TView, Tizen.UI.TextOverflow).TView') +The View instance with the specified ellipsis setting. + + + +## TextExtensions.TextPadding<T>(this T, float) Method + +Sets the padding for the text of the view. + +```csharp +public static T TextPadding<T>(this T view, float uniformSize) + where T : Tizen.UI.ITextPadding; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextPadding_T_(thisT,float).T 'Tizen.UI.TextExtensions.TextPadding<T>(this T, float).T') + +The view to set the text padding for. + + + +`uniformSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform size of the padding. + +#### Returns +[T](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextPadding_T_(thisT,float).T 'Tizen.UI.TextExtensions.TextPadding<T>(this T, float).T') +The view itself. + + + +## TextExtensions.TextPadding<T>(this T, float, float, float, float) Method + +Sets the padding for the text in the view. + +```csharp +public static T TextPadding<T>(this T view, float left, float top, float right, float bottom) + where T : Tizen.UI.ITextPadding; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextPadding_T_(thisT,float,float,float,float).T 'Tizen.UI.TextExtensions.TextPadding<T>(this T, float, float, float, float).T') + +The view to set the text padding for. + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The left padding. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The top padding. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The right padding. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The bottom padding. + +#### Returns +[T](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextPadding_T_(thisT,float,float,float,float).T 'Tizen.UI.TextExtensions.TextPadding<T>(this T, float, float, float, float).T') +The view itself. + + + +## TextExtensions.TextStart<TView>(this TView) Method + +Sets the horizontal and vertical alignment of the text in the view to start. + +```csharp +public static TView TextStart<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStart_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStart<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStart_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStart<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextStartHorizontal<TView>(this TView) Method + +Sets the horizontal alignment of the text in the view to start. + +```csharp +public static TView TextStartHorizontal<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStartHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStartHorizontal<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStartHorizontal_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStartHorizontal<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.TextStartVertical<TView>(this TView) Method + +Sets the vertical alignment of the text in the view to start. + +```csharp +public static TView TextStartVertical<TView>(this TView view) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStartVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStartVertical<TView>(this TView).TView') + +The view instance. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.TextStartVertical_TView_(thisTView).TView 'Tizen.UI.TextExtensions.TextStartVertical<TView>(this TView).TView') +The view instance. + + + +## TextExtensions.VerticalAlignment<TView>(this TView, TextAlignment) Method + +Sets the vertical alignment of the text in the TextView. + +```csharp +public static TView VerticalAlignment<TView>(this TView view, Tizen.UI.TextAlignment alignment) + where TView : Tizen.UI.ITextAlignment; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.VerticalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.TextExtensions.VerticalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') + +The View instance. + + + +`alignment` [TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + +The vertical alignment of the text. + +#### Returns +[TView](Tizen.UI.TextExtensions.md#Tizen.UI.TextExtensions.VerticalAlignment_TView_(thisTView,Tizen.UI.TextAlignment).TView 'Tizen.UI.TextExtensions.VerticalAlignment<TView>(this TView, Tizen.UI.TextAlignment).TView') +The View instance with the specified vertical alignment. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextField.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextField.md new file mode 100644 index 0000000000..7c099dad2e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextField.md @@ -0,0 +1,75 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextField Class + +A text field is an interactive object that the user can enter text into. + +```csharp +public class TextField : Tizen.UI.InputView, +Tizen.UI.Internal.ITextFieldSignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') 🡒 TextField + +Implements Tizen.UI.Internal.ITextFieldSignalHandler +### Constructors + + + +## TextField() Constructor + +Initializes a new instance of the [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') class. + +```csharp +public TextField(); +``` +### Properties + + + +## TextField.IsPassword Property + +Gets or sets a value indicating whether the text field is a password field. + +```csharp +public bool IsPassword { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextField.TextOverflow Property + +Gets or sets the TextOverflow of the text. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +#### Property Value +[TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') +### Methods + + + +## TextField.SetInputMethodSetting(InputMethodSetting) Method + +Sets the input method settings. + +```csharp +public override void SetInputMethodSetting(Tizen.UI.InputMethodSetting setting); +``` +#### Parameters + + + +`setting` [InputMethodSetting](Tizen.UI.InputMethodSetting.md 'Tizen.UI.InputMethodSetting') + +The input method settings. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextFieldExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextFieldExtensions.md new file mode 100644 index 0000000000..6981dd377e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextFieldExtensions.md @@ -0,0 +1,51 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextFieldExtensions Class + +Provides a set of extension methods for the [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') class. + +```csharp +public static class TextFieldExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextFieldExtensions +### Methods + + + +## TextFieldExtensions.IsPassword<TView>(this TView, bool) Method + +Sets the IsPassword property of the given [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') instance. + +```csharp +public static TView IsPassword<TView>(this TView view, bool isPassword) + where TView : Tizen.UI.TextField; +``` +#### Type parameters + + + +`TView` + +The type of the [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') instance. +#### Parameters + + + +`view` [TView](Tizen.UI.TextFieldExtensions.md#Tizen.UI.TextFieldExtensions.IsPassword_TView_(thisTView,bool).TView 'Tizen.UI.TextFieldExtensions.IsPassword<TView>(this TView, bool).TView') + +The [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') instance. + + + +`isPassword` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the text field should display its text as asterisks. + +#### Returns +[TView](Tizen.UI.TextFieldExtensions.md#Tizen.UI.TextFieldExtensions.IsPassword_TView_(thisTView,bool).TView 'Tizen.UI.TextFieldExtensions.IsPassword<TView>(this TView, bool).TView') +The same instance of the [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') class. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextOverflow.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextOverflow.md new file mode 100644 index 0000000000..33c4dc1a87 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextOverflow.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextOverflow Enum + +Enumeration for the text overflow behavior. + +```csharp +public enum TextOverflow +``` +### Fields + + + +`Clip` 4 + +Clip the overflowing text to fix its container. + + + +`EndEllipsis` 0 + +The ellipsis is placed at the end of the text block. + + + +`MiddleEllipsis` 2 + +The ellipsis is placed in the middle of the text block. + + + +`StartEllipsis` 1 + +The ellipsis is placed at the start of the text block. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextShadow.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextShadow.md new file mode 100644 index 0000000000..225390e86e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextShadow.md @@ -0,0 +1,53 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextShadow Struct + +The TextShadow struct represents the shadow effect applied to text. + +```csharp +public struct TextShadow +``` +### Fields + + + +## TextShadow.BlurRadius Field + +Gets or sets the blur radius of the shadow. + +```csharp +public Nullable<float> BlurRadius; +``` + +#### Field Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextShadow.Color Field + +Gets or sets the color of the shadow. + +```csharp +public Nullable<Color> Color; +``` + +#### Field Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## TextShadow.Offset Field + +Gets or sets the offset of the shadow. + +```csharp +public Nullable<Point> Offset; +``` + +#### Field Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Point](Tizen.UI.Point.md 'Tizen.UI.Point')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextView.md new file mode 100644 index 0000000000..d576b8378f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextView.md @@ -0,0 +1,555 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextView Class + +A TextView is a text control that displays a short to medium length string of text. + +```csharp +public class TextView : Tizen.UI.View, +Tizen.UI.IText, +Tizen.UI.ITextPadding, +Tizen.UI.ITextAlignment, +Tizen.UI.ITextFormatting, +Tizen.UI.Internal.ILabelSignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 TextView + +Implements [IText](Tizen.UI.IText.md 'Tizen.UI.IText'), [ITextPadding](Tizen.UI.ITextPadding.md 'Tizen.UI.ITextPadding'), [ITextAlignment](Tizen.UI.ITextAlignment.md 'Tizen.UI.ITextAlignment'), [ITextFormatting](Tizen.UI.ITextFormatting.md 'Tizen.UI.ITextFormatting'), Tizen.UI.Internal.ILabelSignalHandler +### Constructors + + + +## TextView() Constructor + +Creates a new instance of a TextView. + +```csharp +public TextView(); +``` +### Properties + + + +## TextView.AutoAdjustedFontSize Property + +Gets the adjusted font size after fitting the text to the size of the control. + +```csharp +public float AutoAdjustedFontSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextView.FontFamily Property + +Gets or sets the font family of the text. + +```csharp +public string FontFamily { get; set; } +``` + +Implements [FontFamily](Tizen.UI.IText.md#Tizen.UI.IText.FontFamily 'Tizen.UI.IText.FontFamily') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextView.FontSize Property + +Gets or sets the font size of the text. + +```csharp +public float FontSize { get; set; } +``` + +Implements [FontSize](Tizen.UI.IText.md#Tizen.UI.IText.FontSize 'Tizen.UI.IText.FontSize') + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextView.HorizontalAlignment Property + +Gets or sets the horizontal alignment of the text. + +```csharp +public Tizen.UI.TextAlignment HorizontalAlignment { get; set; } +``` + +Implements [HorizontalAlignment](Tizen.UI.ITextAlignment.md#Tizen.UI.ITextAlignment.HorizontalAlignment 'Tizen.UI.ITextAlignment.HorizontalAlignment') + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') + + + +## TextView.IsAbsoluteLineHeight Property + +Gets or sets whether the line height is absolute or relative. Default is false. + +```csharp +public bool IsAbsoluteLineHeight { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.IsMarkupEnabled Property + +Gets or sets whether the text should be marked up with the HTML tags. + +```csharp +public bool IsMarkupEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.IsMultiline Property + +Gets or sets whether the text should be multi-line. + +```csharp +public bool IsMultiline { get; set; } +``` + +Implements [IsMultiline](Tizen.UI.ITextFormatting.md#Tizen.UI.ITextFormatting.IsMultiline 'Tizen.UI.ITextFormatting.IsMultiline') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.IsTextCutout Property + +Gets or sets whether to enable cutout of the text. + +```csharp +public bool IsTextCutout { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.IsTextScrolling Property + +Gets whether the text is currently scrolling. + +```csharp +public bool IsTextScrolling { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.LineBreakMode Property + +Gets or sets the line break mode of the text. + +```csharp +public Tizen.UI.LineBreakMode LineBreakMode { get; set; } +``` + +#### Property Value +[LineBreakMode](Tizen.UI.LineBreakMode.md 'Tizen.UI.LineBreakMode') + + + +## TextView.LineCount Property + +Gets the number of lines of text. + +```csharp +public int LineCount { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## TextView.LineHeight Property + +Gets or sets the line height of the text. + +```csharp +public float LineHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextView.ScaledFontSize Property + +Gets the scaled font size of the text based on the current font size scale. + +```csharp +public float ScaledFontSize { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## TextView.SystemFontScaleEnabled Property + +Gets or sets whether the font size should be scaled based on the system settings. + +```csharp +public bool SystemFontScaleEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TextView.Text Property + +Gets or sets the text to display. + +```csharp +public string Text { get; set; } +``` + +Implements [Text](Tizen.UI.IText.md#Tizen.UI.IText.Text 'Tizen.UI.IText.Text') + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TextView.TextColor Property + +Gets or sets the color of the text. + +```csharp +public Tizen.UI.Color TextColor { get; set; } +``` + +Implements [TextColor](Tizen.UI.IText.md#Tizen.UI.IText.TextColor 'Tizen.UI.IText.TextColor') + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## TextView.TextOverflow Property + +Gets or sets the TextOverflow of the text. + +```csharp +public Tizen.UI.TextOverflow TextOverflow { get; set; } +``` + +Implements [TextOverflow](Tizen.UI.ITextFormatting.md#Tizen.UI.ITextFormatting.TextOverflow 'Tizen.UI.ITextFormatting.TextOverflow') + +#### Property Value +[TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') + + + +## TextView.VerticalAlignment Property + +Gets or sets the vertical alignment of the text. + +```csharp +public Tizen.UI.TextAlignment VerticalAlignment { get; set; } +``` + +Implements [VerticalAlignment](Tizen.UI.ITextAlignment.md#Tizen.UI.ITextAlignment.VerticalAlignment 'Tizen.UI.ITextAlignment.VerticalAlignment') + +#### Property Value +[TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') +### Methods + + + +## TextView.ClearOutline() Method + +Clears the outline + +```csharp +public void ClearOutline(); +``` + + + +## TextView.ClearUnderline() Method + +Clears the underline + +```csharp +public void ClearUnderline(); +``` + + + +## TextView.GetHeightForWidth(float) Method + +Gets for the given width. + +```csharp +public float GetHeightForWidth(float width); +``` +#### Parameters + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width for which to calculate the height. + +#### Returns +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +The height that best fits the given width. + + + +## TextView.Measure(float, float) Method + +Measures the view based on the available width and height. + +```csharp +public override Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The measured size of the view. + + + +## TextView.SetAutoSize(AutoFontSize) Method + +Sets the auto size of the label. + +```csharp +public void SetAutoSize(Tizen.UI.AutoFontSize size); +``` +#### Parameters + + + +`size` [AutoFontSize](Tizen.UI.AutoFontSize.md 'Tizen.UI.AutoFontSize') + +The auto size to set. + + + +## TextView.SetMarqueeConfig(int, int, float, float) Method + +Sets the marquee config on the label. + +```csharp +public void SetMarqueeConfig(int loopCount=2, int speed=80, float gap=50f, float delay=0f); +``` +#### Parameters + + + +`loopCount` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of times the text should scroll before stopping. + + + +`speed` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The speed of the text scroll animation, measured in pixels per second. + + + +`gap` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The gap between the start of the text and the end of the text after each loop. + + + +`delay` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The delay before the text scroll animation starts, measured in seconds. + + + +## TextView.SetOutline(Outline) Method + +Sets the outline style for the text in the label. + +```csharp +public void SetOutline(Tizen.UI.Outline outline); +``` +#### Parameters + + + +`outline` [Outline](Tizen.UI.Outline.md 'Tizen.UI.Outline') + +The outline style to apply to the text. + + + +## TextView.SetTextPadding(Thickness) Method + +Sets the padding for the text within the label. + +```csharp +public void SetTextPadding(Tizen.UI.Thickness thickness); +``` +#### Parameters + + + +`thickness` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The padding thickness. + +Implements [SetTextPadding(Thickness)](Tizen.UI.ITextPadding.md#Tizen.UI.ITextPadding.SetTextPadding(Tizen.UI.Thickness) 'Tizen.UI.ITextPadding.SetTextPadding(Tizen.UI.Thickness)') + + + +## TextView.SetTextShadow(TextShadow) Method + +Sets the text shadow for the label. + +```csharp +public void SetTextShadow(Tizen.UI.TextShadow shadow); +``` +#### Parameters + + + +`shadow` [TextShadow](Tizen.UI.TextShadow.md 'Tizen.UI.TextShadow') + +The text shadow object. + + + +## TextView.SetUnderline(Underline) Method + +Sets the underline style for the text in the label. + +```csharp +public void SetUnderline(Tizen.UI.Underline underline); +``` +#### Parameters + + + +`underline` [Underline](Tizen.UI.Underline.md 'Tizen.UI.Underline') + +The underline style to apply to the text. + + + +## TextView.StartTextScroll(int, int, float, float) Method + +Starts the text scroll animation on the label. + +```csharp +public void StartTextScroll(int loopCount=2, int speed=80, float gap=50f, float delay=0f); +``` +#### Parameters + + + +`loopCount` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The number of times the text should scroll before stopping. + + + +`speed` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The speed of the text scroll animation, measured in pixels per second. + + + +`gap` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The gap between the start of the text and the end of the text after each loop. + + + +`delay` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The delay before the text scroll animation starts, measured in seconds. + + + +## TextView.StopTextScroll(bool) Method + +Stops the text scroll of the label. + +```csharp +public void StopTextScroll(bool immediate=true); +``` +#### Parameters + + + +`immediate` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +If true, the text stops immediately. If false, the text stops after finishing the loop. +### Events + + + +## TextView.AnchorClicked Event + +Occurs when the font size is adjusted by AutoFontSize. + +```csharp +public event EventHandler<AnchorClickedEventArgs> AnchorClicked; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[AnchorClickedEventArgs](Tizen.UI.AnchorClickedEventArgs.md 'Tizen.UI.AnchorClickedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## TextView.FontSizeAdjusted Event + +Occurs when the font size is adjusted by AutoFontSize. + +```csharp +public event EventHandler FontSizeAdjusted; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextViewExtensions.md new file mode 100644 index 0000000000..4cb9c6bf95 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextViewExtensions.md @@ -0,0 +1,191 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TextViewExtensions Class + +Provides a series of extension methods that support configuring a [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView'). + +```csharp +public static class TextViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TextViewExtensions +### Methods + + + +## TextViewExtensions.EllipsisPosition<TView>(this TView, TextOverflow) Method + +Sets the position of the ellipsis in the TextView when the text is truncated. + +```csharp +public static TView EllipsisPosition<TView>(this TView view, Tizen.UI.TextOverflow position) + where TView : Tizen.UI.TextView; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.EllipsisPosition_TView_(thisTView,Tizen.UI.TextOverflow).TView 'Tizen.UI.TextViewExtensions.EllipsisPosition<TView>(this TView, Tizen.UI.TextOverflow).TView') + +The TextView instance. + + + +`position` [TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') + +The position of the ellipsis. + +#### Returns +[TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.EllipsisPosition_TView_(thisTView,Tizen.UI.TextOverflow).TView 'Tizen.UI.TextViewExtensions.EllipsisPosition<TView>(this TView, Tizen.UI.TextOverflow).TView') +The TextView instance with the specified ellipsis position. + + + +## TextViewExtensions.IsAbsoluteLineHeight<TView>(this TView, bool) Method + +Sets whether the line height is absolute or relative. + +```csharp +public static TView IsAbsoluteLineHeight<TView>(this TView view, bool isAbsoluteLineHeight) + where TView : Tizen.UI.TextView; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.IsAbsoluteLineHeight_TView_(thisTView,bool).TView 'Tizen.UI.TextViewExtensions.IsAbsoluteLineHeight<TView>(this TView, bool).TView') + +The TextView instance. + + + +`isAbsoluteLineHeight` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the value of line height is absolute value, false otherwise. + +#### Returns +[TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.IsAbsoluteLineHeight_TView_(thisTView,bool).TView 'Tizen.UI.TextViewExtensions.IsAbsoluteLineHeight<TView>(this TView, bool).TView') +The TextView instance. + + + +## TextViewExtensions.IsMarkupEnabled<TView>(this TView, bool) Method + +Sets whether the text in the TextView should support markup. + +```csharp +public static TView IsMarkupEnabled<TView>(this TView view, bool enable) + where TView : Tizen.UI.TextView; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.IsMarkupEnabled_TView_(thisTView,bool).TView 'Tizen.UI.TextViewExtensions.IsMarkupEnabled<TView>(this TView, bool).TView') + +The TextView instance. + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the text should support markup, false otherwise. + +#### Returns +[TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.IsMarkupEnabled_TView_(thisTView,bool).TView 'Tizen.UI.TextViewExtensions.IsMarkupEnabled<TView>(this TView, bool).TView') +The TextView instance with the specified markup support setting. + + + +## TextViewExtensions.LineBreakMode<TView>(this TView, LineBreakMode) Method + +Sets the line break mode of the text in the TextView. + +```csharp +public static TView LineBreakMode<TView>(this TView view, Tizen.UI.LineBreakMode mode) + where TView : Tizen.UI.TextView; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.LineBreakMode_TView_(thisTView,Tizen.UI.LineBreakMode).TView 'Tizen.UI.TextViewExtensions.LineBreakMode<TView>(this TView, Tizen.UI.LineBreakMode).TView') + +The TextView instance. + + + +`mode` [LineBreakMode](Tizen.UI.LineBreakMode.md 'Tizen.UI.LineBreakMode') + +The line break mode of the text. + +#### Returns +[TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.LineBreakMode_TView_(thisTView,Tizen.UI.LineBreakMode).TView 'Tizen.UI.TextViewExtensions.LineBreakMode<TView>(this TView, Tizen.UI.LineBreakMode).TView') +The TextView instance with the specified line break mode. + + + +## TextViewExtensions.LineHeight<TView>(this TView, float) Method + +Sets the line height of the TextView. + +```csharp +public static TView LineHeight<TView>(this TView view, float height) + where TView : Tizen.UI.TextView; +``` +#### Type parameters + + + +`TView` + +The type of the View. +#### Parameters + + + +`view` [TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.LineHeight_TView_(thisTView,float).TView 'Tizen.UI.TextViewExtensions.LineHeight<TView>(this TView, float).TView') + +The TextView instance. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The relative line height. + +#### Returns +[TView](Tizen.UI.TextViewExtensions.md#Tizen.UI.TextViewExtensions.LineHeight_TView_(thisTView,float).TView 'Tizen.UI.TextViewExtensions.LineHeight<TView>(this TView, float).TView') +The TextView instance with the specified relative line height. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Thickness.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Thickness.md new file mode 100644 index 0000000000..a121d42f0c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Thickness.md @@ -0,0 +1,449 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Thickness Struct + +Defines the thickness of a border around a control. + +```csharp +public struct Thickness +``` +### Constructors + + + +## Thickness(float) Constructor + +Initializes a new instance of the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') struct with the specified uniform size. + +```csharp +public Thickness(float uniformSize); +``` +#### Parameters + + + +`uniformSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform size of the borders. + + + +## Thickness(float, float) Constructor + +Initializes a new instance of the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') struct with the specified horizontal and vertical sizes. + +```csharp +public Thickness(float horizontalSize, float verticalSize); +``` +#### Parameters + + + +`horizontalSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The horizontal size of the borders. + + + +`verticalSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The vertical size of the borders. + + + +## Thickness(float, float, float, float) Constructor + +Initializes a new instance of the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') struct with the specified left, top, right, and bottom sizes. + +```csharp +public Thickness(float left, float top, float right, float bottom); +``` +#### Parameters + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the left border. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the top border. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the right border. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the bottom border. +### Fields + + + +## Thickness.Zero Field + +Represents a [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') with all values set to 0. + +```csharp +public static Thickness Zero; +``` + +#### Field Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') +### Properties + + + +## Thickness.Bottom Property + +Gets or sets the width of the bottom border. + +```csharp +public float Bottom { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Thickness.HorizontalThickness Property + +Gets the total width of the horizontal borders. + +```csharp +public float HorizontalThickness { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Thickness.IsEmpty Property + +Gets a value indicating whether all borders have a width of 0. + +```csharp +public bool IsEmpty { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Thickness.IsNaN Property + +Gets a value indicating whether any border has a width of NaN. + +```csharp +public bool IsNaN { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Thickness.Left Property + +Gets or sets the width of the left border. + +```csharp +public float Left { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Thickness.Right Property + +Gets or sets the width of the right border. + +```csharp +public float Right { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Thickness.Top Property + +Gets or sets the width of the top border. + +```csharp +public float Top { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Thickness.VerticalThickness Property + +Gets the total height of the vertical borders. + +```csharp +public float VerticalThickness { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## Thickness.Deconstruct(float, float, float, float) Method + +Deconstructs the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') into its individual components. + +```csharp +public void Deconstruct(out float left, out float top, out float right, out float bottom); +``` +#### Parameters + + + +`left` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the left border. + + + +`top` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the top border. + + + +`right` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the right border. + + + +`bottom` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The width of the bottom border. + + + +## Thickness.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.Thickness.md#Tizen.UI.Thickness.Equals(object).obj 'Tizen.UI.Thickness.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## Thickness.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. +### Operators + + + +## Thickness.operator +(Thickness, float) Operator + +Adds the specified [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') to each component of the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness'). + +```csharp +public static Tizen.UI.Thickness operator +(Tizen.UI.Thickness left, float addend); +``` +#### Parameters + + + +`left` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +`addend` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The value to add. + +#### Returns +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') +A new [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') with the added values. + + + +## Thickness.operator +(Thickness, Thickness) Operator + +Adds the specified [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') to the current [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness'). + +```csharp +public static Tizen.UI.Thickness operator +(Tizen.UI.Thickness left, Tizen.UI.Thickness right); +``` +#### Parameters + + + +`left` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +`right` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') to add. + +#### Returns +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') +A new [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') with the added values. + + + +## Thickness.operator ==(Thickness, Thickness) Operator + +Compares two [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') objects for equality. + +```csharp +public static bool operator ==(Tizen.UI.Thickness left, Tizen.UI.Thickness right); +``` +#### Parameters + + + +`left` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The first [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') object to compare. + + + +`right` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The second [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') object to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the objects are equal, otherwise false. + + + +## Thickness.implicit operator Thickness(float) Operator + +Implicitly converts a float to a [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness'). + +```csharp +public static Tizen.UI.Thickness implicit operator Thickness(float uniformSize); +``` +#### Parameters + + + +`uniformSize` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The uniform size to convert. + +#### Returns +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## Thickness.implicit operator Thickness(Size) Operator + +Implicitly converts a [Size](Tizen.UI.Size.md 'Tizen.UI.Size') to a [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness'). + +```csharp +public static Tizen.UI.Thickness implicit operator Thickness(Tizen.UI.Size size); +``` +#### Parameters + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size to convert. + +#### Returns +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## Thickness.operator !=(Thickness, Thickness) Operator + +Compares two [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') objects for inequality. + +```csharp +public static bool operator !=(Tizen.UI.Thickness left, Tizen.UI.Thickness right); +``` +#### Parameters + + + +`left` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The first [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') object to compare. + + + +`right` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + +The second [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') object to compare. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the objects are not equal, otherwise false. + + + +## Thickness.operator -(Thickness, float) Operator + +Subtracts the specified [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') from each component of the [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness'). + +```csharp +public static Tizen.UI.Thickness operator -(Tizen.UI.Thickness left, float addend); +``` +#### Parameters + + + +`left` [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +`addend` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +#### Returns +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') +A new [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') with the subtracted values. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Timer.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Timer.md new file mode 100644 index 0000000000..fb85a6cf54 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Timer.md @@ -0,0 +1,159 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Timer Class + +The Timer class provides a convenient way to run a function at specified time intervals. + +```csharp +public class Timer : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 Timer +### Constructors + + + +## Timer(uint) Constructor + +Initializes a new instance of the Timer class with the specified interval in milliseconds. + +```csharp +public Timer(uint millisec); +``` +#### Parameters + + + +`millisec` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The interval in milliseconds. +### Properties + + + +## Timer.Interval Property + +Gets or sets the interval of the timer in milliseconds. + +```csharp +public uint Interval { get; set; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## Timer.IsRunning Property + +Gets a value indicating whether the timer is running or not. + +```csharp +public bool IsRunning { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Timer.TickHandler Property + +Gets or sets the handler function to be called when the timer is ticked. + +```csharp +public System.Func<bool> TickHandler { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') +### Methods + + + +## Timer.Repeat(uint, Func<bool>) Method + +Creates a new [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') instance that repeatedly executes the specified function at a specified interval in milliseconds. + +```csharp +public static Tizen.UI.Timer Repeat(uint interval, System.Func<bool> handler); +``` +#### Parameters + + + +`interval` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The interval in milliseconds between timer ticks. + + + +`handler` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +The function to be invoked when the timer elapses. The function should return a value indicating whether to continue + running the timer. Return true to keep the timer running, false to stop it. + +#### Returns +[Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') +A new [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') instance that will repeatedly execute the specified function at the specified interval. + + + +## Timer.Reset() Method + +Resets the timer. If the timer is running, it is first stopped, and then restarted. + +```csharp +public void Reset(); +``` + + + +## Timer.Start() Method + +Starts the timer. + +```csharp +public void Start(); +``` + + + +## Timer.Stop() Method + +Stops the timer. + +```csharp +public void Stop(); +``` + + + +## Timer.Timeout(uint, Action) Method + +Creates a new [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') instance that executes a single action after the specified timeout in milliseconds. + +```csharp +public static Tizen.UI.Timer Timeout(uint timeout, System.Action action); +``` +#### Parameters + + + +`timeout` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The timeout in milliseconds before executing the action. + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to be executed after the timeout elapses. + +#### Returns +[Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') +A new [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') instance that will execute the specified action after the timeout. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenExtensions.md new file mode 100644 index 0000000000..7005ecacdd --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenExtensions.md @@ -0,0 +1,36 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TokenExtensions Class + +Extensions methods for [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken') + +```csharp +public static class TokenExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TokenExtensions +### Methods + + + +## TokenExtensions.ToRawColor(this Color) Method + +Convert a token color to color value. + +```csharp +public static Tizen.UI.Color ToRawColor(this Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +#### Returns +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenManager.md new file mode 100644 index 0000000000..6a78ab7fa6 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenManager.md @@ -0,0 +1,56 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TokenManager Class + +The manager for the token. It provides a way to set and get the token table. + +```csharp +public static class TokenManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TokenManager +### Properties + + + +## TokenManager.ColorTable Property + +Gets the color token table. If the table is not set, it returns an empty table. + +```csharp +public static Tizen.UI.ITokenTable<Tizen.UI.Color> ColorTable { get; } +``` + +#### Property Value +[Tizen.UI.ITokenTable<](Tizen.UI.ITokenTable_T_.md 'Tizen.UI.ITokenTable<T>')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](Tizen.UI.ITokenTable_T_.md 'Tizen.UI.ITokenTable<T>') +### Methods + + + +## TokenManager.SetTable<T>(TokenType, ITokenTable<T>) Method + +Sets the token table. If the type is not supported, it will be ignored. + +```csharp +public static void SetTable<T>(Tizen.UI.TokenType type, Tizen.UI.ITokenTable<T> table); +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`type` [TokenType](Tizen.UI.TokenType.md 'Tizen.UI.TokenType') + + + +`table` [Tizen.UI.ITokenTable<](Tizen.UI.ITokenTable_T_.md 'Tizen.UI.ITokenTable<T>')[T](Tizen.UI.TokenManager.md#Tizen.UI.TokenManager.SetTable_T_(Tizen.UI.TokenType,Tizen.UI.ITokenTable_T_).T 'Tizen.UI.TokenManager.SetTable<T>(Tizen.UI.TokenType, Tizen.UI.ITokenTable<T>).T')[>](Tizen.UI.ITokenTable_T_.md 'Tizen.UI.ITokenTable<T>') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyChangedEventArgs.md new file mode 100644 index 0000000000..f54c4c3c04 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyChangedEventArgs.md @@ -0,0 +1,48 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TokenPropertyChangedEventArgs Class + +Provides data for token property changed events. + +```csharp +public class TokenPropertyChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 TokenPropertyChangedEventArgs + +Derived +↳ [BackgroundTokenPropertyChangedEventArgs](Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md 'Tizen.UI.BackgroundTokenPropertyChangedEventArgs') +↳ [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') +### Properties + + + +## TokenPropertyChangedEventArgs.Name Property + +Gets or sets the name of the changed property. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyChangedEventArgs.View Property + +Gets or sets the view associated with the property change. + +```csharp +public Tizen.UI.View View { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyNames.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyNames.md new file mode 100644 index 0000000000..0efaa79c76 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyNames.md @@ -0,0 +1,139 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TokenPropertyNames Class + +Provides property names used in token-related events to indicate which property has changed. + +```csharp +public static class TokenPropertyNames +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TokenPropertyNames + +### Remarks +This static class contains predefined property name constants that are used to specify +which token property has been modified in events such as [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs'). +### Fields + + + +## TokenPropertyNames.Background Field + +Provides a constant string identifier for the background property. + +```csharp +public static readonly string Background; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.BorderlineColor Field + +Provides a constant string identifier for the borderline color property. + +```csharp +public static readonly string BorderlineColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.ImageMultipliedColor Field + +Provides a constant string identifier for the image multiplied color property. + +```csharp +public static readonly string ImageMultipliedColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.InnerShadow Field + +Provides a constant string identifier for the inner shadow property. + +```csharp +public static readonly string InnerShadow; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.MultipliedColor Field + +Provides a constant string identifier for the multiplied color property. + +```csharp +public static readonly string MultipliedColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.PlaceholderTextColor Field + +Provides a constant string identifier for the placeholder text color property. + +```csharp +public static readonly string PlaceholderTextColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.PrimaryCursorColor Field + +Provides a constant string identifier for the primary cursor color property. + +```csharp +public static readonly string PrimaryCursorColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.Shadow Field + +Provides a constant string identifier for the shadow property. + +```csharp +public static readonly string Shadow; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## TokenPropertyNames.TextColor Field + +Provides a constant string identifier for the text color property. + +```csharp +public static readonly string TextColor; +``` + +#### Field Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenType.md new file mode 100644 index 0000000000..cb9b719db0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenType.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TokenType Enum + +The type of token. + +```csharp +public enum TokenType +``` +### Fields + + + +`Color` 0 + +The color token. + + + +`FontFamily` 2 + +The font family token. + + + +`FontSize` 3 + +The font weight token. + + + +`Shadow` 1 + +The shadow token. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Touch.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Touch.md new file mode 100644 index 0000000000..c3b69192a9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Touch.md @@ -0,0 +1,135 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Touch Class + +The Touch class represents a touch point on the screen. + +```csharp +public class Touch +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Touch +### Properties + + + +## Touch.DeviceId Property + +Gets the ID of the device that generated the touch event. + +```csharp +public int DeviceId { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Touch.EllipseRadius Property + +Gets the radius of the touch point in the x and y directions. + +```csharp +public Tizen.UI.Point EllipseRadius { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Touch.HitView Property + +Gets the view that passed the hit test. + +```csharp +public Tizen.UI.View HitView { get; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## Touch.MouseButton Property + +Gets the mouse button associated with the touch event. + +```csharp +public Tizen.UI.MouseButton MouseButton { get; } +``` + +#### Property Value +[MouseButton](Tizen.UI.MouseButton.md 'Tizen.UI.MouseButton') + + + +## Touch.Position Property + +Gets the position of the touch point in local coordinates of HitView. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Touch.Pressure Property + +Gets the pressure of the touch point. + +```csharp +public float Pressure { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Touch.Radius Property + +Gets the radius of the touch point. + +```csharp +public float Radius { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## Touch.ScreenPosition Property + +Gets the position of the touch point in screen coordinates. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## Touch.State Property + +Gets the state of the touch point. + +```csharp +public Tizen.UI.TouchState State { get; } +``` + +#### Property Value +[TouchState](Tizen.UI.TouchState.md 'Tizen.UI.TouchState') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEvent.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEvent.md new file mode 100644 index 0000000000..3b470617d2 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEvent.md @@ -0,0 +1,98 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TouchEvent Class + +The TouchEvent class represents a touch event that contains information about the touch points. + +```csharp +public class TouchEvent : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 TouchEvent +### Constructors + + + +## TouchEvent() Constructor + +Creates a new TouchEvent object + +```csharp +public TouchEvent(); +``` + + + +## TouchEvent(IntPtr, bool) Constructor + +Creates a new TouchEvent object using the specified handle. + +```csharp +public TouchEvent(System.IntPtr handle, bool ownshandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The native handle of the touch event. + + + +`ownshandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the object takes ownership of the handle, false otherwise. +### Properties + + + +## TouchEvent.Count Property + +Gets the number of touch points in the touch event. + +```csharp +public int Count { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## TouchEvent.this[int] Property + +Gets the touch point at the specified index. + +```csharp +public Tizen.UI.Touch this[int i] { get; } +``` +#### Parameters + + + +`i` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the touch point. + +#### Property Value +[Touch](Tizen.UI.Touch.md 'Tizen.UI.Touch') + + + +## TouchEvent.Time Property + +Gets the time when the touch event occurred. + +```csharp +public uint Time { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEventArgs.md new file mode 100644 index 0000000000..7d395ae7d3 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TouchEventArgs Class + +Event arguments for [TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent'). + +```csharp +public class TouchEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TouchEventArgs +### Properties + + + +## TouchEventArgs.Handled Property + +Gets or sets a value indicating whether the touch event has been handled. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## TouchEventArgs.Touch Property + +Gets the touch event. + +```csharp +public Tizen.UI.TouchEvent Touch { get; set; } +``` + +#### Property Value +[TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchPoint.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchPoint.md new file mode 100644 index 0000000000..1c07a03358 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchPoint.md @@ -0,0 +1,142 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TouchPoint Class + +TouchPoint represents a single point of contact on a touchscreen device. + +```csharp +public class TouchPoint : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 TouchPoint +### Constructors + + + +## TouchPoint(int, TouchState, float, float) Constructor + +Initializes a new instance of the TouchPoint class with the specified device ID, state, screen X coordinate, and screen Y coordinate. + +```csharp +public TouchPoint(int deviceId, Tizen.UI.TouchState state, float screenX, float screenY); +``` +#### Parameters + + + +`deviceId` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The ID of the device that generated the touch event. + + + +`state` [TouchState](Tizen.UI.TouchState.md 'Tizen.UI.TouchState') + +The state of the touch point. + + + +`screenX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The X coordinate of the touch point in screen coordinates. + + + +`screenY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The Y coordinate of the touch point in screen coordinates. + + + +## TouchPoint(IntPtr, bool) Constructor + +Initializes a new instance of the TouchPoint class with the specified handle and whether to own the handle or not. + +```csharp +public TouchPoint(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +The handle of the touch point. + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether to own the handle or not. +### Properties + + + +## TouchPoint.DeviceId Property + +Gets or sets the ID of the device that generated the touch event. + +```csharp +public int DeviceId { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## TouchPoint.HitView Property + +Gets or sets the view that passed the hit test. + +```csharp +public Tizen.UI.View HitView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## TouchPoint.Position Property + +Gets or sets the position of the touch point in local coordinates. + +```csharp +public Tizen.UI.Point Position { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## TouchPoint.ScreenPosition Property + +Gets or sets the position of the touch point in screen coordinates. + +```csharp +public Tizen.UI.Point ScreenPosition { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## TouchPoint.State Property + +Gets or sets the state of the touch point. + +```csharp +public Tizen.UI.TouchState State { get; set; } +``` + +#### Property Value +[TouchState](Tizen.UI.TouchState.md 'Tizen.UI.TouchState') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchState.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchState.md new file mode 100644 index 0000000000..6a49936ebf --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchState.md @@ -0,0 +1,65 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TouchState Enum + +The TouchState enum represents the possible states of a touch event. + +```csharp +public enum TouchState +``` +### Fields + + + +`Down` 0 + +Screen touched. + + + +`Finished` 1 + +Touch or hover finished. + + + +`Interrupted` 5 + +A system event has occurred which has interrupted the touch or hover event sequence. + + + +`Leave` 3 + +Leave the boundary of an actor. + + + +`Motion` 2 + +Finger dragged or hovered. + + + +`Started` 0 + +Touch or hover started. + + + +`Stationary` 4 + +No change from last event.
+Useful when a multi-point event occurs where all points are sent, but indicates that this particular point has not changed since the last time. + + + +`Up` 1 + +Touch stopped. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TwoWayBindingProperty_TView,TValue_.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TwoWayBindingProperty_TView,TValue_.md new file mode 100644 index 0000000000..c18024efe0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TwoWayBindingProperty_TView,TValue_.md @@ -0,0 +1,70 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## TwoWayBindingProperty<TView,TValue> Class + +This class represents a two-way binding property between a view and its value. + +```csharp +public class TwoWayBindingProperty<TView,TValue> : Tizen.UI.BindingProperty<TView, TValue> +``` +#### Type parameters + + + +`TView` + +The type of the view. + + + +`TValue` + +The type of the value. + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TView](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TView 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TView')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[TValue](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TValue 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TValue')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') 🡒 TwoWayBindingProperty<TView,TValue> +### Properties + + + +## TwoWayBindingProperty<TView,TValue>.AddObserver Property + +Gets or sets the action that adds an observer to the view. + +```csharp +public System.Action<TView,System.Action> AddObserver { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TView 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + +## TwoWayBindingProperty<TView,TValue>.Getter Property + +Gets or sets the function that retrieves the value from the view. + +```csharp +public System.Func<TView,TValue> Getter { get; set; } +``` + +#### Property Value +[System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[TView](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TView 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[TValue](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TValue 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TValue')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') + + + +## TwoWayBindingProperty<TView,TValue>.RemoveObserver Property + +Gets or sets the action that removes an observer from the view. + +```csharp +public System.Action<TView,System.Action> RemoveObserver { get; set; } +``` + +#### Property Value +[System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[TView](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md#Tizen.UI.TwoWayBindingProperty_TView,TValue_.TView 'Tizen.UI.TwoWayBindingProperty<TView,TValue>.TView')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2')[System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System.Action`2') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UIApplication.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UIApplication.md new file mode 100644 index 0000000000..d194c6c132 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UIApplication.md @@ -0,0 +1,238 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## UIApplication Class + +Represents a lite application tha has an UI screen. + +```csharp +public class UIApplication +``` + +Inheritance Tizen.Applications.CoreApplication 🡒 UIApplication +### Constructors + + + +## UIApplication() Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the default window mode. + +```csharp +public UIApplication(); +``` + + + +## UIApplication(Rect) Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the specified window bounds. + +```csharp +public UIApplication(Tizen.UI.Rect windowBounds); +``` +#### Parameters + + + +`windowBounds` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The window bounds. + + + +## UIApplication(WindowMode) Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the specified window mode. + +```csharp +public UIApplication(Tizen.UI.WindowMode mode); +``` +#### Parameters + + + +`mode` [WindowMode](Tizen.UI.WindowMode.md 'Tizen.UI.WindowMode') + +The window mode. + + + +## UIApplication(WindowMode, CoreTask) Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the specified window mode and core task. + +```csharp +public UIApplication(Tizen.UI.WindowMode mode, CoreTask coreTask); +``` +#### Parameters + + + +`mode` [WindowMode](Tizen.UI.WindowMode.md 'Tizen.UI.WindowMode') + +The window mode of the application. + + + +`coreTask` Tizen.Applications.CoreTask + +The core task of the application. + + + +## UIApplication(WindowMode, Rect) Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the specified window mode and bounds. + +```csharp +public UIApplication(Tizen.UI.WindowMode mode, Tizen.UI.Rect windowBounds); +``` +#### Parameters + + + +`mode` [WindowMode](Tizen.UI.WindowMode.md 'Tizen.UI.WindowMode') + +The window mode. + + + +`windowBounds` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The window bounds. + + + +## UIApplication(WindowMode, Rect, CoreTask) Constructor + +Initializes a new instance of the [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') class with the specified window mode, bounds and core task. + +```csharp +public UIApplication(Tizen.UI.WindowMode mode, Tizen.UI.Rect windowBounds, CoreTask coreTask); +``` +#### Parameters + + + +`mode` [WindowMode](Tizen.UI.WindowMode.md 'Tizen.UI.WindowMode') + +The window mode of the application. + + + +`windowBounds` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +The window bounds of the application. + + + +`coreTask` Tizen.Applications.CoreTask + +The core task of the application. +### Properties + + + +## UIApplication.Current Property + +Gets the current instance of the LiteApplication class. + +```csharp +public static Tizen.UI.UIApplication Current { get; set; } +``` + +#### Property Value +[UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') + + + +## UIApplication.IsUIThread Property + +Gets a value indicating whether the current thread is the UI thread. + +```csharp +public bool IsUIThread { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## UIApplication.Windows Property + +Gets the list of created windows + +```csharp +public static System.Collections.Generic.IReadOnlyList<Tizen.UI.Window> Windows { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[Window](Tizen.UI.Window.md 'Tizen.UI.Window')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') +### Methods + + + +## UIApplication.PostToUI(Action) Method + +Posts the specified action to the UI thread. + +```csharp +public void PostToUI(System.Action action); +``` +#### Parameters + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to be executed on the UI thread. + + + +## UIApplication.Run(string[]) Method + +Runs the UI application's main loop. + +```csharp +public override void Run(string[] args); +``` +#### Parameters + + + +`args` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +Arguments from the commandline. +### Events + + + +## UIApplication.Paused Event + +Occurs whenever the application is paused. + +```csharp +public event EventHandler Paused; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## UIApplication.Resumed Event + +Occurs whenever the application is resumed. + +```csharp +public event EventHandler Resumed; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UISettings.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UISettings.md new file mode 100644 index 0000000000..988ec42224 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UISettings.md @@ -0,0 +1,175 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## UISettings Class + +Provides a set of methods for managing the appearance and behavior of the user interface. + +```csharp +public static class UISettings +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 UISettings +### Methods + + + +## UISettings.SetBrokenImageUrl(string) Method + +Sets the broken image URL for all broken image types. + +```csharp +public static void SetBrokenImageUrl(string url); +``` +#### Parameters + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the broken image. + + + +## UISettings.SetBrokenImageUrl(BrokenImageType, string) Method + +Sets the broken image URL for a specific broken image type. + +```csharp +public static void SetBrokenImageUrl(Tizen.UI.BrokenImageType type, string url); +``` +#### Parameters + + + +`type` [BrokenImageType](Tizen.UI.BrokenImageType.md 'Tizen.UI.BrokenImageType') + +The type of broken image. + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The URL of the broken image. + + + +## UISettings.SetDoubleTapTimeout(int) Method + +Sets the duration in milliseconds the duration time for recognizing multi-tap gesture. +If there are two taps within this time, it is a double tap. + +```csharp +public static void SetDoubleTapTimeout(int ms); +``` +#### Parameters + + + +`ms` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The time value in milliseconds + +### Remarks +This is a global configuration option. Affects all gestures. + + + +## UISettings.SetKeyRepeat(float, float) Method + +Sets the key repeat rate and delay. + +```csharp +public static void SetKeyRepeat(float rate, float delay); +``` +#### Parameters + + + +`rate` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The rate at which the keyboard repeats keys. + + + +`delay` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The delay before repeating keys. + + + +## UISettings.SetLongPressMinimumHoldingTime(int) Method + +Sets the minimum holding time required to be recognized as a long press gesture + +```csharp +public static void SetLongPressMinimumHoldingTime(int ms); +``` +#### Parameters + + + +`ms` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The time value in milliseconds + +### Remarks +This is a global configuration option. Affects all gestures. + + + +## UISettings.SetPinchMinimumDistance(float) Method + +Sets the minimum distance required to start a pinch event + +```csharp +public static void SetPinchMinimumDistance(float distance); +``` +#### Parameters + + + +`distance` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +Distance in pixels + +### Remarks +This is a global configuration option. Affects all gestures. + + + +## UISettings.SetTapRecognizerTime(int) Method + +Sets the recognizer time required to be recognized as a tap gesture, +This time is from touch down to touch up to recognize the tap gesture. +If the time between touch down and touch up is longer than recognizer time, it is not recognized as a tap gesture. + +```csharp +public static void SetTapRecognizerTime(int ms); +``` +#### Parameters + + + +`ms` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The time value in milliseconds + +### Remarks +This is a global configuration option. Affects all gestures. + + + +## UISettings.UsePreCompiledShader() Method + +Compile the visual shader in advance. Afterwards, when a visual using a new shader is requested, the pre-compiled shader is used. + +```csharp +public static void UsePreCompiledShader(); +``` + +### Remarks +It is recommended that this method be called at the top of the application code. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Underline.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Underline.md new file mode 100644 index 0000000000..8f91ea7f21 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Underline.md @@ -0,0 +1,79 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Underline Struct + +The Underline struct represents the underline style of a text. + +```csharp +public struct Underline +``` +### Properties + + + +## Underline.Color Property + +Gets or sets the color of the underline. + +```csharp +public System.Nullable<Tizen.UI.Color> Color { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Underline.DashGap Property + +Gets or sets the dash gap of the underline. + +```csharp +public System.Nullable<float> DashGap { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Underline.DashWidth Property + +Gets or sets the dash width of the underline. + +```csharp +public System.Nullable<float> DashWidth { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Underline.Style Property + +Gets or sets the style of the underline. + +```csharp +public System.Nullable<Tizen.UI.UnderlineStyle> Style { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[UnderlineStyle](Tizen.UI.UnderlineStyle.md 'Tizen.UI.UnderlineStyle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + +## Underline.Thickness Property + +Gets or sets the thickness of the underline. + +```csharp +public System.Nullable<float> Thickness { get; set; } +``` + +#### Property Value +[System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnderlineStyle.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnderlineStyle.md new file mode 100644 index 0000000000..ef3016b923 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnderlineStyle.md @@ -0,0 +1,32 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## UnderlineStyle Enum + +The UnderlineStyle enum defines the different styles of underline that can be applied to text. + +```csharp +public enum UnderlineStyle +``` +### Fields + + + +`Dashed` 1 + +A dashed line is used to draw the underline. + + + +`Double` 2 + +Two solid lines are used to draw the underline, appearing as if it is doubled. + + + +`Solid` 0 + +A solid line is used to draw the underline. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnitValue.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnitValue.md new file mode 100644 index 0000000000..4bb1191cb9 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnitValue.md @@ -0,0 +1,15 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## UnitValue Struct + +Represents a value with a unit of measurement. + +```csharp +public readonly struct UnitValue +``` + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UrlWebViewSource.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UrlWebViewSource.md new file mode 100644 index 0000000000..039545c9fc --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UrlWebViewSource.md @@ -0,0 +1,15 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## UrlWebViewSource Class + +A [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') bound to a URL. + +```csharp +public class UrlWebViewSource : Tizen.UI.WebViewSource +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [WebViewSource](Tizen.UI.WebViewSource.md 'Tizen.UI.WebViewSource') 🡒 UrlWebViewSource + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VideoOverlayView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VideoOverlayView.md new file mode 100644 index 0000000000..3fda8a20b5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VideoOverlayView.md @@ -0,0 +1,62 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## VideoOverlayView Class + +VideoOverlayView is a class that displays video content on the screen. + +```csharp +public class VideoOverlayView : Tizen.UI.View, +Tizen.UI.Internal.IResourceReadySignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 VideoOverlayView + +Implements Tizen.UI.Internal.IResourceReadySignalHandler +### Constructors + + + +## VideoOverlayView() Constructor + +Constructor of VideoOverlayView. + +```csharp +public VideoOverlayView(); +``` +### Properties + + + +## VideoOverlayView.DisplayArea Property + +Gets the display area of the video. + +```csharp +public Tizen.UI.Rect DisplayArea { get; } +``` + +#### Property Value +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +### Methods + + + +## VideoOverlayView.SetPlayer(Player) Method + +Sets the player instance to be used to display media by the VideoOverlayView. + +```csharp +public void SetPlayer(Player player); +``` +#### Parameters + + + +`player` Tizen.Multimedia.Player + +The player instance to be used. + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.View.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.View.md new file mode 100644 index 0000000000..009f5d10b1 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.View.md @@ -0,0 +1,1520 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## View Class + +The View class is a base class for other more specific UI components, such as buttons, text fields, and layouts. + +```csharp +public class View : Tizen.UI.NObject, +Tizen.UI.Internal.IViewSignalHandler +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 View + +Derived +↳ [ContentView](Tizen.UI.ContentView.md 'Tizen.UI.ContentView') +↳ [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') +↳ [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') +↳ [TbmSurfaceView](Tizen.UI.TbmSurfaceView.md 'Tizen.UI.TbmSurfaceView') +↳ [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') +↳ [VideoOverlayView](Tizen.UI.VideoOverlayView.md 'Tizen.UI.VideoOverlayView') +↳ [ViewGroup](Tizen.UI.ViewGroup.md 'Tizen.UI.ViewGroup') +↳ [WebView](Tizen.UI.WebView.md 'Tizen.UI.WebView') + +Implements Tizen.UI.Internal.IViewSignalHandler +### Constructors + + + +## View() Constructor + +Initializes a new instance of the View class. + +```csharp +public View(); +``` +### Properties + + + +## View.AccessibilityDescription Property + +Gets or sets the accessibility description of the view. + +```csharp +public string AccessibilityDescription { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## View.AccessibilityHidden Property + +Gets or sets whether the view is hidden for accessibility. + +```csharp +public bool AccessibilityHidden { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.AccessibilityHighlightable Property + +Gets or sets whether the view can be highlighted by accessibility services. + +```csharp +public bool AccessibilityHighlightable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.AccessibilityName Property + +Gets or sets the accessibility name of the view. + +```csharp +public string AccessibilityName { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## View.AccessibilityRole Property + +Gets or sets the accessibility role of the view. + +```csharp +public Tizen.UI.AccessibilityRole AccessibilityRole { get; set; } +``` + +#### Property Value +[AccessibilityRole](Tizen.UI.AccessibilityRole.md 'Tizen.UI.AccessibilityRole') + + + +## View.AccessibilityValue Property + +Gets or sets the accessibility value of the view. + +```csharp +public string AccessibilityValue { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## View.AutomationId Property + +Gets or sets the AutomationId property. + +```csharp +public string AutomationId { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## View.BackgroundColor Property + +Gets or sets the background color of the view. + +```csharp +public Tizen.UI.Color BackgroundColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## View.BorderlineColor Property + +Gets or sets the borderline color of the view. + +```csharp +public Tizen.UI.Color BorderlineColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## View.BorderlineOffset Property + +Gets or sets the borderline offset of the view. + +```csharp +public float BorderlineOffset { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.BorderlineWidth Property + +Gets or sets the width of the borderline. + +```csharp +public float BorderlineWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.Bounds Property + +Gets the bounding rectangle of the view. + +```csharp +public Tizen.UI.Rect Bounds { get; } +``` + +#### Property Value +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + + + +## View.ClippingMode Property + +Gets or sets the clipping mode of the view. + +```csharp +public Tizen.UI.ClippingMode ClippingMode { get; set; } +``` + +#### Property Value +[ClippingMode](Tizen.UI.ClippingMode.md 'Tizen.UI.ClippingMode') + + + +## View.CornerRadius Property + +Gets or sets the corner radius of the view. + +```csharp +public Tizen.UI.CornerRadius CornerRadius { get; set; } +``` + +#### Property Value +[CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + + + +## View.CurrentOpacity Property + +Gets the opacity of view on the render thread. + +```csharp +public float CurrentOpacity { get; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.CurrentPosition Property + +Gets the position of view on the render thread. + +```csharp +public Tizen.UI.Point CurrentPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## View.CurrentScale Property + +Gets the scale of view on the render thread. + +```csharp +public Tizen.UI.Size CurrentScale { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## View.CurrentScreenPosition Property + +Gets the screen position of view on the render thread +It is updated after the view has been rendered. + +```csharp +public Tizen.UI.Point CurrentScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## View.CurrentSize Property + +Gets the size of view on the render thread. + +```csharp +public Tizen.UI.Size CurrentSize { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## View.DesiredHeight Property + +Gets or sets the desired height of the view. + +```csharp +public float DesiredHeight { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.DesiredWidth Property + +Gets or sets the desired width of the view. + +```csharp +public float DesiredWidth { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.DisallowInterceptTouchEvent Property + +Gets or sets a value indicating whether this view should disallow intercepting touch events. +Default value is false. The value will be reset to false when touch is completed (Up, Interrupted). + +```csharp +public bool DisallowInterceptTouchEvent { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.DownFocusableView Property + +Gets or sets the view that should receive focus when the down direction key is pressed. + +```csharp +public Tizen.UI.View DownFocusableView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.Focusable Property + +Gets or sets a value indicating whether the view can receive keyboard focus. + +```csharp +public bool Focusable { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.FocusableChildren Property + +Gets or sets whether the children of the view can be focused using the keyboard. + +```csharp +public bool FocusableChildren { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.FocusableInTouch Property + +Gets or sets whether the view can receive focus through touch events. + +```csharp +public bool FocusableInTouch { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.Height Property + +Gets or sets the height of the view. + +```csharp +public float Height { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.HeightResizePolicy Property + +Gets or sets the height resize policy of the view. + +```csharp +public Tizen.UI.ResizePolicy HeightResizePolicy { get; set; } +``` + +#### Property Value +[ResizePolicy](Tizen.UI.ResizePolicy.md 'Tizen.UI.ResizePolicy') + + + +## View.ID Property + +Gets the ID of the view. + +```csharp +public uint ID { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## View.InheritLayoutDirection Property + +Gets or sets a value indicating whether the view inherits its layout direction from its parent. +If [LayoutDirection](Tizen.UI.View.md#Tizen.UI.View.LayoutDirection 'Tizen.UI.View.LayoutDirection') is set, [InheritLayoutDirection](Tizen.UI.View.md#Tizen.UI.View.InheritLayoutDirection 'Tizen.UI.View.InheritLayoutDirection') is set to false. + +```csharp +public bool InheritLayoutDirection { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.IsEnabled Property + +Gets or sets a value indicating whether this view is enabled for user interaction. + +```csharp +public bool IsEnabled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.IsOnWindow Property + +Gets a value indicating whether the view is currently on the window. + +```csharp +public bool IsOnWindow { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.IsVisible Property + +Gets or sets a value indicating whether the view is visible or not. + +```csharp +public bool IsVisible { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.LayoutDirection Property + +Gets or sets the layout direction of the view. +If [LayoutDirection](Tizen.UI.View.md#Tizen.UI.View.LayoutDirection 'Tizen.UI.View.LayoutDirection') is set, [InheritLayoutDirection](Tizen.UI.View.md#Tizen.UI.View.InheritLayoutDirection 'Tizen.UI.View.InheritLayoutDirection') is set to false. + +```csharp +public Tizen.UI.LayoutDirection LayoutDirection { get; set; } +``` + +#### Property Value +[LayoutDirection](Tizen.UI.LayoutDirection.md 'Tizen.UI.LayoutDirection') + + + +## View.LeftFocusableView Property + +Gets or sets the view that should receive focus when the left direction key is pressed while this view has focus. + +```csharp +public Tizen.UI.View LeftFocusableView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.MultipliedColor Property + +Gets or sets the color of the view, which is multiplied by the view's alpha value. + +```csharp +public Tizen.UI.Color MultipliedColor { get; set; } +``` + +#### Property Value +[Color](Tizen.UI.Color.md 'Tizen.UI.Color') + + + +## View.Name Property + +Gets or sets the name of the view. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## View.NaturalSize Property + +Gets the natural size of the view. + +```csharp +public Tizen.UI.Size NaturalSize { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## View.Opacity Property + +Gets or sets the opacity of the view. + +```csharp +public float Opacity { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.Parent Property + +Gets the parent of the view. + +```csharp +public Tizen.UI.View Parent { get; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.ParentObject Property + +Gets the parent object of the view. + +```csharp +public Tizen.UI.NObject ParentObject { get; } +``` + +#### Property Value +[NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') + + + +## View.ParentOrigin Property + +Gets or sets the parent origin of the view. + +```csharp +public Tizen.UI.Point ParentOrigin { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## View.ParentOriginX Property + +Gets or sets the X position of the view's parent origin. + +```csharp +public float ParentOriginX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.ParentOriginY Property + +Gets or sets the Y position of the view's parent origin. + +```csharp +public float ParentOriginY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.PivotPoint Property + +Gets or sets the pivot point of the view. + +```csharp +public Tizen.UI.Point PivotPoint { get; set; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +### Remarks +The pivot point is the center point around which the view rotates or scales. When a rotation or scaling operation is applied to the view, +it is performed relative to the pivot point. By changing the pivot point, you can control the origin and behavior of the rotation or scaling. + + + +## View.PivotPointX Property + +Gets or sets the X coordinate of the pivot point of the view. + +```csharp +public float PivotPointX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.PivotPointY Property + +Gets or sets the Y coordinate of the pivot point of the view. + +```csharp +public float PivotPointY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.PositionUsesPivotPoint Property + +Gets or sets a value indicating whether the position of the view uses the pivot point. + +```csharp +public bool PositionUsesPivotPoint { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.RightFocusableView Property + +Gets or sets the view that should receive focus when the right direction key is pressed while this view has focus. + +```csharp +public Tizen.UI.View RightFocusableView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.Rotation Property + +Gets or sets the rotation of the view. + +```csharp +public float Rotation { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.RotationX Property + +Gets or sets the rotation angle of the view around the X-axis. + +```csharp +public float RotationX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.RotationY Property + +Gets or sets the rotation angle of the view around the Y-axis. + +```csharp +public float RotationY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.ScaleX Property + +Gets or sets the X-axis scale factor of the view. + +```csharp +public float ScaleX { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.ScaleY Property + +Gets or sets the Y-axis scale factor of the view. + +```csharp +public float ScaleY { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.ScreenPosition Property + +Gets the position of the view in screen coordinates. +This position is based on the view's parent (if any) and the view's position within the parent. +It directly calculates the value using the position of the parent view. This means that you can obtain the updated value before the view is rendered. + +```csharp +public Tizen.UI.Point ScreenPosition { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## View.Sensitive Property + +Gets or sets the status of whether the view should emit touch or hover signals. +If a View is made insensitive, then the View and its children are not hittable. + +```csharp +public bool Sensitive { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## View.this[string] Property + +Gets the descendant view with the specified name. + +```csharp +public Tizen.UI.View this[string name] { get; } +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.TouchEdgeInsets Property + +Gets or sets the inset or outset margins for the rectangle surrounding of touch area +Use this property to extend or reduce touch area. + +```csharp +public Tizen.UI.Thickness TouchEdgeInsets { get; set; } +``` + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## View.UpFocusableView Property + +Gets or sets the view that should receive focus when the up direction key is pressed. + +```csharp +public Tizen.UI.View UpFocusableView { get; set; } +``` + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.Width Property + +Gets or sets the width of the view. + +```csharp +public float Width { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.WidthResizePolicy Property + +Gets or sets the width resize policy of the view. + +```csharp +public Tizen.UI.ResizePolicy WidthResizePolicy { get; set; } +``` + +#### Property Value +[ResizePolicy](Tizen.UI.ResizePolicy.md 'Tizen.UI.ResizePolicy') + + + +## View.WorldScale Property + +Gets the current world scale of the view. + +```csharp +public Tizen.UI.Size WorldScale { get; } +``` + +#### Property Value +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') + + + +## View.X Property + +Gets or sets the x-coordinate of the view's position. + +```csharp +public float X { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + + + +## View.Y Property + +Gets or sets the y-coordinate of the view's position. + +```csharp +public float Y { get; set; } +``` + +#### Property Value +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') +### Methods + + + +## View.AddRenderNotification(RenderNotificationKey, Action) Method + +Adds a render notification to the view. + +```csharp +public void AddRenderNotification(Tizen.UI.RenderNotificationKey key, System.Action action); +``` +#### Parameters + + + +`key` [RenderNotificationKey](Tizen.UI.RenderNotificationKey.md 'Tizen.UI.RenderNotificationKey') + +The key of the render notification. + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to be executed when the render notification is triggered. + + + +## View.ClearAttached<T>() Method + +Clears the attached object of the specified type. + +```csharp +public void ClearAttached<T>(); +``` +#### Type parameters + + + +`T` + +The type of the attached object to clear. + + + +## View.ClearBackground() Method + +Clears the background of the view. + +```csharp +public void ClearBackground(); +``` + + + +## View.ClearShadow() Method + +Clears the shadow of the view. + +```csharp +public void ClearShadow(); +``` + + + +## View.FindViewById(uint) Method + +Finds a view with the specified ID. + +```csharp +public static Tizen.UI.View FindViewById(uint id); +``` +#### Parameters + + + +`id` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The ID of the view to find. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The view with the specified ID, or null if no view with the given ID is found. + + + +## View.GetAttached<T>() Method + +Gets the attached object of the specified type. + +```csharp +public T GetAttached<T>(); +``` +#### Type parameters + + + +`T` + +The type of the attached object to get. + +#### Returns +[T](Tizen.UI.View.md#Tizen.UI.View.GetAttached_T_().T 'Tizen.UI.View.GetAttached<T>().T') +The attached object of the specified type, or the default value of [T](Tizen.UI.View.md#Tizen.UI.View.GetAttached_T_().T 'Tizen.UI.View.GetAttached<T>().T') if it is not found. + + + +## View.GetDescendant(string) Method + +Gets the descendant view with the specified name. + +```csharp +public virtual Tizen.UI.View GetDescendant(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the descendant view to find. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The descendant view with the specified name, or null if not found. + + + +## View.GetDescendant(uint) Method + +Gets the descendant view with the specified ID. + +```csharp +public Tizen.UI.View GetDescendant(uint id); +``` +#### Parameters + + + +`id` [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + +The ID of the descendant view to find. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The descendant view with the specified ID, or null if no match is found. + + + +## View.GetLayer() Method + +Gets the parent layer of this view. + +```csharp +public Tizen.UI.Layer GetLayer(); +``` + +#### Returns +[Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') +The parent layer of view, or null if there is no parent layer. + + + +## View.HasFocus() Method + +Checks if the view has the key input focus. + +```csharp +public bool HasFocus(); +``` + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the view has the key input focus, false otherwise. + + + +## View.Lower() Method + +Lowers the view to the view hierarchy. + +```csharp +public void Lower(); +``` + + + +## View.LowerBelow(View) Method + +Lowers the view below the given target view. + +```csharp +public void LowerBelow(Tizen.UI.View target); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + + + +## View.LowerToBottom() Method + +Lowers the view to the bottom of the view stack. + +```csharp +public void LowerToBottom(); +``` + + + +## View.Measure(float, float) Method + +Measures the view based on the available width and height. + +```csharp +public virtual Tizen.UI.Size Measure(float availableWidth, float availableHeight); +``` +#### Parameters + + + +`availableWidth` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available width for the view. + + + +`availableHeight` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The available height for the view. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The measured size of the view. + + + +## View.Raise() Method + +Raises the view to the view hierarchy. + +```csharp +public void Raise(); +``` + + + +## View.RaiseAbove(View) Method + +Raises the view above the target view. + +```csharp +public void RaiseAbove(Tizen.UI.View target); +``` +#### Parameters + + + +`target` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to raise above. + + + +## View.RaiseToTop() Method + +Raises the view to the top of the view hierarchy. + +```csharp +public void RaiseToTop(); +``` + + + +## View.RemoveRenderNotification(RenderNotificationKey) Method + +Removes a render notification for the specified key. + +```csharp +public void RemoveRenderNotification(Tizen.UI.RenderNotificationKey key); +``` +#### Parameters + + + +`key` [RenderNotificationKey](Tizen.UI.RenderNotificationKey.md 'Tizen.UI.RenderNotificationKey') + +The key associated with the render notification. + + + +## View.RemoveRenderNotification(RenderNotificationKey, Action) Method + +Removes a render notification for the specified key and action. + +```csharp +public void RemoveRenderNotification(Tizen.UI.RenderNotificationKey key, System.Action action); +``` +#### Parameters + + + +`key` [RenderNotificationKey](Tizen.UI.RenderNotificationKey.md 'Tizen.UI.RenderNotificationKey') + +The key associated with the render notification. + + + +`action` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') + +The action to remove from the render notification. + + + +## View.SendMeasureInvalidated() Method + +Sends a measure invalidated event to the view. + +```csharp +public void SendMeasureInvalidated(); +``` + + + +## View.SetAccessibilityRelation(AccessibilityRelation, View) Method + +Sets the accessibility relation between views. + +```csharp +public void SetAccessibilityRelation(Tizen.UI.AccessibilityRelation relation, Tizen.UI.View view); +``` +#### Parameters + + + +`relation` [AccessibilityRelation](Tizen.UI.AccessibilityRelation.md 'Tizen.UI.AccessibilityRelation') + +Relation type + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +View which will be in relation + + + +## View.SetAttached<T>(T) Method + +Sets the attached object of the specified type. + +```csharp +public void SetAttached<T>(T value); +``` +#### Type parameters + + + +`T` + +The type of the attached object. +#### Parameters + + + +`value` [T](Tizen.UI.View.md#Tizen.UI.View.SetAttached_T_(T).T 'Tizen.UI.View.SetAttached<T>(T).T') + +The value of the attached object. + + + +## View.SetBackground(Background) Method + +Sets the background visual of the view. + +```csharp +public void SetBackground(Tizen.UI.Background background); +``` +#### Parameters + + + +`background` [Background](Tizen.UI.Background.md 'Tizen.UI.Background') + +The background visual to set. + + + +## View.SetResizePolicyFactor(Size) Method + +Set ResizePolicy Factor +This factor is only used when ResizePolicy is set to either: ResizePolicy.SizeRelativeToParent or ResizePolicy.SizeFixedOffsetFromParent. + +```csharp +public void SetResizePolicyFactor(Tizen.UI.Size factor); +``` +#### Parameters + + + +`factor` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The factor to be set + + + +## View.SetShadow(Shadow) Method + +Sets the shadow of the view. + +```csharp +public void SetShadow(Tizen.UI.Shadow shadow); +``` +#### Parameters + + + +`shadow` [Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') + +The shadow object to set. +### Events + + + +## View.AttachedToWindow Event + +Occurs when the view is attached to a window. + +```csharp +public event EventHandler AttachedToWindow; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.DetachedFromWindow Event + +Occurs when the view is detached to a window. + +```csharp +public event EventHandler DetachedFromWindow; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.Disposing Event + +This event is emitted when the view is being disposed with disposing true. + +```csharp +public event EventHandler Disposing; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.EnabledChanged Event + +Occurs when the value of [IsEnabled](Tizen.UI.View.md#Tizen.UI.View.IsEnabled 'Tizen.UI.View.IsEnabled') changes. + +```csharp +public event EventHandler EnabledChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.Focused Event + +Occurs when the view receives focus. + +```csharp +public event EventHandler Focused; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.HoverEvent Event + +Occurs when the mouse hovers over the view. + +```csharp +public event EventHandler<HoverEventArgs> HoverEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[HoverEventArgs](Tizen.UI.HoverEventArgs.md 'Tizen.UI.HoverEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.InterceptTouchEvent Event + +Event that allows the parent view to intercept touch events before passing them to child views. + +```csharp +public event EventHandler<TouchEventArgs> InterceptTouchEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TouchEventArgs](Tizen.UI.TouchEventArgs.md 'Tizen.UI.TouchEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.InterceptWheelEvent Event + +Event that allows the parent view to intercept wheel events before passing them to child views. + +```csharp +public event EventHandler<WheelEventArgs> InterceptWheelEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WheelEventArgs](Tizen.UI.WheelEventArgs.md 'Tizen.UI.WheelEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.KeyEvent Event + +Occurs when a key event is received by the view. + +```csharp +public event EventHandler<KeyEventArgs> KeyEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[KeyEventArgs](Tizen.UI.KeyEventArgs.md 'Tizen.UI.KeyEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.LayoutDirectionChanged Event + +Occurs when the layout direction of the view changes. + +```csharp +public event EventHandler LayoutDirectionChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.MeasureInvalidated Event + +Occurs when the measure of the view is invalidated. + +```csharp +public event EventHandler MeasureInvalidated; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.Relayout Event + +Occurs when the view needs to be re-layouted. + +```csharp +public event EventHandler Relayout; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.TokenPropertyChanged Event + +Occurs when a token-related property in the View is changed. + +```csharp +public static event EventHandler<TokenPropertyChangedEventArgs> TokenPropertyChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.TouchEvent Event + +Occurs when a touch event is received by the view. + +```csharp +public event EventHandler<TouchEventArgs> TouchEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TouchEventArgs](Tizen.UI.TouchEventArgs.md 'Tizen.UI.TouchEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## View.Unfocused Event + +Occurs when the view losts focus. + +```csharp +public event EventHandler Unfocused; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## View.WheelEvent Event + +Occurs when the wheel event is fired. + +```csharp +public event EventHandler<WheelEventArgs> WheelEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WheelEventArgs](Tizen.UI.WheelEventArgs.md 'Tizen.UI.WheelEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewBindings.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewBindings.md new file mode 100644 index 0000000000..c3ae356987 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewBindings.md @@ -0,0 +1,96 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ViewBindings Class + +Provides a set of static properties that represent the binding properties of the [View](Tizen.UI.View.md 'Tizen.UI.View') class. + +```csharp +public static class ViewBindings +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewBindings +### Properties + + + +## ViewBindings.BackgroundColorProperty Property + +Gets the binding property for the background color of a [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.View,Tizen.UI.Color> BackgroundColorProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[Color](Tizen.UI.Color.md 'Tizen.UI.Color')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## ViewBindings.HeightProperty Property + +Gets the binding property for the height of a [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.View,float> HeightProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## ViewBindings.IsEnabledProperty Property + +The IsEnabledProperty is a two-way bindable property that indicates the view is enabled in the [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.TwoWayBindingProperty<Tizen.UI.View,bool> IsEnabledProperty { get; } +``` + +#### Property Value +[Tizen.UI.TwoWayBindingProperty<](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') + + + +## ViewBindings.WidthProperty Property + +Gets the binding property for the width of a [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.View,float> WidthProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## ViewBindings.XProperty Property + +Gets the binding property for the x-coordinate of a [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.View,float> XProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + +## ViewBindings.YProperty Property + +Gets the binding property for the y-coordinate of a [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static Tizen.UI.BindingProperty<Tizen.UI.View,float> YProperty { get; } +``` + +#### Property Value +[Tizen.UI.BindingProperty<](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[View](Tizen.UI.View.md 'Tizen.UI.View')[,](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>')[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single')[>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewExtensions.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewExtensions.md new file mode 100644 index 0000000000..42e69c095e --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewExtensions.md @@ -0,0 +1,979 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ViewExtensions Class + +Provides a series of extension methods that support configuring the alignment of controls inheriting from [View](Tizen.UI.View.md 'Tizen.UI.View'). + +```csharp +public static class ViewExtensions +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ViewExtensions +### Methods + + + +## ViewExtensions.Attach<T,U>(this T, U) Method + +Attaches an object to the view. + +```csharp +public static T Attach<T,U>(this T view, U value) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. + + + +`U` + +The type of the object to attach. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Attach_T,U_(thisT,U).T 'Tizen.UI.ViewExtensions.Attach<T,U>(this T, U).T') + +The view to attach the object to. + + + +`value` [U](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Attach_T,U_(thisT,U).U 'Tizen.UI.ViewExtensions.Attach<T,U>(this T, U).U') + +The object to attach. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Attach_T,U_(thisT,U).T 'Tizen.UI.ViewExtensions.Attach<T,U>(this T, U).T') +The view with the attached object. + + + +## ViewExtensions.Background<T>(this T, Background) Method + +Sets the background of the view using a background visual. + +```csharp +public static T Background<T>(this T view, Tizen.UI.Background background) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Background_T_(thisT,Tizen.UI.Background).T 'Tizen.UI.ViewExtensions.Background<T>(this T, Tizen.UI.Background).T') + +The view to set the background for. + + + +`background` [Background](Tizen.UI.Background.md 'Tizen.UI.Background') + +The background visual to use as the background. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Background_T_(thisT,Tizen.UI.Background).T 'Tizen.UI.ViewExtensions.Background<T>(this T, Tizen.UI.Background).T') +The view itself, to allow for method chaining. + + + +## ViewExtensions.BackgroundColor<TView>(this TView, Color) Method + +Sets the background color of the view. + +```csharp +public static TView BackgroundColor<TView>(this TView view, Tizen.UI.Color color) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BackgroundColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.ViewExtensions.BackgroundColor<TView>(this TView, Tizen.UI.Color).TView') + +The view to set the background color for. + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The background color of the view. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BackgroundColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.ViewExtensions.BackgroundColor<TView>(this TView, Tizen.UI.Color).TView') +The view itself. + + + +## ViewExtensions.BackgroundColorFromHex<TView>(this TView, string) Method + +Sets the background color of the view using a hex string. + +```csharp +public static TView BackgroundColorFromHex<TView>(this TView view, string color) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BackgroundColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.ViewExtensions.BackgroundColorFromHex<TView>(this TView, string).TView') + +The view to set the background color for. + + + +`color` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The background color of the view in hex format. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BackgroundColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.ViewExtensions.BackgroundColorFromHex<TView>(this TView, string).TView') +The view itself. + + + +## ViewExtensions.BorderlineColor<TView>(this TView, Color) Method + +Sets the borderline color of the view. + +```csharp +public static TView BorderlineColor<TView>(this TView view, Tizen.UI.Color color) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.ViewExtensions.BorderlineColor<TView>(this TView, Tizen.UI.Color).TView') + +The view to set the borderline color. + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The borderline color to set. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineColor_TView_(thisTView,Tizen.UI.Color).TView 'Tizen.UI.ViewExtensions.BorderlineColor<TView>(this TView, Tizen.UI.Color).TView') +The view itself. + + + +## ViewExtensions.BorderlineColorFromHex<TView>(this TView, string) Method + +Sets the borderline color of the view using a hex string. + +```csharp +public static TView BorderlineColorFromHex<TView>(this TView view, string color) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.ViewExtensions.BorderlineColorFromHex<TView>(this TView, string).TView') + +The view to set the borderline color for. + + + +`color` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The borderline color of the view in hex format. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineColorFromHex_TView_(thisTView,string).TView 'Tizen.UI.ViewExtensions.BorderlineColorFromHex<TView>(this TView, string).TView') +The view itself. + + + +## ViewExtensions.BorderlineOffset<TView>(this TView, float) Method + +Sets the borderline offset of the view. + +```csharp +public static TView BorderlineOffset<TView>(this TView view, float offset) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineOffset_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.BorderlineOffset<TView>(this TView, float).TView') + +The view to set the borderline offest. + + + +`offset` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The borderline offset to set. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineOffset_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.BorderlineOffset<TView>(this TView, float).TView') +The view itself. + + + +## ViewExtensions.BorderlineWidth<TView>(this TView, float) Method + +Sets the borderline width of the view. + +```csharp +public static TView BorderlineWidth<TView>(this TView view, float width) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineWidth_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.BorderlineWidth<TView>(this TView, float).TView') + +The view to set the borderline width. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The borderline width to set. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.BorderlineWidth_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.BorderlineWidth<TView>(this TView, float).TView') +The view itself. + + + +## ViewExtensions.CornerRadius<TView>(this TView, CornerRadius) Method + +Sets the corner radius of the view. + +```csharp +public static TView CornerRadius<TView>(this TView view, Tizen.UI.CornerRadius cornerRadius) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.CornerRadius_TView_(thisTView,Tizen.UI.CornerRadius).TView 'Tizen.UI.ViewExtensions.CornerRadius<TView>(this TView, Tizen.UI.CornerRadius).TView') + +The view to set the corner radius. + + + +`cornerRadius` [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') + +The corner radius to set. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.CornerRadius_TView_(thisTView,Tizen.UI.CornerRadius).TView 'Tizen.UI.ViewExtensions.CornerRadius<TView>(this TView, Tizen.UI.CornerRadius).TView') +The view itself. + + + +## ViewExtensions.DesiredHeight<TView>(this TView, float) Method + +Sets the desired height of the view. + +```csharp +public static TView DesiredHeight<TView>(this TView view, float height) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredHeight_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.DesiredHeight<TView>(this TView, float).TView') + +The view to set the desired height for. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired height of the view. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredHeight_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.DesiredHeight<TView>(this TView, float).TView') +The view itself. + + + +## ViewExtensions.DesiredSize<TView>(this TView, float, float) Method + +Sets the desired size of the view. + +```csharp +public static TView DesiredSize<TView>(this TView view, float width, float height) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredSize_TView_(thisTView,float,float).TView 'Tizen.UI.ViewExtensions.DesiredSize<TView>(this TView, float, float).TView') + +The view to set the desired size for. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired width of the view. + + + +`height` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired height of the view. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredSize_TView_(thisTView,float,float).TView 'Tizen.UI.ViewExtensions.DesiredSize<TView>(this TView, float, float).TView') +The view itself. + + + +## ViewExtensions.DesiredSize<TView>(this TView, Size) Method + +Sets the desired size of the view. + +```csharp +public static TView DesiredSize<TView>(this TView view, Tizen.UI.Size size) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredSize_TView_(thisTView,Tizen.UI.Size).TView 'Tizen.UI.ViewExtensions.DesiredSize<TView>(this TView, Tizen.UI.Size).TView') + +The view to set the desired size for. + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The desired size to set. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredSize_TView_(thisTView,Tizen.UI.Size).TView 'Tizen.UI.ViewExtensions.DesiredSize<TView>(this TView, Tizen.UI.Size).TView') +The view with the desired size set. + + + +## ViewExtensions.DesiredWidth<TView>(this TView, float) Method + +Sets the desired width of the view. + +```csharp +public static TView DesiredWidth<TView>(this TView view, float width) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredWidth_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.DesiredWidth<TView>(this TView, float).TView') + +The view to set the desired width for. + + + +`width` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The desired width of the view. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.DesiredWidth_TView_(thisTView,float).TView 'Tizen.UI.ViewExtensions.DesiredWidth<TView>(this TView, float).TView') +The view itself. + + + +## ViewExtensions.Focusable<TView>(this TView, bool) Method + +Sets a value indicating whether the view can receive keyboard focus. + +```csharp +public static TView Focusable<TView>(this TView view, bool focusable) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The view inheriting from [View](Tizen.UI.View.md 'Tizen.UI.View'). +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Focusable_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.Focusable<TView>(this TView, bool).TView') + +The target view. + + + +`focusable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Focusable_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.Focusable<TView>(this TView, bool).TView') +The view itself. + + + +## ViewExtensions.FocusableChildren<TView>(this TView, bool) Method + +Sets a value indicating whether the view can receive keyboard focus. + +```csharp +public static TView FocusableChildren<TView>(this TView view, bool focusableChildren) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The view inheriting from [View](Tizen.UI.View.md 'Tizen.UI.View'). +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.FocusableChildren_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.FocusableChildren<TView>(this TView, bool).TView') + +The target view. + + + +`focusableChildren` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A boolean value whether the view make focusableChildren or not. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.FocusableChildren_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.FocusableChildren<TView>(this TView, bool).TView') +The view itself. + + + +## ViewExtensions.FocusableInTouch<TView>(this TView, bool) Method + +Sets whether the view can receive focus through touch events. + +```csharp +public static TView FocusableInTouch<TView>(this TView view, bool focusableInTouch) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The view inheriting from [View](Tizen.UI.View.md 'Tizen.UI.View'). +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.FocusableInTouch_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.FocusableInTouch<TView>(this TView, bool).TView') + +The target view. + + + +`focusableInTouch` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A boolean value whether the view make focusableInTouch or not. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.FocusableInTouch_TView_(thisTView,bool).TView 'Tizen.UI.ViewExtensions.FocusableInTouch<TView>(this TView, bool).TView') +The view itself. + + + +## ViewExtensions.IsDescendantOf(this View, View) Method + +Checks if the given view is a descendant of the specified parent view. + +```csharp +public static bool IsDescendantOf(this Tizen.UI.View view, Tizen.UI.View parent); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to check. + + + +`parent` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The parent view to compare with. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the view is a descendant of the parent, otherwise false. + + + +## ViewExtensions.Name<T>(this T, string) Method + +Sets the name of the view. + +```csharp +public static T Name<T>(this T view, string name) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Name_T_(thisT,string).T 'Tizen.UI.ViewExtensions.Name<T>(this T, string).T') + +The view the name for. + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name to set. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Name_T_(thisT,string).T 'Tizen.UI.ViewExtensions.Name<T>(this T, string).T') +The view with the name set. + + + +## ViewExtensions.Position(this View) Method + +Gets the position of the view. + +```csharp +public static Tizen.UI.Point Position(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the position for. + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +The position of the view. + + + +## ViewExtensions.Scale(this View) Method + +Gets the scale of the view. + +```csharp +public static Tizen.UI.Size Scale(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the scale for. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The scale of the view. + + + +## ViewExtensions.Scale<T>(this T, float, float) Method + +Sets the scale of the view. + +```csharp +public static T Scale<T>(this T view, float scaleX, float scaleY) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Scale_T_(thisT,float,float).T 'Tizen.UI.ViewExtensions.Scale<T>(this T, float, float).T') + +The view to set the scale for. + + + +`scaleX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scaleX of the view. + + + +`scaleY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scaleY of the view. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Scale_T_(thisT,float,float).T 'Tizen.UI.ViewExtensions.Scale<T>(this T, float, float).T') +The view itself. + + + +## ViewExtensions.Scale<T>(this T, Size) Method + +Sets the scale of the view. + +```csharp +public static T Scale<T>(this T view, Tizen.UI.Size scale) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Scale_T_(thisT,Tizen.UI.Size).T 'Tizen.UI.ViewExtensions.Scale<T>(this T, Tizen.UI.Size).T') + +The view to set the scale for. + + + +`scale` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The scale to set. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Scale_T_(thisT,Tizen.UI.Size).T 'Tizen.UI.ViewExtensions.Scale<T>(this T, Tizen.UI.Size).T') +The view itself. + + + +## ViewExtensions.ScaleX<T>(this T, float) Method + +Sets the scaleX of the view. + +```csharp +public static T ScaleX<T>(this T view, float scaleX) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.ScaleX_T_(thisT,float).T 'Tizen.UI.ViewExtensions.ScaleX<T>(this T, float).T') + +The view to set the scaleX for. + + + +`scaleX` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scaleX of the view. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.ScaleX_T_(thisT,float).T 'Tizen.UI.ViewExtensions.ScaleX<T>(this T, float).T') +The view itself. + + + +## ViewExtensions.ScaleY<T>(this T, float) Method + +Sets the scaleY of the view. + +```csharp +public static T ScaleY<T>(this T view, float scaleY) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.ScaleY_T_(thisT,float).T 'Tizen.UI.ViewExtensions.ScaleY<T>(this T, float).T') + +The view to set the scaleY for. + + + +`scaleY` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The scaleY of the view. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.ScaleY_T_(thisT,float).T 'Tizen.UI.ViewExtensions.ScaleY<T>(this T, float).T') +The view itself. + + + +## ViewExtensions.ScreenScaledBounds(this View) Method + +Returns the screen-scaled bounds of the view. + +```csharp +public static Tizen.UI.Rect ScreenScaledBounds(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the screen-scaled bounds for. + +#### Returns +[Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') +A rectangle representing the screen-scaled bounds of the view. + + + +## ViewExtensions.Self<TView>(this TView, Action<TView>) Method + +Invokes an action on the specified view. + +```csharp +public static TView Self<TView>(this TView view, System.Action<TView> action) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,System.Action_TView_).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, System.Action<TView>).TView') + +The view to which the action will be applied. + + + +`action` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,System.Action_TView_).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, System.Action<TView>).TView')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') + +The action to invoke on the view. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,System.Action_TView_).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, System.Action<TView>).TView') +The view itself. + + + +## ViewExtensions.Self<TView>(this TView, TView) Method + +Assign this view reference to the given variable. + +```csharp +public static TView Self<TView>(this TView view, out TView variable) + where TView : Tizen.UI.View; +``` +#### Type parameters + + + +`TView` + +The type of the view. +#### Parameters + + + +`view` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,TView).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, TView).TView') + + + +`variable` [TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,TView).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, TView).TView') + +The variable to save the reference to. + +#### Returns +[TView](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Self_TView_(thisTView,TView).TView 'Tizen.UI.ViewExtensions.Self<TView>(this TView, TView).TView') +The view itself. + + + +## ViewExtensions.Shadow<T>(this T, Shadow) Method + +Sets the shadow of the view. + +```csharp +public static T Shadow<T>(this T view, Tizen.UI.Shadow shadow) + where T : Tizen.UI.View; +``` +#### Type parameters + + + +`T` + +The type of the view. +#### Parameters + + + +`view` [T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Shadow_T_(thisT,Tizen.UI.Shadow).T 'Tizen.UI.ViewExtensions.Shadow<T>(this T, Tizen.UI.Shadow).T') + +The view to set the shadow for. + + + +`shadow` [Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') + +The shadow object to apply to the view. + +#### Returns +[T](Tizen.UI.ViewExtensions.md#Tizen.UI.ViewExtensions.Shadow_T_(thisT,Tizen.UI.Shadow).T 'Tizen.UI.ViewExtensions.Shadow<T>(this T, Tizen.UI.Shadow).T') +The view itself, to allow method chaining. + + + +## ViewExtensions.Size(this View) Method + +Gets the size of the view. + +```csharp +public static Tizen.UI.Size Size(this Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to get the size for. + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The size of the view. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewGroup.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewGroup.md new file mode 100644 index 0000000000..1665239c67 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewGroup.md @@ -0,0 +1,307 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ViewGroup Class + +ViewGroup is a container class that manages an array of child views and layouts. It provides layout management and event propagation. + +```csharp +public class ViewGroup : Tizen.UI.View, +System.Collections.Generic.IList<Tizen.UI.View>, +System.Collections.Generic.ICollection<Tizen.UI.View>, +System.Collections.Generic.IEnumerable<Tizen.UI.View>, +System.Collections.IEnumerable, +Tizen.UI.IParentObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 ViewGroup + +Implements [System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1'), [System.Collections.Generic.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System.Collections.Generic.ICollection`1'), [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1'), [System.Collections.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System.Collections.IEnumerable'), [IParentObject](Tizen.UI.IParentObject.md 'Tizen.UI.IParentObject') +### Constructors + + + +## ViewGroup() Constructor + +Constructor for the ViewGroup class. + +```csharp +public ViewGroup(); +``` +### Properties + + + +## ViewGroup.Children Property + +Gets the list of child views. + +```csharp +public System.Collections.Generic.IList<Tizen.UI.View> Children { get; } +``` + +#### Property Value +[System.Collections.Generic.IList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1 'System.Collections.Generic.IList`1') + + + +## ViewGroup.Count Property + +Gets the number of child views. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System.Collections.Generic.ICollection`1.Count') + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## ViewGroup.IsReadOnly Property + +Gets a value indicating whether the list of child views is read-only. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System.Collections.Generic.ICollection`1.IsReadOnly') + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## ViewGroup.this[int] Property + +Gets or sets the child view at the specified index. + +```csharp +public Tizen.UI.View this[int index] { get; set; } +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +Implements [this[int]](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.Item#System_Collections_Generic_IList_1_Item_System_Int32_ 'System.Collections.Generic.IList`1.Item(System.Int32)') + +#### Property Value +[View](Tizen.UI.View.md 'Tizen.UI.View') +### Methods + + + +## ViewGroup.Add(View) Method + +Adds a child view to the end of the list of child views. + +```csharp +public void Add(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to add. + + + +## ViewGroup.Clear() Method + +Removes all child views from the list of child views. + +```csharp +public void Clear(); +``` + +Implements [Clear()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System.Collections.Generic.ICollection`1.Clear') + + + +## ViewGroup.Contains(View) Method + +Checks if the list of child views contains the specified child view. + +```csharp +public bool Contains(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to check for. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the list of child views contains the child view, false otherwise. + + + +## ViewGroup.CopyTo(View[], int) Method + +Copies the child views in the list of child views to the specified array, starting at the specified index. + +```csharp +public void CopyTo(Tizen.UI.View[] array, int arrayIndex); +``` +#### Parameters + + + +`array` [View](Tizen.UI.View.md 'Tizen.UI.View')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') + +The array to copy the child views to. + + + +`arrayIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index in the array to start copying. + + + +## ViewGroup.GetDescendant(string) Method + +Gets the descendant view with the specified name. + +```csharp +public override Tizen.UI.View GetDescendant(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the descendant view to find. + +#### Returns +[View](Tizen.UI.View.md 'Tizen.UI.View') +The descendant view with the specified name, or null if it is not found. + + + +## ViewGroup.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child views. + +```csharp +public System.Collections.Generic.IEnumerator<Tizen.UI.View> GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System.Collections.Generic.IEnumerable`1.GetEnumerator'), [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + +#### Returns +[System.Collections.Generic.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System.Collections.Generic.IEnumerator`1') +An enumerator for the list of child views. + + + +## ViewGroup.IndexOf(View) Method + +Gets the index of the specified child view in the list of child views. + +```csharp +public int IndexOf(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to find the index of. + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The index of the child view, or -1 if it is not found. + + + +## ViewGroup.Insert(int, View) Method + +Inserts a child view at the specified index in the list of child views. + +```csharp +public void Insert(int index, Tizen.UI.View item); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index to insert the child view at. + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to insert. + + + +## ViewGroup.Remove(View) Method + +Removes the specified child view from the list of child views. + +```csharp +public bool Remove(Tizen.UI.View item); +``` +#### Parameters + + + +`item` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The child view to remove. + +Implements [Remove(View)](Tizen.UI.IParentObject.md#Tizen.UI.IParentObject.Remove(Tizen.UI.View) 'Tizen.UI.IParentObject.Remove(Tizen.UI.View)') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the child view was removed, false otherwise. + + + +## ViewGroup.RemoveAt(int) Method + +Removes the child view at the specified index from the list of child views. + +```csharp +public void RemoveAt(int index); +``` +#### Parameters + + + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The index of the child view to remove. + +Implements [RemoveAt(int)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IList-1.RemoveAt#System_Collections_Generic_IList_1_RemoveAt_System_Int32_ 'System.Collections.Generic.IList`1.RemoveAt(System.Int32)') +### Explicit Interface Implementations + + + +## ViewGroup.System.Collections.IEnumerable.GetEnumerator() Method + +Returns an enumerator that iterates through the list of child views. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator()](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System.Collections.IEnumerable.GetEnumerator') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplate.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplate.md new file mode 100644 index 0000000000..1a53d9c235 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplate.md @@ -0,0 +1,53 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ViewTemplate Class + +This class represents a view template used to create reusable views. + +```csharp +public class ViewTemplate : Tizen.UI.Template<Tizen.UI.View> +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Template<](Tizen.UI.Template_T_.md 'Tizen.UI.Template<T>')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](Tizen.UI.Template_T_.md 'Tizen.UI.Template<T>') 🡒 ViewTemplate + +Derived +↳ [ViewTemplateSelector](Tizen.UI.ViewTemplateSelector.md 'Tizen.UI.ViewTemplateSelector') +### Constructors + + + +## ViewTemplate(Func<View>) Constructor + +Constructor for the ViewTemplate class that takes a loadTemplate function parameter. + +```csharp +public ViewTemplate(System.Func<Tizen.UI.View> loadTemplate); +``` +#### Parameters + + + +`loadTemplate` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-1 'System.Func`1') + +A function that returns a [View](Tizen.UI.View.md 'Tizen.UI.View') instance. + + + +## ViewTemplate(Type) Constructor + +Constructor for the ViewTemplate class that takes a type parameter and creates a view instance from the given type. + +```csharp +public ViewTemplate(System.Type type); +``` +#### Parameters + + + +`type` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') + +The type of the view that the template will generate. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplateSelector.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplateSelector.md new file mode 100644 index 0000000000..9234e5d4bb --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplateSelector.md @@ -0,0 +1,43 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## ViewTemplateSelector Class + +This class represents a view template selector used to create reusable view + +```csharp +public abstract class ViewTemplateSelector : Tizen.UI.ViewTemplate +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [Tizen.UI.Template<](Tizen.UI.Template_T_.md 'Tizen.UI.Template<T>')[View](Tizen.UI.View.md 'Tizen.UI.View')[>](Tizen.UI.Template_T_.md 'Tizen.UI.Template<T>') 🡒 [ViewTemplate](Tizen.UI.ViewTemplate.md 'Tizen.UI.ViewTemplate') 🡒 ViewTemplateSelector +### Methods + + + +## ViewTemplateSelector.SelectTemplate(object, View) Method + +Selects the appropriate view template for the specified object based on some custom logic. + +```csharp +public Tizen.UI.ViewTemplate SelectTemplate(object item, Tizen.UI.View container); +``` +#### Parameters + + + +`item` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +An object that represents the item being templated. + + + +`container` [View](Tizen.UI.View.md 'Tizen.UI.View') + +A [View](Tizen.UI.View.md 'Tizen.UI.View') that is the container in which the template will be applied. + +#### Returns +[ViewTemplate](Tizen.UI.ViewTemplate.md 'Tizen.UI.ViewTemplate') +A [ViewTemplate](Tizen.UI.ViewTemplate.md 'Tizen.UI.ViewTemplate') instance that represents the selected template for the specified object. + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisibilityChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisibilityChangedEventArgs.md new file mode 100644 index 0000000000..29c522c9a8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisibilityChangedEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## VisibilityChangedEventArgs Class + +Event arguments for Tizen.UI.View.VisibilityChanged event. + +```csharp +public class VisibilityChangedEventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 VisibilityChangedEventArgs +### Properties + + + +## VisibilityChangedEventArgs.ChangedByParent Property + +Gets or sets a value indicating whether the visibility change was caused by a parent view. + +```csharp +public bool ChangedByParent { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## VisibilityChangedEventArgs.Visibility Property + +Gets or sets the new visibility state of the view. + +```csharp +public bool Visibility { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisualCutoutPolicy.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisualCutoutPolicy.md new file mode 100644 index 0000000000..255ac8e266 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisualCutoutPolicy.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## VisualCutoutPolicy Enum + +Specifies the visual cutout policy, defining how the visual's bounds are adjusted around cutouts + +```csharp +public enum VisualCutoutPolicy +``` +### Fields + + + +`None` 0 + +No cutout + + + +`ViewInside` 2 + +Cutout the inside bound of view + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WeakEventManager.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WeakEventManager.md new file mode 100644 index 0000000000..4c3bda25c5 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WeakEventManager.md @@ -0,0 +1,155 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WeakEventManager Class + +Provides a weak event manager that allows subscribing and unsubscribing from events without causing memory leaks. + +```csharp +public class WeakEventManager +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 WeakEventManager +### Methods + + + +## WeakEventManager.AddEventHandler(Delegate, string) Method + +Adds a delegate to the specified event. + +```csharp +public void AddEventHandler(System.Delegate handler, string eventName=""); +``` +#### Parameters + + + +`handler` [System.Delegate](https://docs.microsoft.com/en-us/dotnet/api/System.Delegate 'System.Delegate') + +The delegate to add to the event. + + + +`eventName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the event to which to add the delegate. + + + +## WeakEventManager.AddEventHandler<TEventArgs>(EventHandler<TEventArgs>, string) Method + +Adds a delegate to the specified event. + +```csharp +public void AddEventHandler<TEventArgs>(System.EventHandler<TEventArgs> handler, string eventName="") + where TEventArgs : System.EventArgs; +``` +#### Type parameters + + + +`TEventArgs` + +The type of event arguments. +#### Parameters + + + +`handler` [System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TEventArgs](Tizen.UI.WeakEventManager.md#Tizen.UI.WeakEventManager.AddEventHandler_TEventArgs_(System.EventHandler_TEventArgs_,string).TEventArgs 'Tizen.UI.WeakEventManager.AddEventHandler<TEventArgs>(System.EventHandler<TEventArgs>, string).TEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + +The delegate to add to the event. + + + +`eventName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the event to which to add the delegate. + + + +## WeakEventManager.HandleEvent(object, object, string) Method + +Raises the specified event with the given sender and event arguments. + +```csharp +public void HandleEvent(object sender, object args, string eventName); +``` +#### Parameters + + + +`sender` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object that raised the event. + + + +`args` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The event arguments. + + + +`eventName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the event to raise. + + + +## WeakEventManager.RemoveEventHandler(Delegate, string) Method + +Removes a delegate from the specified event. + +```csharp +public void RemoveEventHandler(System.Delegate handler, string eventName=""); +``` +#### Parameters + + + +`handler` [System.Delegate](https://docs.microsoft.com/en-us/dotnet/api/System.Delegate 'System.Delegate') + +The delegate to remove from the event. + + + +`eventName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the event from which to remove the delegate. + + + +## WeakEventManager.RemoveEventHandler<TEventArgs>(EventHandler<TEventArgs>, string) Method + +Removes a delegate from the specified event. + +```csharp +public void RemoveEventHandler<TEventArgs>(System.EventHandler<TEventArgs> handler, string eventName="") + where TEventArgs : System.EventArgs; +``` +#### Type parameters + + + +`TEventArgs` + +The type of event arguments. +#### Parameters + + + +`handler` [System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TEventArgs](Tizen.UI.WeakEventManager.md#Tizen.UI.WeakEventManager.RemoveEventHandler_TEventArgs_(System.EventHandler_TEventArgs_,string).TEventArgs 'Tizen.UI.WeakEventManager.RemoveEventHandler<TEventArgs>(System.EventHandler<TEventArgs>, string).TEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + +The delegate to remove from the event. + + + +`eventName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the event from which to remove the delegate. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebNavigationEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebNavigationEventArgs.md new file mode 100644 index 0000000000..0de779196a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebNavigationEventArgs.md @@ -0,0 +1,47 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WebNavigationEventArgs Class + +Provides data for the [NavigationStarted](Tizen.UI.WebView.md#Tizen.UI.WebView.NavigationStarted 'Tizen.UI.WebView.NavigationStarted') or [NavigationCompleted](Tizen.UI.WebView.md#Tizen.UI.WebView.NavigationCompleted 'Tizen.UI.WebView.NavigationCompleted') event. + +```csharp +public class WebNavigationEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 WebNavigationEventArgs +### Constructors + + + +## WebNavigationEventArgs(string) Constructor + +Initializes a new instance of the [WebNavigationEventArgs](Tizen.UI.WebNavigationEventArgs.md 'Tizen.UI.WebNavigationEventArgs') class with the specified url. + +```csharp +public WebNavigationEventArgs(string url); +``` +#### Parameters + + + +`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The url. +### Properties + + + +## WebNavigationEventArgs.Url Property + +Gets the destination of the navigation. + +```csharp +public string Url { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebView.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebView.md new file mode 100644 index 0000000000..906efd7f46 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebView.md @@ -0,0 +1,160 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WebView Class + +```csharp +public class WebView : Tizen.UI.View +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 [View](Tizen.UI.View.md 'Tizen.UI.View') 🡒 WebView +### Constructors + + + +## WebView() Constructor + +Initializes a new instance of the WebView class. + +```csharp +public WebView(); +``` +### Properties + + + +## WebView.CanGoBack Property + +Gets a value that indicates whether the user can navigate to previous pages. + +```csharp +public bool CanGoBack { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WebView.CanGoForward Property + +Gets a value that indicates whether the user can navigate forward. + +```csharp +public bool CanGoForward { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WebView.Source Property + +Gets or sets the [WebViewSource](Tizen.UI.WebViewSource.md 'Tizen.UI.WebViewSource') object that represents the location that this WebView object displays. + +```csharp +public Tizen.UI.WebViewSource Source { get; set; } +``` + +#### Property Value +[WebViewSource](Tizen.UI.WebViewSource.md 'Tizen.UI.WebViewSource') +### Methods + + + +## WebView.EvaluateJavaScript(string) Method + +Evaluates the provided script. + +```csharp +public void EvaluateJavaScript(string script); +``` +#### Parameters + + + +`script` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A script to evaluate. + + + +## WebView.EvaluateJavaScriptAsync(string) Method + +Asynchronously evaluates the provided script. + +```csharp +public System.Threading.Tasks.Task<string> EvaluateJavaScriptAsync(string script); +``` +#### Parameters + + + +`script` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +A script to evaluate. + +#### Returns +[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1') +A task that contains the result of the evaluation as a string. + + + +## WebView.GoBack() Method + +Navigates to the previous page in the navigation history. + +```csharp +public void GoBack(); +``` + + + +## WebView.GoForward() Method + +Navigates to the next page in the navigation history. + +```csharp +public void GoForward(); +``` + + + +## WebView.Reload() Method + +Reloads the current page. + +```csharp +public void Reload(); +``` +### Events + + + +## WebView.NavigationCompleted Event + +Occurs when the web naviagtion completes. + +```csharp +public event EventHandler<WebNavigationEventArgs> NavigationCompleted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WebNavigationEventArgs](Tizen.UI.WebNavigationEventArgs.md 'Tizen.UI.WebNavigationEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## WebView.NavigationStarted Event + +Occurs when the web naviagtion begins. + +```csharp +public event EventHandler<WebNavigationEventArgs> NavigationStarted; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WebNavigationEventArgs](Tizen.UI.WebNavigationEventArgs.md 'Tizen.UI.WebNavigationEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebViewSource.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebViewSource.md new file mode 100644 index 0000000000..178d11b05a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebViewSource.md @@ -0,0 +1,19 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WebViewSource Class + +Abstract class whose subclasses provide the data for a [WebView](Tizen.UI.WebView.md 'Tizen.UI.WebView'). + +```csharp +public abstract class WebViewSource +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 WebViewSource + +Derived +↳ [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') +↳ [UrlWebViewSource](Tizen.UI.UrlWebViewSource.md 'Tizen.UI.UrlWebViewSource') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelDirection.md new file mode 100644 index 0000000000..efdb57578d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelDirection.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WheelDirection Enum + +Enumeration for the direction of a wheel event. + +```csharp +public enum WheelDirection +``` +### Fields + + + +`Horizontal` 1 + +Horizontal direction. + + + +`Vertical` 0 + +Vertical direction. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEvent.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEvent.md new file mode 100644 index 0000000000..d09761af7c --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEvent.md @@ -0,0 +1,159 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WheelEvent Class + +WheelEvent class provides information about wheel events. + +```csharp +public class WheelEvent : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 WheelEvent +### Constructors + + + +## WheelEvent(IntPtr, bool) Constructor + +Constructor for creating WheelEvent object from native handle. + +```csharp +public WheelEvent(System.IntPtr handle, bool ownsHandle); +``` +#### Parameters + + + +`handle` [System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') + +Native handle of wheel event + + + +`ownsHandle` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +Whether the object takes ownership of the handle +### Properties + + + +## WheelEvent.Delta Property + +Gets the delta value of wheel event. + +```csharp +public int Delta { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## WheelEvent.Direction Property + +Gets the direction of wheel event. + +```csharp +public Tizen.UI.WheelDirection Direction { get; } +``` + +#### Property Value +[WheelDirection](Tizen.UI.WheelDirection.md 'Tizen.UI.WheelDirection') + + + +## WheelEvent.IsAltModifier Property + +Checks if the alt modifier key is pressed. + +```csharp +public bool IsAltModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WheelEvent.IsCtrlModifier Property + +Checks if the ctrl modifier key is pressed. + +```csharp +public bool IsCtrlModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WheelEvent.IsShiftModifier Property + +Checks if the shift modifier key is pressed. + +```csharp +public bool IsShiftModifier { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WheelEvent.Modifier Property + +Gets the modifier key of wheel event. + +```csharp +public uint Modifier { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## WheelEvent.Position Property + +Gets the position of wheel event. + +```csharp +public Tizen.UI.Point Position { get; } +``` + +#### Property Value +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') + + + +## WheelEvent.Time Property + +Gets the time stamp of wheel event. + +```csharp +public uint Time { get; } +``` + +#### Property Value +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') + + + +## WheelEvent.WheelType Property + +Gets the type of wheel event. + +```csharp +public Tizen.UI.WheelType WheelType { get; } +``` + +#### Property Value +[WheelType](Tizen.UI.WheelType.md 'Tizen.UI.WheelType') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEventArgs.md new file mode 100644 index 0000000000..902e730f7a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEventArgs.md @@ -0,0 +1,44 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WheelEventArgs Class + +Event arguments for [WheelEvent](Tizen.UI.WheelEvent.md 'Tizen.UI.WheelEvent') event. + +```csharp +public class WheelEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 WheelEventArgs +### Properties + + + +## WheelEventArgs.Handled Property + +Gets or sets a value indicating whether the event has been handled. + +```csharp +public bool Handled { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WheelEventArgs.Wheel Property + +Gets or sets the wheel event that occurred. + +```csharp +public Tizen.UI.WheelEvent Wheel { get; set; } +``` + +#### Property Value +[WheelEvent](Tizen.UI.WheelEvent.md 'Tizen.UI.WheelEvent') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelType.md new file mode 100644 index 0000000000..321296a000 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelType.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WheelType Enum + +Enumeration for wheel types. + +```csharp +public enum WheelType +``` +### Fields + + + +`Custom` 1 + +Represents a custom wheel event. + + + +`Mouse` 0 + +Represents a mouse wheel event. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Window.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Window.md new file mode 100644 index 0000000000..448495c58f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Window.md @@ -0,0 +1,1164 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## Window Class + +Represents a window on the screen. + +```csharp +public class Window : Tizen.UI.NObject +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') 🡒 Window +### Constructors + + + +## Window() Constructor + +Initializes a new instance of the [Window](Tizen.UI.Window.md 'Tizen.UI.Window') class. + +```csharp +public Window(); +``` + + + +## Window(string) Constructor + +Initializes a new instance of the [Window](Tizen.UI.Window.md 'Tizen.UI.Window') class. + +```csharp +public Window(string name); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the window. + + + +## Window(string, bool) Constructor + +Initializes a new instance of the [Window](Tizen.UI.Window.md 'Tizen.UI.Window') class. + +```csharp +public Window(string name, bool isTranslucent); +``` +#### Parameters + + + +`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The name of the window. + + + +`isTranslucent` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +A value indicating whether the window is translucent. +### Properties + + + +## Window.BorderArea Property + +Gets or sets the border area of the window. + +```csharp +public Tizen.UI.Thickness BorderArea { get; set; } +``` + +#### Property Value +[Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') + + + +## Window.Default Property + +Gets the default window. + +```csharp +public static Tizen.UI.Window Default { get; set; } +``` + +#### Property Value +[Window](Tizen.UI.Window.md 'Tizen.UI.Window') + + + +## Window.DefaultLayer Property + +Gets the default layer of the window. + +```csharp +public Tizen.UI.Layer DefaultLayer { get; } +``` + +#### Property Value +[Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + + + +## Window.DPI Property + +Gets the DPI of the window. + +```csharp +public int DPI { get; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## Window.IsMaximized Property + +Gets whether the window is maximized or not. + +```csharp +public bool IsMaximized { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Window.IsMinimized Property + +Gets whether the window is minimized or not. + +```csharp +public bool IsMinimized { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Window.IsVisible Property + +Gets a value indicating whether the window is visible. + +```csharp +public bool IsVisible { get; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## Window.Layers Property + +Gets the list of child layers + +```csharp +public System.Collections.Generic.IReadOnlyList<Tizen.UI.Layer> Layers { get; } +``` + +#### Property Value +[System.Collections.Generic.IReadOnlyList<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1')[Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyList-1 'System.Collections.Generic.IReadOnlyList`1') + + + +## Window.Title Property + +Gets or sets a title of window. + +```csharp +public string Title { get; set; } +``` + +#### Property Value +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + + + +## Window.WindowType Property + +Gets or sets a window type. +Most of window type can be set to use WindowType, except for IME type. +IME type can be set to use one of NUIApplication's constrcutors. + +```csharp +public Tizen.UI.WindowType WindowType { get; set; } +``` + +#### Property Value +[WindowType](Tizen.UI.WindowType.md 'Tizen.UI.WindowType') +### Methods + + + +## Window.Activate() Method + +Activates the window. + +```csharp +public void Activate(); +``` + + + +## Window.Add(Layer) Method + +Adds a layer to the window. + +```csharp +public void Add(Tizen.UI.Layer layer); +``` +#### Parameters + + + +`layer` [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + +The layer to add. + + + +## Window.AddAuxiliaryHint(string, string) Method + +Adds an auxiliary hint to the window. + +```csharp +public uint AddAuxiliaryHint(string hint, string value); +``` +#### Parameters + + + +`hint` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The auxiliary hint string. + + + +`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The value string for the auxiliary hint. + +#### Returns +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') +The ID of the new auxiliary hint on success, 0 on failure. + + + +## Window.AddAvailableOrientation(WindowOrientation) Method + +Adds an available orientation to the window. + +```csharp +public void AddAvailableOrientation(Tizen.UI.WindowOrientation orientation); +``` +#### Parameters + + + +`orientation` [WindowOrientation](Tizen.UI.WindowOrientation.md 'Tizen.UI.WindowOrientation') + +The orientation to add. + + + +## Window.AddFrameUpdateCallback(FrameUpdateCallback) Method + +Adds a frame update callback to the window. + +```csharp +public void AddFrameUpdateCallback(Tizen.UI.FrameUpdateCallback frameUpdateCallback); +``` +#### Parameters + + + +`frameUpdateCallback` [FrameUpdateCallback](Tizen.UI.FrameUpdateCallback.md 'Tizen.UI.FrameUpdateCallback') + +The frame update callback to add. + + + +## Window.FeedHover(TouchPoint) Method + +Feeds a hover event into the window. + +```csharp +public void FeedHover(Tizen.UI.TouchPoint touchPoint=null); +``` +#### Parameters + + + +`touchPoint` [TouchPoint](Tizen.UI.TouchPoint.md 'Tizen.UI.TouchPoint') + +The touch point to feed hover event. If null is entered, the feed hover event is generated with the last inputed touch point. + + + +## Window.FeedKey(KeyEvent) Method + +Feeds a key event to the window. + +```csharp +public void FeedKey(Tizen.UI.KeyEvent keyEvent); +``` +#### Parameters + + + +`keyEvent` [KeyEvent](Tizen.UI.KeyEvent.md 'Tizen.UI.KeyEvent') + +The key event to feed. + + + +## Window.FeedTouch(TouchPoint, int) Method + +Feeds a touch point into the window. + +```csharp +public void FeedTouch(Tizen.UI.TouchPoint touchPoint, int timeStamp); +``` +#### Parameters + + + +`touchPoint` [TouchPoint](Tizen.UI.TouchPoint.md 'Tizen.UI.TouchPoint') + +The touch point to feed. + + + +`timeStamp` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The timeStamp. + + + +## Window.GetAuxiliaryHint(string) Method + +Gets the value of the specified auxiliary hint string of the window. + +```csharp +public string GetAuxiliaryHint(string hint); +``` +#### Parameters + + + +`hint` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The auxiliary hint string to be searched. + +#### Returns +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') +The value of the specified auxiliary hint string, or an empty string if the specified hint is not found. + + + +## Window.GetClientSize() Method + +Gets the size of the client area of the window. + +```csharp +public Tizen.UI.Size GetClientSize(); +``` + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The size of the client area. + + + +## Window.GetCurrentOrientation() Method + +Gets the current orientation of the window. + +```csharp +public Tizen.UI.WindowOrientation GetCurrentOrientation(); +``` + +#### Returns +[WindowOrientation](Tizen.UI.WindowOrientation.md 'Tizen.UI.WindowOrientation') +The current orientation of the window. + + + +## Window.GetLastHoverEvent() Method + +Retrieves the last hover event that occurred on the window. + +```csharp +public Tizen.UI.HoverEvent GetLastHoverEvent(); +``` + +#### Returns +[HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') +The last hover event that occurred on the window. + + + +## Window.GetLastKeyEvent() Method + +Retrieves the last key event that was received by the window. + +```csharp +public Tizen.UI.KeyEvent GetLastKeyEvent(); +``` + +#### Returns +[KeyEvent](Tizen.UI.KeyEvent.md 'Tizen.UI.KeyEvent') +The last key event received by the window. + + + +## Window.GetLastTouchEvent() Method + +Retrieves the last touch event that occurred on the window. + +```csharp +public Tizen.UI.TouchEvent GetLastTouchEvent(); +``` + +#### Returns +[TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent') +The last touch event that occurred on the window. + + + +## Window.GetNativeWindowHandle() Method + +Gets the native window handle of the Window object. + +```csharp +public System.IntPtr GetNativeWindowHandle(); +``` + +#### Returns +[System.IntPtr](https://docs.microsoft.com/en-us/dotnet/api/System.IntPtr 'System.IntPtr') +The native window handle. + + + +## Window.GetPosition() Method + +Gets the position of the window. + +```csharp +public Tizen.UI.Point GetPosition(); +``` + +#### Returns +[Point](Tizen.UI.Point.md 'Tizen.UI.Point') +The position of the window. + + + +## Window.GetSize() Method + +Gets the size of the window. + +```csharp +public Tizen.UI.Size GetSize(); +``` + +#### Returns +[Size](Tizen.UI.Size.md 'Tizen.UI.Size') +The size of the window. + + + +## Window.GetWindow(Layer) Method + +Gets the window associated with the specified layer. + +```csharp +public static Tizen.UI.Window GetWindow(Tizen.UI.Layer layer); +``` +#### Parameters + + + +`layer` [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + +The layer to get the window from. + +#### Returns +[Window](Tizen.UI.Window.md 'Tizen.UI.Window') +The window associated with the specified layer. + + + +## Window.GetWindow(View) Method + +Gets the window that contains the specified view. + +```csharp +public static Tizen.UI.Window GetWindow(Tizen.UI.View view); +``` +#### Parameters + + + +`view` [View](Tizen.UI.View.md 'Tizen.UI.View') + +The view to search for its parent window. + +#### Returns +[Window](Tizen.UI.Window.md 'Tizen.UI.Window') +The window that contains the specified view, or null if the view is not currently added to any window. + + + +## Window.GrabKey(int, KeyGrabMode) Method + +Grabs the key specified by a key for a window in a GrabMode.
+Details: This function can be used for following example scenarios:
+- TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
+- Mobile - When a user presses the Home key, the homescreen appears regardless of the current foreground app.
+- Mobile - Using the volume up or down as zoom up or down in camera apps.
+ +```csharp +public bool GrabKey(int keyCode, Tizen.UI.KeyGrabMode mode); +``` +#### Parameters + + + +`keyCode` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key code to grab. + + + +`mode` [KeyGrabMode](Tizen.UI.KeyGrabMode.md 'Tizen.UI.KeyGrabMode') + +The grab mode for the key. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the grab succeeds. + +#### Exceptions + +[System.UnauthorizedAccessException](https://docs.microsoft.com/en-us/dotnet/api/System.UnauthorizedAccessException 'System.UnauthorizedAccessException') +This exception can be thrown due to permission denied. + + + +## Window.Hide() Method + +Hides the window. + +```csharp +public void Hide(); +``` + + + +## Window.KeepRendering(float) Method + +Keeps rendering the window for the specified duration in seconds. + +```csharp +public void KeepRendering(float durationSeconds); +``` +#### Parameters + + + +`durationSeconds` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') + +The duration in seconds to keep rendering. + + + +## Window.Lower() Method + +Lowers the window to the bottom of the window stack. + +```csharp +public void Lower(); +``` + + + +## Window.LowerLayerToBottom(Layer) Method + +Lowers a layer to the bottom of the window. + +```csharp +public void LowerLayerToBottom(Tizen.UI.Layer layer); +``` +#### Parameters + + + +`layer` [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + +The layer to lower. + + + +## Window.Maximize(bool) Method + +Sets whether the window is maximized or not. + +```csharp +public void Maximize(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the window should be maximized, false otherwise. + + + +## Window.Minimize(bool) Method + +Sets whether the window is minimized or not. + +```csharp +public void Minimize(bool enable); +``` +#### Parameters + + + +`enable` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the window can be minimized, false otherwise. + + + +## Window.Raise() Method + +Raises the window to the top of the window stack. + +```csharp +public void Raise(); +``` + + + +## Window.RaiseLayerToTop(Layer) Method + +Raises a layer to the top of the window. + +```csharp +public void RaiseLayerToTop(Tizen.UI.Layer layer); +``` +#### Parameters + + + +`layer` [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + +The layer to raise. + + + +## Window.Remove(Layer) Method + +Removes a layer from the window. + +```csharp +public void Remove(Tizen.UI.Layer layer); +``` +#### Parameters + + + +`layer` [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') + +The layer to remove. + + + +## Window.RemoveAvailableOrientation(WindowOrientation) Method + +Removes an available orientation from the window. + +```csharp +public void RemoveAvailableOrientation(Tizen.UI.WindowOrientation orientation); +``` +#### Parameters + + + +`orientation` [WindowOrientation](Tizen.UI.WindowOrientation.md 'Tizen.UI.WindowOrientation') + +The orientation to remove. + + + +## Window.RemoveFrameUpdateCallback(FrameUpdateCallback) Method + +Removes a frame update callback from the window. + +```csharp +public void RemoveFrameUpdateCallback(Tizen.UI.FrameUpdateCallback frameUpdateCallbck); +``` +#### Parameters + + + +`frameUpdateCallbck` [FrameUpdateCallback](Tizen.UI.FrameUpdateCallback.md 'Tizen.UI.FrameUpdateCallback') + + + +## Window.SetBackgroundColor(Color) Method + +Sets the background color of the window. + +```csharp +public void SetBackgroundColor(Tizen.UI.Color color); +``` +#### Parameters + + + +`color` [Color](Tizen.UI.Color.md 'Tizen.UI.Color') + +The background color of the window. + + + +## Window.SetFocusSkip(bool) Method + +Sets whether to skip focus on window. + +```csharp +public void SetFocusSkip(bool skip); +``` +#### Parameters + + + +`skip` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True to skip focus on window, otherwise false. + + + +## Window.SetInputRegion(Rect) Method + +Sets the input region for the window to receive touch events. + +```csharp +public void SetInputRegion(Tizen.UI.Rect region); +``` +#### Parameters + + + +`region` [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') + +A rectangular area that defines where touch events will be received by this window. + Touches outside this region will be passed to windows located behind this window. + + + +## Window.SetMaximumSize(int, int) Method + +Sets the maximum size of the window. + +```csharp +public void SetMaximumSize(int width, int height); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The maximum width of the window. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The maximum height of the window. + + + +## Window.SetMinimumSize(int, int) Method + +Sets the minimum size of the window. + +```csharp +public void SetMinimumSize(int width, int height); +``` +#### Parameters + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The minimum width of the window. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The minimum height of the window. + + + +## Window.SetPosition(Point) Method + +Sets the position of the window. + +```csharp +public void SetPosition(Tizen.UI.Point position); +``` +#### Parameters + + + +`position` [Point](Tizen.UI.Point.md 'Tizen.UI.Point') + +The position of the window. + + + +## Window.SetPositionSize(int, int, int, int) Method + +Sets the position and size of the window. + +```csharp +public void SetPositionSize(int x, int y, int width, int height); +``` +#### Parameters + + + +`x` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The x-coordinate of the window. + + + +`y` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The y-coordinate of the window. + + + +`width` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The width of the window. + + + +`height` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The height of the window. + + + +## Window.SetPreferredOrientation(WindowOrientation) Method + +Sets the preferred orientation of the window. + +```csharp +public void SetPreferredOrientation(Tizen.UI.WindowOrientation orientation); +``` +#### Parameters + + + +`orientation` [WindowOrientation](Tizen.UI.WindowOrientation.md 'Tizen.UI.WindowOrientation') + +The preferred orientation. + + + +## Window.SetSize(Size) Method + +Sets the size of the window. + +```csharp +public void SetSize(Tizen.UI.Size size); +``` +#### Parameters + + + +`size` [Size](Tizen.UI.Size.md 'Tizen.UI.Size') + +The size of the window. + + + +## Window.SetSize(ushort, ushort) Method + +Sets the size of the window. + +```csharp +public void SetSize(ushort width, ushort height); +``` +#### Parameters + + + +`width` [System.UInt16](https://docs.microsoft.com/en-us/dotnet/api/System.UInt16 'System.UInt16') + +The width of the window. + + + +`height` [System.UInt16](https://docs.microsoft.com/en-us/dotnet/api/System.UInt16 'System.UInt16') + +The height of the window. + + + +## Window.SetTransparency(bool) Method + +Sets the transparency of the window. + +```csharp +public void SetTransparency(bool transparent); +``` +#### Parameters + + + +`transparent` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + +True if the window should be transparent, false otherwise. + + + +## Window.SetWindowResizePolicy(WindowResizePolicy) Method + +Sets the window resize policy. + +```csharp +public void SetWindowResizePolicy(Tizen.UI.WindowResizePolicy policy); +``` +#### Parameters + + + +`policy` [WindowResizePolicy](Tizen.UI.WindowResizePolicy.md 'Tizen.UI.WindowResizePolicy') + +The window resize policy to set. + + + +## Window.Show() Method + +Shows the window. + +```csharp +public void Show(); +``` + + + +## Window.StartMoveRequest() Method + +Starts the move request for the window. + +```csharp +public System.Threading.Tasks.Task StartMoveRequest(); +``` + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +An awaitable Task. + + + +## Window.StartResizeRequest(WindowResizeDirection) Method + +Starts a window resize request with the specified direction. + +```csharp +public System.Threading.Tasks.Task StartResizeRequest(Tizen.UI.WindowResizeDirection direction); +``` +#### Parameters + + + +`direction` [WindowResizeDirection](Tizen.UI.WindowResizeDirection.md 'Tizen.UI.WindowResizeDirection') + +The direction of the window resize. + +#### Returns +[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') +An awaitable Task. + + + +## Window.UngrabKey(int) Method + +Ungrabs the key specified by a key for a window.
+Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.
+ +```csharp +public bool UngrabKey(int keyCode); +``` +#### Parameters + + + +`keyCode` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The key code to ungrab. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if the ungrab succeeds. + +#### Exceptions + +[System.UnauthorizedAccessException](https://docs.microsoft.com/en-us/dotnet/api/System.UnauthorizedAccessException 'System.UnauthorizedAccessException') +This exception can be thrown due to permission denied. +### Events + + + +## Window.FocusChanged Event + +Occurs when the window receives or losts focus. + +```csharp +public event EventHandler<WindowFocusChangedEventArgs> FocusChanged; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WindowFocusChangedEventArgs](Tizen.UI.WindowFocusChangedEventArgs.md 'Tizen.UI.WindowFocusChangedEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.HoverEvent Event + +Occurs when the mouse hovers over the window. + +```csharp +public event EventHandler<HoverEventArgs> HoverEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[HoverEventArgs](Tizen.UI.HoverEventArgs.md 'Tizen.UI.HoverEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.InterceptTouchEvent Event + +Event that allows the window to intercept touch events before passing them to child views. + +```csharp +public event EventHandler<TouchEventArgs> InterceptTouchEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TouchEventArgs](Tizen.UI.TouchEventArgs.md 'Tizen.UI.TouchEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.InterceptWheelEvent Event + +Event that allows the window to intercept wheel events before passing them to child views. + +```csharp +public event EventHandler<WheelEventArgs> InterceptWheelEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WheelEventArgs](Tizen.UI.WheelEventArgs.md 'Tizen.UI.WheelEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.KeyEvent Event + +Occurs when a key event is received. + +```csharp +public event EventHandler<KeyEventArgs> KeyEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[KeyEventArgs](Tizen.UI.KeyEventArgs.md 'Tizen.UI.KeyEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.Moved Event + +Occurs when the window is moved. + +```csharp +public event EventHandler Moved; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Window.Resized Event + +Occurs when the window is resized. + +```csharp +public event EventHandler Resized; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Window.TouchEvent Event + +Occurs when a touch event is received. + +```csharp +public event EventHandler<TouchEventArgs> TouchEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[TouchEventArgs](Tizen.UI.TouchEventArgs.md 'Tizen.UI.TouchEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + +## Window.VisibilityChanged Event + +Occurs when the window show or hide + +```csharp +public event EventHandler VisibilityChanged; +``` + +#### Event Type +[System.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System.EventHandler') + + + +## Window.WheelEvent Event + +Occurs when the wheel event is fired. + +```csharp +public event EventHandler<WheelEventArgs> WheelEvent; +``` + +#### Event Type +[System.EventHandler<](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1')[WheelEventArgs](Tizen.UI.WheelEventArgs.md 'Tizen.UI.WheelEventArgs')[>](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler-1 'System.EventHandler`1') + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlur.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlur.md new file mode 100644 index 0000000000..da07e1fb17 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlur.md @@ -0,0 +1,230 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowBlur Struct + +WindowBlurInfo is a struct designed to encapsulate the information required to apply a blur effect to a window. +It contains three properties that define how the blur effect is applied to the window, +including the type of blur, its intensity, and the corner rounding for the background blur. + +```csharp +public struct WindowBlur : +System.IEquatable<Tizen.UI.WindowBlur> +``` + +Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') +### Constructors + + + +## WindowBlur() Constructor + +The construct of WindowBlur + +```csharp +public WindowBlur(); +``` + + + +## WindowBlur(WindowBlurType, int) Constructor + +The construct with blur type and radius. + +```csharp +public WindowBlur(Tizen.UI.WindowBlurType blurType, int blurRadius); +``` +#### Parameters + + + +`blurType` [WindowBlurType](Tizen.UI.WindowBlurType.md 'Tizen.UI.WindowBlurType') + + + +`blurRadius` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +## WindowBlur(WindowBlurType, int, int) Constructor + +The construct with blur type, radius and corner radius for background type. + +```csharp +public WindowBlur(Tizen.UI.WindowBlurType blurType, int blurRadius, int cornerRadius); +``` +#### Parameters + + + +`blurType` [WindowBlurType](Tizen.UI.WindowBlurType.md 'Tizen.UI.WindowBlurType') + + + +`blurRadius` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`cornerRadius` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +### Properties + + + +## WindowBlur.BackgroundCornerRadius Property + +Gets or sets the corner radius of the window. +It is only useful when window blur type is background. + +When applying the background corner radius, ensure that the window's own corner radius is applied first. +The blur effect will respect the window's pre-defined corner radius settings +before applying the specified background corner radius. + +```csharp +public int BackgroundCornerRadius { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The corner radius of the window. + + + +## WindowBlur.BlurRadius Property + +Gets or sets the blur radius of the window. + +```csharp +public int BlurRadius { get; set; } +``` + +#### Property Value +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The blur radius of the window. + + + +## WindowBlur.BlurType Property + +Gets or sets the blur type of the window. + +```csharp +public Tizen.UI.WindowBlurType BlurType { get; set; } +``` + +#### Property Value +[WindowBlurType](Tizen.UI.WindowBlurType.md 'Tizen.UI.WindowBlurType') +The window blur type of the window. +### Methods + + + +## WindowBlur.Equals(object) Method + +Indicates whether this instance and a specified object are equal. + +```csharp +public override bool Equals(object obj); +``` +#### Parameters + + + +`obj` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') + +The object to compare with the current instance. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if [obj](Tizen.UI.WindowBlur.md#Tizen.UI.WindowBlur.Equals(object).obj 'Tizen.UI.WindowBlur.Equals(object).obj') and this instance are the same type and represent the same value; otherwise, [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). + + + +## WindowBlur.Equals(WindowBlur) Method + +Whether this is equivalent to other. + +```csharp +public bool Equals(Tizen.UI.WindowBlur other); +``` +#### Parameters + + + +`other` [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + +## WindowBlur.GetHashCode() Method + +Returns the hash code for this instance. + +```csharp +public override int GetHashCode(); +``` + +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +A 32-bit signed integer that is the hash code for this instance. +### Operators + + + +## WindowBlur.operator ==(WindowBlur, WindowBlur) Operator + +Compares two WindowBlurInfo for equality. + +```csharp +public static bool operator ==(Tizen.UI.WindowBlur operand1, Tizen.UI.WindowBlur operand2); +``` +#### Parameters + + + +`operand1` [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') + +The first operand object. + + + +`operand2` [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') + +The second operand object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both are equal, otherwise false. + + + +## WindowBlur.operator !=(WindowBlur, WindowBlur) Operator + +Compares two WindowBlurInfo for inequality. + +```csharp +public static bool operator !=(Tizen.UI.WindowBlur operand1, Tizen.UI.WindowBlur operand2); +``` +#### Parameters + + + +`operand1` [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') + +The first operand object. + + + +`operand2` [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') + +The second operand object. + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +True if both are not equal, otherwise false. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlurType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlurType.md new file mode 100644 index 0000000000..5e6f31dbb8 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlurType.md @@ -0,0 +1,36 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowBlurType Enum + +Enumeration of window blur type. + +```csharp +public enum WindowBlurType +``` +### Fields + + + +`Background` 1 + +background blur for the window. +It has a blur effect ot th background area of the window, making it appear blurred. + + + +`Behind` 2 + +behind blur for the window. +It has a blur effect ot th beind area of except the window background. + + + +`None` 0 + +disable + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowFocusChangedEventArgs.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowFocusChangedEventArgs.md new file mode 100644 index 0000000000..e7f5ac6156 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowFocusChangedEventArgs.md @@ -0,0 +1,31 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowFocusChangedEventArgs Class + +Event arguments for [FocusChanged](Tizen.UI.Window.md#Tizen.UI.Window.FocusChanged 'Tizen.UI.Window.FocusChanged') event. + +```csharp +public class WindowFocusChangedEventArgs : System.EventArgs +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.EventArgs](https://docs.microsoft.com/en-us/dotnet/api/System.EventArgs 'System.EventArgs') 🡒 WindowFocusChangedEventArgs +### Properties + + + +## WindowFocusChangedEventArgs.HasFocus Property + +Gets a value indicating whether the window has focus or not. + +```csharp +public bool HasFocus { get; set; } +``` + +#### Property Value +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowMode.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowMode.md new file mode 100644 index 0000000000..3837a0fcf0 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowMode.md @@ -0,0 +1,28 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowMode Enum + +The WindowMode enum represents the possible modes for a window. + +```csharp +public enum WindowMode +``` +### Fields + + + +`Opaque` 0 + +Indicates that the window is opaque, meaning that it displays a solid color and does not allow any other windows to be seen through it. + + + +`Transparent` 1 + +Indicates that the window is transparent, meaning that it displays a color that is mixed with the color of the window behind it. This allows other windows to be seen through the transparent window. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowOrientation.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowOrientation.md new file mode 100644 index 0000000000..f2478eea84 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowOrientation.md @@ -0,0 +1,40 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowOrientation Enum + +Enumeration for window orientation. + +```csharp +public enum WindowOrientation +``` +### Fields + + + +`Landscape` 90 + +Landscape orientation. + + + +`LandscapeInverse` 270 + +Landscape inverse orientation. + + + +`Portrait` 0 + +Portrait orientation. + + + +`PortraitInverse` 180 + +Portrait inverse orientation. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizeDirection.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizeDirection.md new file mode 100644 index 0000000000..ff917b4c69 --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizeDirection.md @@ -0,0 +1,64 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowResizeDirection Enum + +Enumeration for the direction of resizing a window. + +```csharp +public enum WindowResizeDirection +``` +### Fields + + + +`Bottom` 7 + +The bottom edge of the window. + + + +`BottomLeft` 6 + +The bottom-left corner of the window. + + + +`BottomRight` 8 + +The bottom-right corner of the window. + + + +`Left` 4 + +The left edge of the window. + + + +`Right` 5 + +The right edge of the window. + + + +`Top` 2 + +The top edge of the window. + + + +`TopLeft` 1 + +The top-left corner of the window. + + + +`TopRight` 3 + +The top-right corner of the window. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizePolicy.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizePolicy.md new file mode 100644 index 0000000000..f58459860f --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizePolicy.md @@ -0,0 +1,34 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowResizePolicy Enum + +Enumeration for the resize policy of a window. + +```csharp +public enum WindowResizePolicy +``` +### Fields + + + +`Fixed` 2 + +The window cannot be resized and its size is fixed. + + + +`FreeForm` 0 + +The window can be resized freely with no restrictions. + + + +`KeepRatio` 1 + +The window maintains its original aspect ratio when being resized. + + + + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowType.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowType.md new file mode 100644 index 0000000000..14bb9af66a --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowType.md @@ -0,0 +1,62 @@ +### [Tizen.UI](Tizen.UI.md 'Tizen.UI') + +## WindowType Enum + +An enum of window types. + +```csharp +public enum WindowType +``` +### Fields + + + +`Desktop` 5 + +Used for desktop windows. +This is a desktop type. No other windows can be placed below this type of window. + + + +`Dialog` 3 + +Used for simple dialog windows. + + + +`Ime` 4 + +Used for IME window that is used for keyboard window. +It should be set in UIApplication constructor. +It does not work with Window.Type, because IME window type can not change in runtime. + +### Remarks +See [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') for this type.
+ + + +`Normal` 0 + +A default window type.
+Indicates a normal or top-level window. +Almost every window will be created with this type. + + + +`Notification` 1 + +A notification window, like a warning about battery life or a new email received. + + + +`Utility` 2 + +A persistent utility window, like a toolbox or a palette. + +### Remarks +Most of window type can be set, except for IME type.
+IME type can only be used in one of UIApplication's constrcutors.
+ + + + diff --git a/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.md b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.md new file mode 100644 index 0000000000..9453c8af6d --- /dev/null +++ b/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.md @@ -0,0 +1,244 @@ + +## Tizen.UI Namespace + +| Classes | | +| :--- | :--- | +| [AccessibilityActionReceivedEventArgs](Tizen.UI.AccessibilityActionReceivedEventArgs.md 'Tizen.UI.AccessibilityActionReceivedEventArgs') | Provides the data for the View.AccessibilityActionReceived event. | +| Tizen.UI.AccessibilityDescriptionRequestedEventArgs | Accessibility description requested event args | +| [AccessibilityExtensions](Tizen.UI.AccessibilityExtensions.md 'Tizen.UI.AccessibilityExtensions') | Provides extension methods for the [View](Tizen.UI.View.md 'Tizen.UI.View') class. | +| [AccessibilityHighlightChangedEventArgs](Tizen.UI.AccessibilityHighlightChangedEventArgs.md 'Tizen.UI.AccessibilityHighlightChangedEventArgs') | Provides the data for the [View.AccessibilityHighlightChanged](https://docs.microsoft.com/en-us/dotnet/api/View.AccessibilityHighlightChanged 'View.AccessibilityHighlightChanged') event. | +| [AccessibilityManager](Tizen.UI.AccessibilityManager.md 'Tizen.UI.AccessibilityManager') | Provides accessibility features for the application. | +| [AccessibilityNameRequestedEventArgs](Tizen.UI.AccessibilityNameRequestedEventArgs.md 'Tizen.UI.AccessibilityNameRequestedEventArgs') | Accessibility name requested event args | +| [AlphaFunction](Tizen.UI.AlphaFunction.md 'Tizen.UI.AlphaFunction') | The AlphaFunction class provides a way to define custom interpolation for animations. | +| [AnchorClickedEventArgs](Tizen.UI.AnchorClickedEventArgs.md 'Tizen.UI.AnchorClickedEventArgs') | Provides data for the [AnchorClicked](Tizen.UI.InputView.md#Tizen.UI.InputView.AnchorClicked 'Tizen.UI.InputView.AnchorClicked') event. | +| [AnimatablePropertyValue](Tizen.UI.AnimatablePropertyValue.md 'Tizen.UI.AnimatablePropertyValue') | AnimatablePropertyValue is an abstract class that represents a property value that can be animated. | +| [Animation](Tizen.UI.Animation.md 'Tizen.UI.Animation') | Animation class is used to animate the properties of a view. | +| [AnimationExtensions](Tizen.UI.AnimationExtensions.md 'Tizen.UI.AnimationExtensions') | Provides extension methods for the Animation class. | +| [Background](Tizen.UI.Background.md 'Tizen.UI.Background') | The Background class is an abstract class that provides a base for background visual elements. | +| [BackgroundPropertyValue](Tizen.UI.BackgroundPropertyValue.md 'Tizen.UI.BackgroundPropertyValue') | BackgroundPropertyValue is a class that represents the value of the background property of a View. | +| [BackgroundTokenPropertyChangedEventArgs](Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md 'Tizen.UI.BackgroundTokenPropertyChangedEventArgs') | Provides data for background token property changed events. | +| [BindingExtensions](Tizen.UI.BindingExtensions.md 'Tizen.UI.BindingExtensions') | Provides extension methods for binding properties of a view model to a view. | +| [BindingProperty<TView,TValue>](Tizen.UI.BindingProperty_TView,TValue_.md 'Tizen.UI.BindingProperty<TView,TValue>') | The BindingProperty class represents a binding property for a view. | +| [BindingSession<TViewModel>](Tizen.UI.BindingSession_TViewModel_.md 'Tizen.UI.BindingSession<TViewModel>') | BindingSession class provides a mechanism for binding properties of a view model to a view. | +| [ColorBackground](Tizen.UI.ColorBackground.md 'Tizen.UI.ColorBackground') | The ColorBackground class is used to display a solid color on the screen. | +| [ColorTokenPropertyChangedEventArgs](Tizen.UI.ColorTokenPropertyChangedEventArgs.md 'Tizen.UI.ColorTokenPropertyChangedEventArgs') | Provides data for color token property changed events. | +| [ContentView](Tizen.UI.ContentView.md 'Tizen.UI.ContentView') | ContentView is a view that displays body view as its content. | +| [CornerRadiusPropertyValue](Tizen.UI.CornerRadiusPropertyValue.md 'Tizen.UI.CornerRadiusPropertyValue') | The CornerRadiusPropertyValue class represents a property value of CornerRadius type. | +| [CustomPropertyValue](Tizen.UI.CustomPropertyValue.md 'Tizen.UI.CustomPropertyValue') | Represents a custom property value that can be animated. | +| [DisplayMetrics](Tizen.UI.DisplayMetrics.md 'Tizen.UI.DisplayMetrics') | Provides methods for converting between display units and pixels. | +| [DpExtensions](Tizen.UI.DpExtensions.md 'Tizen.UI.DpExtensions') | Provides extension methods for representing the the device-independent pixels (dp), point (pt) and pixel (px). | +| [DragEventArgs](Tizen.UI.DragEventArgs.md 'Tizen.UI.DragEventArgs') | The event arguments of drag. | +| [EditableTextBindings<T>](Tizen.UI.EditableTextBindings_T_.md 'Tizen.UI.EditableTextBindings<T>') | Provides a set of static properties that represent the data-binding capabilities of the [IText](Tizen.UI.IText.md 'Tizen.UI.IText') and [ITextEditable](Tizen.UI.ITextEditable.md 'Tizen.UI.ITextEditable') interface. | +| [EventHandlerHelper](Tizen.UI.EventHandlerHelper.md 'Tizen.UI.EventHandlerHelper') | EventHandlerHelper class provides a helper method to set and get event handlers using actions. | +| [ExceptionHelper](Tizen.UI.ExceptionHelper.md 'Tizen.UI.ExceptionHelper') | Including methods that helps to throw exceptions. | +| [FocusChangedEventArgs](Tizen.UI.FocusChangedEventArgs.md 'Tizen.UI.FocusChangedEventArgs') | Provides data for the [FocusChanged](Tizen.UI.FocusManager.md#Tizen.UI.FocusManager.FocusChanged 'Tizen.UI.FocusManager.FocusChanged') event. | +| [FocusManager](Tizen.UI.FocusManager.md 'Tizen.UI.FocusManager') | The FocusManager class is used to manage the focus between views. | +| [FontClient](Tizen.UI.FontClient.md 'Tizen.UI.FontClient') | | +| [FrameUpdateCallback](Tizen.UI.FrameUpdateCallback.md 'Tizen.UI.FrameUpdateCallback') | This class provides a callback interface for receiving frame update events. | +| [Gesture](Tizen.UI.Gesture.md 'Tizen.UI.Gesture') | The Gesture class is an abstract class that represents a gesture detected by the system. | +| [GestureDetectedEventArgs](Tizen.UI.GestureDetectedEventArgs.md 'Tizen.UI.GestureDetectedEventArgs') | A base event arguments for gesture events. | +| [GestureDetector](Tizen.UI.GestureDetector.md 'Tizen.UI.GestureDetector') | The GestureDetector class is an abstract class that detects gestures on a View. | +| [GradientBackground](Tizen.UI.GradientBackground.md 'Tizen.UI.GradientBackground') | GradientBackground is a base class for visuals that have a gradient effect. | +| [Hover](Tizen.UI.Hover.md 'Tizen.UI.Hover') | The Hover class. | +| [HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') | The HoverEvent class represents a hover event that contains information about the hover points. | +| [HoverEventArgs](Tizen.UI.HoverEventArgs.md 'Tizen.UI.HoverEventArgs') | Event arguments for [HoverEvent](Tizen.UI.HoverEvent.md 'Tizen.UI.HoverEvent') event. | +| [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') | A [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') bound to an HTML-formatted string. | +| [ImageBackground](Tizen.UI.ImageBackground.md 'Tizen.UI.ImageBackground') | ImageBackground is a visual representation of an image resource. | +| [ImageBackgroundExtensions](Tizen.UI.ImageBackgroundExtensions.md 'Tizen.UI.ImageBackgroundExtensions') | Provides a series of extension methods that support configuring [ImageBackground](Tizen.UI.ImageBackground.md 'Tizen.UI.ImageBackground'). | +| [ImageExtensions](Tizen.UI.ImageExtensions.md 'Tizen.UI.ImageExtensions') | Provides a series of extension methods that support configuring [IImage](Tizen.UI.IImage.md 'Tizen.UI.IImage'). | +| [ImageLoader](Tizen.UI.ImageLoader.md 'Tizen.UI.ImageLoader') | Provides a set of methods for loading images and getting their original sizes. | +| [ImageUrl](Tizen.UI.ImageUrl.md 'Tizen.UI.ImageUrl') | The ImageUrl class represents an internally loaded image resource by its URI. | +| [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') | ImageView is a control for displaying an image resource. | +| [ImageViewBindings](Tizen.UI.ImageViewBindings.md 'Tizen.UI.ImageViewBindings') | Provides a set of static properties that represent the bindable properties of the [ImageView](Tizen.UI.ImageView.md 'Tizen.UI.ImageView') class. | +| [InnerShadowTokenPropertyChangedEventArgs](Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.InnerShadowTokenPropertyChangedEventArgs') | Provides data for inner shadow token property changed events. | +| [InputMethodContext](Tizen.UI.InputMethodContext.md 'Tizen.UI.InputMethodContext') | The InputMethodContext class provides functions to control the input method framework. | +| [InputView](Tizen.UI.InputView.md 'Tizen.UI.InputView') | InputView is a base class for text input controls. It provides common properties and events for text input controls. | +| [InputViewExtensions](Tizen.UI.InputViewExtensions.md 'Tizen.UI.InputViewExtensions') | Provides a set of extension methods for the InputView class. | +| [KeyEvent](Tizen.UI.KeyEvent.md 'Tizen.UI.KeyEvent') | KeyEvent is a class that represents a key event. | +| [KeyEventArgs](Tizen.UI.KeyEventArgs.md 'Tizen.UI.KeyEventArgs') | Event arguments for [KeyEvent](Tizen.UI.KeyEventArgs.md#Tizen.UI.KeyEventArgs.KeyEvent 'Tizen.UI.KeyEventArgs.KeyEvent') event. | +| [Layer](Tizen.UI.Layer.md 'Tizen.UI.Layer') | Layer is a container for views. It provides a way to group views together and manipulate them as a single entity. | +| [LinearGradientBackground](Tizen.UI.LinearGradientBackground.md 'Tizen.UI.LinearGradientBackground') | The LinearGradientBackground class is a visual that renders a linear gradient. | +| [Log](Tizen.UI.Log.md 'Tizen.UI.Log') | Provides methods for logging messages with different levels of importance. | +| [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') | The LongPressGesture class represents a long press gesture. | +| [LongPressGestureDetectedEventArgs](Tizen.UI.LongPressGestureDetectedEventArgs.md 'Tizen.UI.LongPressGestureDetectedEventArgs') | Event arguments for [LongPressGesture](Tizen.UI.LongPressGesture.md 'Tizen.UI.LongPressGesture') event. | +| [LongPressGestureDetector](Tizen.UI.LongPressGestureDetector.md 'Tizen.UI.LongPressGestureDetector') | The LongPressGestureDetector class is used to detect long press gestures on a View. | +| [LottieAnimationView](Tizen.UI.LottieAnimationView.md 'Tizen.UI.LottieAnimationView') | LottieAnimationView is a control for displaying Lottie animations. | +| [NObject](Tizen.UI.NObject.md 'Tizen.UI.NObject') | NObject is a base class for all objects in UI. | +| [OpacityPropertyValue](Tizen.UI.OpacityPropertyValue.md 'Tizen.UI.OpacityPropertyValue') | OpacityPropertyValue is a class that represents the opacity property value for an AnimatableProperty. | +| [OriginPoint](Tizen.UI.OriginPoint.md 'Tizen.UI.OriginPoint') | Provides a set of predefined points for the origin position of an object. | +| [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') | The PanGesture class represents a pan gesture event. | +| [PanGestureDetectedEventArgs](Tizen.UI.PanGestureDetectedEventArgs.md 'Tizen.UI.PanGestureDetectedEventArgs') | Event arguments for [PanGesture](Tizen.UI.PanGesture.md 'Tizen.UI.PanGesture') event. | +| [PanGestureDetector](Tizen.UI.PanGestureDetector.md 'Tizen.UI.PanGestureDetector') | The PanGestureDetector class is used to detect panning gestures on a View. | +| [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') | The PinchGesture class represents a pinch gesture event. | +| [PinchGestureDetectedEventArgs](Tizen.UI.PinchGestureDetectedEventArgs.md 'Tizen.UI.PinchGestureDetectedEventArgs') | Event arguments for [PinchGesture](Tizen.UI.PinchGesture.md 'Tizen.UI.PinchGesture') event. | +| [PinchGestureDetector](Tizen.UI.PinchGestureDetector.md 'Tizen.UI.PinchGestureDetector') | The PinchGestureDetector class is used to detect pinch gestures on a View. | +| [PixelBuffer](Tizen.UI.PixelBuffer.md 'Tizen.UI.PixelBuffer') | PixelBuffer is a class that represents a buffer of pixels. | +| [PixelData](Tizen.UI.PixelData.md 'Tizen.UI.PixelData') | The PixelData class provides a way to manage pixel data. | +| [PositionPropertyValue](Tizen.UI.PositionPropertyValue.md 'Tizen.UI.PositionPropertyValue') | Represents a property value for position animation. | +| [RadialGradientBackground](Tizen.UI.RadialGradientBackground.md 'Tizen.UI.RadialGradientBackground') | The RadialGradientBackground class is a visual which renders a radial gradient. | +| [ResourceLocalizer](Tizen.UI.ResourceLocalizer.md 'Tizen.UI.ResourceLocalizer') | Provides a mechanism for localizing strings and resources. | +| [RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') | The RotationGesture class represents a rotation gesture. | +| [RotationGestureDetectedEventArgs](Tizen.UI.RotationGestureDetectedEventArgs.md 'Tizen.UI.RotationGestureDetectedEventArgs') | Event arguments for [RotationGesture](Tizen.UI.RotationGesture.md 'Tizen.UI.RotationGesture') event. | +| [RotationGestureDetector](Tizen.UI.RotationGestureDetector.md 'Tizen.UI.RotationGestureDetector') | The RotationGestureDetector class is used to detect rotation gestures on a View. | +| [RotationPropertyValue](Tizen.UI.RotationPropertyValue.md 'Tizen.UI.RotationPropertyValue') | Represents a property value that represents a rotation in three dimensions. | +| [ScalePropertyValue](Tizen.UI.ScalePropertyValue.md 'Tizen.UI.ScalePropertyValue') | Represents a property value that represents the scale of a view. | +| [ScopedResourceManager](Tizen.UI.ScopedResourceManager.md 'Tizen.UI.ScopedResourceManager') | Provides a scoped mechanism for managing effective resource managers.
This class implements IDisposable to automatically handle pushing and popping
resource managers based on scope boundaries. | +| [ScrollEventArgs](Tizen.UI.ScrollEventArgs.md 'Tizen.UI.ScrollEventArgs') | The event arguments of scroll. | +| [ShadowTokenPropertyChangedEventArgs](Tizen.UI.ShadowTokenPropertyChangedEventArgs.md 'Tizen.UI.ShadowTokenPropertyChangedEventArgs') | Provides data for shadow token property changed events. | +| [SizePropertyValue](Tizen.UI.SizePropertyValue.md 'Tizen.UI.SizePropertyValue') | Represents a property value that represents the size of a view. | +| [SystemFontSizeManager](Tizen.UI.SystemFontSizeManager.md 'Tizen.UI.SystemFontSizeManager') | Provides a system-wide font size manager. | +| [TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') | The TapGesture class represents a gesture that recognizes a single tap on the screen. | +| [TapGestureDetectedEventArgs](Tizen.UI.TapGestureDetectedEventArgs.md 'Tizen.UI.TapGestureDetectedEventArgs') | Event arguments for [TapGesture](Tizen.UI.TapGesture.md 'Tizen.UI.TapGesture') event. | +| [TapGestureDetector](Tizen.UI.TapGestureDetector.md 'Tizen.UI.TapGestureDetector') | The TapGestureDetector class is used to detect when the user performs a tap gesture on a view. | +| [TbmSurfaceView](Tizen.UI.TbmSurfaceView.md 'Tizen.UI.TbmSurfaceView') | The TbmSurfaceView class represents a view that renders a texture using a TBM (Tizen Buffer Manager) surface. | +| [Template<T>](Tizen.UI.Template_T_.md 'Tizen.UI.Template<T>') | A generic template class that provides a way to create and setup instances of a specified type. | +| [TextBindings<T>](Tizen.UI.TextBindings_T_.md 'Tizen.UI.TextBindings<T>') | Provides a set of static properties that represent the data-binding capabilities of the [Itext](https://docs.microsoft.com/en-us/dotnet/api/Itext 'Itext') interface. | +| [TextEditor](Tizen.UI.TextEditor.md 'Tizen.UI.TextEditor') | A TextEditor is a multi-line text input control that supports various text editing features. | +| [TextEditorExtensions](Tizen.UI.TextEditorExtensions.md 'Tizen.UI.TextEditorExtensions') | Provides a set of extension methods for the [TextEditor](Tizen.UI.TextEditor.md 'Tizen.UI.TextEditor') class. | +| [TextExtensions](Tizen.UI.TextExtensions.md 'Tizen.UI.TextExtensions') | Provides a series of extension methods that support configuring a Text. | +| [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') | A text field is an interactive object that the user can enter text into. | +| [TextFieldExtensions](Tizen.UI.TextFieldExtensions.md 'Tizen.UI.TextFieldExtensions') | Provides a set of extension methods for the [TextField](Tizen.UI.TextField.md 'Tizen.UI.TextField') class. | +| [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView') | A TextView is a text control that displays a short to medium length string of text. | +| [TextViewExtensions](Tizen.UI.TextViewExtensions.md 'Tizen.UI.TextViewExtensions') | Provides a series of extension methods that support configuring a [TextView](Tizen.UI.TextView.md 'Tizen.UI.TextView'). | +| [Timer](Tizen.UI.Timer.md 'Tizen.UI.Timer') | The Timer class provides a convenient way to run a function at specified time intervals. | +| [TokenExtensions](Tizen.UI.TokenExtensions.md 'Tizen.UI.TokenExtensions') | Extensions methods for [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken') | +| [TokenManager](Tizen.UI.TokenManager.md 'Tizen.UI.TokenManager') | The manager for the token. It provides a way to set and get the token table. | +| [TokenPropertyChangedEventArgs](Tizen.UI.TokenPropertyChangedEventArgs.md 'Tizen.UI.TokenPropertyChangedEventArgs') | Provides data for token property changed events. | +| [TokenPropertyNames](Tizen.UI.TokenPropertyNames.md 'Tizen.UI.TokenPropertyNames') | Provides property names used in token-related events to indicate which property has changed. | +| [Touch](Tizen.UI.Touch.md 'Tizen.UI.Touch') | The Touch class represents a touch point on the screen. | +| [TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent') | The TouchEvent class represents a touch event that contains information about the touch points. | +| [TouchEventArgs](Tizen.UI.TouchEventArgs.md 'Tizen.UI.TouchEventArgs') | Event arguments for [TouchEvent](Tizen.UI.TouchEvent.md 'Tizen.UI.TouchEvent'). | +| [TouchPoint](Tizen.UI.TouchPoint.md 'Tizen.UI.TouchPoint') | TouchPoint represents a single point of contact on a touchscreen device. | +| [TwoWayBindingProperty<TView,TValue>](Tizen.UI.TwoWayBindingProperty_TView,TValue_.md 'Tizen.UI.TwoWayBindingProperty<TView,TValue>') | This class represents a two-way binding property between a view and its value. | +| [UIApplication](Tizen.UI.UIApplication.md 'Tizen.UI.UIApplication') | Represents a lite application tha has an UI screen. | +| [UISettings](Tizen.UI.UISettings.md 'Tizen.UI.UISettings') | Provides a set of methods for managing the appearance and behavior of the user interface. | +| [UrlWebViewSource](Tizen.UI.UrlWebViewSource.md 'Tizen.UI.UrlWebViewSource') | A [HtmlWebViewSource](Tizen.UI.HtmlWebViewSource.md 'Tizen.UI.HtmlWebViewSource') bound to a URL. | +| [VideoOverlayView](Tizen.UI.VideoOverlayView.md 'Tizen.UI.VideoOverlayView') | VideoOverlayView is a class that displays video content on the screen. | +| [View](Tizen.UI.View.md 'Tizen.UI.View') | The View class is a base class for other more specific UI components, such as buttons, text fields, and layouts. | +| [ViewBindings](Tizen.UI.ViewBindings.md 'Tizen.UI.ViewBindings') | Provides a set of static properties that represent the binding properties of the [View](Tizen.UI.View.md 'Tizen.UI.View') class. | +| [ViewExtensions](Tizen.UI.ViewExtensions.md 'Tizen.UI.ViewExtensions') | Provides a series of extension methods that support configuring the alignment of controls inheriting from [View](Tizen.UI.View.md 'Tizen.UI.View'). | +| [ViewGroup](Tizen.UI.ViewGroup.md 'Tizen.UI.ViewGroup') | ViewGroup is a container class that manages an array of child views and layouts. It provides layout management and event propagation. | +| [ViewTemplate](Tizen.UI.ViewTemplate.md 'Tizen.UI.ViewTemplate') | This class represents a view template used to create reusable views. | +| [ViewTemplateSelector](Tizen.UI.ViewTemplateSelector.md 'Tizen.UI.ViewTemplateSelector') | This class represents a view template selector used to create reusable view | +| [VisibilityChangedEventArgs](Tizen.UI.VisibilityChangedEventArgs.md 'Tizen.UI.VisibilityChangedEventArgs') | Event arguments for Tizen.UI.View.VisibilityChanged event. | +| [WeakEventManager](Tizen.UI.WeakEventManager.md 'Tizen.UI.WeakEventManager') | Provides a weak event manager that allows subscribing and unsubscribing from events without causing memory leaks. | +| [WebNavigationEventArgs](Tizen.UI.WebNavigationEventArgs.md 'Tizen.UI.WebNavigationEventArgs') | Provides data for the [NavigationStarted](Tizen.UI.WebView.md#Tizen.UI.WebView.NavigationStarted 'Tizen.UI.WebView.NavigationStarted') or [NavigationCompleted](Tizen.UI.WebView.md#Tizen.UI.WebView.NavigationCompleted 'Tizen.UI.WebView.NavigationCompleted') event. | +| [WebView](Tizen.UI.WebView.md 'Tizen.UI.WebView') | | +| [WebViewSource](Tizen.UI.WebViewSource.md 'Tizen.UI.WebViewSource') | Abstract class whose subclasses provide the data for a [WebView](Tizen.UI.WebView.md 'Tizen.UI.WebView'). | +| [WheelEvent](Tizen.UI.WheelEvent.md 'Tizen.UI.WheelEvent') | WheelEvent class provides information about wheel events. | +| [WheelEventArgs](Tizen.UI.WheelEventArgs.md 'Tizen.UI.WheelEventArgs') | Event arguments for [WheelEvent](Tizen.UI.WheelEvent.md 'Tizen.UI.WheelEvent') event. | +| [Window](Tizen.UI.Window.md 'Tizen.UI.Window') | Represents a window on the screen. | +| [WindowFocusChangedEventArgs](Tizen.UI.WindowFocusChangedEventArgs.md 'Tizen.UI.WindowFocusChangedEventArgs') | Event arguments for [FocusChanged](Tizen.UI.Window.md#Tizen.UI.Window.FocusChanged 'Tizen.UI.Window.FocusChanged') event. | + +| Structs | | +| :--- | :--- | +| [AccessibilityStates](Tizen.UI.AccessibilityStates.md 'Tizen.UI.AccessibilityStates') | The AccessibilityStates structure represents a set of states of the view to communicate to assistive service. | +| [AutoFontSize](Tizen.UI.AutoFontSize.md 'Tizen.UI.AutoFontSize') | The AutoFontSize struct represents a set of properties used to control the automatic font size adjustment feature. | +| [Color](Tizen.UI.Color.md 'Tizen.UI.Color') | Defines a color with red, green, blue, and alpha components. | +| [CornerRadius](Tizen.UI.CornerRadius.md 'Tizen.UI.CornerRadius') | Struct representing the radius of each corner of a rectangle. | +| [FontInfo](Tizen.UI.FontInfo.md 'Tizen.UI.FontInfo') | A struct to pass data of FontInfo PropertyMap. | +| [FontStyle](Tizen.UI.FontStyle.md 'Tizen.UI.FontStyle') | A struct to pass data of FontStyle PropertyMap.
| +| [GradientStop](Tizen.UI.GradientStop.md 'Tizen.UI.GradientStop') | The GradientStop structure represents a color and its position along the gradient line. | +| [HiddenInputSetting](Tizen.UI.HiddenInputSetting.md 'Tizen.UI.HiddenInputSetting') | The HiddenInputSetting struct is used to configure the hidden input settings of a text input control. | +| [InnerShadow](Tizen.UI.InnerShadow.md 'Tizen.UI.InnerShadow') | The InnerShadow struct represents a inner shadow effect applied to a view. | +| [InputMethodSetting](Tizen.UI.InputMethodSetting.md 'Tizen.UI.InputMethodSetting') | The InputMethodSetting struct is used to set the input method settings for a text input control. | +| [Outline](Tizen.UI.Outline.md 'Tizen.UI.Outline') | The Outline struct represents the outline property of a view. | +| [Point](Tizen.UI.Point.md 'Tizen.UI.Point') | Struct defining a 2-D point as a pair of floats. | +| [Rect](Tizen.UI.Rect.md 'Tizen.UI.Rect') | Represents a rectangular area by defining its position and size. | +| [Shadow](Tizen.UI.Shadow.md 'Tizen.UI.Shadow') | The Shadow struct represents a shadow effect applied to a view. | +| [Size](Tizen.UI.Size.md 'Tizen.UI.Size') | Struct defining height and width as a pair of floats. | +| [Strikethrough](Tizen.UI.Strikethrough.md 'Tizen.UI.Strikethrough') | A struct to express text strikethrough. | +| [TextShadow](Tizen.UI.TextShadow.md 'Tizen.UI.TextShadow') | The TextShadow struct represents the shadow effect applied to text. | +| [Thickness](Tizen.UI.Thickness.md 'Tizen.UI.Thickness') | Defines the thickness of a border around a control. | +| [Underline](Tizen.UI.Underline.md 'Tizen.UI.Underline') | The Underline struct represents the underline style of a text. | +| [UnitValue](Tizen.UI.UnitValue.md 'Tizen.UI.UnitValue') | Represents a value with a unit of measurement. | +| [WindowBlur](Tizen.UI.WindowBlur.md 'Tizen.UI.WindowBlur') | WindowBlurInfo is a struct designed to encapsulate the information required to apply a blur effect to a window.
It contains three properties that define how the blur effect is applied to the window,
including the type of blur, its intensity, and the corner rounding for the background blur. | + +| Interfaces | | +| :--- | :--- | +| [IBindableView](Tizen.UI.IBindableView.md 'Tizen.UI.IBindableView') | The IBindableView interface provides a mechanism for binding data to a view. | +| [IDescendantFocusObserver](Tizen.UI.IDescendantFocusObserver.md 'Tizen.UI.IDescendantFocusObserver') | The IDescendantFocusObserver interface defines a contract for classes that wish to receive notifications when a descendant view receives focus. | +| [IDescendantUnfocusObserver](Tizen.UI.IDescendantUnfocusObserver.md 'Tizen.UI.IDescendantUnfocusObserver') | The IDescendantUnfocusObserver interface defines a contract for classes that wish to receive notifications when a descendant view loses focus. | +| [IFocusAlgorithm](Tizen.UI.IFocusAlgorithm.md 'Tizen.UI.IFocusAlgorithm') | The IFocusAlgorithm interface defines the methods required for a focus algorithm to be used by the FocusManager. | +| [IImage](Tizen.UI.IImage.md 'Tizen.UI.IImage') | The IImage interface provides a common set of properties and methods for image objects. | +| [IParentObject](Tizen.UI.IParentObject.md 'Tizen.UI.IParentObject') | Represents an interface for managing parent-child relationships between views. | +| [IScrollable](Tizen.UI.IScrollable.md 'Tizen.UI.IScrollable') | An interface describes the functionality of a scrollable component. | +| [IScrollBar](Tizen.UI.IScrollBar.md 'Tizen.UI.IScrollBar') | Defines the interface for a scroll bar, which is responsible for displaying and controlling the scrolling of a target view. | +| [IText](Tizen.UI.IText.md 'Tizen.UI.IText') | The IText interface provides a common set of properties and methods for text-based objects. | +| [ITextAlignment](Tizen.UI.ITextAlignment.md 'Tizen.UI.ITextAlignment') | The ITextAlignment interface provides functionality to be able to align Text. | +| [ITextEditable](Tizen.UI.ITextEditable.md 'Tizen.UI.ITextEditable') | The ITextEditable interface provides a common set of properties and methods for editable text-based objects. | +| [ITextFormatting](Tizen.UI.ITextFormatting.md 'Tizen.UI.ITextFormatting') | The ITextFormatting interface provides a method for setting the text formatting. | +| [ITextPadding](Tizen.UI.ITextPadding.md 'Tizen.UI.ITextPadding') | The ITextPadding interface provides a method for setting the text padding. | +| [IToken](Tizen.UI.IToken.md 'Tizen.UI.IToken') | Interface for token. | +| [ITokenTable<T>](Tizen.UI.ITokenTable_T_.md 'Tizen.UI.ITokenTable<T>') | The interface for a token table. | + +| Enums | | +| :--- | :--- | +| [AccessibilityAction](Tizen.UI.AccessibilityAction.md 'Tizen.UI.AccessibilityAction') | Specifies the accessibility action sent from the accessibility service. | +| [AccessibilityReadingInfo](Tizen.UI.AccessibilityReadingInfo.md 'Tizen.UI.AccessibilityReadingInfo') | Accessibility reading information types. | +| [AccessibilityRelation](Tizen.UI.AccessibilityRelation.md 'Tizen.UI.AccessibilityRelation') | Specifies the ralation type between accessible views. | +| [AccessibilityRole](Tizen.UI.AccessibilityRole.md 'Tizen.UI.AccessibilityRole') | Specifies the role of an accessible object. | +| [AccessibilityState](Tizen.UI.AccessibilityState.md 'Tizen.UI.AccessibilityState') | AccessibilityState is an enumeration that represents the states of the view to send to assistive service. | +| [ActionButtonTitle](Tizen.UI.ActionButtonTitle.md 'Tizen.UI.ActionButtonTitle') | Enumeration for the action button titles. | +| [AnimationEndAction](Tizen.UI.AnimationEndAction.md 'Tizen.UI.AnimationEndAction') | | +| [AnimationState](Tizen.UI.AnimationState.md 'Tizen.UI.AnimationState') | Enumeration for the state of an animation. | +| [AnnouncementState](Tizen.UI.AnnouncementState.md 'Tizen.UI.AnnouncementState') | AnnouncementState is an enumeration that represents the states of an announcement. | +| [AutoCapital](Tizen.UI.AutoCapital.md 'Tizen.UI.AutoCapital') | Enumeration for auto-capitalization settings. | +| [BrokenImageType](Tizen.UI.BrokenImageType.md 'Tizen.UI.BrokenImageType') | The BrokenImageType enum represents the different sizes of broken images that can be displayed when an image fails to load. | +| [BuiltinAlphaFunctions](Tizen.UI.BuiltinAlphaFunctions.md 'Tizen.UI.BuiltinAlphaFunctions') | Built-in alpha functions for animations. | +| [ClippingMode](Tizen.UI.ClippingMode.md 'Tizen.UI.ClippingMode') | Enumeration for ClippingMode. | +| [FittingMode](Tizen.UI.FittingMode.md 'Tizen.UI.FittingMode') | Enumeration for FittingMode. | +| [FocusDirection](Tizen.UI.FocusDirection.md 'Tizen.UI.FocusDirection') | The FocusDirection enum represents the direction of focus movement within a view. | +| [FontSlant](Tizen.UI.FontSlant.md 'Tizen.UI.FontSlant') | Enumeration type for the font's slant. | +| [FontWeight](Tizen.UI.FontWeight.md 'Tizen.UI.FontWeight') | Enumeration type for the font's weight. | +| [FontWidth](Tizen.UI.FontWidth.md 'Tizen.UI.FontWidth') | Enumeration type for the font's width. | +| [GestureSource](Tizen.UI.GestureSource.md 'Tizen.UI.GestureSource') | Enumeration for gesture source. | +| [GestureSourceData](Tizen.UI.GestureSourceData.md 'Tizen.UI.GestureSourceData') | Enumeration for gesture source data. | +| [GestureState](Tizen.UI.GestureState.md 'Tizen.UI.GestureState') | The GestureState enum represents the possible states of a gesture. | +| [GradientVisualSpreadMethod](Tizen.UI.GradientVisualSpreadMethod.md 'Tizen.UI.GradientVisualSpreadMethod') | Specifies the method used to spread the gradient colors across the area being painted. | +| [HiddenInputMode](Tizen.UI.HiddenInputMode.md 'Tizen.UI.HiddenInputMode') | Enumeration for hidden input mode. | +| [ImageLoaderFittingMode](Tizen.UI.ImageLoaderFittingMode.md 'Tizen.UI.ImageLoaderFittingMode') | Enumeration for [ImageLoader](Tizen.UI.ImageLoader.md 'Tizen.UI.ImageLoader') fitting mode. | +| [ImageLoaderSamplingMode](Tizen.UI.ImageLoaderSamplingMode.md 'Tizen.UI.ImageLoaderSamplingMode') | Enumeration for [ImageLoader](Tizen.UI.ImageLoader.md 'Tizen.UI.ImageLoader') sampling mode. | +| [ImageLoadingStatus](Tizen.UI.ImageLoadingStatus.md 'Tizen.UI.ImageLoadingStatus') | Enumeration for the image loading status. | +| [ImageMaskingMode](Tizen.UI.ImageMaskingMode.md 'Tizen.UI.ImageMaskingMode') | | +| [ImageReleasePolicy](Tizen.UI.ImageReleasePolicy.md 'Tizen.UI.ImageReleasePolicy') | Enumeration for ImageReleasePolicy. | +| [ImageWrapMode](Tizen.UI.ImageWrapMode.md 'Tizen.UI.ImageWrapMode') | Enumeration for image wrap mode. | +| [InputPanelLanguage](Tizen.UI.InputPanelLanguage.md 'Tizen.UI.InputPanelLanguage') | Enumeration for the language mode of the input panel. | +| [InputPanelState](Tizen.UI.InputPanelState.md 'Tizen.UI.InputPanelState') | Enumeration for the states of the input panel. | +| [KeyDeviceClass](Tizen.UI.KeyDeviceClass.md 'Tizen.UI.KeyDeviceClass') | The KeyDeviceClass enum represents the class of a key device. | +| [KeyDeviceSubClass](Tizen.UI.KeyDeviceSubClass.md 'Tizen.UI.KeyDeviceSubClass') | The KeyDeviceSubClass enum represents the sub-class of a key device. | +| [KeyGrabMode](Tizen.UI.KeyGrabMode.md 'Tizen.UI.KeyGrabMode') | Enumeration for the key grab mode for platform-level APIs. | +| [KeyState](Tizen.UI.KeyState.md 'Tizen.UI.KeyState') | The KeyState enum represents the state of a key on the keyboard. | +| [LayoutDirection](Tizen.UI.LayoutDirection.md 'Tizen.UI.LayoutDirection') | The `LayoutDirection` enum is used to specify the direction of the UI elements. | +| [LineBreakMode](Tizen.UI.LineBreakMode.md 'Tizen.UI.LineBreakMode') | Enumeration for line break modes. | +| [MouseButton](Tizen.UI.MouseButton.md 'Tizen.UI.MouseButton') | The MouseButton enum represents the different mouse buttons that can be pressed. | +| [PanelLayout](Tizen.UI.PanelLayout.md 'Tizen.UI.PanelLayout') | Enumeration for input method panel layout types. | +| [PanGestureDirection](Tizen.UI.PanGestureDirection.md 'Tizen.UI.PanGestureDirection') | Enumeration for the direction of a pan gesture. | +| [PixelFormat](Tizen.UI.PixelFormat.md 'Tizen.UI.PixelFormat') | Enumeration for Pixel formats.

Pixel format, default color depth is RGBA 32 bit with alpha. | +| [RenderNotificationKey](Tizen.UI.RenderNotificationKey.md 'Tizen.UI.RenderNotificationKey') | The RenderNotificationKey enum defines the keys used for notifications related to rendering. | +| [ResizePolicy](Tizen.UI.ResizePolicy.md 'Tizen.UI.ResizePolicy') | The ResizePolicy enum represents the possible resize policies for a view. | +| [ReturnType](Tizen.UI.ReturnType.md 'Tizen.UI.ReturnType') | Enumeration for the return type of a function. | +| [ScrollBarVisibility](Tizen.UI.ScrollBarVisibility.md 'Tizen.UI.ScrollBarVisibility') | Enumerates conditions under which scroll bars will be visible. | +| [ScrollDirection](Tizen.UI.ScrollDirection.md 'Tizen.UI.ScrollDirection') | Enumeration for the direction of scrolling. | +| [ScrollToPosition](Tizen.UI.ScrollToPosition.md 'Tizen.UI.ScrollToPosition') | Enumeration for the position to scroll to. | +| [TextAlignment](Tizen.UI.TextAlignment.md 'Tizen.UI.TextAlignment') | Enumeration for text alignment options. | +| [TextOverflow](Tizen.UI.TextOverflow.md 'Tizen.UI.TextOverflow') | Enumeration for the text overflow behavior. | +| [TokenType](Tizen.UI.TokenType.md 'Tizen.UI.TokenType') | The type of token. | +| [TouchState](Tizen.UI.TouchState.md 'Tizen.UI.TouchState') | The TouchState enum represents the possible states of a touch event. | +| [UnderlineStyle](Tizen.UI.UnderlineStyle.md 'Tizen.UI.UnderlineStyle') | The UnderlineStyle enum defines the different styles of underline that can be applied to text. | +| [VisualCutoutPolicy](Tizen.UI.VisualCutoutPolicy.md 'Tizen.UI.VisualCutoutPolicy') | Specifies the visual cutout policy, defining how the visual's bounds are adjusted around cutouts | +| [WheelDirection](Tizen.UI.WheelDirection.md 'Tizen.UI.WheelDirection') | Enumeration for the direction of a wheel event. | +| [WheelType](Tizen.UI.WheelType.md 'Tizen.UI.WheelType') | Enumeration for wheel types. | +| [WindowBlurType](Tizen.UI.WindowBlurType.md 'Tizen.UI.WindowBlurType') | Enumeration of window blur type. | +| [WindowMode](Tizen.UI.WindowMode.md 'Tizen.UI.WindowMode') | The WindowMode enum represents the possible modes for a window. | +| [WindowOrientation](Tizen.UI.WindowOrientation.md 'Tizen.UI.WindowOrientation') | Enumeration for window orientation. | +| [WindowResizeDirection](Tizen.UI.WindowResizeDirection.md 'Tizen.UI.WindowResizeDirection') | Enumeration for the direction of resizing a window. | +| [WindowResizePolicy](Tizen.UI.WindowResizePolicy.md 'Tizen.UI.WindowResizePolicy') | Enumeration for the resize policy of a window. | +| [WindowType](Tizen.UI.WindowType.md 'Tizen.UI.WindowType') | An enum of window types. | + + + + + + + diff --git a/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.Log.md b/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.Log.md new file mode 100644 index 0000000000..4feaa89983 --- /dev/null +++ b/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.Log.md @@ -0,0 +1,749 @@ +### [TizenX.ZLog](TizenX.ZLog.md 'TizenX.ZLog') + +## Log Class + +```csharp +public static class Log +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 Log +### Methods + + + +## Log.Debug(string, string, string, string, int) Method + +Prints a regular log message with the DEBUG priority. + +```csharp +public static void Debug(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Debug(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the DEBUG priority. + +```csharp +public static void Debug(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Debug(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the DEBUG priority. + +```csharp +public static void Debug(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Error(string, string, string, string, int) Method + +Prints a regular log message with the ERROR priority. + +```csharp +public static void Error(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Error(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the ERROR priority. + +```csharp +public static void Error(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Error(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the ERROR priority. + +```csharp +public static void Error(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Fatal(string, string, string, string, int) Method + +Prints a regular log message with the FATAL priority. + +```csharp +public static void Fatal(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Fatal(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the FATAL priority. + +```csharp +public static void Fatal(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Fatal(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the FATAL priority. + +```csharp +public static void Fatal(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Info(string, string, string, string, int) Method + +Prints a regular log message with the INFO priority. + +```csharp +public static void Info(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Info(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the INFO priority. + +```csharp +public static void Info(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Info(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the INFO priority. + +```csharp +public static void Info(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Verbose(string, string, string, string, int) Method + +Prints a regular log message with the VERBOSE priority. + +```csharp +public static void Verbose(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Verbose(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the VERBOSE priority. + +```csharp +public static void Verbose(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Verbose(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the VERBOSE priority. + +```csharp +public static void Verbose(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Warn(string, string, string, string, int) Method + +Prints a regular log message with the WARNING priority. + +```csharp +public static void Warn(string tag, string message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Warn(string, ReadOnlySpan<char>, string, string, int) Method + +Prints a regular log message with the WARNING priority. + +```csharp +public static void Warn(string tag, System.ReadOnlySpan<char> message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` [System.ReadOnlySpan<](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1')[System.Char](https://docs.microsoft.com/en-us/dotnet/api/System.Char 'System.Char')[>](https://docs.microsoft.com/en-us/dotnet/api/System.ReadOnlySpan-1 'System.ReadOnlySpan`1') + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + + + +## Log.Warn(string, LogInterpolatedStringHandler, string, string, int) Method + +Prints a regular log message with the WARNING priority. + +```csharp +public static void Warn(string tag, TizenX.ZLog.LogInterpolatedStringHandler message, string file="", string func="", int line=0); +``` +#### Parameters + + + +`tag` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The tag name of the log message. + + + +`message` TizenX.ZLog.LogInterpolatedStringHandler + +The log message to print. + + + +`file` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The source file path of the caller function. This argument will be set automatically by the compiler. + + + +`func` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The function name of the caller function. This argument will be set automatically by the compiler. + + + +`line` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The line number of the calling position. This argument will be set automatically by the compiler. + diff --git a/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.md b/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.md new file mode 100644 index 0000000000..2754e082a4 --- /dev/null +++ b/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.md @@ -0,0 +1,6 @@ +## TizenX.ZLog Namespace + +| Classes | | +| :--- | :--- | +| [Log](TizenX.ZLog.Log.md 'TizenX.ZLog.Log') | Provides high-performance logging designed specifically for the Tizen platform. | + diff --git a/docs/extensions/tizenx/api/toc.md b/docs/extensions/tizenx/api/toc.md new file mode 100644 index 0000000000..ea7ba881c7 --- /dev/null +++ b/docs/extensions/tizenx/api/toc.md @@ -0,0 +1,746 @@ +# [Tizen.UI]() +## [AccessibilityAction](Tizen.UI/Tizen.UI.AccessibilityAction.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityAction.md tags:['AccessibilityAction'], author:['jh5.cho@samsung.com']" +## [AccessibilityActionReceivedEventArgs](Tizen.UI/Tizen.UI.AccessibilityActionReceivedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityActionReceivedEventArgs.md tags:['AccessibilityActionReceivedEventArgs'], author:['jh5.cho@samsung.com']" +## [AccessibilityDescriptionRequestedEventArgs](Tizen.UI/Tizen.UI.AccessibilityDescriptionRequestedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityDescriptionRequestedEventArgs.md tags:['AccessibilityDescriptionRequestedEventArgs'], author:['jh5.cho@samsung.com']" +## [AccessibilityExtensions](Tizen.UI/Tizen.UI.AccessibilityExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityExtensions.md tags:['AccessibilityExtensions'], author:['jh5.cho@samsung.com']" +## [AccessibilityHighlightChangedEventArgs](Tizen.UI/Tizen.UI.AccessibilityHighlightChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityHighlightChangedEventArgs.md tags:['AccessibilityHighlightChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [AccessibilityManager](Tizen.UI/Tizen.UI.AccessibilityManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityManager.md tags:['AccessibilityManager'], author:['jh5.cho@samsung.com']" +## [AccessibilityNameRequestedEventArgs](Tizen.UI/Tizen.UI.AccessibilityNameRequestedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityNameRequestedEventArgs.md tags:['AccessibilityNameRequestedEventArgs'], author:['jh5.cho@samsung.com']" +## [AccessibilityReadingInfo](Tizen.UI/Tizen.UI.AccessibilityReadingInfo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityReadingInfo.md tags:['AccessibilityReadingInfo'], author:['jh5.cho@samsung.com']" +## [AccessibilityRelation](Tizen.UI/Tizen.UI.AccessibilityRelation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRelation.md tags:['AccessibilityRelation'], author:['jh5.cho@samsung.com']" +## [AccessibilityRole](Tizen.UI/Tizen.UI.AccessibilityRole.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityRole.md tags:['AccessibilityRole'], author:['jh5.cho@samsung.com']" +## [AccessibilityState](Tizen.UI/Tizen.UI.AccessibilityState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityState.md tags:['AccessibilityState'], author:['jh5.cho@samsung.com']" +## [AccessibilityStates](Tizen.UI/Tizen.UI.AccessibilityStates.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AccessibilityStates.md tags:['AccessibilityStates'], author:['jh5.cho@samsung.com']" +## [ActionButtonTitle](Tizen.UI/Tizen.UI.ActionButtonTitle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ActionButtonTitle.md tags:['ActionButtonTitle'], author:['jh5.cho@samsung.com']" +## [AlphaFunction](Tizen.UI/Tizen.UI.AlphaFunction.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AlphaFunction.md tags:['AlphaFunction'], author:['jh5.cho@samsung.com']" +## [AnchorClickedEventArgs](Tizen.UI/Tizen.UI.AnchorClickedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnchorClickedEventArgs.md tags:['AnchorClickedEventArgs'], author:['jh5.cho@samsung.com']" +## [AnimatablePropertyValue](Tizen.UI/Tizen.UI.AnimatablePropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimatablePropertyValue.md tags:['AnimatablePropertyValue'], author:['jh5.cho@samsung.com']" +## [Animation](Tizen.UI/Tizen.UI.Animation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Animation.md tags:['Animation'], author:['jh5.cho@samsung.com']" +## [AnimationEndAction](Tizen.UI/Tizen.UI.AnimationEndAction.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationEndAction.md tags:['AnimationEndAction'], author:['jh5.cho@samsung.com']" +## [AnimationExtensions](Tizen.UI/Tizen.UI.AnimationExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationExtensions.md tags:['AnimationExtensions'], author:['jh5.cho@samsung.com']" +## [AnimationState](Tizen.UI/Tizen.UI.AnimationState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnimationState.md tags:['AnimationState'], author:['jh5.cho@samsung.com']" +## [AnnouncementState](Tizen.UI/Tizen.UI.AnnouncementState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AnnouncementState.md tags:['AnnouncementState'], author:['jh5.cho@samsung.com']" +## [AutoCapital](Tizen.UI/Tizen.UI.AutoCapital.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoCapital.md tags:['AutoCapital'], author:['jh5.cho@samsung.com']" +## [AutoFontSize](Tizen.UI/Tizen.UI.AutoFontSize.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.AutoFontSize.md tags:['AutoFontSize'], author:['jh5.cho@samsung.com']" +## [Background](Tizen.UI/Tizen.UI.Background.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Background.md tags:['Background'], author:['jh5.cho@samsung.com']" +## [BackgroundPropertyValue](Tizen.UI/Tizen.UI.BackgroundPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundPropertyValue.md tags:['BackgroundPropertyValue'], author:['jh5.cho@samsung.com']" +## [BackgroundTokenPropertyChangedEventArgs](Tizen.UI/Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BackgroundTokenPropertyChangedEventArgs.md tags:['BackgroundTokenPropertyChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [BindingExtensions](Tizen.UI/Tizen.UI.BindingExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingExtensions.md tags:['BindingExtensions'], author:['jh5.cho@samsung.com']" +## [BindingProperty_TView,TValue_](Tizen.UI/Tizen.UI.BindingProperty_TView,TValue_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingProperty_TView,TValue_.md tags:['BindingProperty_TView,TValue_'], author:['jh5.cho@samsung.com']" +## [BindingSession_TViewModel_](Tizen.UI/Tizen.UI.BindingSession_TViewModel_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BindingSession_TViewModel_.md tags:['BindingSession_TViewModel_'], author:['jh5.cho@samsung.com']" +## [BrokenImageType](Tizen.UI/Tizen.UI.BrokenImageType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BrokenImageType.md tags:['BrokenImageType'], author:['jh5.cho@samsung.com']" +## [BuiltinAlphaFunctions](Tizen.UI/Tizen.UI.BuiltinAlphaFunctions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.BuiltinAlphaFunctions.md tags:['BuiltinAlphaFunctions'], author:['jh5.cho@samsung.com']" +## [ClippingMode](Tizen.UI/Tizen.UI.ClippingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ClippingMode.md tags:['ClippingMode'], author:['jh5.cho@samsung.com']" +## [Color](Tizen.UI/Tizen.UI.Color.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Color.md tags:['Color'], author:['jh5.cho@samsung.com']" +## [ColorBackground](Tizen.UI/Tizen.UI.ColorBackground.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorBackground.md tags:['ColorBackground'], author:['jh5.cho@samsung.com']" +## [ColorTokenPropertyChangedEventArgs](Tizen.UI/Tizen.UI.ColorTokenPropertyChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ColorTokenPropertyChangedEventArgs.md tags:['ColorTokenPropertyChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [ContentView](Tizen.UI/Tizen.UI.ContentView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ContentView.md tags:['ContentView'], author:['jh5.cho@samsung.com']" +## [CornerRadius](Tizen.UI/Tizen.UI.CornerRadius.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadius.md tags:['CornerRadius'], author:['jh5.cho@samsung.com']" +## [CornerRadiusPropertyValue](Tizen.UI/Tizen.UI.CornerRadiusPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CornerRadiusPropertyValue.md tags:['CornerRadiusPropertyValue'], author:['jh5.cho@samsung.com']" +## [CustomPropertyValue](Tizen.UI/Tizen.UI.CustomPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.CustomPropertyValue.md tags:['CustomPropertyValue'], author:['jh5.cho@samsung.com']" +## [DisplayMetrics](Tizen.UI/Tizen.UI.DisplayMetrics.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DisplayMetrics.md tags:['DisplayMetrics'], author:['jh5.cho@samsung.com']" +## [DpExtensions](Tizen.UI/Tizen.UI.DpExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DpExtensions.md tags:['DpExtensions'], author:['jh5.cho@samsung.com']" +## [DragEventArgs](Tizen.UI/Tizen.UI.DragEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.DragEventArgs.md tags:['DragEventArgs'], author:['jh5.cho@samsung.com']" +## [EditableTextBindings_T_](Tizen.UI/Tizen.UI.EditableTextBindings_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EditableTextBindings_T_.md tags:['EditableTextBindings_T_'], author:['jh5.cho@samsung.com']" +## [EventHandlerHelper](Tizen.UI/Tizen.UI.EventHandlerHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.EventHandlerHelper.md tags:['EventHandlerHelper'], author:['jh5.cho@samsung.com']" +## [ExceptionHelper](Tizen.UI/Tizen.UI.ExceptionHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ExceptionHelper.md tags:['ExceptionHelper'], author:['jh5.cho@samsung.com']" +## [FittingMode](Tizen.UI/Tizen.UI.FittingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FittingMode.md tags:['FittingMode'], author:['jh5.cho@samsung.com']" +## [FocusChangedEventArgs](Tizen.UI/Tizen.UI.FocusChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusChangedEventArgs.md tags:['FocusChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [FocusDirection](Tizen.UI/Tizen.UI.FocusDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusDirection.md tags:['FocusDirection'], author:['jh5.cho@samsung.com']" +## [FocusManager](Tizen.UI/Tizen.UI.FocusManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FocusManager.md tags:['FocusManager'], author:['jh5.cho@samsung.com']" +## [FontClient](Tizen.UI/Tizen.UI.FontClient.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontClient.md tags:['FontClient'], author:['jh5.cho@samsung.com']" +## [FontInfo](Tizen.UI/Tizen.UI.FontInfo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontInfo.md tags:['FontInfo'], author:['jh5.cho@samsung.com']" +## [FontSlant](Tizen.UI/Tizen.UI.FontSlant.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontSlant.md tags:['FontSlant'], author:['jh5.cho@samsung.com']" +## [FontStyle](Tizen.UI/Tizen.UI.FontStyle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontStyle.md tags:['FontStyle'], author:['jh5.cho@samsung.com']" +## [FontWeight](Tizen.UI/Tizen.UI.FontWeight.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWeight.md tags:['FontWeight'], author:['jh5.cho@samsung.com']" +## [FontWidth](Tizen.UI/Tizen.UI.FontWidth.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FontWidth.md tags:['FontWidth'], author:['jh5.cho@samsung.com']" +## [FrameUpdateCallback](Tizen.UI/Tizen.UI.FrameUpdateCallback.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.FrameUpdateCallback.md tags:['FrameUpdateCallback'], author:['jh5.cho@samsung.com']" +## [Gesture](Tizen.UI/Tizen.UI.Gesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Gesture.md tags:['Gesture'], author:['jh5.cho@samsung.com']" +## [GestureDetectedEventArgs](Tizen.UI/Tizen.UI.GestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetectedEventArgs.md tags:['GestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [GestureDetector](Tizen.UI/Tizen.UI.GestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureDetector.md tags:['GestureDetector'], author:['jh5.cho@samsung.com']" +## [GestureSource](Tizen.UI/Tizen.UI.GestureSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSource.md tags:['GestureSource'], author:['jh5.cho@samsung.com']" +## [GestureSourceData](Tizen.UI/Tizen.UI.GestureSourceData.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureSourceData.md tags:['GestureSourceData'], author:['jh5.cho@samsung.com']" +## [GestureState](Tizen.UI/Tizen.UI.GestureState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GestureState.md tags:['GestureState'], author:['jh5.cho@samsung.com']" +## [GradientBackground](Tizen.UI/Tizen.UI.GradientBackground.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientBackground.md tags:['GradientBackground'], author:['jh5.cho@samsung.com']" +## [GradientStop](Tizen.UI/Tizen.UI.GradientStop.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientStop.md tags:['GradientStop'], author:['jh5.cho@samsung.com']" +## [GradientVisualSpreadMethod](Tizen.UI/Tizen.UI.GradientVisualSpreadMethod.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.GradientVisualSpreadMethod.md tags:['GradientVisualSpreadMethod'], author:['jh5.cho@samsung.com']" +## [HiddenInputMode](Tizen.UI/Tizen.UI.HiddenInputMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputMode.md tags:['HiddenInputMode'], author:['jh5.cho@samsung.com']" +## [HiddenInputSetting](Tizen.UI/Tizen.UI.HiddenInputSetting.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HiddenInputSetting.md tags:['HiddenInputSetting'], author:['jh5.cho@samsung.com']" +## [Hover](Tizen.UI/Tizen.UI.Hover.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Hover.md tags:['Hover'], author:['jh5.cho@samsung.com']" +## [HoverEvent](Tizen.UI/Tizen.UI.HoverEvent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEvent.md tags:['HoverEvent'], author:['jh5.cho@samsung.com']" +## [HoverEventArgs](Tizen.UI/Tizen.UI.HoverEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HoverEventArgs.md tags:['HoverEventArgs'], author:['jh5.cho@samsung.com']" +## [HtmlWebViewSource](Tizen.UI/Tizen.UI.HtmlWebViewSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.HtmlWebViewSource.md tags:['HtmlWebViewSource'], author:['jh5.cho@samsung.com']" +## [IBindableView](Tizen.UI/Tizen.UI.IBindableView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IBindableView.md tags:['IBindableView'], author:['jh5.cho@samsung.com']" +## [IDescendantFocusObserver](Tizen.UI/Tizen.UI.IDescendantFocusObserver.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantFocusObserver.md tags:['IDescendantFocusObserver'], author:['jh5.cho@samsung.com']" +## [IDescendantUnfocusObserver](Tizen.UI/Tizen.UI.IDescendantUnfocusObserver.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IDescendantUnfocusObserver.md tags:['IDescendantUnfocusObserver'], author:['jh5.cho@samsung.com']" +## [IFocusAlgorithm](Tizen.UI/Tizen.UI.IFocusAlgorithm.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IFocusAlgorithm.md tags:['IFocusAlgorithm'], author:['jh5.cho@samsung.com']" +## [IImage](Tizen.UI/Tizen.UI.IImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IImage.md tags:['IImage'], author:['jh5.cho@samsung.com']" +## [ImageBackground](Tizen.UI/Tizen.UI.ImageBackground.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackground.md tags:['ImageBackground'], author:['jh5.cho@samsung.com']" +## [ImageBackgroundExtensions](Tizen.UI/Tizen.UI.ImageBackgroundExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageBackgroundExtensions.md tags:['ImageBackgroundExtensions'], author:['jh5.cho@samsung.com']" +## [ImageExtensions](Tizen.UI/Tizen.UI.ImageExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageExtensions.md tags:['ImageExtensions'], author:['jh5.cho@samsung.com']" +## [ImageLoader](Tizen.UI/Tizen.UI.ImageLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoader.md tags:['ImageLoader'], author:['jh5.cho@samsung.com']" +## [ImageLoaderFittingMode](Tizen.UI/Tizen.UI.ImageLoaderFittingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderFittingMode.md tags:['ImageLoaderFittingMode'], author:['jh5.cho@samsung.com']" +## [ImageLoaderSamplingMode](Tizen.UI/Tizen.UI.ImageLoaderSamplingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoaderSamplingMode.md tags:['ImageLoaderSamplingMode'], author:['jh5.cho@samsung.com']" +## [ImageLoadingStatus](Tizen.UI/Tizen.UI.ImageLoadingStatus.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageLoadingStatus.md tags:['ImageLoadingStatus'], author:['jh5.cho@samsung.com']" +## [ImageMaskingMode](Tizen.UI/Tizen.UI.ImageMaskingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageMaskingMode.md tags:['ImageMaskingMode'], author:['jh5.cho@samsung.com']" +## [ImageReleasePolicy](Tizen.UI/Tizen.UI.ImageReleasePolicy.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageReleasePolicy.md tags:['ImageReleasePolicy'], author:['jh5.cho@samsung.com']" +## [ImageUrl](Tizen.UI/Tizen.UI.ImageUrl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageUrl.md tags:['ImageUrl'], author:['jh5.cho@samsung.com']" +## [ImageView](Tizen.UI/Tizen.UI.ImageView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageView.md tags:['ImageView'], author:['jh5.cho@samsung.com']" +## [ImageViewBindings](Tizen.UI/Tizen.UI.ImageViewBindings.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageViewBindings.md tags:['ImageViewBindings'], author:['jh5.cho@samsung.com']" +## [ImageWrapMode](Tizen.UI/Tizen.UI.ImageWrapMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ImageWrapMode.md tags:['ImageWrapMode'], author:['jh5.cho@samsung.com']" +## [InnerShadow](Tizen.UI/Tizen.UI.InnerShadow.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadow.md tags:['InnerShadow'], author:['jh5.cho@samsung.com']" +## [InnerShadowTokenPropertyChangedEventArgs](Tizen.UI/Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InnerShadowTokenPropertyChangedEventArgs.md tags:['InnerShadowTokenPropertyChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [InputMethodContext](Tizen.UI/Tizen.UI.InputMethodContext.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodContext.md tags:['InputMethodContext'], author:['jh5.cho@samsung.com']" +## [InputMethodSetting](Tizen.UI/Tizen.UI.InputMethodSetting.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputMethodSetting.md tags:['InputMethodSetting'], author:['jh5.cho@samsung.com']" +## [InputPanelLanguage](Tizen.UI/Tizen.UI.InputPanelLanguage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelLanguage.md tags:['InputPanelLanguage'], author:['jh5.cho@samsung.com']" +## [InputPanelState](Tizen.UI/Tizen.UI.InputPanelState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputPanelState.md tags:['InputPanelState'], author:['jh5.cho@samsung.com']" +## [InputView](Tizen.UI/Tizen.UI.InputView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputView.md tags:['InputView'], author:['jh5.cho@samsung.com']" +## [InputViewExtensions](Tizen.UI/Tizen.UI.InputViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.InputViewExtensions.md tags:['InputViewExtensions'], author:['jh5.cho@samsung.com']" +## [Internal.BlendEquationType](Tizen.UI/Tizen.UI.Internal.BlendEquationType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendEquationType.md tags:['Internal.BlendEquationType'], author:['jh5.cho@samsung.com']" +## [Internal.BlendFactorType](Tizen.UI/Tizen.UI.Internal.BlendFactorType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendFactorType.md tags:['Internal.BlendFactorType'], author:['jh5.cho@samsung.com']" +## [Internal.BlendModeType](Tizen.UI/Tizen.UI.Internal.BlendModeType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.BlendModeType.md tags:['Internal.BlendModeType'], author:['jh5.cho@samsung.com']" +## [Internal.DaliProperty](Tizen.UI/Tizen.UI.Internal.DaliProperty.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliProperty.md tags:['Internal.DaliProperty'], author:['jh5.cho@samsung.com']" +## [Internal.DaliPropertyType](Tizen.UI/Tizen.UI.Internal.DaliPropertyType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DaliPropertyType.md tags:['Internal.DaliPropertyType'], author:['jh5.cho@samsung.com']" +## [Internal.DepthFunctionType](Tizen.UI/Tizen.UI.Internal.DepthFunctionType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthFunctionType.md tags:['Internal.DepthFunctionType'], author:['jh5.cho@samsung.com']" +## [Internal.DepthTestModeType](Tizen.UI/Tizen.UI.Internal.DepthTestModeType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthTestModeType.md tags:['Internal.DepthTestModeType'], author:['jh5.cho@samsung.com']" +## [Internal.DepthWriteModeType](Tizen.UI/Tizen.UI.Internal.DepthWriteModeType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.DepthWriteModeType.md tags:['Internal.DepthWriteModeType'], author:['jh5.cho@samsung.com']" +## [Internal.FaceCullingModeType](Tizen.UI/Tizen.UI.Internal.FaceCullingModeType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FaceCullingModeType.md tags:['Internal.FaceCullingModeType'], author:['jh5.cho@samsung.com']" +## [Internal.FilterMode](Tizen.UI/Tizen.UI.Internal.FilterMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.FilterMode.md tags:['Internal.FilterMode'], author:['jh5.cho@samsung.com']" +## [Internal.GeometryType](Tizen.UI/Tizen.UI.Internal.GeometryType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.GeometryType.md tags:['Internal.GeometryType'], author:['jh5.cho@samsung.com']" +## [Internal.ImageVisualMap](Tizen.UI/Tizen.UI.Internal.ImageVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ImageVisualMap.md tags:['Internal.ImageVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal.LottieVisualMap](Tizen.UI/Tizen.UI.Internal.LottieVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.LottieVisualMap.md tags:['Internal.LottieVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal](Tizen.UI/Tizen.UI.Internal.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.md tags:['Internal'], author:['jh5.cho@samsung.com']" +## [Internal.NativeImageSource](Tizen.UI/Tizen.UI.Internal.NativeImageSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.NativeImageSource.md tags:['Internal.NativeImageSource'], author:['jh5.cho@samsung.com']" +## [Internal.ObjectPool](Tizen.UI/Tizen.UI.Internal.ObjectPool.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool.md tags:['Internal.ObjectPool'], author:['jh5.cho@samsung.com']" +## [Internal.ObjectPool_T_](Tizen.UI/Tizen.UI.Internal.ObjectPool_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ObjectPool_T_.md tags:['Internal.ObjectPool_T_'], author:['jh5.cho@samsung.com']" +## [Internal.RenderingBehavior](Tizen.UI/Tizen.UI.Internal.RenderingBehavior.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderingBehavior.md tags:['Internal.RenderingBehavior'], author:['jh5.cho@samsung.com']" +## [Internal.RenderModeType](Tizen.UI/Tizen.UI.Internal.RenderModeType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.RenderModeType.md tags:['Internal.RenderModeType'], author:['jh5.cho@samsung.com']" +## [Internal.ResourceManager](Tizen.UI/Tizen.UI.Internal.ResourceManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ResourceManager.md tags:['Internal.ResourceManager'], author:['jh5.cho@samsung.com']" +## [Internal.ShaderHint](Tizen.UI/Tizen.UI.Internal.ShaderHint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.ShaderHint.md tags:['Internal.ShaderHint'], author:['jh5.cho@samsung.com']" +## [Internal.StencilFunctionType](Tizen.UI/Tizen.UI.Internal.StencilFunctionType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilFunctionType.md tags:['Internal.StencilFunctionType'], author:['jh5.cho@samsung.com']" +## [Internal.StencilOperationType](Tizen.UI/Tizen.UI.Internal.StencilOperationType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.StencilOperationType.md tags:['Internal.StencilOperationType'], author:['jh5.cho@samsung.com']" +## [Internal.TextureType](Tizen.UI/Tizen.UI.Internal.TextureType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.TextureType.md tags:['Internal.TextureType'], author:['jh5.cho@samsung.com']" +## [Internal.WindowExtensions](Tizen.UI/Tizen.UI.Internal.WindowExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Internal.WindowExtensions.md tags:['Internal.WindowExtensions'], author:['jh5.cho@samsung.com']" +## [IParentObject](Tizen.UI/Tizen.UI.IParentObject.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IParentObject.md tags:['IParentObject'], author:['jh5.cho@samsung.com']" +## [IScrollable](Tizen.UI/Tizen.UI.IScrollable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollable.md tags:['IScrollable'], author:['jh5.cho@samsung.com']" +## [IScrollBar](Tizen.UI/Tizen.UI.IScrollBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IScrollBar.md tags:['IScrollBar'], author:['jh5.cho@samsung.com']" +## [IText](Tizen.UI/Tizen.UI.IText.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IText.md tags:['IText'], author:['jh5.cho@samsung.com']" +## [ITextAlignment](Tizen.UI/Tizen.UI.ITextAlignment.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextAlignment.md tags:['ITextAlignment'], author:['jh5.cho@samsung.com']" +## [ITextEditable](Tizen.UI/Tizen.UI.ITextEditable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextEditable.md tags:['ITextEditable'], author:['jh5.cho@samsung.com']" +## [ITextFormatting](Tizen.UI/Tizen.UI.ITextFormatting.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextFormatting.md tags:['ITextFormatting'], author:['jh5.cho@samsung.com']" +## [ITextPadding](Tizen.UI/Tizen.UI.ITextPadding.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITextPadding.md tags:['ITextPadding'], author:['jh5.cho@samsung.com']" +## [IToken](Tizen.UI/Tizen.UI.IToken.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.IToken.md tags:['IToken'], author:['jh5.cho@samsung.com']" +## [ITokenTable_T_](Tizen.UI/Tizen.UI.ITokenTable_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ITokenTable_T_.md tags:['ITokenTable_T_'], author:['jh5.cho@samsung.com']" +## [KeyDeviceClass](Tizen.UI/Tizen.UI.KeyDeviceClass.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceClass.md tags:['KeyDeviceClass'], author:['jh5.cho@samsung.com']" +## [KeyDeviceSubClass](Tizen.UI/Tizen.UI.KeyDeviceSubClass.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyDeviceSubClass.md tags:['KeyDeviceSubClass'], author:['jh5.cho@samsung.com']" +## [KeyEvent](Tizen.UI/Tizen.UI.KeyEvent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEvent.md tags:['KeyEvent'], author:['jh5.cho@samsung.com']" +## [KeyEventArgs](Tizen.UI/Tizen.UI.KeyEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyEventArgs.md tags:['KeyEventArgs'], author:['jh5.cho@samsung.com']" +## [KeyGrabMode](Tizen.UI/Tizen.UI.KeyGrabMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyGrabMode.md tags:['KeyGrabMode'], author:['jh5.cho@samsung.com']" +## [KeyState](Tizen.UI/Tizen.UI.KeyState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.KeyState.md tags:['KeyState'], author:['jh5.cho@samsung.com']" +## [Layer](Tizen.UI/Tizen.UI.Layer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Layer.md tags:['Layer'], author:['jh5.cho@samsung.com']" +## [LayoutDirection](Tizen.UI/Tizen.UI.LayoutDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LayoutDirection.md tags:['LayoutDirection'], author:['jh5.cho@samsung.com']" +## [LinearGradientBackground](Tizen.UI/Tizen.UI.LinearGradientBackground.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LinearGradientBackground.md tags:['LinearGradientBackground'], author:['jh5.cho@samsung.com']" +## [LineBreakMode](Tizen.UI/Tizen.UI.LineBreakMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LineBreakMode.md tags:['LineBreakMode'], author:['jh5.cho@samsung.com']" +## [Log](Tizen.UI/Tizen.UI.Log.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Log.md tags:['Log'], author:['jh5.cho@samsung.com']" +## [LongPressGesture](Tizen.UI/Tizen.UI.LongPressGesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGesture.md tags:['LongPressGesture'], author:['jh5.cho@samsung.com']" +## [LongPressGestureDetectedEventArgs](Tizen.UI/Tizen.UI.LongPressGestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetectedEventArgs.md tags:['LongPressGestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [LongPressGestureDetector](Tizen.UI/Tizen.UI.LongPressGestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LongPressGestureDetector.md tags:['LongPressGestureDetector'], author:['jh5.cho@samsung.com']" +## [LottieAnimationView](Tizen.UI/Tizen.UI.LottieAnimationView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.LottieAnimationView.md tags:['LottieAnimationView'], author:['jh5.cho@samsung.com']" +## [Tizen.UI](Tizen.UI/Tizen.UI.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.md tags:['Tizen.UI'], author:['jh5.cho@samsung.com']" +## [MouseButton](Tizen.UI/Tizen.UI.MouseButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.MouseButton.md tags:['MouseButton'], author:['jh5.cho@samsung.com']" +## [NativeHandle.ActorHandle](Tizen.UI/Tizen.UI.NativeHandle.ActorHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ActorHandle.md tags:['NativeHandle.ActorHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.AnimatablePropertyHandle](Tizen.UI/Tizen.UI.NativeHandle.AnimatablePropertyHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.AnimatablePropertyHandle.md tags:['NativeHandle.AnimatablePropertyHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.ByteVectorHandle](Tizen.UI/Tizen.UI.NativeHandle.ByteVectorHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ByteVectorHandle.md tags:['NativeHandle.ByteVectorHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.DegreeHandle](Tizen.UI/Tizen.UI.NativeHandle.DegreeHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.DegreeHandle.md tags:['NativeHandle.DegreeHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.ExtentsHandle](Tizen.UI/Tizen.UI.NativeHandle.ExtentsHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.ExtentsHandle.md tags:['NativeHandle.ExtentsHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.GeometryHandle](Tizen.UI/Tizen.UI.NativeHandle.GeometryHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.GeometryHandle.md tags:['NativeHandle.GeometryHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.KeyFramesHandle](Tizen.UI/Tizen.UI.NativeHandle.KeyFramesHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.KeyFramesHandle.md tags:['NativeHandle.KeyFramesHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle](Tizen.UI/Tizen.UI.NativeHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.md tags:['NativeHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.NativeBaseHandle](Tizen.UI/Tizen.UI.NativeHandle.NativeBaseHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeBaseHandle.md tags:['NativeHandle.NativeBaseHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.NativeHandleExtensions](Tizen.UI/Tizen.UI.NativeHandle.NativeHandleExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeHandleExtensions.md tags:['NativeHandle.NativeHandleExtensions'], author:['jh5.cho@samsung.com']" +## [NativeHandle.NativeImageSourceWrapperHandle](Tizen.UI/Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.NativeImageSourceWrapperHandle.md tags:['NativeHandle.NativeImageSourceWrapperHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyArrayExtensions](Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayExtensions.md tags:['NativeHandle.PropertyArrayExtensions'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyArrayHandle](Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyArrayHandle.md tags:['NativeHandle.PropertyArrayHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyKeyHandle](Tizen.UI/Tizen.UI.NativeHandle.PropertyKeyHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyKeyHandle.md tags:['NativeHandle.PropertyKeyHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyMapHandle](Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandle.md tags:['NativeHandle.PropertyMapHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyMapHandleExtensions](Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyMapHandleExtensions.md tags:['NativeHandle.PropertyMapHandleExtensions'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyValueHandle](Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandle.md tags:['NativeHandle.PropertyValueHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyValueHandleExtensions](Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.PropertyValueHandleExtensions.md tags:['NativeHandle.PropertyValueHandleExtensions'], author:['jh5.cho@samsung.com']" +## [NativeHandle.RadianHandle](Tizen.UI/Tizen.UI.NativeHandle.RadianHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RadianHandle.md tags:['NativeHandle.RadianHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.RectangleHandle](Tizen.UI/Tizen.UI.NativeHandle.RectangleHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RectangleHandle.md tags:['NativeHandle.RectangleHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.RendererHandle](Tizen.UI/Tizen.UI.NativeHandle.RendererHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RendererHandle.md tags:['NativeHandle.RendererHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.RotationHandle](Tizen.UI/Tizen.UI.NativeHandle.RotationHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.RotationHandle.md tags:['NativeHandle.RotationHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.StyleManagerHandle](Tizen.UI/Tizen.UI.NativeHandle.StyleManagerHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.StyleManagerHandle.md tags:['NativeHandle.StyleManagerHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.TimePeriodHandle](Tizen.UI/Tizen.UI.NativeHandle.TimePeriodHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.TimePeriodHandle.md tags:['NativeHandle.TimePeriodHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.Vector2Handle](Tizen.UI/Tizen.UI.NativeHandle.Vector2Handle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector2Handle.md tags:['NativeHandle.Vector2Handle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.Vector3Handle](Tizen.UI/Tizen.UI.NativeHandle.Vector3Handle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector3Handle.md tags:['NativeHandle.Vector3Handle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.Vector4Handle](Tizen.UI/Tizen.UI.NativeHandle.Vector4Handle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.Vector4Handle.md tags:['NativeHandle.Vector4Handle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.WindowBlurHandle](Tizen.UI/Tizen.UI.NativeHandle.WindowBlurHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NativeHandle.WindowBlurHandle.md tags:['NativeHandle.WindowBlurHandle'], author:['jh5.cho@samsung.com']" +## [NObject](Tizen.UI/Tizen.UI.NObject.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.NObject.md tags:['NObject'], author:['jh5.cho@samsung.com']" +## [OpacityPropertyValue](Tizen.UI/Tizen.UI.OpacityPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OpacityPropertyValue.md tags:['OpacityPropertyValue'], author:['jh5.cho@samsung.com']" +## [OriginPoint](Tizen.UI/Tizen.UI.OriginPoint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.OriginPoint.md tags:['OriginPoint'], author:['jh5.cho@samsung.com']" +## [Outline](Tizen.UI/Tizen.UI.Outline.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Outline.md tags:['Outline'], author:['jh5.cho@samsung.com']" +## [PanelLayout](Tizen.UI/Tizen.UI.PanelLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanelLayout.md tags:['PanelLayout'], author:['jh5.cho@samsung.com']" +## [PanGesture](Tizen.UI/Tizen.UI.PanGesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGesture.md tags:['PanGesture'], author:['jh5.cho@samsung.com']" +## [PanGestureDetectedEventArgs](Tizen.UI/Tizen.UI.PanGestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetectedEventArgs.md tags:['PanGestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [PanGestureDetector](Tizen.UI/Tizen.UI.PanGestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDetector.md tags:['PanGestureDetector'], author:['jh5.cho@samsung.com']" +## [PanGestureDirection](Tizen.UI/Tizen.UI.PanGestureDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PanGestureDirection.md tags:['PanGestureDirection'], author:['jh5.cho@samsung.com']" +## [PinchGesture](Tizen.UI/Tizen.UI.PinchGesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGesture.md tags:['PinchGesture'], author:['jh5.cho@samsung.com']" +## [PinchGestureDetectedEventArgs](Tizen.UI/Tizen.UI.PinchGestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetectedEventArgs.md tags:['PinchGestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [PinchGestureDetector](Tizen.UI/Tizen.UI.PinchGestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PinchGestureDetector.md tags:['PinchGestureDetector'], author:['jh5.cho@samsung.com']" +## [PixelBuffer](Tizen.UI/Tizen.UI.PixelBuffer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelBuffer.md tags:['PixelBuffer'], author:['jh5.cho@samsung.com']" +## [PixelData](Tizen.UI/Tizen.UI.PixelData.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelData.md tags:['PixelData'], author:['jh5.cho@samsung.com']" +## [PixelFormat](Tizen.UI/Tizen.UI.PixelFormat.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PixelFormat.md tags:['PixelFormat'], author:['jh5.cho@samsung.com']" +## [Point](Tizen.UI/Tizen.UI.Point.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Point.md tags:['Point'], author:['jh5.cho@samsung.com']" +## [PositionPropertyValue](Tizen.UI/Tizen.UI.PositionPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.PositionPropertyValue.md tags:['PositionPropertyValue'], author:['jh5.cho@samsung.com']" +## [RadialGradientBackground](Tizen.UI/Tizen.UI.RadialGradientBackground.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RadialGradientBackground.md tags:['RadialGradientBackground'], author:['jh5.cho@samsung.com']" +## [Rect](Tizen.UI/Tizen.UI.Rect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Rect.md tags:['Rect'], author:['jh5.cho@samsung.com']" +## [RenderNotificationKey](Tizen.UI/Tizen.UI.RenderNotificationKey.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RenderNotificationKey.md tags:['RenderNotificationKey'], author:['jh5.cho@samsung.com']" +## [ResizePolicy](Tizen.UI/Tizen.UI.ResizePolicy.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResizePolicy.md tags:['ResizePolicy'], author:['jh5.cho@samsung.com']" +## [ResourceLocalizer](Tizen.UI/Tizen.UI.ResourceLocalizer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ResourceLocalizer.md tags:['ResourceLocalizer'], author:['jh5.cho@samsung.com']" +## [ReturnType](Tizen.UI/Tizen.UI.ReturnType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ReturnType.md tags:['ReturnType'], author:['jh5.cho@samsung.com']" +## [RotationGesture](Tizen.UI/Tizen.UI.RotationGesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGesture.md tags:['RotationGesture'], author:['jh5.cho@samsung.com']" +## [RotationGestureDetectedEventArgs](Tizen.UI/Tizen.UI.RotationGestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetectedEventArgs.md tags:['RotationGestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [RotationGestureDetector](Tizen.UI/Tizen.UI.RotationGestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationGestureDetector.md tags:['RotationGestureDetector'], author:['jh5.cho@samsung.com']" +## [RotationPropertyValue](Tizen.UI/Tizen.UI.RotationPropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.RotationPropertyValue.md tags:['RotationPropertyValue'], author:['jh5.cho@samsung.com']" +## [ScalePropertyValue](Tizen.UI/Tizen.UI.ScalePropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScalePropertyValue.md tags:['ScalePropertyValue'], author:['jh5.cho@samsung.com']" +## [ScopedResourceManager](Tizen.UI/Tizen.UI.ScopedResourceManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScopedResourceManager.md tags:['ScopedResourceManager'], author:['jh5.cho@samsung.com']" +## [ScrollBarVisibility](Tizen.UI/Tizen.UI.ScrollBarVisibility.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollBarVisibility.md tags:['ScrollBarVisibility'], author:['jh5.cho@samsung.com']" +## [ScrollDirection](Tizen.UI/Tizen.UI.ScrollDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollDirection.md tags:['ScrollDirection'], author:['jh5.cho@samsung.com']" +## [ScrollEventArgs](Tizen.UI/Tizen.UI.ScrollEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollEventArgs.md tags:['ScrollEventArgs'], author:['jh5.cho@samsung.com']" +## [ScrollToPosition](Tizen.UI/Tizen.UI.ScrollToPosition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ScrollToPosition.md tags:['ScrollToPosition'], author:['jh5.cho@samsung.com']" +## [Shadow](Tizen.UI/Tizen.UI.Shadow.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Shadow.md tags:['Shadow'], author:['jh5.cho@samsung.com']" +## [ShadowTokenPropertyChangedEventArgs](Tizen.UI/Tizen.UI.ShadowTokenPropertyChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ShadowTokenPropertyChangedEventArgs.md tags:['ShadowTokenPropertyChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [Size](Tizen.UI/Tizen.UI.Size.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Size.md tags:['Size'], author:['jh5.cho@samsung.com']" +## [SizePropertyValue](Tizen.UI/Tizen.UI.SizePropertyValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SizePropertyValue.md tags:['SizePropertyValue'], author:['jh5.cho@samsung.com']" +## [Strikethrough](Tizen.UI/Tizen.UI.Strikethrough.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Strikethrough.md tags:['Strikethrough'], author:['jh5.cho@samsung.com']" +## [SystemFontSizeManager](Tizen.UI/Tizen.UI.SystemFontSizeManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.SystemFontSizeManager.md tags:['SystemFontSizeManager'], author:['jh5.cho@samsung.com']" +## [TapGesture](Tizen.UI/Tizen.UI.TapGesture.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGesture.md tags:['TapGesture'], author:['jh5.cho@samsung.com']" +## [TapGestureDetectedEventArgs](Tizen.UI/Tizen.UI.TapGestureDetectedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetectedEventArgs.md tags:['TapGestureDetectedEventArgs'], author:['jh5.cho@samsung.com']" +## [TapGestureDetector](Tizen.UI/Tizen.UI.TapGestureDetector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TapGestureDetector.md tags:['TapGestureDetector'], author:['jh5.cho@samsung.com']" +## [TbmSurfaceView](Tizen.UI/Tizen.UI.TbmSurfaceView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TbmSurfaceView.md tags:['TbmSurfaceView'], author:['jh5.cho@samsung.com']" +## [Template_T_](Tizen.UI/Tizen.UI.Template_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Template_T_.md tags:['Template_T_'], author:['jh5.cho@samsung.com']" +## [TextAlignment](Tizen.UI/Tizen.UI.TextAlignment.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextAlignment.md tags:['TextAlignment'], author:['jh5.cho@samsung.com']" +## [TextBindings_T_](Tizen.UI/Tizen.UI.TextBindings_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextBindings_T_.md tags:['TextBindings_T_'], author:['jh5.cho@samsung.com']" +## [TextEditor](Tizen.UI/Tizen.UI.TextEditor.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditor.md tags:['TextEditor'], author:['jh5.cho@samsung.com']" +## [TextEditorExtensions](Tizen.UI/Tizen.UI.TextEditorExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextEditorExtensions.md tags:['TextEditorExtensions'], author:['jh5.cho@samsung.com']" +## [TextExtensions](Tizen.UI/Tizen.UI.TextExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextExtensions.md tags:['TextExtensions'], author:['jh5.cho@samsung.com']" +## [TextField](Tizen.UI/Tizen.UI.TextField.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextField.md tags:['TextField'], author:['jh5.cho@samsung.com']" +## [TextFieldExtensions](Tizen.UI/Tizen.UI.TextFieldExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextFieldExtensions.md tags:['TextFieldExtensions'], author:['jh5.cho@samsung.com']" +## [TextOverflow](Tizen.UI/Tizen.UI.TextOverflow.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextOverflow.md tags:['TextOverflow'], author:['jh5.cho@samsung.com']" +## [TextShadow](Tizen.UI/Tizen.UI.TextShadow.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextShadow.md tags:['TextShadow'], author:['jh5.cho@samsung.com']" +## [TextView](Tizen.UI/Tizen.UI.TextView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextView.md tags:['TextView'], author:['jh5.cho@samsung.com']" +## [TextViewExtensions](Tizen.UI/Tizen.UI.TextViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TextViewExtensions.md tags:['TextViewExtensions'], author:['jh5.cho@samsung.com']" +## [Thickness](Tizen.UI/Tizen.UI.Thickness.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Thickness.md tags:['Thickness'], author:['jh5.cho@samsung.com']" +## [Timer](Tizen.UI/Tizen.UI.Timer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Timer.md tags:['Timer'], author:['jh5.cho@samsung.com']" +## [TokenExtensions](Tizen.UI/Tizen.UI.TokenExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenExtensions.md tags:['TokenExtensions'], author:['jh5.cho@samsung.com']" +## [TokenManager](Tizen.UI/Tizen.UI.TokenManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenManager.md tags:['TokenManager'], author:['jh5.cho@samsung.com']" +## [TokenPropertyChangedEventArgs](Tizen.UI/Tizen.UI.TokenPropertyChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyChangedEventArgs.md tags:['TokenPropertyChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [TokenPropertyNames](Tizen.UI/Tizen.UI.TokenPropertyNames.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenPropertyNames.md tags:['TokenPropertyNames'], author:['jh5.cho@samsung.com']" +## [TokenType](Tizen.UI/Tizen.UI.TokenType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TokenType.md tags:['TokenType'], author:['jh5.cho@samsung.com']" +## [Touch](Tizen.UI/Tizen.UI.Touch.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Touch.md tags:['Touch'], author:['jh5.cho@samsung.com']" +## [TouchEvent](Tizen.UI/Tizen.UI.TouchEvent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEvent.md tags:['TouchEvent'], author:['jh5.cho@samsung.com']" +## [TouchEventArgs](Tizen.UI/Tizen.UI.TouchEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchEventArgs.md tags:['TouchEventArgs'], author:['jh5.cho@samsung.com']" +## [TouchPoint](Tizen.UI/Tizen.UI.TouchPoint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchPoint.md tags:['TouchPoint'], author:['jh5.cho@samsung.com']" +## [TouchState](Tizen.UI/Tizen.UI.TouchState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TouchState.md tags:['TouchState'], author:['jh5.cho@samsung.com']" +## [TwoWayBindingProperty_TView,TValue_](Tizen.UI/Tizen.UI.TwoWayBindingProperty_TView,TValue_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.TwoWayBindingProperty_TView,TValue_.md tags:['TwoWayBindingProperty_TView,TValue_'], author:['jh5.cho@samsung.com']" +## [UIApplication](Tizen.UI/Tizen.UI.UIApplication.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UIApplication.md tags:['UIApplication'], author:['jh5.cho@samsung.com']" +## [UISettings](Tizen.UI/Tizen.UI.UISettings.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UISettings.md tags:['UISettings'], author:['jh5.cho@samsung.com']" +## [Underline](Tizen.UI/Tizen.UI.Underline.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Underline.md tags:['Underline'], author:['jh5.cho@samsung.com']" +## [UnderlineStyle](Tizen.UI/Tizen.UI.UnderlineStyle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnderlineStyle.md tags:['UnderlineStyle'], author:['jh5.cho@samsung.com']" +## [UnitValue](Tizen.UI/Tizen.UI.UnitValue.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UnitValue.md tags:['UnitValue'], author:['jh5.cho@samsung.com']" +## [UrlWebViewSource](Tizen.UI/Tizen.UI.UrlWebViewSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.UrlWebViewSource.md tags:['UrlWebViewSource'], author:['jh5.cho@samsung.com']" +## [VideoOverlayView](Tizen.UI/Tizen.UI.VideoOverlayView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VideoOverlayView.md tags:['VideoOverlayView'], author:['jh5.cho@samsung.com']" +## [View](Tizen.UI/Tizen.UI.View.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.View.md tags:['View'], author:['jh5.cho@samsung.com']" +## [ViewBindings](Tizen.UI/Tizen.UI.ViewBindings.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewBindings.md tags:['ViewBindings'], author:['jh5.cho@samsung.com']" +## [ViewExtensions](Tizen.UI/Tizen.UI.ViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewExtensions.md tags:['ViewExtensions'], author:['jh5.cho@samsung.com']" +## [ViewGroup](Tizen.UI/Tizen.UI.ViewGroup.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewGroup.md tags:['ViewGroup'], author:['jh5.cho@samsung.com']" +## [ViewTemplate](Tizen.UI/Tizen.UI.ViewTemplate.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplate.md tags:['ViewTemplate'], author:['jh5.cho@samsung.com']" +## [ViewTemplateSelector](Tizen.UI/Tizen.UI.ViewTemplateSelector.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.ViewTemplateSelector.md tags:['ViewTemplateSelector'], author:['jh5.cho@samsung.com']" +## [VisibilityChangedEventArgs](Tizen.UI/Tizen.UI.VisibilityChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisibilityChangedEventArgs.md tags:['VisibilityChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [VisualCutoutPolicy](Tizen.UI/Tizen.UI.VisualCutoutPolicy.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.VisualCutoutPolicy.md tags:['VisualCutoutPolicy'], author:['jh5.cho@samsung.com']" +## [WeakEventManager](Tizen.UI/Tizen.UI.WeakEventManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WeakEventManager.md tags:['WeakEventManager'], author:['jh5.cho@samsung.com']" +## [WebNavigationEventArgs](Tizen.UI/Tizen.UI.WebNavigationEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebNavigationEventArgs.md tags:['WebNavigationEventArgs'], author:['jh5.cho@samsung.com']" +## [WebView](Tizen.UI/Tizen.UI.WebView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebView.md tags:['WebView'], author:['jh5.cho@samsung.com']" +## [WebViewSource](Tizen.UI/Tizen.UI.WebViewSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WebViewSource.md tags:['WebViewSource'], author:['jh5.cho@samsung.com']" +## [WheelDirection](Tizen.UI/Tizen.UI.WheelDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelDirection.md tags:['WheelDirection'], author:['jh5.cho@samsung.com']" +## [WheelEvent](Tizen.UI/Tizen.UI.WheelEvent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEvent.md tags:['WheelEvent'], author:['jh5.cho@samsung.com']" +## [WheelEventArgs](Tizen.UI/Tizen.UI.WheelEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelEventArgs.md tags:['WheelEventArgs'], author:['jh5.cho@samsung.com']" +## [WheelType](Tizen.UI/Tizen.UI.WheelType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WheelType.md tags:['WheelType'], author:['jh5.cho@samsung.com']" +## [Window](Tizen.UI/Tizen.UI.Window.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.Window.md tags:['Window'], author:['jh5.cho@samsung.com']" +## [WindowBlur](Tizen.UI/Tizen.UI.WindowBlur.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlur.md tags:['WindowBlur'], author:['jh5.cho@samsung.com']" +## [WindowBlurType](Tizen.UI/Tizen.UI.WindowBlurType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowBlurType.md tags:['WindowBlurType'], author:['jh5.cho@samsung.com']" +## [WindowFocusChangedEventArgs](Tizen.UI/Tizen.UI.WindowFocusChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowFocusChangedEventArgs.md tags:['WindowFocusChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [WindowMode](Tizen.UI/Tizen.UI.WindowMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowMode.md tags:['WindowMode'], author:['jh5.cho@samsung.com']" +## [WindowOrientation](Tizen.UI/Tizen.UI.WindowOrientation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowOrientation.md tags:['WindowOrientation'], author:['jh5.cho@samsung.com']" +## [WindowResizeDirection](Tizen.UI/Tizen.UI.WindowResizeDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizeDirection.md tags:['WindowResizeDirection'], author:['jh5.cho@samsung.com']" +## [WindowResizePolicy](Tizen.UI/Tizen.UI.WindowResizePolicy.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowResizePolicy.md tags:['WindowResizePolicy'], author:['jh5.cho@samsung.com']" +## [WindowType](Tizen.UI/Tizen.UI.WindowType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI/Tizen.UI.WindowType.md tags:['WindowType'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Components]() +## [AnimatedImageVisualMap](Tizen.UI.Components/Tizen.UI.Components.AnimatedImageVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedImageVisualMap.md tags:['AnimatedImageVisualMap'], author:['jh5.cho@samsung.com']" +## [AnimatedLayout](Tizen.UI.Components/Tizen.UI.Components.AnimatedLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.AnimatedLayout.md tags:['AnimatedLayout'], author:['jh5.cho@samsung.com']" +## [Animations.AnimationExtensions](Tizen.UI.Components/Tizen.UI.Components.Animations.AnimationExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.AnimationExtensions.md tags:['Animations.AnimationExtensions'], author:['jh5.cho@samsung.com']" +## [Animations.Bezier](Tizen.UI.Components/Tizen.UI.Components.Animations.Bezier.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Bezier.md tags:['Animations.Bezier'], author:['jh5.cho@samsung.com']" +## [Animations.Easing](Tizen.UI.Components/Tizen.UI.Components.Animations.Easing.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.Easing.md tags:['Animations.Easing'], author:['jh5.cho@samsung.com']" +## [Animations](Tizen.UI.Components/Tizen.UI.Components.Animations.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.md tags:['Animations'], author:['jh5.cho@samsung.com']" +## [Animations.TypedAnimationExtensions](Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationExtensions.md tags:['Animations.TypedAnimationExtensions'], author:['jh5.cho@samsung.com']" +## [Animations.TypedAnimationTargetBridge_T_](Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.TypedAnimationTargetBridge_T_.md tags:['Animations.TypedAnimationTargetBridge_T_'], author:['jh5.cho@samsung.com']" +## [Animations.UIAnimation](Tizen.UI.Components/Tizen.UI.Components.Animations.UIAnimation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Animations.UIAnimation.md tags:['Animations.UIAnimation'], author:['jh5.cho@samsung.com']" +## [Clickable](Tizen.UI.Components/Tizen.UI.Components.Clickable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Clickable.md tags:['Clickable'], author:['jh5.cho@samsung.com']" +## [ClickableBox](Tizen.UI.Components/Tizen.UI.Components.ClickableBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableBox.md tags:['ClickableBox'], author:['jh5.cho@samsung.com']" +## [ClickableGrid](Tizen.UI.Components/Tizen.UI.Components.ClickableGrid.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableGrid.md tags:['ClickableGrid'], author:['jh5.cho@samsung.com']" +## [ClickableHStack](Tizen.UI.Components/Tizen.UI.Components.ClickableHStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableHStack.md tags:['ClickableHStack'], author:['jh5.cho@samsung.com']" +## [ClickableVStack](Tizen.UI.Components/Tizen.UI.Components.ClickableVStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickableVStack.md tags:['ClickableVStack'], author:['jh5.cho@samsung.com']" +## [ClickKeyType](Tizen.UI.Components/Tizen.UI.Components.ClickKeyType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClickKeyType.md tags:['ClickKeyType'], author:['jh5.cho@samsung.com']" +## [ClosedRange_T_](Tizen.UI.Components/Tizen.UI.Components.ClosedRange_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ClosedRange_T_.md tags:['ClosedRange_T_'], author:['jh5.cho@samsung.com']" +## [DestroyUtility](Tizen.UI.Components/Tizen.UI.Components.DestroyUtility.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DestroyUtility.md tags:['DestroyUtility'], author:['jh5.cho@samsung.com']" +## [DummyFontFamilyLoader](Tizen.UI.Components/Tizen.UI.Components.DummyFontFamilyLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontFamilyLoader.md tags:['DummyFontFamilyLoader'], author:['jh5.cho@samsung.com']" +## [DummyFontScaleLoader](Tizen.UI.Components/Tizen.UI.Components.DummyFontScaleLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyFontScaleLoader.md tags:['DummyFontScaleLoader'], author:['jh5.cho@samsung.com']" +## [DummyThemeLoader](Tizen.UI.Components/Tizen.UI.Components.DummyThemeLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.DummyThemeLoader.md tags:['DummyThemeLoader'], author:['jh5.cho@samsung.com']" +## [EdgeDirection](Tizen.UI.Components/Tizen.UI.Components.EdgeDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeDirection.md tags:['EdgeDirection'], author:['jh5.cho@samsung.com']" +## [EdgeState](Tizen.UI.Components/Tizen.UI.Components.EdgeState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.EdgeState.md tags:['EdgeState'], author:['jh5.cho@samsung.com']" +## [FloatingOrigin](Tizen.UI.Components/Tizen.UI.Components.FloatingOrigin.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.FloatingOrigin.md tags:['FloatingOrigin'], author:['jh5.cho@samsung.com']" +## [GroupSelectable](Tizen.UI.Components/Tizen.UI.Components.GroupSelectable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectable.md tags:['GroupSelectable'], author:['jh5.cho@samsung.com']" +## [GroupSelectableBox](Tizen.UI.Components/Tizen.UI.Components.GroupSelectableBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectableBox.md tags:['GroupSelectableBox'], author:['jh5.cho@samsung.com']" +## [GroupSelectionChangedEventArgs](Tizen.UI.Components/Tizen.UI.Components.GroupSelectionChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.GroupSelectionChangedEventArgs.md tags:['GroupSelectionChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [IAnchoredModal](Tizen.UI.Components/Tizen.UI.Components.IAnchoredModal.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnchoredModal.md tags:['IAnchoredModal'], author:['jh5.cho@samsung.com']" +## [IAnimatedImage](Tizen.UI.Components/Tizen.UI.Components.IAnimatedImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IAnimatedImage.md tags:['IAnimatedImage'], author:['jh5.cho@samsung.com']" +## [IClickable](Tizen.UI.Components/Tizen.UI.Components.IClickable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickable.md tags:['IClickable'], author:['jh5.cho@samsung.com']" +## [IClickableVariables](Tizen.UI.Components/Tizen.UI.Components.IClickableVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IClickableVariables.md tags:['IClickableVariables'], author:['jh5.cho@samsung.com']" +## [IColorProvider](Tizen.UI.Components/Tizen.UI.Components.IColorProvider.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IColorProvider.md tags:['IColorProvider'], author:['jh5.cho@samsung.com']" +## [IconPlacement](Tizen.UI.Components/Tizen.UI.Components.IconPlacement.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IconPlacement.md tags:['IconPlacement'], author:['jh5.cho@samsung.com']" +## [IDecoratableText](Tizen.UI.Components/Tizen.UI.Components.IDecoratableText.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDecoratableText.md tags:['IDecoratableText'], author:['jh5.cho@samsung.com']" +## [IDoubleTitle](Tizen.UI.Components/Tizen.UI.Components.IDoubleTitle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IDoubleTitle.md tags:['IDoubleTitle'], author:['jh5.cho@samsung.com']" +## [IEdgeEffect](Tizen.UI.Components/Tizen.UI.Components.IEdgeEffect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IEdgeEffect.md tags:['IEdgeEffect'], author:['jh5.cho@samsung.com']" +## [IFlexibleText](Tizen.UI.Components/Tizen.UI.Components.IFlexibleText.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFlexibleText.md tags:['IFlexibleText'], author:['jh5.cho@samsung.com']" +## [IFontFamilyLoader](Tizen.UI.Components/Tizen.UI.Components.IFontFamilyLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontFamilyLoader.md tags:['IFontFamilyLoader'], author:['jh5.cho@samsung.com']" +## [IFontScaleLoader](Tizen.UI.Components/Tizen.UI.Components.IFontScaleLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IFontScaleLoader.md tags:['IFontScaleLoader'], author:['jh5.cho@samsung.com']" +## [IGroupSelectable](Tizen.UI.Components/Tizen.UI.Components.IGroupSelectable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IGroupSelectable.md tags:['IGroupSelectable'], author:['jh5.cho@samsung.com']" +## [IImage](Tizen.UI.Components/Tizen.UI.Components.IImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IImage.md tags:['IImage'], author:['jh5.cho@samsung.com']" +## [ILayoutBox](Tizen.UI.Components/Tizen.UI.Components.ILayoutBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ILayoutBox.md tags:['ILayoutBox'], author:['jh5.cho@samsung.com']" +## [IModalContainer](Tizen.UI.Components/Tizen.UI.Components.IModalContainer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IModalContainer.md tags:['IModalContainer'], author:['jh5.cho@samsung.com']" +## [INavigateBackHandler](Tizen.UI.Components/Tizen.UI.Components.INavigateBackHandler.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigateBackHandler.md tags:['INavigateBackHandler'], author:['jh5.cho@samsung.com']" +## [INavigation](Tizen.UI.Components/Tizen.UI.Components.INavigation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigation.md tags:['INavigation'], author:['jh5.cho@samsung.com']" +## [INavigationAnimation](Tizen.UI.Components/Tizen.UI.Components.INavigationAnimation.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimation.md tags:['INavigationAnimation'], author:['jh5.cho@samsung.com']" +## [INavigationAnimationController](Tizen.UI.Components/Tizen.UI.Components.INavigationAnimationController.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationAnimationController.md tags:['INavigationAnimationController'], author:['jh5.cho@samsung.com']" +## [INavigationTransition](Tizen.UI.Components/Tizen.UI.Components.INavigationTransition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.INavigationTransition.md tags:['INavigationTransition'], author:['jh5.cho@samsung.com']" +## [InputEditorImpl](Tizen.UI.Components/Tizen.UI.Components.InputEditorImpl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEditorImpl.md tags:['InputEditorImpl'], author:['jh5.cho@samsung.com']" +## [InputEventArgs](Tizen.UI.Components/Tizen.UI.Components.InputEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputEventArgs.md tags:['InputEventArgs'], author:['jh5.cho@samsung.com']" +## [InputFieldImpl](Tizen.UI.Components/Tizen.UI.Components.InputFieldImpl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputFieldImpl.md tags:['InputFieldImpl'], author:['jh5.cho@samsung.com']" +## [InputTextBaseImpl](Tizen.UI.Components/Tizen.UI.Components.InputTextBaseImpl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InputTextBaseImpl.md tags:['InputTextBaseImpl'], author:['jh5.cho@samsung.com']" +## [InteractionType](Tizen.UI.Components/Tizen.UI.Components.InteractionType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractionType.md tags:['InteractionType'], author:['jh5.cho@samsung.com']" +## [InteractiveProgress](Tizen.UI.Components/Tizen.UI.Components.InteractiveProgress.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgress.md tags:['InteractiveProgress'], author:['jh5.cho@samsung.com']" +## [InteractiveProgressHelper](Tizen.UI.Components/Tizen.UI.Components.InteractiveProgressHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.InteractiveProgressHelper.md tags:['InteractiveProgressHelper'], author:['jh5.cho@samsung.com']" +## [IPressable](Tizen.UI.Components/Tizen.UI.Components.IPressable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPressable.md tags:['IPressable'], author:['jh5.cho@samsung.com']" +## [IPropertySetter_TValue_](Tizen.UI.Components/Tizen.UI.Components.IPropertySetter_TValue_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IPropertySetter_TValue_.md tags:['IPropertySetter_TValue_'], author:['jh5.cho@samsung.com']" +## [ISelectable](Tizen.UI.Components/Tizen.UI.Components.ISelectable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectable.md tags:['ISelectable'], author:['jh5.cho@samsung.com']" +## [ISelectionGroup](Tizen.UI.Components/Tizen.UI.Components.ISelectionGroup.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ISelectionGroup.md tags:['ISelectionGroup'], author:['jh5.cho@samsung.com']" +## [IThemeLoader](Tizen.UI.Components/Tizen.UI.Components.IThemeLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.IThemeLoader.md tags:['IThemeLoader'], author:['jh5.cho@samsung.com']" +## [ITitle](Tizen.UI.Components/Tizen.UI.Components.ITitle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITitle.md tags:['ITitle'], author:['jh5.cho@samsung.com']" +## [ITouchEffectTarget](Tizen.UI.Components/Tizen.UI.Components.ITouchEffectTarget.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ITouchEffectTarget.md tags:['ITouchEffectTarget'], author:['jh5.cho@samsung.com']" +## [JsonParser](Tizen.UI.Components/Tizen.UI.Components.JsonParser.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.JsonParser.md tags:['JsonParser'], author:['jh5.cho@samsung.com']" +## [LabelImpl](Tizen.UI.Components/Tizen.UI.Components.LabelImpl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LabelImpl.md tags:['LabelImpl'], author:['jh5.cho@samsung.com']" +## [LocalizationExtensions](Tizen.UI.Components/Tizen.UI.Components.LocalizationExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LocalizationExtensions.md tags:['LocalizationExtensions'], author:['jh5.cho@samsung.com']" +## [LottieImageVisualMap](Tizen.UI.Components/Tizen.UI.Components.LottieImageVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.LottieImageVisualMap.md tags:['LottieImageVisualMap'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Components](Tizen.UI.Components/Tizen.UI.Components.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.md tags:['Tizen.UI.Components'], author:['jh5.cho@samsung.com']" +## [ModalPivot](Tizen.UI.Components/Tizen.UI.Components.ModalPivot.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ModalPivot.md tags:['ModalPivot'], author:['jh5.cho@samsung.com']" +## [Navigator](Tizen.UI.Components/Tizen.UI.Components.Navigator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Navigator.md tags:['Navigator'], author:['jh5.cho@samsung.com']" +## [OffScreenRenderingMode](Tizen.UI.Components/Tizen.UI.Components.OffScreenRenderingMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OffScreenRenderingMode.md tags:['OffScreenRenderingMode'], author:['jh5.cho@samsung.com']" +## [OverScrollMode](Tizen.UI.Components/Tizen.UI.Components.OverScrollMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.OverScrollMode.md tags:['OverScrollMode'], author:['jh5.cho@samsung.com']" +## [Palette](Tizen.UI.Components/Tizen.UI.Components.Palette.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Palette.md tags:['Palette'], author:['jh5.cho@samsung.com']" +## [Pressable](Tizen.UI.Components/Tizen.UI.Components.Pressable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Pressable.md tags:['Pressable'], author:['jh5.cho@samsung.com']" +## [PressableBox](Tizen.UI.Components/Tizen.UI.Components.PressableBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PressableBox.md tags:['PressableBox'], author:['jh5.cho@samsung.com']" +## [Progress](Tizen.UI.Components/Tizen.UI.Components.Progress.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Progress.md tags:['Progress'], author:['jh5.cho@samsung.com']" +## [PropertySetter_TView,TValue_](Tizen.UI.Components/Tizen.UI.Components.PropertySetter_TView,TValue_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.PropertySetter_TView,TValue_.md tags:['PropertySetter_TView,TValue_'], author:['jh5.cho@samsung.com']" +## [RecoilEffect](Tizen.UI.Components/Tizen.UI.Components.RecoilEffect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.RecoilEffect.md tags:['RecoilEffect'], author:['jh5.cho@samsung.com']" +## [Recycler.Adapter](Tizen.UI.Components/Tizen.UI.Components.Recycler.Adapter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.Adapter.md tags:['Recycler.Adapter'], author:['jh5.cho@samsung.com']" +## [Recycler.AnimationFinishedEventArgs](Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationFinishedEventArgs.md tags:['Recycler.AnimationFinishedEventArgs'], author:['jh5.cho@samsung.com']" +## [Recycler.AnimationType](Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.AnimationType.md tags:['Recycler.AnimationType'], author:['jh5.cho@samsung.com']" +## [Recycler.DefaultItemAnimator](Tizen.UI.Components/Tizen.UI.Components.Recycler.DefaultItemAnimator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.DefaultItemAnimator.md tags:['Recycler.DefaultItemAnimator'], author:['jh5.cho@samsung.com']" +## [Recycler.ExclusiveSelectionModelGroup_T_](Tizen.UI.Components/Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ExclusiveSelectionModelGroup_T_.md tags:['Recycler.ExclusiveSelectionModelGroup_T_'], author:['jh5.cho@samsung.com']" +## [Recycler.GridLayoutManager](Tizen.UI.Components/Tizen.UI.Components.Recycler.GridLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GridLayoutManager.md tags:['Recycler.GridLayoutManager'], author:['jh5.cho@samsung.com']" +## [Recycler.GroupInfo](Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupInfo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupInfo.md tags:['Recycler.GroupInfo'], author:['jh5.cho@samsung.com']" +## [Recycler.GroupItemSource](Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemSource.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemSource.md tags:['Recycler.GroupItemSource'], author:['jh5.cho@samsung.com']" +## [Recycler.GroupItemTemplateAdapter](Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.GroupItemTemplateAdapter.md tags:['Recycler.GroupItemTemplateAdapter'], author:['jh5.cho@samsung.com']" +## [Recycler.HolderExtensions](Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderExtensions.md tags:['Recycler.HolderExtensions'], author:['jh5.cho@samsung.com']" +## [Recycler.HolderInfo](Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderInfo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.HolderInfo.md tags:['Recycler.HolderInfo'], author:['jh5.cho@samsung.com']" +## [Recycler.IChildSeizable](Tizen.UI.Components/Tizen.UI.Components.Recycler.IChildSeizable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IChildSeizable.md tags:['Recycler.IChildSeizable'], author:['jh5.cho@samsung.com']" +## [Recycler.IDividerProvider](Tizen.UI.Components/Tizen.UI.Components.Recycler.IDividerProvider.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IDividerProvider.md tags:['Recycler.IDividerProvider'], author:['jh5.cho@samsung.com']" +## [Recycler.IGridRelativeSizeHelper](Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridRelativeSizeHelper.md tags:['Recycler.IGridRelativeSizeHelper'], author:['jh5.cho@samsung.com']" +## [Recycler.IGridSpanHelper](Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridSpanHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGridSpanHelper.md tags:['Recycler.IGridSpanHelper'], author:['jh5.cho@samsung.com']" +## [Recycler.IGroupedAdapter](Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedAdapter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedAdapter.md tags:['Recycler.IGroupedAdapter'], author:['jh5.cho@samsung.com']" +## [Recycler.IGroupedItem](Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IGroupedItem.md tags:['Recycler.IGroupedItem'], author:['jh5.cho@samsung.com']" +## [Recycler.IItemAnimator](Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemAnimator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemAnimator.md tags:['Recycler.IItemAnimator'], author:['jh5.cho@samsung.com']" +## [Recycler.IItemDecoration](Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemDecoration.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.IItemDecoration.md tags:['Recycler.IItemDecoration'], author:['jh5.cho@samsung.com']" +## [Recycler.ISelectableModel](Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectableModel.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectableModel.md tags:['Recycler.ISelectableModel'], author:['jh5.cho@samsung.com']" +## [Recycler.ISelectionModelGroup](Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup.md tags:['Recycler.ISelectionModelGroup'], author:['jh5.cho@samsung.com']" +## [Recycler.ISelectionModelGroup_T_](Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ISelectionModelGroup_T_.md tags:['Recycler.ISelectionModelGroup_T_'], author:['jh5.cho@samsung.com']" +## [Recycler.ItemTemplateAdapter](Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTemplateAdapter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTemplateAdapter.md tags:['Recycler.ItemTemplateAdapter'], author:['jh5.cho@samsung.com']" +## [Recycler.ItemTouchHelper](Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelper.md tags:['Recycler.ItemTouchHelper'], author:['jh5.cho@samsung.com']" +## [Recycler.ItemTouchHelperCallback](Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ItemTouchHelperCallback.md tags:['Recycler.ItemTouchHelperCallback'], author:['jh5.cho@samsung.com']" +## [Recycler.LayoutManager](Tizen.UI.Components/Tizen.UI.Components.Recycler.LayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LayoutManager.md tags:['Recycler.LayoutManager'], author:['jh5.cho@samsung.com']" +## [Recycler.LinearLayoutManager](Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearLayoutManager.md tags:['Recycler.LinearLayoutManager'], author:['jh5.cho@samsung.com']" +## [Recycler.LinearSwapCallback](Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearSwapCallback.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.LinearSwapCallback.md tags:['Recycler.LinearSwapCallback'], author:['jh5.cho@samsung.com']" +## [Recycler](Tizen.UI.Components/Tizen.UI.Components.Recycler.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.md tags:['Recycler'], author:['jh5.cho@samsung.com']" +## [Recycler.RecyclerView](Tizen.UI.Components/Tizen.UI.Components.Recycler.RecyclerView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecyclerView.md tags:['Recycler.RecyclerView'], author:['jh5.cho@samsung.com']" +## [Recycler.RecycleScroller](Tizen.UI.Components/Tizen.UI.Components.Recycler.RecycleScroller.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.RecycleScroller.md tags:['Recycler.RecycleScroller'], author:['jh5.cho@samsung.com']" +## [Recycler.SelectableModel](Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectableModel.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectableModel.md tags:['Recycler.SelectableModel'], author:['jh5.cho@samsung.com']" +## [Recycler.SelectionModelGroup_T_](Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.SelectionModelGroup_T_.md tags:['Recycler.SelectionModelGroup_T_'], author:['jh5.cho@samsung.com']" +## [Recycler.StickyArea](Tizen.UI.Components/Tizen.UI.Components.Recycler.StickyArea.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.StickyArea.md tags:['Recycler.StickyArea'], author:['jh5.cho@samsung.com']" +## [Recycler.TouchActionState](Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchActionState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchActionState.md tags:['Recycler.TouchActionState'], author:['jh5.cho@samsung.com']" +## [Recycler.TouchDirection](Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.TouchDirection.md tags:['Recycler.TouchDirection'], author:['jh5.cho@samsung.com']" +## [Recycler.ViewHolder](Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewHolder.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewHolder.md tags:['Recycler.ViewHolder'], author:['jh5.cho@samsung.com']" +## [Recycler.ViewModel](Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModel.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModel.md tags:['Recycler.ViewModel'], author:['jh5.cho@samsung.com']" +## [Recycler.ViewModelGroup_T_](Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModelGroup_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Recycler.ViewModelGroup_T_.md tags:['Recycler.ViewModelGroup_T_'], author:['jh5.cho@samsung.com']" +## [ScaffoldBase](Tizen.UI.Components/Tizen.UI.Components.ScaffoldBase.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScaffoldBase.md tags:['ScaffoldBase'], author:['jh5.cho@samsung.com']" +## [Scrollable](Tizen.UI.Components/Tizen.UI.Components.Scrollable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Scrollable.md tags:['Scrollable'], author:['jh5.cho@samsung.com']" +## [ScrollableLayoutManager](Tizen.UI.Components/Tizen.UI.Components.ScrollableLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollableLayoutManager.md tags:['ScrollableLayoutManager'], author:['jh5.cho@samsung.com']" +## [ScrollBarBase](Tizen.UI.Components/Tizen.UI.Components.ScrollBarBase.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ScrollBarBase.md tags:['ScrollBarBase'], author:['jh5.cho@samsung.com']" +## [Selectable](Tizen.UI.Components/Tizen.UI.Components.Selectable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Selectable.md tags:['Selectable'], author:['jh5.cho@samsung.com']" +## [SelectableBindings_TView_](Tizen.UI.Components/Tizen.UI.Components.SelectableBindings_TView_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBindings_TView_.md tags:['SelectableBindings_TView_'], author:['jh5.cho@samsung.com']" +## [SelectableBox](Tizen.UI.Components/Tizen.UI.Components.SelectableBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableBox.md tags:['SelectableBox'], author:['jh5.cho@samsung.com']" +## [SelectableHStack](Tizen.UI.Components/Tizen.UI.Components.SelectableHStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableHStack.md tags:['SelectableHStack'], author:['jh5.cho@samsung.com']" +## [SelectableVStack](Tizen.UI.Components/Tizen.UI.Components.SelectableVStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectableVStack.md tags:['SelectableVStack'], author:['jh5.cho@samsung.com']" +## [SelectionGroup](Tizen.UI.Components/Tizen.UI.Components.SelectionGroup.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroup.md tags:['SelectionGroup'], author:['jh5.cho@samsung.com']" +## [SelectionGroupBox_T_](Tizen.UI.Components/Tizen.UI.Components.SelectionGroupBox_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupBox_T_.md tags:['SelectionGroupBox_T_'], author:['jh5.cho@samsung.com']" +## [SelectionGroupItemClickedEventArgs](Tizen.UI.Components/Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SelectionGroupItemClickedEventArgs.md tags:['SelectionGroupItemClickedEventArgs'], author:['jh5.cho@samsung.com']" +## [SnapControlExtensions](Tizen.UI.Components/Tizen.UI.Components.SnapControlExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SnapControlExtensions.md tags:['SnapControlExtensions'], author:['jh5.cho@samsung.com']" +## [Swatch](Tizen.UI.Components/Tizen.UI.Components.Swatch.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Swatch.md tags:['Swatch'], author:['jh5.cho@samsung.com']" +## [SystemFeedback](Tizen.UI.Components/Tizen.UI.Components.SystemFeedback.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.SystemFeedback.md tags:['SystemFeedback'], author:['jh5.cho@samsung.com']" +## [TextBaseImpl](Tizen.UI.Components/Tizen.UI.Components.TextBaseImpl.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextBaseImpl.md tags:['TextBaseImpl'], author:['jh5.cho@samsung.com']" +## [TextTranslator](Tizen.UI.Components/Tizen.UI.Components.TextTranslator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TextTranslator.md tags:['TextTranslator'], author:['jh5.cho@samsung.com']" +## [TimeCounter](Tizen.UI.Components/Tizen.UI.Components.TimeCounter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TimeCounter.md tags:['TimeCounter'], author:['jh5.cho@samsung.com']" +## [TizenFontFamilyLoader](Tizen.UI.Components/Tizen.UI.Components.TizenFontFamilyLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenFontFamilyLoader.md tags:['TizenFontFamilyLoader'], author:['jh5.cho@samsung.com']" +## [TizenThemeLoader](Tizen.UI.Components/Tizen.UI.Components.TizenThemeLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TizenThemeLoader.md tags:['TizenThemeLoader'], author:['jh5.cho@samsung.com']" +## [TokenTableExtensions](Tizen.UI.Components/Tizen.UI.Components.TokenTableExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TokenTableExtensions.md tags:['TokenTableExtensions'], author:['jh5.cho@samsung.com']" +## [TouchEffect](Tizen.UI.Components/Tizen.UI.Components.TouchEffect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.TouchEffect.md tags:['TouchEffect'], author:['jh5.cho@samsung.com']" +## [UIAttachable](Tizen.UI.Components/Tizen.UI.Components.UIAttachable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachable.md tags:['UIAttachable'], author:['jh5.cho@samsung.com']" +## [UIAttachableManager](Tizen.UI.Components/Tizen.UI.Components.UIAttachableManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIAttachableManager.md tags:['UIAttachableManager'], author:['jh5.cho@samsung.com']" +## [UIConfig](Tizen.UI.Components/Tizen.UI.Components.UIConfig.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfig.md tags:['UIConfig'], author:['jh5.cho@samsung.com']" +## [UIConfigManager](Tizen.UI.Components/Tizen.UI.Components.UIConfigManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIConfigManager.md tags:['UIConfigManager'], author:['jh5.cho@samsung.com']" +## [UIShadowExtensions](Tizen.UI.Components/Tizen.UI.Components.UIShadowExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIShadowExtensions.md tags:['UIShadowExtensions'], author:['jh5.cho@samsung.com']" +## [UIState](Tizen.UI.Components/Tizen.UI.Components.UIState.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIState.md tags:['UIState'], author:['jh5.cho@samsung.com']" +## [UIStateChangedEventArgs](Tizen.UI.Components/Tizen.UI.Components.UIStateChangedEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateChangedEventArgs.md tags:['UIStateChangedEventArgs'], author:['jh5.cho@samsung.com']" +## [UIStateConnectingProperty_TView_](Tizen.UI.Components/Tizen.UI.Components.UIStateConnectingProperty_TView_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConnectingProperty_TView_.md tags:['UIStateConnectingProperty_TView_'], author:['jh5.cho@samsung.com']" +## [UIStateConstraint](Tizen.UI.Components/Tizen.UI.Components.UIStateConstraint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateConstraint.md tags:['UIStateConstraint'], author:['jh5.cho@samsung.com']" +## [UIStateManager](Tizen.UI.Components/Tizen.UI.Components.UIStateManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIStateManager.md tags:['UIStateManager'], author:['jh5.cho@samsung.com']" +## [UITextManager](Tizen.UI.Components/Tizen.UI.Components.UITextManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UITextManager.md tags:['UITextManager'], author:['jh5.cho@samsung.com']" +## [UIThemeManager](Tizen.UI.Components/Tizen.UI.Components.UIThemeManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIThemeManager.md tags:['UIThemeManager'], author:['jh5.cho@samsung.com']" +## [UIVariables](Tizen.UI.Components/Tizen.UI.Components.UIVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVariables.md tags:['UIVariables'], author:['jh5.cho@samsung.com']" +## [UIVectorExtensions](Tizen.UI.Components/Tizen.UI.Components.UIVectorExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.UIVectorExtensions.md tags:['UIVectorExtensions'], author:['jh5.cho@samsung.com']" +## [Variables](Tizen.UI.Components/Tizen.UI.Components.Variables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.Variables.md tags:['Variables'], author:['jh5.cho@samsung.com']" +## [ViewExtensions](Tizen.UI.Components/Tizen.UI.Components.ViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components/Tizen.UI.Components.ViewExtensions.md tags:['ViewExtensions'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Components.Material]() +## [ActionButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ActionButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ActionButton.md tags:['ActionButton'], author:['jh5.cho@samsung.com']" +## [AdapterView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AdapterView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AdapterView.md tags:['AdapterView'], author:['jh5.cho@samsung.com']" +## [AlertDialog](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialog.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialog.md tags:['AlertDialog'], author:['jh5.cho@samsung.com']" +## [AlertDialogVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialogVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AlertDialogVariables.md tags:['AlertDialogVariables'], author:['jh5.cho@samsung.com']" +## [AnimatedImage](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AnimatedImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AnimatedImage.md tags:['AnimatedImage'], author:['jh5.cho@samsung.com']" +## [AppBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBar.md tags:['AppBar'], author:['jh5.cho@samsung.com']" +## [AppBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.AppBarVariables.md tags:['AppBarVariables'], author:['jh5.cho@samsung.com']" +## [BackButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BackButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BackButton.md tags:['BackButton'], author:['jh5.cho@samsung.com']" +## [BottomBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar.md tags:['BottomBar'], author:['jh5.cho@samsung.com']" +## [BottomBar_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomBar_T_.md tags:['BottomBar_T_'], author:['jh5.cho@samsung.com']" +## [BottomSheet](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheet.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheet.md tags:['BottomSheet'], author:['jh5.cho@samsung.com']" +## [BottomSheetContainer](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainer.md tags:['BottomSheetContainer'], author:['jh5.cho@samsung.com']" +## [BottomSheetContainerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetContainerVariables.md tags:['BottomSheetContainerVariables'], author:['jh5.cho@samsung.com']" +## [BottomSheetVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BottomSheetVariables.md tags:['BottomSheetVariables'], author:['jh5.cho@samsung.com']" +## [BounceEdgeEffect](Tizen.UI.Components.Material/Tizen.UI.Components.Material.BounceEdgeEffect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.BounceEdgeEffect.md tags:['BounceEdgeEffect'], author:['jh5.cho@samsung.com']" +## [Button](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Button.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Button.md tags:['Button'], author:['jh5.cho@samsung.com']" +## [ButtonVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ButtonVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ButtonVariables.md tags:['ButtonVariables'], author:['jh5.cho@samsung.com']" +## [Card](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Card.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Card.md tags:['Card'], author:['jh5.cho@samsung.com']" +## [CardVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.CardVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CardVariables.md tags:['CardVariables'], author:['jh5.cho@samsung.com']" +## [Checkbox](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Checkbox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Checkbox.md tags:['Checkbox'], author:['jh5.cho@samsung.com']" +## [CheckboxVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.CheckboxVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CheckboxVariables.md tags:['CheckboxVariables'], author:['jh5.cho@samsung.com']" +## [CircleButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButton.md tags:['CircleButton'], author:['jh5.cho@samsung.com']" +## [CircleButtonVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButtonVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.CircleButtonVariables.md tags:['CircleButtonVariables'], author:['jh5.cho@samsung.com']" +## [Dialog](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Dialog.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Dialog.md tags:['Dialog'], author:['jh5.cho@samsung.com']" +## [DialogContainer](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainer.md tags:['DialogContainer'], author:['jh5.cho@samsung.com']" +## [DialogContainerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogContainerVariables.md tags:['DialogContainerVariables'], author:['jh5.cho@samsung.com']" +## [DialogVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DialogVariables.md tags:['DialogVariables'], author:['jh5.cho@samsung.com']" +## [Divider](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Divider.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Divider.md tags:['Divider'], author:['jh5.cho@samsung.com']" +## [DividerDirection](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerDirection.md tags:['DividerDirection'], author:['jh5.cho@samsung.com']" +## [DividerStyle](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerStyle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerStyle.md tags:['DividerStyle'], author:['jh5.cho@samsung.com']" +## [DividerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DividerVariables.md tags:['DividerVariables'], author:['jh5.cho@samsung.com']" +## [DoubleTitle](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitle.md tags:['DoubleTitle'], author:['jh5.cho@samsung.com']" +## [DoubleTitleVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitleVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DoubleTitleVariables.md tags:['DoubleTitleVariables'], author:['jh5.cho@samsung.com']" +## [Drawer_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Drawer_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Drawer_T_.md tags:['Drawer_T_'], author:['jh5.cho@samsung.com']" +## [DrawerItem](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItem.md tags:['DrawerItem'], author:['jh5.cho@samsung.com']" +## [DrawerItemVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItemVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DrawerItemVariables.md tags:['DrawerItemVariables'], author:['jh5.cho@samsung.com']" +## [DropdownActionItem](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownActionItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownActionItem.md tags:['DropdownActionItem'], author:['jh5.cho@samsung.com']" +## [DropdownCheckItem](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownCheckItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownCheckItem.md tags:['DropdownCheckItem'], author:['jh5.cho@samsung.com']" +## [DropdownItem](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItem.md tags:['DropdownItem'], author:['jh5.cho@samsung.com']" +## [DropdownItemVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItemVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownItemVariables.md tags:['DropdownItemVariables'], author:['jh5.cho@samsung.com']" +## [DropdownList](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList.md tags:['DropdownList'], author:['jh5.cho@samsung.com']" +## [DropdownList_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownList_T_.md tags:['DropdownList_T_'], author:['jh5.cho@samsung.com']" +## [DropdownListVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownListVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DropdownListVariables.md tags:['DropdownListVariables'], author:['jh5.cho@samsung.com']" +## [DynamicType](Tizen.UI.Components.Material/Tizen.UI.Components.Material.DynamicType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.DynamicType.md tags:['DynamicType'], author:['jh5.cho@samsung.com']" +## [FloatingActionButtonScrollBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.FloatingActionButtonScrollBar.md tags:['FloatingActionButtonScrollBar'], author:['jh5.cho@samsung.com']" +## [GoToTopScrollBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.GoToTopScrollBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GoToTopScrollBar.md tags:['GoToTopScrollBar'], author:['jh5.cho@samsung.com']" +## [GridView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.GridView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.GridView.md tags:['GridView'], author:['jh5.cho@samsung.com']" +## [IAppBarContent](Tizen.UI.Components.Material/Tizen.UI.Components.Material.IAppBarContent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IAppBarContent.md tags:['IAppBarContent'], author:['jh5.cho@samsung.com']" +## [IconButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButton.md tags:['IconButton'], author:['jh5.cho@samsung.com']" +## [IconButtonVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButtonVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IconButtonVariables.md tags:['IconButtonVariables'], author:['jh5.cho@samsung.com']" +## [Image](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Image.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Image.md tags:['Image'], author:['jh5.cho@samsung.com']" +## [InputEditor](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditor.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditor.md tags:['InputEditor'], author:['jh5.cho@samsung.com']" +## [InputEditorVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditorVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputEditorVariables.md tags:['InputEditorVariables'], author:['jh5.cho@samsung.com']" +## [InputField](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputField.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputField.md tags:['InputField'], author:['jh5.cho@samsung.com']" +## [InputFieldVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputFieldVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputFieldVariables.md tags:['InputFieldVariables'], author:['jh5.cho@samsung.com']" +## [InputPicker](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputPicker.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputPicker.md tags:['InputPicker'], author:['jh5.cho@samsung.com']" +## [InputTextVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputTextVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.InputTextVariables.md tags:['InputTextVariables'], author:['jh5.cho@samsung.com']" +## [IPageIndicator](Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPageIndicator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPageIndicator.md tags:['IPageIndicator'], author:['jh5.cho@samsung.com']" +## [IPager](Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.IPager.md tags:['IPager'], author:['jh5.cho@samsung.com']" +## [Label](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Label.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Label.md tags:['Label'], author:['jh5.cho@samsung.com']" +## [LabelVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LabelVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LabelVariables.md tags:['LabelVariables'], author:['jh5.cho@samsung.com']" +## [LevelBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBar.md tags:['LevelBar'], author:['jh5.cho@samsung.com']" +## [LevelBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LevelBarVariables.md tags:['LevelBarVariables'], author:['jh5.cho@samsung.com']" +## [ListView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ListView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ListView.md tags:['ListView'], author:['jh5.cho@samsung.com']" +## [LoopedAdapterView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LoopedAdapterView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LoopedAdapterView.md tags:['LoopedAdapterView'], author:['jh5.cho@samsung.com']" +## [LottieImage](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImage.md tags:['LottieImage'], author:['jh5.cho@samsung.com']" +## [LottieImageProgress](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageProgress.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageProgress.md tags:['LottieImageProgress'], author:['jh5.cho@samsung.com']" +## [LottieImageTimeCounter](Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageTimeCounter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.LottieImageTimeCounter.md tags:['LottieImageTimeCounter'], author:['jh5.cho@samsung.com']" +## [MaterialApplication](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialApplication.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialApplication.md tags:['MaterialApplication'], author:['jh5.cho@samsung.com']" +## [MaterialBorder](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialBorder.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialBorder.md tags:['MaterialBorder'], author:['jh5.cho@samsung.com']" +## [MaterialColor](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialColor.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialColor.md tags:['MaterialColor'], author:['jh5.cho@samsung.com']" +## [MaterialComponentVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialComponentVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialComponentVariables.md tags:['MaterialComponentVariables'], author:['jh5.cho@samsung.com']" +## [MaterialConfig](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialConfig.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialConfig.md tags:['MaterialConfig'], author:['jh5.cho@samsung.com']" +## [MaterialCorner](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialCorner.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialCorner.md tags:['MaterialCorner'], author:['jh5.cho@samsung.com']" +## [MaterialFont](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFont.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFont.md tags:['MaterialFont'], author:['jh5.cho@samsung.com']" +## [MaterialFontSize](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFontSize.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialFontSize.md tags:['MaterialFontSize'], author:['jh5.cho@samsung.com']" +## [MaterialIcon](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialIcon.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialIcon.md tags:['MaterialIcon'], author:['jh5.cho@samsung.com']" +## [MaterialResourceManager](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialResourceManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialResourceManager.md tags:['MaterialResourceManager'], author:['jh5.cho@samsung.com']" +## [MaterialSpacing](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialSpacing.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialSpacing.md tags:['MaterialSpacing'], author:['jh5.cho@samsung.com']" +## [MaterialThemeLoader](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialThemeLoader.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialThemeLoader.md tags:['MaterialThemeLoader'], author:['jh5.cho@samsung.com']" +## [MaterialWidgetApplication](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialWidgetApplication.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MaterialWidgetApplication.md tags:['MaterialWidgetApplication'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Components.Material](Tizen.UI.Components.Material/Tizen.UI.Components.Material.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.md tags:['Tizen.UI.Components.Material'], author:['jh5.cho@samsung.com']" +## [ModalDrawer](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer.md tags:['ModalDrawer'], author:['jh5.cho@samsung.com']" +## [ModalDrawer_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawer_T_.md tags:['ModalDrawer_T_'], author:['jh5.cho@samsung.com']" +## [ModalDrawerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ModalDrawerVariables.md tags:['ModalDrawerVariables'], author:['jh5.cho@samsung.com']" +## [MoreButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.MoreButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.MoreButton.md tags:['MoreButton'], author:['jh5.cho@samsung.com']" +## [NotificationDuration](Tizen.UI.Components.Material/Tizen.UI.Components.Material.NotificationDuration.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.NotificationDuration.md tags:['NotificationDuration'], author:['jh5.cho@samsung.com']" +## [PageAdapter](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageAdapter.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageAdapter.md tags:['PageAdapter'], author:['jh5.cho@samsung.com']" +## [PageIndicator](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicator.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicator.md tags:['PageIndicator'], author:['jh5.cho@samsung.com']" +## [PageIndicatorDot](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDot.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDot.md tags:['PageIndicatorDot'], author:['jh5.cho@samsung.com']" +## [PageIndicatorDotVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDotVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorDotVariables.md tags:['PageIndicatorDotVariables'], author:['jh5.cho@samsung.com']" +## [PageIndicatorVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageIndicatorVariables.md tags:['PageIndicatorVariables'], author:['jh5.cho@samsung.com']" +## [PageScroller](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageScroller.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PageScroller.md tags:['PageScroller'], author:['jh5.cho@samsung.com']" +## [Picker](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Picker.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Picker.md tags:['Picker'], author:['jh5.cho@samsung.com']" +## [PickerBase](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerBase.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerBase.md tags:['PickerBase'], author:['jh5.cho@samsung.com']" +## [PickerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.PickerVariables.md tags:['PickerVariables'], author:['jh5.cho@samsung.com']" +## [ProgressBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBar.md tags:['ProgressBar'], author:['jh5.cho@samsung.com']" +## [ProgressBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressBarVariables.md tags:['ProgressBarVariables'], author:['jh5.cho@samsung.com']" +## [ProgressCircle](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircle.md tags:['ProgressCircle'], author:['jh5.cho@samsung.com']" +## [ProgressCircleVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircleVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressCircleVariables.md tags:['ProgressCircleVariables'], author:['jh5.cho@samsung.com']" +## [ProgressTimer](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimer.md tags:['ProgressTimer'], author:['jh5.cho@samsung.com']" +## [ProgressTimerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ProgressTimerVariables.md tags:['ProgressTimerVariables'], author:['jh5.cho@samsung.com']" +## [RadioButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButton.md tags:['RadioButton'], author:['jh5.cho@samsung.com']" +## [RadioButtonVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButtonVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.RadioButtonVariables.md tags:['RadioButtonVariables'], author:['jh5.cho@samsung.com']" +## [Scaffold](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Scaffold.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Scaffold.md tags:['Scaffold'], author:['jh5.cho@samsung.com']" +## [ScrollBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBar.md tags:['ScrollBar'], author:['jh5.cho@samsung.com']" +## [ScrollBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollBarVariables.md tags:['ScrollBarVariables'], author:['jh5.cho@samsung.com']" +## [ScrollView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ScrollView.md tags:['ScrollView'], author:['jh5.cho@samsung.com']" +## [SelectableLottieImage](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SelectableLottieImage.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SelectableLottieImage.md tags:['SelectableLottieImage'], author:['jh5.cho@samsung.com']" +## [Slider](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Slider.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Slider.md tags:['Slider'], author:['jh5.cho@samsung.com']" +## [SliderVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SliderVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SliderVariables.md tags:['SliderVariables'], author:['jh5.cho@samsung.com']" +## [SmartTip](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTip.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTip.md tags:['SmartTip'], author:['jh5.cho@samsung.com']" +## [SmartTipArrowPosition](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipArrowPosition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipArrowPosition.md tags:['SmartTipArrowPosition'], author:['jh5.cho@samsung.com']" +## [SmartTipBase](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipBase.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipBase.md tags:['SmartTipBase'], author:['jh5.cho@samsung.com']" +## [SmartTipMenu](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipMenu.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipMenu.md tags:['SmartTipMenu'], author:['jh5.cho@samsung.com']" +## [SmartTipVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipVariables.md tags:['SmartTipVariables'], author:['jh5.cho@samsung.com']" +## [SmartTipView](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipView.md tags:['SmartTipView'], author:['jh5.cho@samsung.com']" +## [SmartTipViewVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipViewVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SmartTipViewVariables.md tags:['SmartTipViewVariables'], author:['jh5.cho@samsung.com']" +## [SnackBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBar.md tags:['SnackBar'], author:['jh5.cho@samsung.com']" +## [SnackBarAction](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarAction.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarAction.md tags:['SnackBarAction'], author:['jh5.cho@samsung.com']" +## [SnackBarActionEventArgs](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarActionEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarActionEventArgs.md tags:['SnackBarActionEventArgs'], author:['jh5.cho@samsung.com']" +## [SnackBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SnackBarVariables.md tags:['SnackBarVariables'], author:['jh5.cho@samsung.com']" +## [SpinnerButton](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButton.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButton.md tags:['SpinnerButton'], author:['jh5.cho@samsung.com']" +## [SpinnerButtonVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButtonVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SpinnerButtonVariables.md tags:['SpinnerButtonVariables'], author:['jh5.cho@samsung.com']" +## [StaticDrawer](Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer.md tags:['StaticDrawer'], author:['jh5.cho@samsung.com']" +## [StaticDrawer_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawer_T_.md tags:['StaticDrawer_T_'], author:['jh5.cho@samsung.com']" +## [StaticDrawerVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawerVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.StaticDrawerVariables.md tags:['StaticDrawerVariables'], author:['jh5.cho@samsung.com']" +## [Switch](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Switch.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Switch.md tags:['Switch'], author:['jh5.cho@samsung.com']" +## [SwitchVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.SwitchVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.SwitchVariables.md tags:['SwitchVariables'], author:['jh5.cho@samsung.com']" +## [TabBar](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar.md tags:['TabBar'], author:['jh5.cho@samsung.com']" +## [TabBar_T_](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBar_T_.md tags:['TabBar_T_'], author:['jh5.cho@samsung.com']" +## [TabBarVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBarVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabBarVariables.md tags:['TabBarVariables'], author:['jh5.cho@samsung.com']" +## [TabItem](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItem.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItem.md tags:['TabItem'], author:['jh5.cho@samsung.com']" +## [TabItemVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItemVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TabItemVariables.md tags:['TabItemVariables'], author:['jh5.cho@samsung.com']" +## [Title](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Title.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Title.md tags:['Title'], author:['jh5.cho@samsung.com']" +## [TitleVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.TitleVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.TitleVariables.md tags:['TitleVariables'], author:['jh5.cho@samsung.com']" +## [Toast](Tizen.UI.Components.Material/Tizen.UI.Components.Material.Toast.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.Toast.md tags:['Toast'], author:['jh5.cho@samsung.com']" +## [ToastVariables](Tizen.UI.Components.Material/Tizen.UI.Components.Material.ToastVariables.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Components.Material/Tizen.UI.Components.Material.ToastVariables.md tags:['ToastVariables'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Layouts]() +## [AbsoluteLayout](Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayout.md tags:['AbsoluteLayout'], author:['jh5.cho@samsung.com']" +## [AbsoluteLayoutExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutExtensions.md tags:['AbsoluteLayoutExtensions'], author:['jh5.cho@samsung.com']" +## [AbsoluteLayoutFlags](Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutFlags.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutFlags.md tags:['AbsoluteLayoutFlags'], author:['jh5.cho@samsung.com']" +## [AbsoluteLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteLayoutManager.md tags:['AbsoluteLayoutManager'], author:['jh5.cho@samsung.com']" +## [AbsoluteParam](Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteParam.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.AbsoluteParam.md tags:['AbsoluteParam'], author:['jh5.cho@samsung.com']" +## [Dimension](Tizen.UI.Layouts/Tizen.UI.Layouts.Dimension.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Dimension.md tags:['Dimension'], author:['jh5.cho@samsung.com']" +## [FlexAlignContent](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignContent.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignContent.md tags:['FlexAlignContent'], author:['jh5.cho@samsung.com']" +## [FlexAlignItems](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignItems.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignItems.md tags:['FlexAlignItems'], author:['jh5.cho@samsung.com']" +## [FlexAlignSelf](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignSelf.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexAlignSelf.md tags:['FlexAlignSelf'], author:['jh5.cho@samsung.com']" +## [FlexBasis](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBasis.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBasis.md tags:['FlexBasis'], author:['jh5.cho@samsung.com']" +## [FlexBox](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBox.md tags:['FlexBox'], author:['jh5.cho@samsung.com']" +## [FlexBoxExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBoxExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexBoxExtensions.md tags:['FlexBoxExtensions'], author:['jh5.cho@samsung.com']" +## [FlexDirection](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexDirection.md tags:['FlexDirection'], author:['jh5.cho@samsung.com']" +## [FlexJustify](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexJustify.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexJustify.md tags:['FlexJustify'], author:['jh5.cho@samsung.com']" +## [FlexLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexLayoutManager.md tags:['FlexLayoutManager'], author:['jh5.cho@samsung.com']" +## [FlexParam](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexParam.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexParam.md tags:['FlexParam'], author:['jh5.cho@samsung.com']" +## [FlexPosition](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexPosition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexPosition.md tags:['FlexPosition'], author:['jh5.cho@samsung.com']" +## [FlexWrap](Tizen.UI.Layouts/Tizen.UI.Layouts.FlexWrap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.FlexWrap.md tags:['FlexWrap'], author:['jh5.cho@samsung.com']" +## [Grid](Tizen.UI.Layouts/Tizen.UI.Layouts.Grid.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Grid.md tags:['Grid'], author:['jh5.cho@samsung.com']" +## [GridColumnDefinition](Tizen.UI.Layouts/Tizen.UI.Layouts.GridColumnDefinition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridColumnDefinition.md tags:['GridColumnDefinition'], author:['jh5.cho@samsung.com']" +## [GridExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.GridExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridExtensions.md tags:['GridExtensions'], author:['jh5.cho@samsung.com']" +## [GridLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.GridLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLayoutManager.md tags:['GridLayoutManager'], author:['jh5.cho@samsung.com']" +## [GridLength](Tizen.UI.Layouts/Tizen.UI.Layouts.GridLength.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridLength.md tags:['GridLength'], author:['jh5.cho@samsung.com']" +## [GridParam](Tizen.UI.Layouts/Tizen.UI.Layouts.GridParam.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridParam.md tags:['GridParam'], author:['jh5.cho@samsung.com']" +## [GridRowColumns.Columns](Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Columns.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Columns.md tags:['GridRowColumns.Columns'], author:['jh5.cho@samsung.com']" +## [GridRowColumns](Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.md tags:['GridRowColumns'], author:['jh5.cho@samsung.com']" +## [GridRowColumns.Rows](Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Rows.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowColumns.Rows.md tags:['GridRowColumns.Rows'], author:['jh5.cho@samsung.com']" +## [GridRowDefinition](Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowDefinition.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridRowDefinition.md tags:['GridRowDefinition'], author:['jh5.cho@samsung.com']" +## [GridUnitType](Tizen.UI.Layouts/Tizen.UI.Layouts.GridUnitType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.GridUnitType.md tags:['GridUnitType'], author:['jh5.cho@samsung.com']" +## [HStack](Tizen.UI.Layouts/Tizen.UI.Layouts.HStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStack.md tags:['HStack'], author:['jh5.cho@samsung.com']" +## [HStackLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.HStackLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.HStackLayoutManager.md tags:['HStackLayoutManager'], author:['jh5.cho@samsung.com']" +## [IFlexBox](Tizen.UI.Layouts/Tizen.UI.Layouts.IFlexBox.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IFlexBox.md tags:['IFlexBox'], author:['jh5.cho@samsung.com']" +## [IGridLayout](Tizen.UI.Layouts/Tizen.UI.Layouts.IGridLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IGridLayout.md tags:['IGridLayout'], author:['jh5.cho@samsung.com']" +## [ILayout](Tizen.UI.Layouts/Tizen.UI.Layouts.ILayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayout.md tags:['ILayout'], author:['jh5.cho@samsung.com']" +## [ILayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.ILayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ILayoutManager.md tags:['ILayoutManager'], author:['jh5.cho@samsung.com']" +## [IStackLayout](Tizen.UI.Layouts/Tizen.UI.Layouts.IStackLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.IStackLayout.md tags:['IStackLayout'], author:['jh5.cho@samsung.com']" +## [Layout](Tizen.UI.Layouts/Tizen.UI.Layouts.Layout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.Layout.md tags:['Layout'], author:['jh5.cho@samsung.com']" +## [LayoutAlignment](Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutAlignment.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutAlignment.md tags:['LayoutAlignment'], author:['jh5.cho@samsung.com']" +## [LayoutExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutExtensions.md tags:['LayoutExtensions'], author:['jh5.cho@samsung.com']" +## [LayoutHelper](Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutHelper.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutHelper.md tags:['LayoutHelper'], author:['jh5.cho@samsung.com']" +## [LayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutManager.md tags:['LayoutManager'], author:['jh5.cho@samsung.com']" +## [LayoutParam](Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutParam.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.LayoutParam.md tags:['LayoutParam'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Layouts](Tizen.UI.Layouts/Tizen.UI.Layouts.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.md tags:['Tizen.UI.Layouts'], author:['jh5.cho@samsung.com']" +## [ScrollLayout](Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayout.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayout.md tags:['ScrollLayout'], author:['jh5.cho@samsung.com']" +## [ScrollLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollLayoutManager.md tags:['ScrollLayoutManager'], author:['jh5.cho@samsung.com']" +## [ScrollViewExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ScrollViewExtensions.md tags:['ScrollViewExtensions'], author:['jh5.cho@samsung.com']" +## [SnapControlExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.SnapControlExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapControlExtensions.md tags:['SnapControlExtensions'], author:['jh5.cho@samsung.com']" +## [SnapPointsAlignment](Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsAlignment.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsAlignment.md tags:['SnapPointsAlignment'], author:['jh5.cho@samsung.com']" +## [SnapPointsType](Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.SnapPointsType.md tags:['SnapPointsType'], author:['jh5.cho@samsung.com']" +## [StackBase](Tizen.UI.Layouts/Tizen.UI.Layouts.StackBase.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBase.md tags:['StackBase'], author:['jh5.cho@samsung.com']" +## [StackBaseExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.StackBaseExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackBaseExtensions.md tags:['StackBaseExtensions'], author:['jh5.cho@samsung.com']" +## [StackLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.StackLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.StackLayoutManager.md tags:['StackLayoutManager'], author:['jh5.cho@samsung.com']" +## [ViewExtensions](Tizen.UI.Layouts/Tizen.UI.Layouts.ViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.ViewExtensions.md tags:['ViewExtensions'], author:['jh5.cho@samsung.com']" +## [VStack](Tizen.UI.Layouts/Tizen.UI.Layouts.VStack.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStack.md tags:['VStack'], author:['jh5.cho@samsung.com']" +## [VStackLayoutManager](Tizen.UI.Layouts/Tizen.UI.Layouts.VStackLayoutManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Layouts/Tizen.UI.Layouts.VStackLayoutManager.md tags:['VStackLayoutManager'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Primitives2D]() +## [ArcTo](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ArcTo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ArcTo.md tags:['ArcTo'], author:['jh5.cho@samsung.com']" +## [BezierTo](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.BezierTo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.BezierTo.md tags:['BezierTo'], author:['jh5.cho@samsung.com']" +## [Close](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Close.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Close.md tags:['Close'], author:['jh5.cho@samsung.com']" +## [CustomShape](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.CustomShape.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.CustomShape.md tags:['CustomShape'], author:['jh5.cho@samsung.com']" +## [Drawable](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Drawable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Drawable.md tags:['Drawable'], author:['jh5.cho@samsung.com']" +## [DrawableGroup](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawableGroup.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawableGroup.md tags:['DrawableGroup'], author:['jh5.cho@samsung.com']" +## [DrawCircle](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawCircle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawCircle.md tags:['DrawCircle'], author:['jh5.cho@samsung.com']" +## [DrawOval](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawOval.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawOval.md tags:['DrawOval'], author:['jh5.cho@samsung.com']" +## [DrawRect](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRect.md tags:['DrawRect'], author:['jh5.cho@samsung.com']" +## [DrawRoundRect](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRoundRect.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.DrawRoundRect.md tags:['DrawRoundRect'], author:['jh5.cho@samsung.com']" +## [Ellipse](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Ellipse.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Ellipse.md tags:['Ellipse'], author:['jh5.cho@samsung.com']" +## [FillRule](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.FillRule.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.FillRule.md tags:['FillRule'], author:['jh5.cho@samsung.com']" +## [GradientPaint](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.GradientPaint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.GradientPaint.md tags:['GradientPaint'], author:['jh5.cho@samsung.com']" +## [ImageDrawable](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ImageDrawable.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.ImageDrawable.md tags:['ImageDrawable'], author:['jh5.cho@samsung.com']" +## [IPaint](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPaint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPaint.md tags:['IPaint'], author:['jh5.cho@samsung.com']" +## [IPath](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPath.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.IPath.md tags:['IPath'], author:['jh5.cho@samsung.com']" +## [LinearGradientPaint](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LinearGradientPaint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LinearGradientPaint.md tags:['LinearGradientPaint'], author:['jh5.cho@samsung.com']" +## [LineTo](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LineTo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.LineTo.md tags:['LineTo'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Primitives2D](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.md tags:['Tizen.UI.Primitives2D'], author:['jh5.cho@samsung.com']" +## [MoveTo](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.MoveTo.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.MoveTo.md tags:['MoveTo'], author:['jh5.cho@samsung.com']" +## [Path](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Path.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Path.md tags:['Path'], author:['jh5.cho@samsung.com']" +## [RadialGradientPaint](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RadialGradientPaint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RadialGradientPaint.md tags:['RadialGradientPaint'], author:['jh5.cho@samsung.com']" +## [Rectangle](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Rectangle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Rectangle.md tags:['Rectangle'], author:['jh5.cho@samsung.com']" +## [RoundRectangle](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RoundRectangle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.RoundRectangle.md tags:['RoundRectangle'], author:['jh5.cho@samsung.com']" +## [Shape](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Shape.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.Shape.md tags:['Shape'], author:['jh5.cho@samsung.com']" +## [SolidPaint](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SolidPaint.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SolidPaint.md tags:['SolidPaint'], author:['jh5.cho@samsung.com']" +## [SpreadType](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SpreadType.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.SpreadType.md tags:['SpreadType'], author:['jh5.cho@samsung.com']" +## [StrokeCap](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeCap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeCap.md tags:['StrokeCap'], author:['jh5.cho@samsung.com']" +## [StrokeJoin](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeJoin.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.StrokeJoin.md tags:['StrokeJoin'], author:['jh5.cho@samsung.com']" +## [VectorView](Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.VectorView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Primitives2D/Tizen.UI.Primitives2D.VectorView.md tags:['VectorView'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Scene3D]() +## [Animatable3DPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animatable3DPropertyValue_T_.md tags:['Animatable3DPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [Animation3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animation3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Animation3D.md tags:['Animation3D'], author:['jh5.cho@samsung.com']" +## [Camera](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Camera.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Camera.md tags:['Camera'], author:['jh5.cho@samsung.com']" +## [CameraExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.CameraExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CameraExtensions.md tags:['CameraExtensions'], author:['jh5.cho@samsung.com']" +## [CustomPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.CustomPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.CustomPropertyValue_T_.md tags:['CustomPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [FieldOfViewPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.FieldOfViewPropertyValue_T_.md tags:['FieldOfViewPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [IMotionData](Tizen.UI.Scene3D/Tizen.UI.Scene3D.IMotionData.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.IMotionData.md tags:['IMotionData'], author:['jh5.cho@samsung.com']" +## [Light](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Light.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Light.md tags:['Light'], author:['jh5.cho@samsung.com']" +## [Material](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Material.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Material.md tags:['Material'], author:['jh5.cho@samsung.com']" +## [MaterialAlphaMode](Tizen.UI.Scene3D/Tizen.UI.Scene3D.MaterialAlphaMode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MaterialAlphaMode.md tags:['MaterialAlphaMode'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Scene3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.md tags:['Tizen.UI.Scene3D'], author:['jh5.cho@samsung.com']" +## [Model3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3D.md tags:['Model3D'], author:['jh5.cho@samsung.com']" +## [Model3DExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3DExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Model3DExtensions.md tags:['Model3DExtensions'], author:['jh5.cho@samsung.com']" +## [ModelNode](Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelNode.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelNode.md tags:['ModelNode'], author:['jh5.cho@samsung.com']" +## [ModelPrimitive](Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelPrimitive.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ModelPrimitive.md tags:['ModelPrimitive'], author:['jh5.cho@samsung.com']" +## [MotionData](Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData.md tags:['MotionData'], author:['jh5.cho@samsung.com']" +## [MotionData_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionData_T_.md tags:['MotionData_T_'], author:['jh5.cho@samsung.com']" +## [MotionDataSet](Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionDataSet.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionDataSet.md tags:['MotionDataSet'], author:['jh5.cho@samsung.com']" +## [MotionIndex](Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionIndex.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.MotionIndex.md tags:['MotionIndex'], author:['jh5.cho@samsung.com']" +## [NativeHandle.AnimationHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.AnimationHandle.md tags:['NativeHandle.AnimationHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.CameraHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.CameraHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.CameraHandle.md tags:['NativeHandle.CameraHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.MaterialHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MaterialHandle.md tags:['NativeHandle.MaterialHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.md tags:['NativeHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.ModelNodeHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelNodeHandle.md tags:['NativeHandle.ModelNodeHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.ModelPrimitiveHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.ModelPrimitiveHandle.md tags:['NativeHandle.ModelPrimitiveHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.MotionDataHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionDataHandle.md tags:['NativeHandle.MotionDataHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.MotionIndexHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionIndexHandle.md tags:['NativeHandle.MotionIndexHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.MotionValueHandle](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.MotionValueHandle.md tags:['NativeHandle.MotionValueHandle'], author:['jh5.cho@samsung.com']" +## [NativeHandle.PropertyValueHandleExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.NativeHandle.PropertyValueHandleExtensions.md tags:['NativeHandle.PropertyValueHandleExtensions'], author:['jh5.cho@samsung.com']" +## [OpacityPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.OpacityPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OpacityPropertyValue_T_.md tags:['OpacityPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [OrthographicSizePropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.OrthographicSizePropertyValue_T_.md tags:['OrthographicSizePropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [Panel](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Panel.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Panel.md tags:['Panel'], author:['jh5.cho@samsung.com']" +## [Point3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Point3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Point3D.md tags:['Point3D'], author:['jh5.cho@samsung.com']" +## [Position3DPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Position3DPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Position3DPropertyValue_T_.md tags:['Position3DPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [ProjectionDirection](Tizen.UI.Scene3D/Tizen.UI.Scene3D.ProjectionDirection.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ProjectionDirection.md tags:['ProjectionDirection'], author:['jh5.cho@samsung.com']" +## [Quaternion](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Quaternion.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Quaternion.md tags:['Quaternion'], author:['jh5.cho@samsung.com']" +## [QuaternionExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.QuaternionExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.QuaternionExtensions.md tags:['QuaternionExtensions'], author:['jh5.cho@samsung.com']" +## [Rotation3DPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Rotation3DPropertyValue_T_.md tags:['Rotation3DPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [Scale3DPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scale3DPropertyValue_T_.md tags:['Scale3DPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [Scene3DView](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scene3DView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Scene3DView.md tags:['Scene3DView'], author:['jh5.cho@samsung.com']" +## [SceneObject](Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObject.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObject.md tags:['SceneObject'], author:['jh5.cho@samsung.com']" +## [SceneObjectExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectExtensions.md tags:['SceneObjectExtensions'], author:['jh5.cho@samsung.com']" +## [SceneObjectGroup_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectGroup_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.SceneObjectGroup_T_.md tags:['SceneObjectGroup_T_'], author:['jh5.cho@samsung.com']" +## [Size3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3D.md tags:['Size3D'], author:['jh5.cho@samsung.com']" +## [Size3DPropertyValue_T_](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3DPropertyValue_T_.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Size3DPropertyValue_T_.md tags:['Size3DPropertyValue_T_'], author:['jh5.cho@samsung.com']" +## [TouchExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.TouchExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TouchExtensions.md tags:['TouchExtensions'], author:['jh5.cho@samsung.com']" +## [TransformTypes](Tizen.UI.Scene3D/Tizen.UI.Scene3D.TransformTypes.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.TransformTypes.md tags:['TransformTypes'], author:['jh5.cho@samsung.com']" +## [Vector3D](Tizen.UI.Scene3D/Tizen.UI.Scene3D.Vector3D.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.Vector3D.md tags:['Vector3D'], author:['jh5.cho@samsung.com']" +## [ViewExtensions](Tizen.UI.Scene3D/Tizen.UI.Scene3D.ViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Scene3D/Tizen.UI.Scene3D.ViewExtensions.md tags:['ViewExtensions'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Skia]() +## [CustomRenderingView](Tizen.UI.Skia/Tizen.UI.Skia.CustomRenderingView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.CustomRenderingView.md tags:['CustomRenderingView'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Skia](Tizen.UI.Skia/Tizen.UI.Skia.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.md tags:['Tizen.UI.Skia'], author:['jh5.cho@samsung.com']" +## [SKCanvasView](Tizen.UI.Skia/Tizen.UI.Skia.SKCanvasView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKCanvasView.md tags:['SKCanvasView'], author:['jh5.cho@samsung.com']" +## [SKPaintSurfaceEventArgs](Tizen.UI.Skia/Tizen.UI.Skia.SKPaintSurfaceEventArgs.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Skia/Tizen.UI.Skia.SKPaintSurfaceEventArgs.md tags:['SKPaintSurfaceEventArgs'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Visuals]() +## [ColorVisual](Tizen.UI.Visuals/Tizen.UI.Visuals.ColorVisual.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ColorVisual.md tags:['ColorVisual'], author:['jh5.cho@samsung.com']" +## [ImageVisual](Tizen.UI.Visuals/Tizen.UI.Visuals.ImageVisual.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ImageVisual.md tags:['ImageVisual'], author:['jh5.cho@samsung.com']" +## [Internal.ColorVisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ColorVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ColorVisualMap.md tags:['Internal.ColorVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal.ImageVisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ImageVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.ImageVisualMap.md tags:['Internal.ImageVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.md tags:['Internal'], author:['jh5.cho@samsung.com']" +## [Internal.NPatchVisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.NPatchVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.NPatchVisualMap.md tags:['Internal.NPatchVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal.RoundedVisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.RoundedVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.RoundedVisualMap.md tags:['Internal.RoundedVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal.TextVisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.TextVisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.TextVisualMap.md tags:['Internal.TextVisualMap'], author:['jh5.cho@samsung.com']" +## [Internal.VisualMap](Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.VisualMap.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.Internal.VisualMap.md tags:['Internal.VisualMap'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.Visuals](Tizen.UI.Visuals/Tizen.UI.Visuals.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.md tags:['Tizen.UI.Visuals'], author:['jh5.cho@samsung.com']" +## [NPatchVisual](Tizen.UI.Visuals/Tizen.UI.Visuals.NPatchVisual.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.NPatchVisual.md tags:['NPatchVisual'], author:['jh5.cho@samsung.com']" +## [RoundedVisual](Tizen.UI.Visuals/Tizen.UI.Visuals.RoundedVisual.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.RoundedVisual.md tags:['RoundedVisual'], author:['jh5.cho@samsung.com']" +## [ShadowExtensions](Tizen.UI.Visuals/Tizen.UI.Visuals.ShadowExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ShadowExtensions.md tags:['ShadowExtensions'], author:['jh5.cho@samsung.com']" +## [TextVisual](Tizen.UI.Visuals/Tizen.UI.Visuals.TextVisual.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TextVisual.md tags:['TextVisual'], author:['jh5.cho@samsung.com']" +## [TransformFlags](Tizen.UI.Visuals/Tizen.UI.Visuals.TransformFlags.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.TransformFlags.md tags:['TransformFlags'], author:['jh5.cho@samsung.com']" +## [ViewExtensions](Tizen.UI.Visuals/Tizen.UI.Visuals.ViewExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.ViewExtensions.md tags:['ViewExtensions'], author:['jh5.cho@samsung.com']" +## [VisualAlign](Tizen.UI.Visuals/Tizen.UI.Visuals.VisualAlign.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualAlign.md tags:['VisualAlign'], author:['jh5.cho@samsung.com']" +## [VisualManager](Tizen.UI.Visuals/Tizen.UI.Visuals.VisualManager.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualManager.md tags:['VisualManager'], author:['jh5.cho@samsung.com']" +## [VisualObject](Tizen.UI.Visuals/Tizen.UI.Visuals.VisualObject.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Visuals/Tizen.UI.Visuals.VisualObject.md tags:['VisualObject'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.Widget]() +## [Tizen.UI.Widget](Tizen.UI.Widget/Tizen.UI.Widget.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.md tags:['Tizen.UI.Widget'], author:['jh5.cho@samsung.com']" +## [Widget](Tizen.UI.Widget/Tizen.UI.Widget.Widget.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.Widget.md tags:['Widget'], author:['jh5.cho@samsung.com']" +## [WidgetApplication](Tizen.UI.Widget/Tizen.UI.Widget.WidgetApplication.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.Widget/Tizen.UI.Widget.WidgetApplication.md tags:['WidgetApplication'], author:['jh5.cho@samsung.com']" +# [Tizen.UI.WindowBorder]() +## [BorderView.BorderViewModel](Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.BorderViewModel.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.BorderViewModel.md tags:['BorderView.BorderViewModel'], author:['jh5.cho@samsung.com']" +## [BorderView](Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.BorderView.md tags:['BorderView'], author:['jh5.cho@samsung.com']" +## [IWindowBorderProvider](Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.IWindowBorderProvider.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.IWindowBorderProvider.md tags:['IWindowBorderProvider'], author:['jh5.cho@samsung.com']" +## [Tizen.UI.WindowBorder](Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.md tags:['Tizen.UI.WindowBorder'], author:['jh5.cho@samsung.com']" +## [WindowExtensions](Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.WindowExtensions.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/Tizen.UI.WindowBorder/Tizen.UI.WindowBorder.WindowExtensions.md tags:['WindowExtensions'], author:['jh5.cho@samsung.com']" +# [TizenX.ZLog]() +## [Log](TizenX.ZLog/TizenX.ZLog.Log.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.Log.md tags:['Log'], author:['jh5.cho@samsung.com']" +## [TizenX.ZLog](TizenX.ZLog/TizenX.ZLog.md) "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/api/TizenX.ZLog/TizenX.ZLog.md tags:['TizenX.ZLog'], author:['jh5.cho@samsung.com']" diff --git a/docs/extensions/tizenx/guides/toc.md b/docs/extensions/tizenx/guides/toc.md index e2d006e4c7..937a0e62c9 100644 --- a/docs/extensions/tizenx/guides/toc.md +++ b/docs/extensions/tizenx/guides/toc.md @@ -1,20 +1,20 @@ -# [Overview](overview.md "source:https://github.com/Samung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/overview.md tags:['TizenX', 'extension', 'library', 'Tizen.UI', 'TizenX.ZLog'], authors:['jh5.cho@samsung.com']") +# [Overview](overview.md "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/overview.md tags:['TizenX', 'extension', 'library', 'Tizen.UI', 'TizenX.ZLog'], authors:['jh5.cho@samsung.com']") # [Tizen.UI]() -## [Overview](tizen-ui/overview.md "source:https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/overview.md tags:['TizenX', 'Tizen.UI']") -## [Getting Started](tizen-ui/getting-started.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/getting-started.md tags:['TizenX', 'Tizen.UI'], authors:['jh5.cho@samsung.com']") +## [Overview](tizen-ui/overview.md "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/overview.md tags:['TizenX', 'Tizen.UI']") +## [Getting Started](tizen-ui/getting-started.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/getting-started.md tags:['TizenX', 'Tizen.UI'], authors:['jh5.cho@samsung.com']") ## [Foundations]() -### [Unit & Scale](tizen-ui/foundations/unit_and_scale.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/foundations/unit_and_scale.md tags:['Tizen.UI', 'Unit', 'Scale'], authors:['jh5.cho@samsung.com']") -### [Touch & Gesture](tizen-ui/foundations/touch_and_gesture.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/foundations/touch_and_gesture.md tags:['Tizen.UI', 'Touch', 'Gesture'], authors:['jh5.cho@samsung.com']") -### [Scroll & List](tizen-ui/foundations/scroll_and_list.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/foundations/scroll_and_list.md tags:['Tizen.UI', 'Scroll', 'List'], authors:['jh5.cho@samsung.com']") -### [Navigation](tizen-ui/foundations/navigation.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/foundations/navigation.md tags:['Tizen.UI', 'Navigation'], authors:['jh5.cho@samsung.com']") -### [State Management](tizen-ui/foundations/state_management.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/foundations/state_management.md tags:['Tizen.UI', 'State'], authors:['jh5.cho@samsung.com']") +### [Unit & Scale](tizen-ui/foundations/unit_and_scale.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/foundations/unit_and_scale.md tags:['Tizen.UI', 'Unit', 'Scale'], authors:['jh5.cho@samsung.com']") +### [Touch & Gesture](tizen-ui/foundations/touch_and_gesture.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/foundations/touch_and_gesture.md tags:['Tizen.UI', 'Touch', 'Gesture'], authors:['jh5.cho@samsung.com']") +### [Scroll & List](tizen-ui/foundations/scroll_and_list.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/foundations/scroll_and_list.md tags:['Tizen.UI', 'Scroll', 'List'], authors:['jh5.cho@samsung.com']") +### [Navigation](tizen-ui/foundations/navigation.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/foundations/navigation.md tags:['Tizen.UI', 'Navigation'], authors:['jh5.cho@samsung.com']") +### [State Management](tizen-ui/foundations/state_management.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/foundations/state_management.md tags:['Tizen.UI', 'State'], authors:['jh5.cho@samsung.com']") ## [Layouts]() -### [Overview](tizen-ui/layouts/overview.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/layouts/overview.md tags:['Tizen.UI', 'Layout'], authors:['jh5.cho@samsung.com']") -### [AbsoluteLayout](tizen-ui/layouts/aboluteLayout.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/layouts/aboluteLayout.md tags:['Tizen.UI', 'Layout', 'AboluteLayout'], authors:['jh5.cho@samsung.com']") -### [Grid](tizen-ui/layouts/grid.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/layouts/grid.md tags:['Tizen.UI', 'Layout', 'Grid'], authors:['jh5.cho@samsung.com']") -### [HStack&VStack](tizen-ui/layouts/stack.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/layouts/stack.md tags:['Tizen.UI', 'Layout', 'Stack', 'HStack', 'VStack'], authors:['jh5.cho@samsung.com']") -## [C# Markup](tizen-ui/csharp_markup.md "source: https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizen-ui/csharp_markup.md tags:['Tizen.UI', 'Markup'], authors:['jh5.cho@samsung.com']") +### [Overview](tizen-ui/layouts/overview.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/layouts/overview.md tags:['Tizen.UI', 'Layout'], authors:['jh5.cho@samsung.com']") +### [AbsoluteLayout](tizen-ui/layouts/aboluteLayout.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/layouts/aboluteLayout.md tags:['Tizen.UI', 'Layout', 'AboluteLayout'], authors:['jh5.cho@samsung.com']") +### [Grid](tizen-ui/layouts/grid.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/layouts/grid.md tags:['Tizen.UI', 'Layout', 'Grid'], authors:['jh5.cho@samsung.com']") +### [HStack&VStack](tizen-ui/layouts/stack.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/layouts/stack.md tags:['Tizen.UI', 'Layout', 'Stack', 'HStack', 'VStack'], authors:['jh5.cho@samsung.com']") +## [C# Markup](tizen-ui/csharp_markup.md "source: https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizen-ui/csharp_markup.md tags:['Tizen.UI', 'Markup'], authors:['jh5.cho@samsung.com']") # [TizenX.ZLog]() -## [Overview](tizenx-zlog/overview.md "source:https://github.com/Samsung/tizen-docs/blob/add-tizenx/docs/extensions/tizenx/guides/tizenx-zlog/overview.md tags:['TizenX', 'TizenX.ZLog'], authors:['jh5.cho@samsung.com']") \ No newline at end of file +## [Overview](tizenx-zlog/overview.md "source:https://github.com/Samsung/tizen-docs/blob/master/docs/extensions/tizenx/guides/tizenx-zlog/overview.md tags:['TizenX', 'TizenX.ZLog'], authors:['jh5.cho@samsung.com']") \ No newline at end of file