Class View
Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
View is the base class for all views.
public class View : Container, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
- Inheritance
- Derived
- Implements
-
System.IDisposable
Constructors
View SourceView()
Creates a new instance of a view.
Declaration
public View()
View(bool)
Create a new instance of a View with setting the status of shown or hidden.
Declaration
public View(bool shown)
Parameters
Type | Name | Description |
---|---|---|
bool | shown | false : Not displayed (hidden), true : displayed (shown) |
View(ViewAccessibilityMode)
Declaration
public View(View.ViewAccessibilityMode accessibilityMode)
Parameters
Type | Name | Description |
---|---|---|
View.ViewAccessibilityMode | accessibilityMode |
View(ViewStyle)
Declaration
public View(ViewStyle viewStyle)
Parameters
Type | Name | Description |
---|---|---|
ViewStyle | viewStyle |
Fields
View SourceAccessibilityActivateAction
Declaration
protected static readonly string AccessibilityActivateAction
Field Value
Type | Description |
---|---|
string |
AccessibilityDescriptionProperty
AccessibilityDescriptionProperty
Declaration
public static readonly BindableProperty AccessibilityDescriptionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AccessibilityHiddenProperty
AccessibilityHiddenProperty
Declaration
public static readonly BindableProperty AccessibilityHiddenProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AccessibilityHighlightableProperty
AccessibilityHighlightableProperty
Declaration
public static readonly BindableProperty AccessibilityHighlightableProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AccessibilityNameProperty
AccessibilityNameProperty
Declaration
public static readonly BindableProperty AccessibilityNameProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AccessibilityReadingCancelledAction
Declaration
protected static readonly string AccessibilityReadingCancelledAction
Field Value
Type | Description |
---|---|
string |
AccessibilityReadingPausedAction
Declaration
protected static readonly string AccessibilityReadingPausedAction
Field Value
Type | Description |
---|---|
string |
AccessibilityReadingResumedAction
Declaration
protected static readonly string AccessibilityReadingResumedAction
Field Value
Type | Description |
---|---|
string |
AccessibilityReadingSkippedAction
Declaration
protected static readonly string AccessibilityReadingSkippedAction
Field Value
Type | Description |
---|---|
string |
AccessibilityReadingStoppedAction
Declaration
protected static readonly string AccessibilityReadingStoppedAction
Field Value
Type | Description |
---|---|
string |
AccessibilityRoleProperty
AccessibilityRoleProperty
Declaration
public static readonly BindableProperty AccessibilityRoleProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AccessibilityTranslationDomainProperty
AccessibilityTranslationDomainProperty
Declaration
public static readonly BindableProperty AccessibilityTranslationDomainProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AlignSelfProperty
AlignSelfProperty
Declaration
public static readonly BindableProperty AlignSelfProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AllowOnlyOwnTouchProperty
AllowOnlyOwnTouchProperty
Declaration
public static readonly BindableProperty AllowOnlyOwnTouchProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AnchorPointProperty
AnchorPointProperty
Declaration
public static readonly BindableProperty AnchorPointProperty
Field Value
Type | Description |
---|---|
BindableProperty |
AutomationIdProperty
AutomationIdProperty
Declaration
public static readonly BindableProperty AutomationIdProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundColorProperty
BackgroundColorProperty
Declaration
public static readonly BindableProperty BackgroundColorProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundImageBorderProperty
BackgroundImageBorderProperty
Declaration
public static readonly BindableProperty BackgroundImageBorderProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundImageProperty
BackgroundImageProperty
Declaration
public static readonly BindableProperty BackgroundImageProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundImageSynchronosLoadingProperty
BackgroundImageSynchronosLoadingProperty
Declaration
public static readonly BindableProperty BackgroundImageSynchronosLoadingProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundImageSynchronousLoadingProperty
BackgroundImageSynchronousLoadingProperty
Declaration
public static readonly BindableProperty BackgroundImageSynchronousLoadingProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BackgroundProperty
BackgroundProperty
Declaration
public static readonly BindableProperty BackgroundProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BlendEquationProperty
BlendEquationProperty
Declaration
public static readonly BindableProperty BlendEquationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BorderlineColorProperty
BorderlineColor Property
Declaration
public static readonly BindableProperty BorderlineColorProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BorderlineOffsetProperty
BorderlineOffset Property
Declaration
public static readonly BindableProperty BorderlineOffsetProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BorderlineWidthProperty
BorderlineWidth Property
Declaration
public static readonly BindableProperty BorderlineWidthProperty
Field Value
Type | Description |
---|---|
BindableProperty |
BoxShadowProperty
Shadow Property
Declaration
public static readonly BindableProperty BoxShadowProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CellHorizontalAlignmentProperty
CellHorizontalAlignmentProperty
Declaration
public static readonly BindableProperty CellHorizontalAlignmentProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CellIndexProperty
CellIndexProperty
Declaration
public static readonly BindableProperty CellIndexProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CellVerticalAlignmentProperty
CellVerticalAlignmentProperty
Declaration
public static readonly BindableProperty CellVerticalAlignmentProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ClippingModeProperty
ClippingModeProperty
Declaration
public static readonly BindableProperty ClippingModeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ClockwiseFocusableViewProperty
ClockwiseFocusableViewProperty
Declaration
public static readonly BindableProperty ClockwiseFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ColorBlueProperty
ColorBlueProperty
Declaration
public static readonly BindableProperty ColorBlueProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ColorGreenProperty
ColorGreenProperty
Declaration
public static readonly BindableProperty ColorGreenProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ColorProperty
ColorProperty
Declaration
public static readonly BindableProperty ColorProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ColorRedProperty
ColorRedProperty
Declaration
public static readonly BindableProperty ColorRedProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ColumnSpanProperty
ColumnSpanProperty
Declaration
public static readonly BindableProperty ColumnSpanProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CornerRadiusPolicyProperty
CornerRadiusPolicy Property
Declaration
public static readonly BindableProperty CornerRadiusPolicyProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CornerRadiusProperty
CornerRadius Property
Declaration
public static readonly BindableProperty CornerRadiusProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CounterClockwiseFocusableViewProperty
CounterClockwiseFocusableViewProperty
Declaration
public static readonly BindableProperty CounterClockwiseFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
DispatchHoverMotionProperty
DispatchHoverMotionProperty
Declaration
public static readonly BindableProperty DispatchHoverMotionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
DispatchKeyEventsProperty
DispatchKeyEventsProperty
Declaration
public static readonly BindableProperty DispatchKeyEventsProperty
Field Value
Type | Description |
---|---|
BindableProperty |
DispatchTouchMotionProperty
DispatchTouchMotionProperty
Declaration
public static readonly BindableProperty DispatchTouchMotionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
DownFocusableViewProperty
DownFocusableViewProperty
Declaration
public static readonly BindableProperty DownFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
DrawModeProperty
DrawModeProperty
Declaration
public static readonly BindableProperty DrawModeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
EnableControlStatePropagationProperty
EnableControlStatePropagationProperty
Declaration
public static readonly BindableProperty EnableControlStatePropagationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
EnableControlStateProperty
EnableControlState property
Declaration
public static readonly BindableProperty EnableControlStateProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ExcludeLayoutingProperty
ExcludeLayoutingProperty
Declaration
public static readonly BindableProperty ExcludeLayoutingProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FlexMarginProperty
FlexMarginProperty
Declaration
public static readonly BindableProperty FlexMarginProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FlexProperty
FlexProperty
Declaration
public static readonly BindableProperty FlexProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FocusableChildrenProperty
FocusableChildrenProperty
Declaration
public static readonly BindableProperty FocusableChildrenProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FocusableInTouchProperty
FocusableInTouchProperty
Declaration
public static readonly BindableProperty FocusableInTouchProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FocusableProperty
FocusableProperty
Declaration
public static readonly BindableProperty FocusableProperty
Field Value
Type | Description |
---|---|
BindableProperty |
GrabTouchAfterLeaveProperty
GrabTouchAfterLeaveProperty
Declaration
public static readonly BindableProperty GrabTouchAfterLeaveProperty
Field Value
Type | Description |
---|---|
BindableProperty |
HeightForWidthProperty
HeightForWidthProperty
Declaration
public static readonly BindableProperty HeightForWidthProperty
Field Value
Type | Description |
---|---|
BindableProperty |
HeightResizePolicyProperty
HeightResizePolicyProperty
Declaration
public static readonly BindableProperty HeightResizePolicyProperty
Field Value
Type | Description |
---|---|
BindableProperty |
HeightSpecificationProperty
HeightSpecificationProperty
Declaration
public static readonly BindableProperty HeightSpecificationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ImageShadowProperty
ImageShadow Property
Declaration
public static readonly BindableProperty ImageShadowProperty
Field Value
Type | Description |
---|---|
BindableProperty |
InheritLayoutDirectionProperty
InheritLayoutDirectionProperty
Declaration
public static readonly BindableProperty InheritLayoutDirectionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
InheritOrientationProperty
InheritOrientationProperty
Declaration
public static readonly BindableProperty InheritOrientationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
InheritPositionProperty
InheritPositionProperty
Declaration
public static readonly BindableProperty InheritPositionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
InheritScaleProperty
InheritScaleProperty
Declaration
public static readonly BindableProperty InheritScaleProperty
Field Value
Type | Description |
---|---|
BindableProperty |
IsEnabledProperty
IsEnabledProperty
Declaration
public static readonly BindableProperty IsEnabledProperty
Field Value
Type | Description |
---|---|
BindableProperty |
KeyInputFocusProperty
KeyInputFocusProperty
Declaration
public static readonly BindableProperty KeyInputFocusProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LayoutDirectionProperty
LayoutDirectionProperty
Declaration
public static readonly BindableProperty LayoutDirectionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LayoutProperty
LayoutProperty
Declaration
public static readonly BindableProperty LayoutProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LayoutTransitionProperty
LayoutTransitionProperty
Declaration
public static readonly BindableProperty LayoutTransitionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LeaveRequiredProperty
LeaveRequiredProperty
Declaration
public static readonly BindableProperty LeaveRequiredProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LeftFocusableViewProperty
LeftFocusableViewProperty
Declaration
public static readonly BindableProperty LeftFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
MarginProperty
MarginProperty
Declaration
public static readonly BindableProperty MarginProperty
Field Value
Type | Description |
---|---|
BindableProperty |
MaximumSizeProperty
MaximumSizeProperty
Declaration
public static readonly BindableProperty MaximumSizeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
MinimumSizeProperty
MinimumSizeProperty
Declaration
public static readonly BindableProperty MinimumSizeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
NameProperty
NameProperty
Declaration
public static readonly BindableProperty NameProperty
Field Value
Type | Description |
---|---|
BindableProperty |
OpacityProperty
OpacityProperty
Declaration
public static readonly BindableProperty OpacityProperty
Field Value
Type | Description |
---|---|
BindableProperty |
OrientationProperty
OrientationProperty
Declaration
public static readonly BindableProperty OrientationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PaddingEXProperty
PaddingEXProperty
Declaration
public static readonly BindableProperty PaddingEXProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PaddingProperty
PaddingProperty
Declaration
public static readonly BindableProperty PaddingProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ParentOriginProperty
ParentOriginProperty
Declaration
public static readonly BindableProperty ParentOriginProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PivotPointProperty
PivotPointProperty
Declaration
public static readonly BindableProperty PivotPointProperty
Field Value
Type | Description |
---|---|
BindableProperty |
Position2DProperty
Position2DProperty
Declaration
public static readonly BindableProperty Position2DProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionProperty
PositionProperty
Declaration
public static readonly BindableProperty PositionProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionUsesAnchorPointProperty
PositionUsesAnchorPointProperty
Declaration
public static readonly BindableProperty PositionUsesAnchorPointProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionUsesPivotPointProperty
PositionUsesPivotPointProperty
Declaration
public static readonly BindableProperty PositionUsesPivotPointProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionXProperty
PositionXProperty
Declaration
public static readonly BindableProperty PositionXProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionYProperty
PositionYProperty
Declaration
public static readonly BindableProperty PositionYProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PositionZProperty
PositionZProperty
Declaration
public static readonly BindableProperty PositionZProperty
Field Value
Type | Description |
---|---|
BindableProperty |
PropagatableControlStatesProperty
PropagatableControlStatesProperty
Declaration
public static readonly BindableProperty PropagatableControlStatesProperty
Field Value
Type | Description |
---|---|
BindableProperty |
RightFocusableViewProperty
RightFocusableViewProperty
Declaration
public static readonly BindableProperty RightFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
RowSpanProperty
RowSpanProperty
Declaration
public static readonly BindableProperty RowSpanProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ScaleProperty
ScaleProperty
Declaration
public static readonly BindableProperty ScaleProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ScaleXProperty
ScaleXProperty
Declaration
public static readonly BindableProperty ScaleXProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ScaleYProperty
ScaleYProperty
Declaration
public static readonly BindableProperty ScaleYProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ScaleZProperty
ScaleZProperty
Declaration
public static readonly BindableProperty ScaleZProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SensitiveProperty
SensitiveProperty
Declaration
public static readonly BindableProperty SensitiveProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SiblingOrderProperty
SiblingOrderProperty
Declaration
public static readonly BindableProperty SiblingOrderProperty
Field Value
Type | Description |
---|---|
BindableProperty |
Size2DProperty
Size2DProperty
Declaration
public static readonly BindableProperty Size2DProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SizeHeightProperty
SizeHeightProperty
Declaration
public static readonly BindableProperty SizeHeightProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SizeModeFactorProperty
SizeModeFactorProperty
Declaration
public static readonly BindableProperty SizeModeFactorProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SizeProperty
SizeProperty
Declaration
public static readonly BindableProperty SizeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SizeScalePolicyProperty
SizeScalePolicyProperty
Declaration
public static readonly BindableProperty SizeScalePolicyProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SizeWidthProperty
SizeWidthProperty
Declaration
public static readonly BindableProperty SizeWidthProperty
Field Value
Type | Description |
---|---|
BindableProperty |
StateProperty
StateProperty
Declaration
public static readonly BindableProperty StateProperty
Field Value
Type | Description |
---|---|
BindableProperty |
StyleNameProperty
StyleNameProperty (DALi json)
Declaration
public static readonly BindableProperty StyleNameProperty
Field Value
Type | Description |
---|---|
BindableProperty |
SubStateProperty
SubStateProperty
Declaration
public static readonly BindableProperty SubStateProperty
Field Value
Type | Description |
---|---|
BindableProperty |
ThemeChangeSensitiveProperty
ThemeChangeSensitive property
Declaration
public static readonly BindableProperty ThemeChangeSensitiveProperty
Field Value
Type | Description |
---|---|
BindableProperty |
TooltipProperty
TooltipProperty
Declaration
public static readonly BindableProperty TooltipProperty
Field Value
Type | Description |
---|---|
BindableProperty |
TooltipTextProperty
TooltipTextProperty
Declaration
public static readonly BindableProperty TooltipTextProperty
Field Value
Type | Description |
---|---|
BindableProperty |
TouchAreaOffsetProperty
TouchAreaOffsetProperty
Declaration
public static readonly BindableProperty TouchAreaOffsetProperty
Field Value
Type | Description |
---|---|
BindableProperty |
TransitionOptionsProperty
TransitionOptionsProperty
Declaration
public static readonly BindableProperty TransitionOptionsProperty
Field Value
Type | Description |
---|---|
BindableProperty |
UpdateAreaHintProperty
UpdateAreaHintProperty
Declaration
public static readonly BindableProperty UpdateAreaHintProperty
Field Value
Type | Description |
---|---|
BindableProperty |
UpFocusableViewProperty
UpFocusableViewProperty
Declaration
public static readonly BindableProperty UpFocusableViewProperty
Field Value
Type | Description |
---|---|
BindableProperty |
WeightProperty
"DO not use this, that will be deprecated. Use 'View Weight' instead of BindableProperty" This needs to be hidden as inhouse API until all applications using it have been updated. Do not make public.
Declaration
public static readonly BindableProperty WeightProperty
Field Value
Type | Description |
---|---|
BindableProperty |
WidthForHeightProperty
WidthForHeightProperty
Declaration
public static readonly BindableProperty WidthForHeightProperty
Field Value
Type | Description |
---|---|
BindableProperty |
WidthResizePolicyProperty
WidthResizePolicyProperty
Declaration
public static readonly BindableProperty WidthResizePolicyProperty
Field Value
Type | Description |
---|---|
BindableProperty |
WidthSpecificationProperty
WidthSpecificationProperty
Declaration
public static readonly BindableProperty WidthSpecificationProperty
Field Value
Type | Description |
---|---|
BindableProperty |
Properties
View SourceAccessibilityAttributes
Dictionary of accessibility attributes (key-value pairs of strings).
Declaration
public Dictionary<string, string> AccessibilityAttributes { get; }
Property Value
Type | Description |
---|---|
Dictionary<, ><string, string> |
AccessibilityDescription
Gets or sets accessibility description.
Declaration
public string AccessibilityDescription { get; set; }
Property Value
Type | Description |
---|---|
string |
AccessibilityDynamicAttributes
Dictionary of dynamically-evaluated accessibility attributes (key-value pairs of strings).
Declaration
public Dictionary<string, Func<string>> AccessibilityDynamicAttributes { get; }
Property Value
Type | Description |
---|---|
Dictionary<, ><string, Func<><string>> |
AccessibilityHidden
Controls whether the view is hidden from the AT-SPI tree.
Declaration
public bool AccessibilityHidden { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
False by default. Hiding an object means that any AT-SPI clients are not able to see it.
AccessibilityHighlightable
Gets or sets whether the view is highlightable for accessibility or not.
Declaration
public bool AccessibilityHighlightable { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
For views, which intend to receive accessibility highlight focus, this value should be set as true. Otherwise it is set to false by default and the object is omitted in AT-SPI2 navigation.
AccessibilityName
Gets or sets accessibility name.
Declaration
public string AccessibilityName { get; set; }
Property Value
Type | Description |
---|---|
string |
AccessibilityRole
Gets or sets accessibility role.
Declaration
public Role AccessibilityRole { get; set; }
Property Value
Type | Description |
---|---|
Role |
AccessibilitySuppressedEvents
Modifiable collection of suppressed AT-SPI events (D-Bus signals).
Declaration
public AccessibilityEvents AccessibilitySuppressedEvents { get; }
Property Value
Type | Description |
---|---|
AccessibilityEvents |
AccessibilityTranslationDomain
Gets or sets accessibility translation domain.
Declaration
public string AccessibilityTranslationDomain { get; set; }
Property Value
Type | Description |
---|---|
string |
AlignSelf
The Child property of FlexContainer.
The alignment of the flex item along the cross axis, which, if set, overrides the default alignment for all items in the container.
Declaration
public int AlignSelf { get; set; }
Property Value
Type | Description |
---|---|
int |
AliveCount
Gets the number of currently alived View object.
Declaration
public static int AliveCount { get; }
Property Value
Type | Description |
---|---|
int |
AllowOnlyOwnTouch
Whether the view will only receive own touch.
Declaration
public bool AllowOnlyOwnTouch { get; set; }
Property Value
Type | Description |
---|---|
bool | true, if it only receives touches that started from itself. |
AnchorPoint
This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead.
Declaration
public Position AnchorPoint { get; set; }
Property Value
Type | Description |
---|---|
Position |
Remarks
The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
AutomationId
Gets or sets a value that allows the automation framework to find and interact with this element.
Declaration
public string AutomationId { get; set; }
Property Value
Type | Description |
---|---|
string |
Background
The background of view.
Declaration
public PropertyMap Background { get; set; }
Property Value
Type | Description |
---|---|
PropertyMap |
BackgroundColor
The mutually exclusive with "backgroundImage" and "background" type Vector4.
Declaration
public Color BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
Remarks
The property cascade chaining set is not recommended.
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "BackgroundColor", new Color(r, g, b, a));
Examples
This way is recommended for setting the property
var view = new View();
view.BackgroundColor = new Color(0.5f, 0.1f, 0, 1);
This way to set the property is prohibited
view.BackgroundColor.R = 0.5f; //This does not guarantee a proper operation
View Source
BackgroundImage
The mutually exclusive with "backgroundColor" and "background" type Map.
Declaration
public string BackgroundImage { get; set; }
Property Value
Type | Description |
---|---|
string |
BackgroundImageBorder
Get or set the border of background image.
Declaration
public Rectangle BackgroundImageBorder { get; set; }
Property Value
Type | Description |
---|---|
Rectangle |
BackgroundImageSynchronosLoading
Whether to load the BackgroundImage synchronously. If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously. Note: For Normal Quad images only.
Declaration
public bool BackgroundImageSynchronosLoading { get; set; }
Property Value
Type | Description |
---|---|
bool |
BackgroundImageSynchronousLoading
Whether to load the BackgroundImage synchronously. If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously. Note: For Normal Quad images only.
Declaration
public bool BackgroundImageSynchronousLoading { get; set; }
Property Value
Type | Description |
---|---|
bool |
BlendEquation
Determines which blend equation will be used to render renderers of this actor.
Declaration
public BlendEquationType BlendEquation { get; set; }
Property Value
Type | Description |
---|---|
BlendEquationType | blend equation enum currently assigned |
BorderlineColor
The color for the borderline of the View. It is Color.Black by default.
Declaration
public Color BorderlineColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "BorderlineColor", new Color(r, g, b, a));
BorderlineOffset
The Relative offset for the borderline of the View. Recommended range : [-1.0f to 1.0f]. If -1.0f, draw borderline inside of the View. If 1.0f, draw borderline outside of the View. If 0.0f, draw borderline half inside and half outside. It is 0.0f by default.
Declaration
public float BorderlineOffset { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "BorderlineOffset", -1.0f);
BorderlineWidth
The width for the borderline of the View.
Declaration
public float BorderlineWidth { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "BorderlineWidth", 100.0f);
Note that, an image background may not have borderline if it uses the Border property.
BoxShadow
Describes a box shaped shadow drawing for a View. It is null by default.
Declaration
public Shadow BoxShadow { get; set; }
Property Value
Type | Description |
---|---|
Shadow |
Remarks
The mutually exclusive with "ImageShadow".
CellHorizontalAlignment
The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
Declaration
public HorizontalAlignmentType CellHorizontalAlignment { get; set; }
Property Value
Type | Description |
---|---|
HorizontalAlignmentType |
Remarks
View SourceCellIndex
The top-left cell this child occupies, if not set, the first available cell is used.
Declaration
public Vector2 CellIndex { get; set; }
Property Value
Type | Description |
---|---|
Vector2 |
Remarks
The property cascade chaining set is not recommended. Also, this property is for TableView class. Please use the property for the child position of TableView.
Examples
This way is recommended for setting the property
var view = new View();
view.CellIndex = new Vector2(1, 3);
This way to set the property is prohibited
view.CellIndex.X = 1; //This does not guarantee a proper operation
View Source
CellVerticalAlignment
The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
Declaration
public VerticalAlignmentType CellVerticalAlignment { get; set; }
Property Value
Type | Description |
---|---|
VerticalAlignmentType |
Remarks
View SourceChildCount
Get the number of children held by the view.
Declaration
public uint ChildCount { get; }
Property Value
Type | Description |
---|---|
uint |
ClippingMode
Gets or sets the clipping behavior (mode) of it's children.
Declaration
public ClippingModeType ClippingMode { get; set; }
Property Value
Type | Description |
---|---|
ClippingModeType |
ClockwiseFocusableView
The clockwise focusable view by rotary wheel.
This will return null if not set.
This will also return null if the specified clockwise focusable view is not on a window.
Declaration
public View ClockwiseFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
Color
The Color of View. This is an RGBA value. Each RGBA components match as ColorRed, ColorGreen, ColorBlue, and Opacity. This property will multiply the final color of this view. (BackgroundColor, BorderlineColor, BackgroundImage, etc). For example, if view.BackgroundColor = Color.Yellow and view.Color = Color.Purple, this view will shown as Red. Inherient of color value depend on Tizen.NUI.BaseComponents.View.ColorMode.
Declaration
public Color Color { get; set; }
Property Value
Type | Description |
---|---|
Color |
Remarks
Animatable - This property can be animated using Animation
class.
Examples
This way is recommended for setting the property
var view = new View();
view.Color = new Color(0.5f, 0.2f, 0.1f, 0.5f);
This way to set the property is prohibited
view.Color.A = 0.5f; //This does not guarantee a proper operation
View Source
ColorBlue
The Blue component of View.Color.
Declaration
public float ColorBlue { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
ColorGreen
The Green component of View.Color.
Declaration
public float ColorGreen { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
ColorRed
The Red component of View.Color.
Declaration
public float ColorRed { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
ColumnSpan
The number of columns this child occupies, if not set, the default value is 1.
Declaration
public float ColumnSpan { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
View SourceControlState
Get/Set the control state. Note that the ControlState only available for the classes derived from Control. If the classes that are not derived from Control (such as View, ImageView and TextLabel) want to use this system, please set EnableControlState to true.
Declaration
public ControlState ControlState { get; protected set; }
Property Value
Type | Description |
---|---|
ControlState |
CornerRadius
The radius for the rounded corners of the View. This will rounds background and shadow edges. The values in Vector4 are used in clockwise order from top-left to bottom-left : Vector4(top-left-corner, top-right-corner, bottom-right-corner, bottom-left-corner). Each radius will clamp internally to the half of smaller of the view's width or height. Note that, an image background (or shadow) may not have rounded corners if it uses a Border property.
Declaration
public Vector4 CornerRadius { get; set; }
Property Value
Type | Description |
---|---|
Vector4 |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "CornerRadius", new Vector4(10, 10, 10, 10));
CornerRadiusPolicy
Whether the CornerRadius property value is relative (percentage [0.0f to 0.5f] of the view size) or absolute (in world units). It is absolute by default. When the policy is relative, the corner radius is relative to the smaller of the view's width and height.
Declaration
public VisualTransformPolicyType CornerRadiusPolicy { get; set; }
Property Value
Type | Description |
---|---|
VisualTransformPolicyType |
CounterClockwiseFocusableView
The counter clockwise focusable view by rotary wheel.
This will return null if not set.
This will also return null if the specified counter clockwise focusable view is not on a window.
Declaration
public View CounterClockwiseFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
Culled
Get whether the View is culled or not. True means that the View is out of the view frustum.
Declaration
public bool Culled { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Hidden-API (Inhouse-API).
CurrentColor
Retrieve the View's current Color.
Declaration
public Color CurrentColor { get; }
Property Value
Type | Description |
---|---|
Color |
Remarks
The Size, Position, Color, and Scale properties are set in the main thread. Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation). However, CurrentSize, CurrentPosition, CurrentColor, and CurrentScale properties are updated in real time, and users can get the current actual values through them.
CurrentPosition
Retrieves the position of the view. The coordinates are relative to the view's parent.
Declaration
public Position CurrentPosition { get; }
Property Value
Type | Description |
---|---|
Position |
Remarks
The Size, Position, Color, and Scale properties are set in the main thread. Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation). However, CurrentSize, CurrentPosition, CurrentColor, and CurrentScale properties are updated in real time, and users can get the current actual values through them.
CurrentScale
Retrieve the current scale factor applied to the View.
Declaration
public Vector3 CurrentScale { get; }
Property Value
Type | Description |
---|---|
Vector3 |
Remarks
The Size, Position, Color, and Scale properties are set in the main thread. Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation). However, CurrentSize, CurrentPosition, CurrentColor, and CurrentScale properties are updated in real time, and users can get the current actual values through them.
CurrentSize
Retrieves the size of the view. The coordinates are relative to the view's parent.
Declaration
public Size2D CurrentSize { get; }
Property Value
Type | Description |
---|---|
Size2D |
Remarks
The Size, Position, Color, and Scale properties are set in the main thread. Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation). However, CurrentSize, CurrentPosition, CurrentColor, and CurrentScale properties are updated in real time, and users can get the current actual values through them.
DisallowInterceptTouchEvent
If child view doesn't want the parent's view to intercept the touch, you can set it to true. for example : parent.Add(child); parent.InterceptTouchEvent += OnInterceptTouchEvent; View view = child.GetParent() as View; view.DisallowInterceptTouchEvent = true; This prevents the parent from intercepting touch.
Declaration
public bool DisallowInterceptTouchEvent { get; set; }
Property Value
Type | Description |
---|---|
bool |
DisallowInterceptWheelEvent
If child view doesn't want the parent's view to intercept the wheel event, you can set it to true. for example : parent.Add(child); parent.InterceptWheelEvent += OnInterceptWheelEvent; View view = child.GetParent() as View; view.DisallowInterceptWheelEvent = true; This prevents the parent from intercepting wheel event.
Declaration
public bool DisallowInterceptWheelEvent { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchGestureEvents
Gets or sets the status of whether the view should emit Gesture event signals. If a View's DispatchGestureEvents is set to false, then itself and parents will not receive all gesture event signals. The itself and parents does not receive tap, pinch, pan, rotation, or longpress gestures.
Declaration
public bool DispatchGestureEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchHoverEvents
Gets or sets the status of whether hover events can be dispatched. If a View's DispatchHoverEvents is set to false, then it's can not will receive hover event and parents will not receive a hover event signal either. This works without adding a HoverEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit hover event.
Declaration
public bool DispatchHoverEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchHoverMotion
Gets or sets the status of whether motion event of Hover can be dispatched. If a View's DispatchHoverMotion is set to false, then it's can not will receive motion event of HoverEvent.
Declaration
public bool DispatchHoverMotion { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchKeyEvents
Gets or sets the status of whether the view should emit key event signals. If a View's DispatchKeyEvents is set to false, then itself and parents will not receive key event signals.
Declaration
public bool DispatchKeyEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchParentGestureEvents
Gets or sets the status of whether the view should emit Gesture event signals. If a View's DispatchParentGestureEvents is set to false, then parents will not receive all gesture event signals. The parents does not receive tap, pinch, pan, rotation, or longpress gestures.
Declaration
public bool DispatchParentGestureEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchParentHoverEvents
Gets or sets the status of whether hover events can be dispatched to the parent. If a View's DispatchParentHoverEvents is set to false, then parents will not receive a hover event signal either. This works without adding a HoverEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit hover event.
Declaration
public bool DispatchParentHoverEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchParentTouchEvents
Gets or sets the status of whether touch events can be dispatched to the parent. If a View's DispatchParentTouchEvents is set to false, then parents will not receive a touch event signal either. This works without adding a TouchEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit touch event.
Declaration
public bool DispatchParentTouchEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchParentWheelEvents
Gets or sets the status of whether wheel events can be dispatched to the parent. If a View's DispatchParentWheelEvents is set to false, then parents will not receive a wheel event signal either. This works without adding a WheelEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit hover event.
Declaration
public bool DispatchParentWheelEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchTouchEvents
Gets or sets the status of whether touch events can be dispatched. If a View's DispatchTouchEvents is set to false, then it's can not will receive touch and parents will not receive a touch event signal either. This works without adding a TouchEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit touch event.
Declaration
public bool DispatchTouchEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchTouchMotion
Gets or sets the status of whether motion event of Touch can be dispatched. If a View's DispatchTouchMotion is set to false, then it's can not will receive motion event of TouchEvent.
Declaration
public bool DispatchTouchMotion { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchWheelEvents
Gets or sets the status of whether wheel events can be dispatched. If a View's DispatchWheelEvents is set to false, then it's can not will receive wheel event and parents will not receive a wheel event signal either. This works without adding a WheelEvent callback in the View.
note
If the Sensitive is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit hover event.
Declaration
public bool DispatchWheelEvents { get; set; }
Property Value
Type | Description |
---|---|
bool |
DownFocusableView
The down focusable view.
This will return null if not set.
This will also return null if the specified down focusable view is not on a window.
Declaration
public View DownFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
DrawMode
Gets or sets the status of how the view and its children should be drawn.
Not all views are renderable, but DrawMode can be inherited from any view.
If an object is in a 3D layer, it will be depth-tested against other objects in the world, i.e., it may be obscured if other objects are in front.
If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.
Overlay views are drawn in a separate pass, after all non-overlay views within the layer.
For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.
Declaration
public DrawModeType DrawMode { get; set; }
Property Value
Type | Description |
---|---|
DrawModeType |
EnableControlState
By default, it is false in View, true in Control. Note that if the value is true, the View will be a touch receptor.
Declaration
public bool EnableControlState { get; set; }
Property Value
Type | Description |
---|---|
bool |
EnableControlStatePropagation
Enable/Disable ControlState propagation for children. It is false by default. If the View needs to share ControlState with descendants, please set it true. Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
Declaration
public bool EnableControlStatePropagation { get; set; }
Property Value
Type | Description |
---|---|
bool |
ExcludeLayouting
Gets / Sets the status of whether the view is excluded from its parent's layouting or not.
Declaration
public bool ExcludeLayouting { get; set; }
Property Value
Type | Description |
---|---|
bool |
Flex
The Child property of FlexContainer.
The proportion of the free space in the container, the flex item will receive.
If all items in the container set this property, their sizes will be proportional to the specified flex factor.
Declaration
public float Flex { get; set; }
Property Value
Type | Description |
---|---|
float |
FlexMargin
The Child property of FlexContainer.
The space around the flex item.
Declaration
public Vector4 FlexMargin { get; set; }
Property Value
Type | Description |
---|---|
Vector4 |
Remarks
The property cascade chaining set is possible. For example, this (view.FlexMargin.X = 0.1f;) is possible.
Focusable
Whether the view should be focusable by keyboard navigation.
Declaration
public bool Focusable { get; set; }
Property Value
Type | Description |
---|---|
bool |
FocusableChildren
Whether the children of this view can be focusable by keyboard navigation. If user sets this to false, the children of this actor view will not be focused. Note : Default value is true.
Declaration
public bool FocusableChildren { get; set; }
Property Value
Type | Description |
---|---|
bool |
FocusableInTouch
Whether this view can focus by touch. If Focusable is false, FocusableInTouch is disabled. If you want to have focus on touch, you need to set both Focusable and FocusableInTouch settings to true.
Declaration
public bool FocusableInTouch { get; set; }
Property Value
Type | Description |
---|---|
bool |
GrabTouchAfterLeave
Whether the actor grab all touches even if touch leaves its boundary.
Declaration
public bool GrabTouchAfterLeave { get; set; }
Property Value
Type | Description |
---|---|
bool | true, if it grab all touch after start |
HeightForWidth
Gets or sets the status of whether the height size is dependent on the width size.
Declaration
public bool HeightForWidth { get; set; }
Property Value
Type | Description |
---|---|
bool |
HeightResizePolicy
Gets or sets the height resize policy to be used.
Declaration
public ResizePolicyType HeightResizePolicy { get; set; }
Property Value
Type | Description |
---|---|
ResizePolicyType |
HeightSpecification
The required policy for this dimension, LayoutParamPolicies values or exact value.
Declaration
public int HeightSpecification { get; set; }
Property Value
Type | Description |
---|---|
int |
Examples
// matchParentView matches its size to its parent size.
matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
// wrapContentView wraps its children with their desired size.
wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
// exactSizeView shows itself with an exact size.
exactSizeView.WidthSpecification = 100;
exactSizeView.HeightSpecification = 100;
View Source
HierarchyDepth
Gets the depth in the hierarchy for the view.
Declaration
public int HierarchyDepth { get; }
Property Value
Type | Description |
---|---|
int |
ID
Gets the view's ID. Read-only
Declaration
public uint ID { get; }
Property Value
Type | Description |
---|---|
uint |
ImageShadow
Describes a shadow as an image for a View. It is null by default.
Declaration
public ImageShadow ImageShadow { get; set; }
Property Value
Type | Description |
---|---|
ImageShadow |
Remarks
Getter returns copied instance of current shadow.
InheritLayoutDirection
Gets/Sets whether inherit parent's the layout Direction.
Declaration
public bool InheritLayoutDirection { get; set; }
Property Value
Type | Description |
---|---|
bool |
InheritOrientation
Gets or sets the status of whether a child view inherits it's parent's orientation.
Declaration
public bool InheritOrientation { get; set; }
Property Value
Type | Description |
---|---|
bool |
InheritPosition
Gets or sets whether a child view inherits it's parent's position.
Default is to inherit.
Switching this off means that using position sets the view's world position, i.e., translates from the world origin (0,0,0) to the pivot point of the view.
Declaration
public bool InheritPosition { get; set; }
Property Value
Type | Description |
---|---|
bool |
InheritScale
Gets or sets the status of whether a child view inherits it's parent's scale.
Declaration
public bool InheritScale { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsEnabled
Gets or sets the status of whether the view should be enabled user interactions. If a View is made disabled, then user interactions including touch, focus, and actiavation is disabled.
Declaration
public bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsHighlighted
Flag to check whether this view is highlighted or not.
Declaration
protected bool IsHighlighted { get; }
Property Value
Type | Description |
---|---|
bool |
IsOnWindow
Queries whether the view is connected to the stage.
When a view is connected, it will be directly or indirectly parented to the root view.
Declaration
public bool IsOnWindow { get; }
Property Value
Type | Description |
---|---|
bool |
KeyInputFocus
The KeyInputFocus, type bool.
Declaration
public bool KeyInputFocus { get; set; }
Property Value
Type | Description |
---|---|
bool |
Layout
Set the layout on this View. Replaces any existing Layout.
Declaration
public LayoutItem Layout { get; set; }
Property Value
Type | Description |
---|---|
LayoutItem |
Remarks
If this Layout is set as null explicitly, it means this View itself and it's child Views will not use Layout anymore.
LayoutDirection
Gets/Sets the layout Direction.
Declaration
public ViewLayoutDirectionType LayoutDirection { get; set; }
Property Value
Type | Description |
---|---|
ViewLayoutDirectionType |
LayoutingDisabled
Flag to allow Layouting to be disabled for Views. Once a View has a Layout set then any children added to Views from then on will receive automatic Layouts.
Declaration
public static bool LayoutingDisabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
LayoutSet
Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.
Declaration
public bool LayoutSet { get; }
Property Value
Type | Description |
---|---|
bool |
LayoutTransition
Sets a layout transitions for this View.
Declaration
public LayoutTransition LayoutTransition { get; set; }
Property Value
Type | Description |
---|---|
LayoutTransition |
Remarks
Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
LayoutTransitions
Gets the List of transitions for this View.
Declaration
public Dictionary<TransitionCondition, TransitionList> LayoutTransitions { get; }
Property Value
Type | Description |
---|---|
Dictionary<, ><TransitionCondition, TransitionList> |
LeaveRequired
Gets or sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view.
Declaration
public bool LeaveRequired { get; set; }
Property Value
Type | Description |
---|---|
bool |
LeftFocusableView
The left focusable view.
This will return null if not set.
This will also return null if the specified left focusable view is not on a window.
Declaration
public View LeftFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
Margin
Gets or sets the Margin for use in layout.
Declaration
public Extents Margin { get; set; }
Property Value
Type | Description |
---|---|
Extents |
Remarks
Margin property is supported by Layout algorithms and containers. Please Set Layout if you want to use Margin property. The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Margin = new Extents(10, 5, 15, 20);
This way to set the property is prohibited
view.Margin.Top = 15; //This does not guarantee a proper operation
View Source
MaximumSize
Gets or sets the maximum size the view can be assigned in size negotiation.
Declaration
public Size2D MaximumSize { get; set; }
Property Value
Type | Description |
---|---|
Size2D |
Examples
This way is recommended for setting the property
var view = new View();
view.MaximumSize = new Size2D(100, 200);
This way to set the property is prohibited
view.MaximumSize.Height = 200; //This does not guarantee a proper operation
View Source
MinimumSize
Gets or sets the minimum size the view can be assigned in size negotiation.
Declaration
public Size2D MinimumSize { get; set; }
Property Value
Type | Description |
---|---|
Size2D |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.MinimumSize = new Size2D(100, 200);
This way to set the property is prohibited
view.MinimumSize.Width = 100; //This does not guarantee a proper operation
View Source
Name
Gets or sets the view's name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
NaturalSize
Returns the natural size of the view.
Declaration
public Vector3 NaturalSize { get; }
Property Value
Type | Description |
---|---|
Vector3 |
Remarks
Deriving classes stipulate the natural size and by default a view has a zero natural size.
NaturalSize2D
Returns the natural size (Size2D) of the view.
Declaration
public Size2D NaturalSize2D { get; }
Property Value
Type | Description |
---|---|
Size2D |
Remarks
Deriving classes stipulate the natural size and by default a view has a zero natural size.
Opacity
Retrieves and sets the view's opacity.
Declaration
public float Opacity { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Opacity", 0.5f);
Orientation
Gets or sets the orientation of the view.
The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
Declaration
public Rotation Orientation { get; set; }
Property Value
Type | Description |
---|---|
Rotation |
Remarks
This is an asynchronous method.
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Orientation", new Rotation(new Radian((float)Math.PI), Vector3.XAxis));
Padding
Gets or sets the padding for use in layout.
Declaration
public Extents Padding { get; set; }
Property Value
Type | Description |
---|---|
Extents |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Padding = new Extents(5, 5, 5, 5);
This way to set the property is prohibited
view.Padding.Start = 5; //This does not guarantee a proper operation
View Source
PaddingEX
This has been deprecated in API5 and will be removed in API8. Use Padding instead.
Declaration
public Extents PaddingEX { get; set; }
Property Value
Type | Description |
---|---|
Extents |
Remarks
The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
Parent
This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead.
Declaration
public View Parent { get; }
Property Value
Type | Description |
---|---|
View |
ParentOrigin
Gets or sets the origin of a view within its parent's area.
This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and (1.0, 1.0, 0.5) is the bottom-right corner.
The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).
A view's position is the distance between this origin and the view's anchor-point.
Declaration
public Position ParentOrigin { get; set; }
Property Value
Type | Description |
---|---|
Position |
PivotPoint
Gets or sets the anchor-point of a view.
This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the view, and (1.0, 1.0, 0.5) is the bottom-right corner.
The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).
A view position is the distance between its parent-origin and this anchor-point.
A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
The view has been initialized.
Declaration
public Position PivotPoint { get; set; }
Property Value
Type | Description |
---|---|
Position |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.PivotPoint = PivotPoint.Center;
This way to set the property is prohibited
view.PivotPoint.X = 0.5f; //This does not guarantee a proper operation
View Source
Position
Gets or sets the position of the view.
By default, sets the position vector between the parent origin and pivot point (default).
If the position inheritance is disabled, sets the world position.
Declaration
public Position Position { get; set; }
Property Value
Type | Description |
---|---|
Position |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Position", new Position(50, 0));
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Position = new Position(100, 200.5f, 0);
This way to set the property is prohibited
view.Position.Y = 200.5f; //This does not guarantee a proper operation
View Source
Position2D
Sets the position of the view for X and Y.
By default, sets the position vector between the parent origin and the pivot point (default).
If the position inheritance is disabled, sets the world position.
Declaration
public Position2D Position2D { get; set; }
Property Value
Type | Description |
---|---|
Position2D |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Position2D = new Position2D(100, 200);
This way to set the property is prohibited
view.Position2D.X = 100; //This does not guarantee a proper operation
View Source
PositionUsesAnchorPoint
This has been deprecated in API5 and Will be removed in API8. Use PositionUsesPivotPoint instead.
Declaration
public bool PositionUsesAnchorPoint { get; set; }
Property Value
Type | Description |
---|---|
bool |
PositionUsesPivotPoint
Determines whether the pivot point should be used to determine the position of the view. This is false by default.
Declaration
public bool PositionUsesPivotPoint { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
If false, then the top-left of the view is used for the position. Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
PositionX
Gets or sets the position X of the view.
Declaration
public float PositionX { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "PositionX", 50.0f);
PositionY
Gets or sets the position Y of the view.
Declaration
public float PositionY { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "PositionY", 50.0f);
PositionZ
Gets or sets the position Z of the view.
Declaration
public float PositionZ { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "PositionZ", 50.0f);
PropagatableControlStates
The ControlStates can propagate from the parent. Listed ControlStates will be accepted propagation of the parent ControlState changes if parent view EnableControlState is true. EnableControlState. Default is ControlState.All, so every ControlStates will be propagated from the parent.
Declaration
public ControlState PropagatableControlStates { get; set; }
Property Value
Type | Description |
---|---|
ControlState |
RendererCount
Gets the number of renderers held by the view.
Declaration
public uint RendererCount { get; }
Property Value
Type | Description |
---|---|
uint |
RightFocusableView
The right focusable view.
This will return null if not set.
This will also return null if the specified right focusable view is not on a window.
Declaration
public View RightFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
RowSpan
The number of rows this child occupies, if not set, the default value is 1.
Declaration
public float RowSpan { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
View SourceScale
Gets or sets the scale factor applied to the view.
Declaration
public Vector3 Scale { get; set; }
Property Value
Type | Description |
---|---|
Vector3 |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Scale", new Vector3(1.5f, 1.5f, 1.0f));
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Scale = new Vector3(1.5f, 2.0f, 1.0f);
This way to set the property is prohibited
view.Scale.Width = 1.5f; //This does not guarantee a proper operation
View Source
ScaleX
Gets or sets the scale X factor applied to the view.
Declaration
public float ScaleX { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "ScaleX", 1.5f);
ScaleY
Gets or sets the scale Y factor applied to the view.
Declaration
public float ScaleY { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "ScaleY", 1.5f);
ScaleZ
Gets or sets the scale Z factor applied to the view.
Declaration
public float ScaleZ { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "ScaleZ", 1.5f);
ScreenPosition
Retrieves the screen position of the view.
Declaration
public Vector2 ScreenPosition { get; }
Property Value
Type | Description |
---|---|
Vector2 |
ScreenPositionSize
Retrieves the screen position and size of the view.
Declaration
public Vector4 ScreenPositionSize { get; }
Property Value
Type | Description |
---|---|
Vector4 |
Remarks
The float type Rectangle class is not ready yet. Therefore, it transmits data in Vector4 class. This type should later be changed to the appropriate data type.
Sensitive
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.
Declaration
public bool Sensitive { get; set; }
Property Value
Type | Description |
---|---|
bool |
SiblingOrder
Sets the sibling order of the view so the depth position can be defined within the same parent.
Declaration
public int SiblingOrder { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0. Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order. The values set by this property will likely change.
Size
Sets the size of a view for the width, the height and the depth.
Geometry can be scaled to fit within this area.
This does not interfere with the view's scale factor.
The views default depth is the minimum of width and height.
Declaration
public Size Size { get; set; }
Property Value
Type | Description |
---|---|
Size |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Size", new Size(100, 100));
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Size = new Size(100.5f, 200, 0);
This way to set the property is prohibited
view.Size.Width = 100.5f; //This does not guarantee a proper operation
View Source
Size2D
Sets the size of a view for the width and the height.
Geometry can be scaled to fit within this area.
This does not interfere with the view's scale factor.
The views default depth is the minimum of width and height.
Declaration
public Size2D Size2D { get; set; }
Property Value
Type | Description |
---|---|
Size2D |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var view = new View();
view.Size2D = new Size2D(100, 200);
This way to set the property is prohibited
view.Size2D.Width = 100; //This does not guarantee a proper operation
View Source
SizeHeight
Gets or sets the size height of the view.
Declaration
public float SizeHeight { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "SizeHeight", 500.0f);
SizeModeFactor
Gets or sets the relative to parent size factor of the view.
This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.
This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.
Declaration
public Vector3 SizeModeFactor { get; set; }
Property Value
Type | Description |
---|---|
Vector3 |
Remarks
The property cascade chaining set is not recommended.
Examples
This way is recommended for setting the property
var text = new TextField();
text.SizeModeFactor = new Vector3(1.0f, 0.45f, 1.0f);
This way to set the property is prohibited
text.SizeModeFactor.Width = 1.0f; //This does not guarantee a proper operation
View Source
SizeScalePolicy
Gets or sets the policy to use when setting size with size negotiation.
Defaults to SizeScalePolicyType.UseSizeSet.
Declaration
public SizeScalePolicyType SizeScalePolicy { get; set; }
Property Value
Type | Description |
---|---|
SizeScalePolicyType |
SizeWidth
Gets or sets the size width of the view.
Declaration
public float SizeWidth { get; set; }
Property Value
Type | Description |
---|---|
float |
Remarks
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "SizeWidth", 500.0f);
State
The current state of the view.
Declaration
public View.States State { get; set; }
Property Value
Type | Description |
---|---|
View.States |
StyleName
The StyleName, type string. The value indicates DALi style name defined in json theme file.
Declaration
public string StyleName { get; set; }
Property Value
Type | Description |
---|---|
string |
SubState
The current sub state of the view.
Declaration
public View.States SubState { get; set; }
Property Value
Type | Description |
---|---|
View.States |
ThemeChangeSensitive
If the value is true, the View will change its style as the theme changes. The default value is false in normal case but it can be true when the NUIApplication is created with ThemeChangeSensitive.
Declaration
public bool ThemeChangeSensitive { get; set; }
Property Value
Type | Description |
---|---|
bool |
Tooltip
Displays a tooltip
Declaration
public PropertyMap Tooltip { get; set; }
Property Value
Type | Description |
---|---|
PropertyMap |
TooltipText
Displays a tooltip as a text.
Declaration
public string TooltipText { get; set; }
Property Value
Type | Description |
---|---|
string |
TouchAreaOffset
The expanded touch area.
TouchArea can expand the view's touchable area.
If you set the TouchAreaOffset on an view, when you touch the view, the touch area is used rather than the size of the view.
Declaration
public Offset TouchAreaOffset { get; set; }
Property Value
Type | Description |
---|---|
Offset |
Remarks
This is based on the top left x, y coordinates.
For example)
view.Size = new Size(100, 100);
view.TouchAreaOffset = new Offset(-10, 20, 30, -40); // left, right, bottom, top
Then, touch area is 130x170.
This is view.width + TouchAreaOffset.right - TouchAreaOffset.left and view.height + TouchAreaOffset.bottom - TouchAreaOffset.top
+---------------------+
| ^ |
| | |
| | -40 |
| | |
| | |
| +----+----+ |
| | | |
| -10| | 20 |
|<---+ +----->|
| | | |
| | | |
| +----+----+ |
| | |
| | 30 |
| | |
| v |
+---------------------+
TransitionOptions
Set or Get TransitionOptions for the page transition. This property is used to define how this view will be transitioned during Page switching.
Declaration
public TransitionOptions TransitionOptions { get; set; }
Property Value
Type | Description |
---|---|
TransitionOptions |
UpdateAreaHint
Declaration
public Vector4 UpdateAreaHint { get; set; }
Property Value
Type | Description |
---|---|
Vector4 |
UpFocusableView
The up focusable view.
This will return null if not set.
This will also return null if the specified up focusable view is not on a window.
Declaration
public View UpFocusableView { get; set; }
Property Value
Type | Description |
---|---|
View |
ViewStyle
Deprecate. Do not use this. The style instance applied to this view. Note that do not modify the ViewStyle. Modifying ViewStyle will affect other views with same ViewStyle.
Declaration
protected ViewStyle ViewStyle { get; }
Property Value
Type | Description |
---|---|
ViewStyle |
Visibility
Retrieves the visibility flag of the view.
Declaration
public bool Visibility { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
If the view is not visible, then the view and its children will not be rendered. This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true.
Animatable - This property can be animated using Animation
class.
animation.AnimateTo(view, "Visibility", false);
Weight
The weight of the View, used to share available space in a layout with siblings.
Declaration
public float Weight { get; set; }
Property Value
Type | Description |
---|---|
float |
WidthForHeight
Gets or sets the status of whether the width size is dependent on the height size.
Declaration
public bool WidthForHeight { get; set; }
Property Value
Type | Description |
---|---|
bool |
WidthResizePolicy
Gets or sets the width resize policy to be used.
Declaration
public ResizePolicyType WidthResizePolicy { get; set; }
Property Value
Type | Description |
---|---|
ResizePolicyType |
WidthSpecification
The required policy for this dimension, LayoutParamPolicies values or exact value.
Declaration
public int WidthSpecification { get; set; }
Property Value
Type | Description |
---|---|
int |
Examples
// matchParentView matches its size to its parent size.
matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
// wrapContentView wraps its children with their desired size.
wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
// exactSizeView shows itself with an exact size.
exactSizeView.WidthSpecification = 100;
exactSizeView.HeightSpecification = 100;
View Source
WorldColor
Gets the view's world color.
Declaration
public Vector4 WorldColor { get; }
Property Value
Type | Description |
---|---|
Vector4 |
WorldOrientation
Gets or sets the world orientation of the view.
Declaration
public Rotation WorldOrientation { get; }
Property Value
Type | Description |
---|---|
Rotation |
WorldPosition
Gets or sets the world position of the view.
Declaration
public Vector3 WorldPosition { get; }
Property Value
Type | Description |
---|---|
Vector3 |
WorldScale
Gets the world scale of the view.
Declaration
public Vector3 WorldScale { get; }
Property Value
Type | Description |
---|---|
Vector3 |
Methods
View SourceAccessibilityCalculateStates()
Declaration
protected virtual AccessibilityStates AccessibilityCalculateStates()
Returns
Type | Description |
---|---|
AccessibilityStates |
AccessibilityDoAction(string)
Declaration
protected virtual bool AccessibilityDoAction(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name |
Returns
Type | Description |
---|---|
bool |
AccessibilityGetActionCount()
Declaration
protected virtual int AccessibilityGetActionCount()
Returns
Type | Description |
---|---|
int |
AccessibilityGetActionName(int)
Declaration
protected virtual string AccessibilityGetActionName(int index)
Parameters
Type | Name | Description |
---|---|---|
int | index |
Returns
Type | Description |
---|---|
string |
AccessibilityGetDescription()
Declaration
protected virtual string AccessibilityGetDescription()
Returns
Type | Description |
---|---|
string |
AccessibilityGetName()
Declaration
protected virtual string AccessibilityGetName()
Returns
Type | Description |
---|---|
string |
AccessibilityIsScrollable()
Declaration
protected virtual bool AccessibilityIsScrollable()
Returns
Type | Description |
---|---|
bool |
AccessibilityScrollToChild(View)
Declaration
protected virtual bool AccessibilityScrollToChild(View child)
Parameters
Type | Name | Description |
---|---|---|
View | child |
Returns
Type | Description |
---|---|
bool |
Add(View)
Adds a child view to this view.
Declaration
public override void Add(View child)
Parameters
Type | Name | Description |
---|---|---|
View | child |
Overrides
See Also
View SourceAddRenderer(Renderer)
Declaration
public uint AddRenderer(Renderer renderer)
Parameters
Type | Name | Description |
---|---|---|
Renderer | renderer |
Returns
Type | Description |
---|---|
uint |
AnimateBackgroundColor(object, int, int, BuiltinFunctions?, object)
Creates an animation to animate the background color visual. If there is no background visual, creates one with transparent black as it's mixColor.
Declaration
public Animation AnimateBackgroundColor(object destinationValue, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialValue = null)
Parameters
Type | Name | Description |
---|---|---|
object | destinationValue | |
int | startTime | |
int | endTime | |
BuiltinFunctions? | alphaFunction | |
object | initialValue |
Returns
Type | Description |
---|---|
Animation |
AnimateColor(string, object, int, int, BuiltinFunctions?, object)
Creates an animation to animate the mixColor of the named visual.
Declaration
public Animation AnimateColor(string targetVisual, object destinationColor, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialColor = null)
Parameters
Type | Name | Description |
---|---|---|
string | targetVisual | |
object | destinationColor | |
int | startTime | |
int | endTime | |
BuiltinFunctions? | alphaFunction | |
object | initialColor |
Returns
Type | Description |
---|---|
Animation |
AppendAccessibilityRelation(View, AccessibilityRelationType)
Creates relation between objects.
Declaration
public void AppendAccessibilityRelation(View second, AccessibilityRelationType relation)
Parameters
Type | Name | Description |
---|---|---|
View | second | Object which will be in relation. |
AccessibilityRelationType | relation | Relation type. |
ApplyStyle(ViewStyle)
Apply style instance to the view. Basically it sets the bindable property to the value of the bindable property with same name in the style.
Declaration
public virtual void ApplyStyle(ViewStyle viewStyle)
Parameters
Type | Name | Description |
---|---|---|
ViewStyle | viewStyle |
CalculateScreenPosition()
Calculate the screen position of the view.
Declaration
public Vector2 CalculateScreenPosition()
Returns
Type | Description |
---|---|
Vector2 |
Remarks
This is a hidden API(inhouse API) only for internal purpose.
CalculateScreenPositionSize()
Calculate the screen position and size of the view.
Declaration
public Vector4 CalculateScreenPositionSize()
Returns
Type | Description |
---|---|
Vector4 |
Remarks
The float type Rectangle class is not ready yet. Therefore, it transmits data in Vector4 class. This type should later be changed to the appropriate data type.
CheckResourceReady()
Declaration
protected virtual bool CheckResourceReady()
Returns
Type | Description |
---|---|
bool |
ClearAccessibilityHighlight()
Clears accessibility highlight.
Declaration
public bool ClearAccessibilityHighlight()
Returns
Type | Description |
---|---|
bool | True if cleared, otherwise false when it is not possible |
ClearAccessibilityRelations()
Removes all previously appended relations.
Declaration
public void ClearAccessibilityRelations()
ClearBackground()
Clears the background.
Declaration
public void ClearBackground()
CreateViewStyle()
Create Style, it is abstract function and must be override.
Declaration
protected virtual ViewStyle CreateViewStyle()
Returns
Type | Description |
---|---|
ViewStyle |
Dispose(bool)
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing |
Overrides
View SourceDispose(DisposeTypes)
you can override it to clean-up your own resources.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type | DisposeTypes |
Overrides
View SourceDoAction(int, int, PropertyValue)
Perform an action on a visual registered to this view.
Visuals will have actions. This API is used to perform one of these actions with the given attributes.
Declaration
public void DoAction(int propertyIndexOfVisual, int propertyIndexOfActionId, PropertyValue attributes)
Parameters
Type | Name | Description |
---|---|---|
int | propertyIndexOfVisual | The Property index of the visual. |
int | propertyIndexOfActionId | The action to perform. See Visual to find the supported actions. |
PropertyValue | attributes | Optional attributes for the action. |
EmitAccessibilityEvent(AccessibilityPropertyChangeEvent)
Emits accessibility property changed event.
Declaration
public void EmitAccessibilityEvent(AccessibilityPropertyChangeEvent changeEvent)
Parameters
Type | Name | Description |
---|---|---|
AccessibilityPropertyChangeEvent | changeEvent | Property changed event |
EmitAccessibilityStateChangedEvent(AccessibilityState, bool)
Emits accessibility states changed event.
Declaration
public void EmitAccessibilityStateChangedEvent(AccessibilityState state, bool equal)
Parameters
Type | Name | Description |
---|---|---|
AccessibilityState | state | Accessibility state |
bool | equal | True if the state is set or enabled, otherwise false |
EmitScrollFinishedEvent()
Emits accessibility scroll finished event.
Declaration
public void EmitScrollFinishedEvent()
EmitScrollStartedEvent()
Emits accessibility scroll started event.
Declaration
public void EmitScrollStartedEvent()
EmitTextCursorMovedEvent(int)
Emits accessibility text cursor moved event.
Declaration
public void EmitTextCursorMovedEvent(int cursorPosition)
Parameters
Type | Name | Description |
---|---|---|
int | cursorPosition | The new cursor position |
EmitTextDeletedEvent(int, int, string)
Emits accessibility text deleted event.
Declaration
public void EmitTextDeletedEvent(int cursorPosition, int length, string content)
Parameters
Type | Name | Description |
---|---|---|
int | cursorPosition | Text cursor position |
int | length | Text length |
string | content | Inserted text content |
EmitTextInsertedEvent(int, int, string)
Emits accessibility text inserted event.
Declaration
public void EmitTextInsertedEvent(int cursorPosition, int length, string content)
Parameters
Type | Name | Description |
---|---|---|
int | cursorPosition | Text cursor position |
int | length | Text length |
string | content | Inserted text content |
FindChildAnimatableByName(string)
Search through this view's hierarchy for a view as Animatable with the given name. The view itself is also considered in the search.
Declaration
public Animatable FindChildAnimatableByName(string childName)
Parameters
Type | Name | Description |
---|---|---|
string | childName | The name of the Animatable to find. |
Returns
Type | Description |
---|---|
Animatable | A handle to the view as Animatable if found, or an empty handle if not. |
FindChildByID(uint)
Search through this View's hierarchy for a View with the given unique ID. The View itself is also considered in the search.
Declaration
public View FindChildByID(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The ID of the View to find |
Returns
Type | Description |
---|---|
View | A View if found or a null if not |
FindChildByName(string)
Search through this view's hierarchy for a view with the given name. The view itself is also considered in the search.
Declaration
public View FindChildByName(string viewName)
Parameters
Type | Name | Description |
---|---|---|
string | viewName | The name of the view to find. |
Returns
Type | Description |
---|---|
View | A handle to the view if found, or an empty handle if not. |
FindDescendantByID(uint)
Search through this View's hierarchy for a View with the given unique ID.
Declaration
public View FindDescendantByID(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The ID of the View to find. |
Returns
Type | Description |
---|---|
View | A handle to the View if found, or an empty handle if not. |
GetAccessibilityReadingInfoTypes()
Gets accessibility reading information.
Declaration
public AccessibilityReadingInfoTypes GetAccessibilityReadingInfoTypes()
Returns
Type | Description |
---|---|
AccessibilityReadingInfoTypes | Reading information type |
GetAccessibilityRelations()
Gets accessibility collection connected with the current object.
Declaration
public Dictionary<AccessibilityRelationType, List<View>> GetAccessibilityRelations()
Returns
Type | Description |
---|---|
Dictionary<, ><AccessibilityRelationType, List<><View>> | A dictionary mapping a relation type to a set of objects in that relation |
GetAccessibilityStates()
Gets Accessibility States.
Declaration
public AccessibilityStates GetAccessibilityStates()
Returns
Type | Description |
---|---|
AccessibilityStates | Accessibility States |
GetChildAnimatableAt(uint)
Retrieves a child view as Animatable by index.
Declaration
public Animatable GetChildAnimatableAt(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index | The index of the Animatable to find. |
Returns
Type | Description |
---|---|
Animatable | A handle to the view as Animatable if found, or an empty handle if not. |
GetChildAt(uint)
Retrieves a child view by index.
Declaration
public override View GetChildAt(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index |
Returns
Type | Description |
---|---|
View |
Overrides
See Also
GetChildCount()
Retrieves the number of children held by the view.
Declaration
public override uint GetChildCount()
Returns
Type | Description |
---|---|
uint |
Overrides
See Also
View SourceGetHeightForWidth(float)
Calculates the height of the view given a width.
The natural size is used for default calculation.
Size 0 is treated as aspect ratio 1:1.
Declaration
public float GetHeightForWidth(float width)
Parameters
Type | Name | Description |
---|---|---|
float | width | The width to use. |
Returns
Type | Description |
---|---|
float | The height based on the width. |
GetLayer()
Gets the parent layer of this view.If a view has no parent, this method does not do anything.
Declaration
public Layer GetLayer()
Returns
Type | Description |
---|---|
Layer | The parent layer of view |
GetPadding(PaddingType)
Return the value of padding for the view.
Declaration
public void GetPadding(PaddingType paddingOut)
Parameters
Type | Name | Description |
---|---|---|
PaddingType | paddingOut | the value of padding for the view |
GetParent()
Gets the views parent.
Declaration
public override Container GetParent()
Returns
Type | Description |
---|---|
Container |
Overrides
See Also
View SourceGetRelayoutSize(DimensionType)
Return the amount of size allocated for relayout.
Declaration
public float GetRelayoutSize(DimensionType dimension)
Parameters
Type | Name | Description |
---|---|---|
DimensionType | dimension | The dimension to retrieve. |
Returns
Type | Description |
---|---|
float | Return the size. |
GetRendererAt(uint)
Declaration
public Renderer GetRendererAt(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index |
Returns
Type | Description |
---|---|
Renderer |
GetStyleName()
Retrieves the name of the style to be applied to the view (if any).
Declaration
public string GetStyleName()
Returns
Type | Description |
---|---|
string | A string matching a style, or an empty string. |
GetWidthForHeight(float)
Calculates the width of the view given a height.
The natural size is used for default calculation.
Size 0 is treated as aspect ratio 1:1.
Declaration
public float GetWidthForHeight(float height)
Parameters
Type | Name | Description |
---|---|---|
float | height | The height to use. |
Returns
Type | Description |
---|---|
float | The width based on the height. |
GrabAccessibilityHighlight()
Grabs accessibility highlight.
Declaration
public bool GrabAccessibilityHighlight()
Returns
Type | Description |
---|---|
bool | True if cleared, otherwise false when it is not possible |
HandleControlStateOnTouch(Touch)
The touch event handler for ControlState. Please change ControlState value by touch state if needed.
Declaration
protected virtual bool HandleControlStateOnTouch(Touch touch)
Parameters
Type | Name | Description |
---|---|---|
Touch | touch |
Returns
Type | Description |
---|---|
bool |
HasFocus()
Queries whether the view has a focus.
Declaration
public bool HasFocus()
Returns
Type | Description |
---|---|
bool | True if this view has a focus. |
Hide()
Hides the view.
Declaration
public void Hide()
Remarks
This is an asynchronous method. If the view is hidden, then the view and its children will not be rendered. This is regardless of the individual visibility of the children, i.e., the view will only be rendered if all of its parents are shown.
HitTest(Touch)
Called when the view is hit through TouchEvent or GestureEvent. If it returns true, it means that it was hit, and the touch/gesture event is called from the view. If it returns false, it means that it will not be hit, and the hit-test continues to the next view. User can override whether hit or not in HitTest. You can get the coordinates relative to tthe top-left of the hit view by touch.GetLocalPosition(0). or you can get the coordinates relative to the top-left of the screen by touch.GetScreenPosition(0).
Declaration
protected virtual bool HitTest(Touch touch)
Parameters
Type | Name | Description |
---|---|---|
Touch | touch |
Returns
Type | Description |
---|---|
bool |
InitializeStyle(ViewStyle)
Apply initial style to the view.
Declaration
protected virtual void InitializeStyle(ViewStyle style = null)
Parameters
Type | Name | Description |
---|---|---|
ViewStyle | style |
IsResourceReady()
Queries if all resources required by a view are loaded and ready.
Declaration
public bool IsResourceReady()
Returns
Type | Description |
---|---|
bool |
Remarks
Most resources are only loaded when the control is placed on the stage.
LookAt(Vector3, Vector3, Vector3, Vector3)
Rotate the view look at specific position. It will change the view's orientation property.
Declaration
public void LookAt(Vector3 target, Vector3 up = null, Vector3 localForward = null, Vector3 localUp = null)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | target | The target world position to look at. |
Vector3 | up | The up vector after target look at. If it is null, up vector become +Y axis |
Vector3 | localForward | The forward vector of view when it's orientation is not applied. If it is null, localForward vector become +Z axis |
Vector3 | localUp | The up vector of view when it's orientation is not applied. If it is null, localUp vector become +Y axis |
Lower()
Lower the view below the previous sibling view.
Declaration
public void Lower()
LowerBelow(View)
Lowers the view to below the target view.
Declaration
public void LowerBelow(View target)
Parameters
Type | Name | Description |
---|---|---|
View | target | Will be lowered below this view. |
Remarks
The sibling order of views within the parent will be updated automatically. Once a raise or lower API is used then that view will have an exclusive sibling order independent of insertion.
LowerToBottom()
Lowers the view to the bottom of all views.
Declaration
public void LowerToBottom()
Remarks
The sibling order of views within the parent will be updated automatically. Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.
NotifyAccessibilityStatesChange(AccessibilityStates, AccessibilityStatesNotifyMode)
Notifies sending notifications about the current states to accessibility clients.
Declaration
public void NotifyAccessibilityStatesChange(AccessibilityStates states, AccessibilityStatesNotifyMode notifyMode)
Parameters
Type | Name | Description |
---|---|---|
AccessibilityStates | states | Accessibility States |
AccessibilityStatesNotifyMode | notifyMode | Controls the notification strategy |
Remarks
In essence, this is equivalent to calling EmitAccessibilityStateChangedEvent in a loop for all specified states. If recursive mode is specified, all children of the Accessibility object will also re-emit the states.
ObjectDump()
Declaration
public void ObjectDump()
OnAccessibilityActivated()
This method is called when the control accessibility is activated.
Derived classes should override this to perform custom accessibility activation.
Declaration
protected virtual bool OnAccessibilityActivated()
Returns
Type | Description |
---|---|
bool | True if this control can perform accessibility activation. |
OnAccessibilityReadingCancelled()
This method is called when reading is cancelled.
Declaration
protected virtual bool OnAccessibilityReadingCancelled()
Returns
Type | Description |
---|---|
bool | True if information was served. |
OnAccessibilityReadingPaused()
This method is called when reading was paused.
Declaration
protected virtual bool OnAccessibilityReadingPaused()
Returns
Type | Description |
---|---|
bool | True if information was served. |
OnAccessibilityReadingResumed()
This method is called when reading is resumed.
Declaration
protected virtual bool OnAccessibilityReadingResumed()
Returns
Type | Description |
---|---|
bool | True if information was served. |
OnAccessibilityReadingSkipped()
This method is called when reading is skipped.
Declaration
protected virtual bool OnAccessibilityReadingSkipped()
Returns
Type | Description |
---|---|
bool | True if information was served. |
OnAccessibilityReadingStopped()
This method is called when reading is stopped.
Declaration
protected virtual bool OnAccessibilityReadingStopped()
Returns
Type | Description |
---|---|
bool | True if information was served. |
OnControlStateChanged(ControlStateChangedEventArgs)
Called after the View's ControlStates changed.
Declaration
protected virtual void OnControlStateChanged(View.ControlStateChangedEventArgs controlStateChangedInfo)
Parameters
Type | Name | Description |
---|---|---|
View.ControlStateChangedEventArgs | controlStateChangedInfo | The information including state changed variables. |
OnEnabled(bool)
Internal callback of enabled property changes. Inherited view can override this method to implements enabled property changes.
Declaration
protected virtual void OnEnabled(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
bool | enabled |
OnThemeChanged(object, ThemeChangedEventArgs)
Declaration
protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
object | sender | |
ThemeChangedEventArgs | e |
Raise()
Raise view above the next sibling view.
Declaration
public void Raise()
RaiseAbove(View)
Raises the view to above the target view.
Declaration
public void RaiseAbove(View target)
Parameters
Type | Name | Description |
---|---|---|
View | target | Will be raised above this view. |
Remarks
The sibling order of views within the parent will be updated automatically. Views on the level above the target view will still be shown above this view. Once a raise or lower API is used then that view will have an exclusive sibling order independent of insertion.
RaiseToTop()
Raises the view above all other views.
Declaration
public void RaiseToTop()
Remarks
Sibling order of views within the parent will be updated automatically. Once a raise or lower API is used, that view will then have an exclusive sibling order independent of insertion.
RegisterDefaultLabel()
Registers component as a source of an accessibility "default label". The "Default label" is a text that could be read by screen-reader immediately after the navigation context has changed (window activates, popup shows up, tab changes) and before first UI element is highlighted.
Declaration
public void RegisterDefaultLabel()
RegisterHitTestCallback()
Register custom HitTest function for this view.
Declaration
protected void RegisterHitTestCallback()
Remarks
This is a hidden API(inhouse API) only for internal purpose.
See Also
View SourceReleaseSwigCPtr(HandleRef)
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
View SourceRemove(View)
Removes a child view from this View. If the view was not a child of this view, this is a no-op.
Declaration
public override void Remove(View child)
Parameters
Type | Name | Description |
---|---|---|
View | child |
Overrides
See Also
View SourceRemoveAccessibilityRelation(View, AccessibilityRelationType)
Removes accessibility relation.
Declaration
public void RemoveAccessibilityRelation(View second, AccessibilityRelationType relation)
Parameters
Type | Name | Description |
---|---|---|
View | second | Object which will be removed in relation |
AccessibilityRelationType | relation | Relation type |
RemoveRenderer(uint)
Declaration
public void RemoveRenderer(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index |
RemoveRenderer(Renderer)
Declaration
public void RemoveRenderer(Renderer renderer)
Parameters
Type | Name | Description |
---|---|---|
Renderer | renderer |
RotateBy(Degree, Vector3)
Declaration
public void RotateBy(Degree angle, Vector3 axis)
Parameters
Type | Name | Description |
---|---|---|
Degree | angle | |
Vector3 | axis |
RotateBy(Radian, Vector3)
Declaration
public void RotateBy(Radian angle, Vector3 axis)
Parameters
Type | Name | Description |
---|---|---|
Radian | angle | |
Vector3 | axis |
RotateBy(Rotation)
Declaration
public void RotateBy(Rotation relativeRotation)
Parameters
Type | Name | Description |
---|---|---|
Rotation | relativeRotation |
ScaleBy(Vector3)
Declaration
public void ScaleBy(Vector3 relativeScale)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | relativeScale |
ScreenToLocal(out float, out float, float, float)
Converts screen coordinates into the view's coordinate system using the default camera.
Declaration
public bool ScreenToLocal(out float localX, out float localY, float screenX, float screenY)
Parameters
Type | Name | Description |
---|---|---|
float | localX | On return, the X-coordinate relative to the view. |
float | localY | On return, the Y-coordinate relative to the view. |
float | screenX | The screen X-coordinate. |
float | screenY | The screen Y-coordinate. |
Returns
Type | Description |
---|---|
bool | True if the conversion succeeded. |
Remarks
The view coordinates are relative to the top-left(0.0, 0.0, 0.5).
SetAccessibilityReadingInfoTypes(AccessibilityReadingInfoTypes)
Sets accessibility reading information.
Declaration
public void SetAccessibilityReadingInfoTypes(AccessibilityReadingInfoTypes type)
Parameters
Type | Name | Description |
---|---|---|
AccessibilityReadingInfoTypes | type | Reading information type |
SetColorMode(ColorMode)
Declaration
public void SetColorMode(ColorMode colorMode)
Parameters
Type | Name | Description |
---|---|---|
ColorMode | colorMode |
SetDefaultAllowOnlyOwnTouch(bool)
If set to true, the AllowOnlyOwnTouch property value is set to true when all Views are created.
Declaration
public static void SetDefaultAllowOnlyOwnTouch(bool enable)
Parameters
Type | Name | Description |
---|---|---|
bool | enable | Sets value of AllowOnlyOwnTouch property |
SetDefaultGrabTouchAfterLeave(bool)
If set to true, the GrabTouchAfterLeave property value is set to true when all Views are created.
Declaration
public static void SetDefaultGrabTouchAfterLeave(bool enable)
Parameters
Type | Name | Description |
---|---|---|
bool | enable | Sets value of GrabTouchAfterLeave property |
SetPadding(PaddingType)
Set the padding for the view.
Declaration
public void SetPadding(PaddingType padding)
Parameters
Type | Name | Description |
---|---|---|
PaddingType | padding | Padding for the view. |
SetPosition(float, float, float)
Sets the position of the View. The coordinates are relative to the View's parent.
Declaration
public void SetPosition(float x, float y, float z)
Parameters
Type | Name | Description |
---|---|---|
float | x | The new x position |
float | y | The new y position |
float | z | The new z position |
Remarks
This is a hidden API(inhouse API) only for internal purpose.
SetPosition(float, float)
Sets the position of the View. The coordinates are relative to the View's parent. The View's z position will be set to 0.0f.
Declaration
public void SetPosition(float x, float y)
Parameters
Type | Name | Description |
---|---|---|
float | x | The new x position |
float | y | The new y position |
Remarks
This is a hidden API(inhouse API) only for internal purpose.
SetPosition(Vector3)
Sets the position of the View. The coordinates are relative to the View's parent.
Declaration
public void SetPosition(Vector3 position)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | position | The new position |
Remarks
This is a hidden API(inhouse API) only for internal purpose.
SetSizeModeFactor(Vector3)
Sets the relative to parent size factor of the view.
This factor is only used when ResizePolicy is set to either:
ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicy.
Declaration
public void SetSizeModeFactor(Vector3 factor)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | factor | A Vector3 representing the relative factor to be applied to each axis. |
SetStyleName(string)
Sets the name of the style to be applied to the view.
Declaration
public void SetStyleName(string styleName)
Parameters
Type | Name | Description |
---|---|---|
string | styleName | A string matching a style described in a stylesheet. |
Show()
Shows the view.
Declaration
public void Show()
Remarks
This is an asynchronous method.
Unparent()
Removes a view from its parent view or layer. If a view has no parent, this method does nothing.
Declaration
public void Unparent()
UnregisterDefaultLabel()
Unregisters component that has been registered previously as a source of an accessibility "default label". The "Default label" is a text that could be read by screen-reader immediately after the navigation context has changed (window activates, popup shows up, tab changes) and before first UI element is highlighted.
Declaration
public void UnregisterDefaultLabel()
UnregisterHitTestCallback()
Unregister custom HitTest function.
Declaration
protected void UnregisterHitTestCallback()
Remarks
This is a hidden API(inhouse API) only for internal purpose.
Events
View SourceAccessibilityActivated
Accessibility is activated.
Declaration
public event EventHandler AccessibilityActivated
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityDescriptionRequested
AccessibilityDescription is requested.
Declaration
public event EventHandler<GetDescriptionEventArgs> AccessibilityDescriptionRequested
Event Type
Type | Description |
---|---|
EventHandler<><GetDescriptionEventArgs> |
AccessibilityGestureInfoReceived
AccessibilityGestureInfo is received.
Declaration
public event EventHandler<GestureInfoEventArgs> AccessibilityGestureInfoReceived
Event Type
Type | Description |
---|---|
EventHandler<><GestureInfoEventArgs> |
AccessibilityNameRequested
AccessibilityName is requested.
Declaration
public event EventHandler<GetNameEventArgs> AccessibilityNameRequested
Event Type
Type | Description |
---|---|
EventHandler<><GetNameEventArgs> |
AccessibilityReadingCancelled
AccessibilityReading is cancelled.
Declaration
public event EventHandler AccessibilityReadingCancelled
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityReadingPaused
AccessibilityReading is paused.
Declaration
public event EventHandler AccessibilityReadingPaused
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityReadingResumed
AccessibilityReading is resumed.
Declaration
public event EventHandler AccessibilityReadingResumed
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityReadingSkipped
AccessibilityReading is skipped.
Declaration
public event EventHandler AccessibilityReadingSkipped
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityReadingStopped
AccessibilityReading is stopped.
Declaration
public event EventHandler AccessibilityReadingStopped
Event Type
Type | Description |
---|---|
EventHandler |
AccessibilityValueTextRequested
Declaration
public event EventHandler<View.AccessibilityValueTextRequestedEventArgs> AccessibilityValueTextRequested
Event Type
Type | Description |
---|---|
EventHandler<><AccessibilityValueTextRequestedEventArgs> |
AddedToWindow
An event for the OnWindow signal which can be used to subscribe or unsubscribe the event handler.
The OnWindow signal is emitted after the view has been connected to the window.
Declaration
public event EventHandler AddedToWindow
Event Type
Type | Description |
---|---|
EventHandler |
BackKeyPressed
An event for getting notice when physical back key is pressed.
This event is emitted BackKey is up.
Declaration
public event EventHandler BackKeyPressed
Event Type
Type | Description |
---|---|
EventHandler |
ChildAdded
Event when a child is added.
Declaration
public event EventHandler<View.ChildAddedEventArgs> ChildAdded
Event Type
Type | Description |
---|---|
EventHandler<><ChildAddedEventArgs> |
ChildRemoved
Event when a child is removed.
Declaration
public event EventHandler<View.ChildRemovedEventArgs> ChildRemoved
Event Type
Type | Description |
---|---|
EventHandler<><ChildRemovedEventArgs> |
ControlStateChangedEvent
The event that is triggered when the View's ControlState is changed.
Declaration
public event EventHandler<View.ControlStateChangedEventArgs> ControlStateChangedEvent
Event Type
Type | Description |
---|---|
EventHandler<><ControlStateChangedEventArgs> |
FocusGained
An event for the KeyInputFocusGained signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The KeyInputFocusGained signal is emitted when the control gets the key input focus.
Declaration
public event EventHandler FocusGained
Event Type
Type | Description |
---|---|
EventHandler |
FocusLost
An event for the KeyInputFocusLost signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The KeyInputFocusLost signal is emitted when the control loses the key input focus.
Declaration
public event EventHandler FocusLost
Event Type
Type | Description |
---|---|
EventHandler |
HoverEvent
An event for the hovered signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The hovered signal is emitted when the hover input is received.
Declaration
public event EventHandlerWithReturnType<object, View.HoverEventArgs, bool> HoverEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.HoverEventArgs, bool> |
InterceptTouchEvent
An event for the touched signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The touched signal is emitted when the touch input is received.
This can receive touch events before child.
If it returns false, the child can receive the touch event. If it returns true, the touch event is intercepted. So child cannot receive touch event.
Declaration
public event EventHandlerWithReturnType<object, View.TouchEventArgs, bool> InterceptTouchEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.TouchEventArgs, bool> |
InterceptWheelEvent
An event for the wheel which can be used to subscribe or unsubscribe the event handler provided by the user.
The wheel event is emitted when the wheel input is received.
This can receive wheel events before child.
If it returns false, the child can receive the wheel event. If it returns true, the wheel event is intercepted. So child cannot receive wheel event.
Declaration
public event EventHandlerWithReturnType<object, View.WheelEventArgs, bool> InterceptWheelEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.WheelEventArgs, bool> |
KeyEvent
An event for the KeyPressed signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The KeyPressed signal is emitted when the key event is received.
Declaration
public event EventHandlerWithReturnType<object, View.KeyEventArgs, bool> KeyEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.KeyEventArgs, bool> |
LayoutDirectionChanged
Event for layout direction change which can be used to subscribe/unsubscribe the event handler.
This signal is emitted when the layout direction property of this or a parent view is changed.
Declaration
public event EventHandler<View.LayoutDirectionChangedEventArgs> LayoutDirectionChanged
Event Type
Type | Description |
---|---|
EventHandler<><LayoutDirectionChangedEventArgs> |
Relayout
An event for the OnRelayout signal which can be used to subscribe or unsubscribe the event handler.
The OnRelayout signal is emitted after the size has been set on the view during relayout.
Declaration
public event EventHandler Relayout
Event Type
Type | Description |
---|---|
EventHandler |
RemovedFromWindow
An event for the OffWindow signal, which can be used to subscribe or unsubscribe the event handler.
OffWindow signal is emitted after the view has been disconnected from the window.
Declaration
public event EventHandler RemovedFromWindow
Event Type
Type | Description |
---|---|
EventHandler |
ResourcesLoaded
An event for the ResourcesLoadedSignal signal which can be used to subscribe or unsubscribe the event handler provided by the user.
This signal is emitted after all resources required by a view are loaded and ready.
Declaration
public event EventHandler ResourcesLoaded
Event Type
Type | Description |
---|---|
EventHandler |
TouchEvent
An event for the touched signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The touched signal is emitted when the touch input is received.
Declaration
public event EventHandlerWithReturnType<object, View.TouchEventArgs, bool> TouchEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.TouchEventArgs, bool> |
VisibilityChanged
An event for visibility change which can be used to subscribe or unsubscribe the event handler.
This event is sent when the visibility of this or a parent view is changed.
Declaration
public event EventHandler<View.VisibilityChangedEventArgs> VisibilityChanged
Event Type
Type | Description |
---|---|
EventHandler<><VisibilityChangedEventArgs> |
Remarks
When VisibilityChangedEventArgs.Type is SELF, VisibilityChangedEventArgs.Visibility is true means this View's Visibility property is true. When VisibilityChangedEventArgs.Type is PARENT, VisibilityChangedEventArgs.Visibility is true means a parent's Visibility property has changed to true.
This event is NOT sent if the view becomes transparent (or the reverse), it's ONLY linked with View.Show() and View.Hide(). For reference, a view is only shown if the view and its parents (up to the root view) are also visible, they are not transparent, and the view has a non-zero size. So if its parent is not visible, the view is not shown even though VisibilityChangedEventArgs.Type is SELF and VisibilityChangedEventArgs.Visibility is true.
WheelEvent
An event for the WheelMoved signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The WheelMoved signal is emitted when the wheel event is received.
Declaration
public event EventHandlerWithReturnType<object, View.WheelEventArgs, bool> WheelEvent
Event Type
Type | Description |
---|---|
EventHandlerWithReturnType<object, View.WheelEventArgs, bool> |