Class View

Definition

Namespace:
Tizen.NUI.BaseComponents
Assembly:
Tizen.NUI.dll
API Level:
3

View is the base class for all views.

C#
Copy
public class View : Container, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
Inheritance
Derived
Implements

Constructors

View Source

View()

Creates a new instance of a view.

Declaration
C#
Copy
public View()
API Level: 3
View Source

View(Boolean)

Create a new instance of a View with setting the status of shown or hidden.

Declaration
C#
Copy
public View(bool shown)
Parameters
Type Name Description
Boolean shown

false : Not displayed (hidden), true : displayed (shown)

View Source

View(View.ViewAccessibilityMode)

Declaration
C#
Copy
public View(View.ViewAccessibilityMode accessibilityMode)
Parameters
Type Name Description
View.ViewAccessibilityMode accessibilityMode
View Source

View(ViewStyle)

Declaration
C#
Copy
public View(ViewStyle viewStyle)
Parameters
Type Name Description
ViewStyle viewStyle

Fields

View Source

AccessibilityActivateAction

Declaration
C#
Copy
protected static readonly string AccessibilityActivateAction
Field Value
Type Description
String
View Source

AccessibilityDescriptionProperty

AccessibilityDescriptionProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityDescriptionProperty
Field Value
Type Description
BindableProperty
View Source

AccessibilityHiddenProperty

AccessibilityHiddenProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityHiddenProperty
Field Value
Type Description
BindableProperty
View Source

AccessibilityHighlightableProperty

AccessibilityHighlightableProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityHighlightableProperty
Field Value
Type Description
BindableProperty
View Source

AccessibilityNameProperty

AccessibilityNameProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityNameProperty
Field Value
Type Description
BindableProperty
View Source

AccessibilityReadingCancelledAction

Declaration
C#
Copy
protected static readonly string AccessibilityReadingCancelledAction
Field Value
Type Description
String
View Source

AccessibilityReadingPausedAction

Declaration
C#
Copy
protected static readonly string AccessibilityReadingPausedAction
Field Value
Type Description
String
View Source

AccessibilityReadingResumedAction

Declaration
C#
Copy
protected static readonly string AccessibilityReadingResumedAction
Field Value
Type Description
String
View Source

AccessibilityReadingSkippedAction

Declaration
C#
Copy
protected static readonly string AccessibilityReadingSkippedAction
Field Value
Type Description
String
View Source

AccessibilityReadingStoppedAction

Declaration
C#
Copy
protected static readonly string AccessibilityReadingStoppedAction
Field Value
Type Description
String
View Source

AccessibilityRoleProperty

AccessibilityRoleProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityRoleProperty
Field Value
Type Description
BindableProperty
View Source

AccessibilityTranslationDomainProperty

AccessibilityTranslationDomainProperty

Declaration
C#
Copy
public static readonly BindableProperty AccessibilityTranslationDomainProperty
Field Value
Type Description
BindableProperty
View Source

AlignSelfProperty

AlignSelfProperty

Declaration
C#
Copy
public static readonly BindableProperty AlignSelfProperty
Field Value
Type Description
BindableProperty
View Source

AllowOnlyOwnTouchProperty

AllowOnlyOwnTouchProperty

Declaration
C#
Copy
public static readonly BindableProperty AllowOnlyOwnTouchProperty
Field Value
Type Description
BindableProperty
View Source

AnchorPointProperty

AnchorPointProperty

Declaration
C#
Copy
public static readonly BindableProperty AnchorPointProperty
Field Value
Type Description
BindableProperty
View Source

AutomationIdProperty

AutomationIdProperty

Declaration
C#
Copy
public static readonly BindableProperty AutomationIdProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundColorProperty

BackgroundColorProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundColorProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundImageBorderProperty

BackgroundImageBorderProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundImageBorderProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundImageProperty

BackgroundImageProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundImageProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundImageSynchronosLoadingProperty

BackgroundImageSynchronosLoadingProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundImageSynchronosLoadingProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundImageSynchronousLoadingProperty

BackgroundImageSynchronousLoadingProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundImageSynchronousLoadingProperty
Field Value
Type Description
BindableProperty
View Source

BackgroundProperty

BackgroundProperty

Declaration
C#
Copy
public static readonly BindableProperty BackgroundProperty
Field Value
Type Description
BindableProperty
View Source

BlendEquationProperty

BlendEquationProperty

Declaration
C#
Copy
public static readonly BindableProperty BlendEquationProperty
Field Value
Type Description
BindableProperty
View Source

BorderlineColorProperty

BorderlineColor Property

Declaration
C#
Copy
public static readonly BindableProperty BorderlineColorProperty
Field Value
Type Description
BindableProperty
View Source

BorderlineOffsetProperty

BorderlineOffset Property

Declaration
C#
Copy
public static readonly BindableProperty BorderlineOffsetProperty
Field Value
Type Description
BindableProperty
View Source

BorderlineWidthProperty

BorderlineWidth Property

Declaration
C#
Copy
public static readonly BindableProperty BorderlineWidthProperty
Field Value
Type Description
BindableProperty
View Source

BoxShadowProperty

Shadow Property

Declaration
C#
Copy
public static readonly BindableProperty BoxShadowProperty
Field Value
Type Description
BindableProperty
View Source

CellHorizontalAlignmentProperty

CellHorizontalAlignmentProperty

Declaration
C#
Copy
public static readonly BindableProperty CellHorizontalAlignmentProperty
Field Value
Type Description
BindableProperty
View Source

CellIndexProperty

CellIndexProperty

Declaration
C#
Copy
public static readonly BindableProperty CellIndexProperty
Field Value
Type Description
BindableProperty
View Source

CellVerticalAlignmentProperty

CellVerticalAlignmentProperty

Declaration
C#
Copy
public static readonly BindableProperty CellVerticalAlignmentProperty
Field Value
Type Description
BindableProperty
View Source

ClippingModeProperty

ClippingModeProperty

Declaration
C#
Copy
public static readonly BindableProperty ClippingModeProperty
Field Value
Type Description
BindableProperty
View Source

ClockwiseFocusableViewProperty

ClockwiseFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty ClockwiseFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

ColorBlueProperty

ColorBlueProperty

Declaration
C#
Copy
public static readonly BindableProperty ColorBlueProperty
Field Value
Type Description
BindableProperty
View Source

ColorGreenProperty

ColorGreenProperty

Declaration
C#
Copy
public static readonly BindableProperty ColorGreenProperty
Field Value
Type Description
BindableProperty
View Source

ColorProperty

ColorProperty

Declaration
C#
Copy
public static readonly BindableProperty ColorProperty
Field Value
Type Description
BindableProperty
View Source

ColorRedProperty

ColorRedProperty

Declaration
C#
Copy
public static readonly BindableProperty ColorRedProperty
Field Value
Type Description
BindableProperty
View Source

ColumnSpanProperty

ColumnSpanProperty

Declaration
C#
Copy
public static readonly BindableProperty ColumnSpanProperty
Field Value
Type Description
BindableProperty
View Source

CornerRadiusPolicyProperty

CornerRadiusPolicy Property

Declaration
C#
Copy
public static readonly BindableProperty CornerRadiusPolicyProperty
Field Value
Type Description
BindableProperty
View Source

CornerRadiusProperty

CornerRadius Property

Declaration
C#
Copy
public static readonly BindableProperty CornerRadiusProperty
Field Value
Type Description
BindableProperty
View Source

CounterClockwiseFocusableViewProperty

CounterClockwiseFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty CounterClockwiseFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

DispatchHoverMotionProperty

DispatchHoverMotionProperty

Declaration
C#
Copy
public static readonly BindableProperty DispatchHoverMotionProperty
Field Value
Type Description
BindableProperty
View Source

DispatchKeyEventsProperty

DispatchKeyEventsProperty

Declaration
C#
Copy
public static readonly BindableProperty DispatchKeyEventsProperty
Field Value
Type Description
BindableProperty
View Source

DispatchTouchMotionProperty

DispatchTouchMotionProperty

Declaration
C#
Copy
public static readonly BindableProperty DispatchTouchMotionProperty
Field Value
Type Description
BindableProperty
View Source

DownFocusableViewProperty

DownFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty DownFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

DrawModeProperty

DrawModeProperty

Declaration
C#
Copy
public static readonly BindableProperty DrawModeProperty
Field Value
Type Description
BindableProperty
View Source

EnableControlStatePropagationProperty

EnableControlStatePropagationProperty

Declaration
C#
Copy
public static readonly BindableProperty EnableControlStatePropagationProperty
Field Value
Type Description
BindableProperty
View Source

EnableControlStateProperty

EnableControlState property

Declaration
C#
Copy
public static readonly BindableProperty EnableControlStateProperty
Field Value
Type Description
BindableProperty
View Source

ExcludeLayoutingProperty

ExcludeLayoutingProperty

Declaration
C#
Copy
public static readonly BindableProperty ExcludeLayoutingProperty
Field Value
Type Description
BindableProperty
View Source

FlexMarginProperty

FlexMarginProperty

Declaration
C#
Copy
public static readonly BindableProperty FlexMarginProperty
Field Value
Type Description
BindableProperty
View Source

FlexProperty

FlexProperty

Declaration
C#
Copy
public static readonly BindableProperty FlexProperty
Field Value
Type Description
BindableProperty
View Source

FocusableChildrenProperty

FocusableChildrenProperty

Declaration
C#
Copy
public static readonly BindableProperty FocusableChildrenProperty
Field Value
Type Description
BindableProperty
View Source

FocusableInTouchProperty

FocusableInTouchProperty

Declaration
C#
Copy
public static readonly BindableProperty FocusableInTouchProperty
Field Value
Type Description
BindableProperty
View Source

FocusableProperty

FocusableProperty

Declaration
C#
Copy
public static readonly BindableProperty FocusableProperty
Field Value
Type Description
BindableProperty
View Source

GrabTouchAfterLeaveProperty

GrabTouchAfterLeaveProperty

Declaration
C#
Copy
public static readonly BindableProperty GrabTouchAfterLeaveProperty
Field Value
Type Description
BindableProperty
View Source

HeightForWidthProperty

HeightForWidthProperty

Declaration
C#
Copy
public static readonly BindableProperty HeightForWidthProperty
Field Value
Type Description
BindableProperty
View Source

HeightResizePolicyProperty

HeightResizePolicyProperty

Declaration
C#
Copy
public static readonly BindableProperty HeightResizePolicyProperty
Field Value
Type Description
BindableProperty
View Source

HeightSpecificationProperty

HeightSpecificationProperty

Declaration
C#
Copy
public static readonly BindableProperty HeightSpecificationProperty
Field Value
Type Description
BindableProperty
View Source

ImageShadowProperty

ImageShadow Property

Declaration
C#
Copy
public static readonly BindableProperty ImageShadowProperty
Field Value
Type Description
BindableProperty
View Source

InheritLayoutDirectionProperty

InheritLayoutDirectionProperty

Declaration
C#
Copy
public static readonly BindableProperty InheritLayoutDirectionProperty
Field Value
Type Description
BindableProperty
View Source

InheritOrientationProperty

InheritOrientationProperty

Declaration
C#
Copy
public static readonly BindableProperty InheritOrientationProperty
Field Value
Type Description
BindableProperty
View Source

InheritPositionProperty

InheritPositionProperty

Declaration
C#
Copy
public static readonly BindableProperty InheritPositionProperty
Field Value
Type Description
BindableProperty
View Source

InheritScaleProperty

InheritScaleProperty

Declaration
C#
Copy
public static readonly BindableProperty InheritScaleProperty
Field Value
Type Description
BindableProperty
View Source

IsEnabledProperty

IsEnabledProperty

Declaration
C#
Copy
public static readonly BindableProperty IsEnabledProperty
Field Value
Type Description
BindableProperty
View Source

KeyInputFocusProperty

KeyInputFocusProperty

Declaration
C#
Copy
public static readonly BindableProperty KeyInputFocusProperty
Field Value
Type Description
BindableProperty
View Source

LayoutDirectionProperty

LayoutDirectionProperty

Declaration
C#
Copy
public static readonly BindableProperty LayoutDirectionProperty
Field Value
Type Description
BindableProperty
View Source

LayoutProperty

LayoutProperty

Declaration
C#
Copy
public static readonly BindableProperty LayoutProperty
Field Value
Type Description
BindableProperty
View Source

LayoutTransitionProperty

LayoutTransitionProperty

Declaration
C#
Copy
public static readonly BindableProperty LayoutTransitionProperty
Field Value
Type Description
BindableProperty
View Source

LeaveRequiredProperty

LeaveRequiredProperty

Declaration
C#
Copy
public static readonly BindableProperty LeaveRequiredProperty
Field Value
Type Description
BindableProperty
View Source

LeftFocusableViewProperty

LeftFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty LeftFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

MarginProperty

MarginProperty

Declaration
C#
Copy
public static readonly BindableProperty MarginProperty
Field Value
Type Description
BindableProperty
View Source

MaximumSizeProperty

MaximumSizeProperty

Declaration
C#
Copy
public static readonly BindableProperty MaximumSizeProperty
Field Value
Type Description
BindableProperty
View Source

MinimumSizeProperty

MinimumSizeProperty

Declaration
C#
Copy
public static readonly BindableProperty MinimumSizeProperty
Field Value
Type Description
BindableProperty
View Source

NameProperty

NameProperty

Declaration
C#
Copy
public static readonly BindableProperty NameProperty
Field Value
Type Description
BindableProperty
View Source

OpacityProperty

OpacityProperty

Declaration
C#
Copy
public static readonly BindableProperty OpacityProperty
Field Value
Type Description
BindableProperty
View Source

OrientationProperty

OrientationProperty

Declaration
C#
Copy
public static readonly BindableProperty OrientationProperty
Field Value
Type Description
BindableProperty
View Source

PaddingEXProperty

PaddingEXProperty

Declaration
C#
Copy
public static readonly BindableProperty PaddingEXProperty
Field Value
Type Description
BindableProperty
View Source

PaddingProperty

PaddingProperty

Declaration
C#
Copy
public static readonly BindableProperty PaddingProperty
Field Value
Type Description
BindableProperty
View Source

ParentOriginProperty

ParentOriginProperty

Declaration
C#
Copy
public static readonly BindableProperty ParentOriginProperty
Field Value
Type Description
BindableProperty
View Source

PivotPointProperty

PivotPointProperty

Declaration
C#
Copy
public static readonly BindableProperty PivotPointProperty
Field Value
Type Description
BindableProperty
View Source

Position2DProperty

Position2DProperty

Declaration
C#
Copy
public static readonly BindableProperty Position2DProperty
Field Value
Type Description
BindableProperty
View Source

PositionProperty

PositionProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionProperty
Field Value
Type Description
BindableProperty
View Source

PositionUsesAnchorPointProperty

PositionUsesAnchorPointProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionUsesAnchorPointProperty
Field Value
Type Description
BindableProperty
View Source

PositionUsesPivotPointProperty

PositionUsesPivotPointProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionUsesPivotPointProperty
Field Value
Type Description
BindableProperty
View Source

PositionXProperty

PositionXProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionXProperty
Field Value
Type Description
BindableProperty
View Source

PositionYProperty

PositionYProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionYProperty
Field Value
Type Description
BindableProperty
View Source

PositionZProperty

PositionZProperty

Declaration
C#
Copy
public static readonly BindableProperty PositionZProperty
Field Value
Type Description
BindableProperty
View Source

PropagatableControlStatesProperty

PropagatableControlStatesProperty

Declaration
C#
Copy
public static readonly BindableProperty PropagatableControlStatesProperty
Field Value
Type Description
BindableProperty
View Source

RightFocusableViewProperty

RightFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty RightFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

RowSpanProperty

RowSpanProperty

Declaration
C#
Copy
public static readonly BindableProperty RowSpanProperty
Field Value
Type Description
BindableProperty
View Source

ScaleProperty

ScaleProperty

Declaration
C#
Copy
public static readonly BindableProperty ScaleProperty
Field Value
Type Description
BindableProperty
View Source

ScaleXProperty

ScaleXProperty

Declaration
C#
Copy
public static readonly BindableProperty ScaleXProperty
Field Value
Type Description
BindableProperty
View Source

ScaleYProperty

ScaleYProperty

Declaration
C#
Copy
public static readonly BindableProperty ScaleYProperty
Field Value
Type Description
BindableProperty
View Source

ScaleZProperty

ScaleZProperty

Declaration
C#
Copy
public static readonly BindableProperty ScaleZProperty
Field Value
Type Description
BindableProperty
View Source

SensitiveProperty

SensitiveProperty

Declaration
C#
Copy
public static readonly BindableProperty SensitiveProperty
Field Value
Type Description
BindableProperty
View Source

SiblingOrderProperty

SiblingOrderProperty

Declaration
C#
Copy
public static readonly BindableProperty SiblingOrderProperty
Field Value
Type Description
BindableProperty
View Source

Size2DProperty

Size2DProperty

Declaration
C#
Copy
public static readonly BindableProperty Size2DProperty
Field Value
Type Description
BindableProperty
View Source

SizeHeightProperty

SizeHeightProperty

Declaration
C#
Copy
public static readonly BindableProperty SizeHeightProperty
Field Value
Type Description
BindableProperty
View Source

SizeModeFactorProperty

SizeModeFactorProperty

Declaration
C#
Copy
public static readonly BindableProperty SizeModeFactorProperty
Field Value
Type Description
BindableProperty
View Source

SizeProperty

SizeProperty

Declaration
C#
Copy
public static readonly BindableProperty SizeProperty
Field Value
Type Description
BindableProperty
View Source

SizeScalePolicyProperty

SizeScalePolicyProperty

Declaration
C#
Copy
public static readonly BindableProperty SizeScalePolicyProperty
Field Value
Type Description
BindableProperty
View Source

SizeWidthProperty

SizeWidthProperty

Declaration
C#
Copy
public static readonly BindableProperty SizeWidthProperty
Field Value
Type Description
BindableProperty
View Source

StateProperty

StateProperty

Declaration
C#
Copy
public static readonly BindableProperty StateProperty
Field Value
Type Description
BindableProperty
View Source

StyleNameProperty

StyleNameProperty (DALi json)

Declaration
C#
Copy
public static readonly BindableProperty StyleNameProperty
Field Value
Type Description
BindableProperty
View Source

SubStateProperty

SubStateProperty

Declaration
C#
Copy
public static readonly BindableProperty SubStateProperty
Field Value
Type Description
BindableProperty
View Source

ThemeChangeSensitiveProperty

ThemeChangeSensitive property

Declaration
C#
Copy
public static readonly BindableProperty ThemeChangeSensitiveProperty
Field Value
Type Description
BindableProperty
View Source

TooltipProperty

TooltipProperty

Declaration
C#
Copy
public static readonly BindableProperty TooltipProperty
Field Value
Type Description
BindableProperty
View Source

TooltipTextProperty

TooltipTextProperty

Declaration
C#
Copy
public static readonly BindableProperty TooltipTextProperty
Field Value
Type Description
BindableProperty
View Source

TouchAreaOffsetProperty

TouchAreaOffsetProperty

Declaration
C#
Copy
public static readonly BindableProperty TouchAreaOffsetProperty
Field Value
Type Description
BindableProperty
View Source

TransitionOptionsProperty

TransitionOptionsProperty

Declaration
C#
Copy
public static readonly BindableProperty TransitionOptionsProperty
Field Value
Type Description
BindableProperty
View Source

UpdateAreaHintProperty

UpdateAreaHintProperty

Declaration
C#
Copy
public static readonly BindableProperty UpdateAreaHintProperty
Field Value
Type Description
BindableProperty
View Source

UpFocusableViewProperty

UpFocusableViewProperty

Declaration
C#
Copy
public static readonly BindableProperty UpFocusableViewProperty
Field Value
Type Description
BindableProperty
View Source

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
C#
Copy
public static readonly BindableProperty WeightProperty
Field Value
Type Description
BindableProperty
View Source

WidthForHeightProperty

WidthForHeightProperty

Declaration
C#
Copy
public static readonly BindableProperty WidthForHeightProperty
Field Value
Type Description
BindableProperty
View Source

WidthResizePolicyProperty

WidthResizePolicyProperty

Declaration
C#
Copy
public static readonly BindableProperty WidthResizePolicyProperty
Field Value
Type Description
BindableProperty
View Source

WidthSpecificationProperty

WidthSpecificationProperty

Declaration
C#
Copy
public static readonly BindableProperty WidthSpecificationProperty
Field Value
Type Description
BindableProperty

Properties

View Source

AccessibilityAttributes

Dictionary of accessibility attributes (key-value pairs of strings).

Declaration
C#
Copy
public Dictionary<string, string> AccessibilityAttributes { get; }
Property Value
Type Description
Dictionary<String, String>
View Source

AccessibilityDescription

Gets or sets accessibility description.

Declaration
C#
Copy
public string AccessibilityDescription { get; set; }
Property Value
Type Description
String
View Source

AccessibilityDynamicAttributes

Dictionary of dynamically-evaluated accessibility attributes (key-value pairs of strings).

Declaration
C#
Copy
public Dictionary<string, Func<string>> AccessibilityDynamicAttributes { get; }
Property Value
Type Description
Dictionary<String, Func<String>>
View Source

AccessibilityHidden

Controls whether the view is hidden from the AT-SPI tree.

Declaration
C#
Copy
public bool AccessibilityHidden { get; set; }
Property Value
Type Description
Boolean
Remarks

False by default. Hiding an object means that any AT-SPI clients are not able to see it.

View Source

AccessibilityHighlightable

Gets or sets whether the view is highlightable for accessibility or not.

Declaration
C#
Copy
public bool AccessibilityHighlightable { get; set; }
Property Value
Type Description
Boolean
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.

View Source

AccessibilityName

Gets or sets accessibility name.

Declaration
C#
Copy
public string AccessibilityName { get; set; }
Property Value
Type Description
String
View Source

AccessibilityRole

Gets or sets accessibility role.

Declaration
C#
Copy
public Role AccessibilityRole { get; set; }
Property Value
Type Description
Role
View Source

AccessibilitySuppressedEvents

Modifiable collection of suppressed AT-SPI events (D-Bus signals).

Declaration
C#
Copy
public AccessibilityEvents AccessibilitySuppressedEvents { get; }
Property Value
Type Description
AccessibilityEvents
View Source

AccessibilityTranslationDomain

Gets or sets accessibility translation domain.

Declaration
C#
Copy
public string AccessibilityTranslationDomain { get; set; }
Property Value
Type Description
String
View Source

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
C#
Copy
public int AlignSelf { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

AliveCount

Gets the number of currently alived View object.

Declaration
C#
Copy
public static int AliveCount { get; }
Property Value
Type Description
Int32
View Source

AllowOnlyOwnTouch

Whether the view will only receive own touch.

Declaration
C#
Copy
public bool AllowOnlyOwnTouch { get; set; }
Property Value
Type Description
Boolean

true, if it only receives touches that started from itself.

View Source

AnchorPoint

This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead.

Declaration
C#
Copy
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.

API Level: 3
View Source

AutomationId

Gets or sets a value that allows the automation framework to find and interact with this element.

Declaration
C#
Copy
public string AutomationId { get; set; }
Property Value
Type Description
String
View Source

Background

The background of view.

Declaration
C#
Copy
public PropertyMap Background { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

BackgroundColor

The mutually exclusive with "backgroundImage" and "background" type Vector4.

Declaration
C#
Copy
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.

Copy
animation.AnimateTo(view, "BackgroundColor", new Color(r, g, b, a));

Examples

This way is recommended for setting the property

Copy
var view = new View(); view.BackgroundColor = new Color(0.5f, 0.1f, 0, 1);

This way to set the property is prohibited

Copy
view.BackgroundColor.R = 0.5f; //This does not guarantee a proper operation
API Level: 3
View Source

BackgroundImage

The mutually exclusive with "backgroundColor" and "background" type Map.

Declaration
C#
Copy
public string BackgroundImage { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

BackgroundImageBorder

Get or set the border of background image.

Declaration
C#
Copy
public Rectangle BackgroundImageBorder { get; set; }
Property Value
Type Description
Rectangle
View Source

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
C#
Copy
public bool BackgroundImageSynchronosLoading { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool BackgroundImageSynchronousLoading { get; set; }
Property Value
Type Description
Boolean
View Source

BlendEquation

Determines which blend equation will be used to render renderers of this actor.

Declaration
C#
Copy
public BlendEquationType BlendEquation { get; set; }
Property Value
Type Description
BlendEquationType

blend equation enum currently assigned

View Source

BorderlineColor

The color for the borderline of the View. It is Color.Black by default.

Declaration
C#
Copy
public Color BorderlineColor { get; set; }
Property Value
Type Description
Color
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "BorderlineColor", new Color(r, g, b, a));

API Level: 9
View Source

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
C#
Copy
public float BorderlineOffset { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "BorderlineOffset", -1.0f);

API Level: 9
View Source

BorderlineWidth

The width for the borderline of the View.

Declaration
C#
Copy
public float BorderlineWidth { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "BorderlineWidth", 100.0f);

Note that, an image background may not have borderline if it uses the Border property.

API Level: 9
View Source

BoxShadow

Describes a box shaped shadow drawing for a View. It is null by default.

Declaration
C#
Copy
public Shadow BoxShadow { get; set; }
Property Value
Type Description
Shadow
Remarks

The mutually exclusive with "ImageShadow".

API Level: 9
View Source

CellHorizontalAlignment

The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.

Declaration
C#
Copy
public HorizontalAlignmentType CellHorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignmentType
Remarks

This property is for TableView class. Use the property for the child position of TableView.

API Level: 3
View Source

CellIndex

The top-left cell this child occupies, if not set, the first available cell is used.

Declaration
C#
Copy
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

Copy
var view = new View(); view.CellIndex = new Vector2(1, 3);

This way to set the property is prohibited

Copy
view.CellIndex.X = 1; //This does not guarantee a proper operation
API Level: 3
View Source

CellVerticalAlignment

The vertical alignment of this child inside the cells, if not set, the default value is 'top'.

Declaration
C#
Copy
public VerticalAlignmentType CellVerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignmentType
Remarks

This property is for TableView class. Use the property for the child position of TableView.

API Level: 3
View Source

ChildCount

Get the number of children held by the view.

Declaration
C#
Copy
public uint ChildCount { get; }
Property Value
Type Description
UInt32
API Level: 3
View Source

ClippingMode

Gets or sets the clipping behavior (mode) of it's children.

Declaration
C#
Copy
public ClippingModeType ClippingMode { get; set; }
Property Value
Type Description
ClippingModeType
API Level: 3
View Source

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
C#
Copy
public View ClockwiseFocusableView { get; set; }
Property Value
Type Description
View
View Source

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
C#
Copy
public Color Color { get; set; }
Property Value
Type Description
Color
Remarks

Animatable - This property can be animated using Animation class.

The property cascade chaining set is not recommended.

Examples

This way is recommended for setting the property

Copy
var view = new View(); view.Color = new Color(0.5f, 0.2f, 0.1f, 0.5f);

This way to set the property is prohibited

Copy
view.Color.A = 0.5f; //This does not guarantee a proper operation
View Source

ColorBlue

The Blue component of View.Color.

Declaration
C#
Copy
public float ColorBlue { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

View Source

ColorGreen

The Green component of View.Color.

Declaration
C#
Copy
public float ColorGreen { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

View Source

ColorRed

The Red component of View.Color.

Declaration
C#
Copy
public float ColorRed { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

View Source

ColumnSpan

The number of columns this child occupies, if not set, the default value is 1.

Declaration
C#
Copy
public float ColumnSpan { get; set; }
Property Value
Type Description
Single
Remarks

This property is for TableView class. Use the property for the child position of TableView.

API Level: 3
View Source

ControlState

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
C#
Copy
public ControlState ControlState { get; protected set; }
Property Value
Type Description
ControlState
View Source

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
C#
Copy
public Vector4 CornerRadius { get; set; }
Property Value
Type Description
Vector4
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "CornerRadius", new Vector4(10, 10, 10, 10));

API Level: 9
View Source

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
C#
Copy
public VisualTransformPolicyType CornerRadiusPolicy { get; set; }
Property Value
Type Description
VisualTransformPolicyType
API Level: 9
View Source

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
C#
Copy
public View CounterClockwiseFocusableView { get; set; }
Property Value
Type Description
View
View Source

Culled

Get whether the View is culled or not. True means that the View is out of the view frustum.

Declaration
C#
Copy
public bool Culled { get; }
Property Value
Type Description
Boolean
Remarks

Hidden-API (Inhouse-API).

View Source

CurrentColor

Retrieve the View's current Color.

Declaration
C#
Copy
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.

View Source

CurrentPosition

Retrieves the position of the view. The coordinates are relative to the view's parent.

Declaration
C#
Copy
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.

API Level: 3
View Source

CurrentScale

Retrieve the current scale factor applied to the View.

Declaration
C#
Copy
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.

View Source

CurrentSize

Retrieves the size of the view. The coordinates are relative to the view's parent.

Declaration
C#
Copy
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.

API Level: 3
View Source

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
C#
Copy
public bool DisallowInterceptTouchEvent { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DisallowInterceptWheelEvent { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchGestureEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchHoverEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchHoverMotion { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchKeyEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchParentGestureEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchParentHoverEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchParentTouchEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchParentWheelEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchTouchEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchTouchMotion { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool DispatchWheelEvents { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public View DownFocusableView { get; set; }
Property Value
Type Description
View
API Level: 3
View Source

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
C#
Copy
public DrawModeType DrawMode { get; set; }
Property Value
Type Description
DrawModeType
API Level: 3
View Source

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
C#
Copy
public bool EnableControlState { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool EnableControlStatePropagation { get; set; }
Property Value
Type Description
Boolean
View Source

ExcludeLayouting

Gets / Sets the status of whether the view is excluded from its parent's layouting or not.

Declaration
C#
Copy
public bool ExcludeLayouting { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public float Flex { get; set; }
Property Value
Type Description
Single
API Level: 3
View Source

FlexMargin

The Child property of FlexContainer.
The space around the flex item.

Declaration
C#
Copy
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.

API Level: 3
View Source

Focusable

Whether the view should be focusable by keyboard navigation.

Declaration
C#
Copy
public bool Focusable { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

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
C#
Copy
public bool FocusableChildren { get; set; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool FocusableInTouch { get; set; }
Property Value
Type Description
Boolean
View Source

GrabTouchAfterLeave

Whether the actor grab all touches even if touch leaves its boundary.

Declaration
C#
Copy
public bool GrabTouchAfterLeave { get; set; }
Property Value
Type Description
Boolean

true, if it grab all touch after start

View Source

HeightForWidth

Gets or sets the status of whether the height size is dependent on the width size.

Declaration
C#
Copy
public bool HeightForWidth { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

HeightResizePolicy

Gets or sets the height resize policy to be used.

Declaration
C#
Copy
public ResizePolicyType HeightResizePolicy { get; set; }
Property Value
Type Description
ResizePolicyType
API Level: 3
View Source

HeightSpecification

The required policy for this dimension, LayoutParamPolicies values or exact value.

Declaration
C#
Copy
public int HeightSpecification { get; set; }
Property Value
Type Description
Int32
Examples
Copy
// 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;
API Level: 6
View Source

HierarchyDepth

Gets the depth in the hierarchy for the view.

Declaration
C#
Copy
public int HierarchyDepth { get; }
Property Value
Type Description
Int32
API Level: 3
View Source

ID

Gets the view's ID. Read-only

Declaration
C#
Copy
public uint ID { get; }
Property Value
Type Description
UInt32
API Level: 3
View Source

ImageShadow

Describes a shadow as an image for a View. It is null by default.

Declaration
C#
Copy
public ImageShadow ImageShadow { get; set; }
Property Value
Type Description
ImageShadow
Remarks

Getter returns copied instance of current shadow.

View Source

InheritLayoutDirection

Gets/Sets whether inherit parent's the layout Direction.

Declaration
C#
Copy
public bool InheritLayoutDirection { get; set; }
Property Value
Type Description
Boolean
API Level: 4
View Source

InheritOrientation

Gets or sets the status of whether a child view inherits it's parent's orientation.

Declaration
C#
Copy
public bool InheritOrientation { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

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
C#
Copy
public bool InheritPosition { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

InheritScale

Gets or sets the status of whether a child view inherits it's parent's scale.

Declaration
C#
Copy
public bool InheritScale { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

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
C#
Copy
public bool IsEnabled { get; set; }
Property Value
Type Description
Boolean
API Level: tizen_next
View Source

IsHighlighted

Flag to check whether this view is highlighted or not.

Declaration
C#
Copy
protected bool IsHighlighted { get; }
Property Value
Type Description
Boolean
View Source

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
C#
Copy
public bool IsOnWindow { get; }
Property Value
Type Description
Boolean
API Level: 3
View Source

KeyInputFocus

The KeyInputFocus, type bool.

Declaration
C#
Copy
public bool KeyInputFocus { get; set; }
Property Value
Type Description
Boolean
View Source

Layout

Set the layout on this View. Replaces any existing Layout.

Declaration
C#
Copy
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.

API Level: 6
View Source

LayoutDirection

Gets/Sets the layout Direction.

Declaration
C#
Copy
public ViewLayoutDirectionType LayoutDirection { get; set; }
Property Value
Type Description
ViewLayoutDirectionType
API Level: 4
View Source

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
C#
Copy
public static bool LayoutingDisabled { get; set; }
Property Value
Type Description
Boolean
View Source

LayoutSet

Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.

Declaration
C#
Copy
public bool LayoutSet { get; }
Property Value
Type Description
Boolean
View Source

LayoutTransition

Sets a layout transitions for this View.

Declaration
C#
Copy
public LayoutTransition LayoutTransition { get; set; }
Property Value
Type Description
LayoutTransition
Remarks

Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.

API Level: 6
View Source

LayoutTransitions

Gets the List of transitions for this View.

Declaration
C#
Copy
public Dictionary<TransitionCondition, TransitionList> LayoutTransitions { get; }
Property Value
Type Description
Dictionary<TransitionCondition, TransitionList>
API Level: 6
View Source

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
C#
Copy
public bool LeaveRequired { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

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
C#
Copy
public View LeftFocusableView { get; set; }
Property Value
Type Description
View
API Level: 3
View Source

Margin

Gets or sets the Margin for use in layout.

Declaration
C#
Copy
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

Copy
var view = new View(); view.Margin = new Extents(10, 5, 15, 20);

This way to set the property is prohibited

Copy
view.Margin.Top = 15; //This does not guarantee a proper operation
API Level: 4
View Source

MaximumSize

Gets or sets the maximum size the view can be assigned in size negotiation.

Declaration
C#
Copy
public Size2D MaximumSize { get; set; }
Property Value
Type Description
Size2D
Examples

This way is recommended for setting the property

Copy
var view = new View(); view.MaximumSize = new Size2D(100, 200);

This way to set the property is prohibited

Copy
view.MaximumSize.Height = 200; //This does not guarantee a proper operation
API Level: 3
View Source

MinimumSize

Gets or sets the minimum size the view can be assigned in size negotiation.

Declaration
C#
Copy
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

Copy
var view = new View(); view.MinimumSize = new Size2D(100, 200);

This way to set the property is prohibited

Copy
view.MinimumSize.Width = 100; //This does not guarantee a proper operation
API Level: 3
View Source

Name

Gets or sets the view's name.

Declaration
C#
Copy
public string Name { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

NaturalSize

Returns the natural size of the view.

Declaration
C#
Copy
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.

API Level: 5
View Source

NaturalSize2D

Returns the natural size (Size2D) of the view.

Declaration
C#
Copy
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.

API Level: 4
View Source

Opacity

Retrieves and sets the view's opacity.

Declaration
C#
Copy
public float Opacity { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "Opacity", 0.5f);

API Level: 3
View Source

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
C#
Copy
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.

Copy
animation.AnimateTo(view, "Orientation", new Rotation(new Radian((float)Math.PI), Vector3.XAxis));

API Level: 3
View Source

Padding

Gets or sets the padding for use in layout.

Declaration
C#
Copy
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

Copy
var view = new View(); view.Padding = new Extents(5, 5, 5, 5);

This way to set the property is prohibited

Copy
view.Padding.Start = 5; //This does not guarantee a proper operation
API Level: 5
View Source

PaddingEX

This has been deprecated in API5 and will be removed in API8. Use Padding instead.

Declaration
C#
Copy
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.

API Level: 4
View Source

Parent

This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead.

Declaration
C#
Copy
public View Parent { get; }
Property Value
Type Description
View
API Level: 3
View Source

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
C#
Copy
public Position ParentOrigin { get; set; }
Property Value
Type Description
Position
API Level: 3
Precondition: The view has been initialized.
View Source

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
C#
Copy
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

Copy
var view = new View(); view.PivotPoint = PivotPoint.Center;

This way to set the property is prohibited

Copy
view.PivotPoint.X = 0.5f; //This does not guarantee a proper operation
API Level: 3
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
C#
Copy
public Position Position { get; set; }
Property Value
Type Description
Position
Remarks

Animatable - This property can be animated using Animation class.

Copy
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

Copy
var view = new View(); view.Position = new Position(100, 200.5f, 0);

This way to set the property is prohibited

Copy
view.Position.Y = 200.5f; //This does not guarantee a proper operation
API Level: 3
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
C#
Copy
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

Copy
var view = new View(); view.Position2D = new Position2D(100, 200);

This way to set the property is prohibited

Copy
view.Position2D.X = 100; //This does not guarantee a proper operation
API Level: 3
View Source

PositionUsesAnchorPoint

This has been deprecated in API5 and Will be removed in API8. Use PositionUsesPivotPoint instead.

Declaration
C#
Copy
public bool PositionUsesAnchorPoint { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

PositionUsesPivotPoint

Determines whether the pivot point should be used to determine the position of the view. This is false by default.

Declaration
C#
Copy
public bool PositionUsesPivotPoint { get; set; }
Property Value
Type Description
Boolean
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.

API Level: 3
View Source

PositionX

Gets or sets the position X of the view.

Declaration
C#
Copy
public float PositionX { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "PositionX", 50.0f);

API Level: 3
View Source

PositionY

Gets or sets the position Y of the view.

Declaration
C#
Copy
public float PositionY { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "PositionY", 50.0f);

API Level: 3
View Source

PositionZ

Gets or sets the position Z of the view.

Declaration
C#
Copy
public float PositionZ { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "PositionZ", 50.0f);

API Level: 3
View Source

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
C#
Copy
public ControlState PropagatableControlStates { get; set; }
Property Value
Type Description
ControlState
View Source

RendererCount

Gets the number of renderers held by the view.

Declaration
C#
Copy
public uint RendererCount { get; }
Property Value
Type Description
UInt32
API Level: 3
View Source

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
C#
Copy
public View RightFocusableView { get; set; }
Property Value
Type Description
View
API Level: 3
View Source

RowSpan

The number of rows this child occupies, if not set, the default value is 1.

Declaration
C#
Copy
public float RowSpan { get; set; }
Property Value
Type Description
Single
Remarks

This property is for TableView class. Use the property for the child position of TableView.

API Level: 3
View Source

Scale

Gets or sets the scale factor applied to the view.

Declaration
C#
Copy
public Vector3 Scale { get; set; }
Property Value
Type Description
Vector3
Remarks

Animatable - This property can be animated using Animation class.

Copy
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

Copy
var view = new View(); view.Scale = new Vector3(1.5f, 2.0f, 1.0f);

This way to set the property is prohibited

Copy
view.Scale.Width = 1.5f; //This does not guarantee a proper operation
API Level: 3
View Source

ScaleX

Gets or sets the scale X factor applied to the view.

Declaration
C#
Copy
public float ScaleX { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "ScaleX", 1.5f);

API Level: 3
View Source

ScaleY

Gets or sets the scale Y factor applied to the view.

Declaration
C#
Copy
public float ScaleY { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "ScaleY", 1.5f);

API Level: 3
View Source

ScaleZ

Gets or sets the scale Z factor applied to the view.

Declaration
C#
Copy
public float ScaleZ { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "ScaleZ", 1.5f);

API Level: 3
View Source

ScreenPosition

Retrieves the screen position of the view.

Declaration
C#
Copy
public Vector2 ScreenPosition { get; }
Property Value
Type Description
Vector2
API Level: 3
View Source

ScreenPositionSize

Retrieves the screen position and size of the view.

Declaration
C#
Copy
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.

View Source

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
C#
Copy
public bool Sensitive { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

SiblingOrder

Sets the sibling order of the view so the depth position can be defined within the same parent.

Declaration
C#
Copy
public int SiblingOrder { get; set; }
Property Value
Type Description
Int32
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.

API Level: 3
View Source

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
C#
Copy
public Size Size { get; set; }
Property Value
Type Description
Size
Remarks

Animatable - This property can be animated using Animation class.

Copy
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

Copy
var view = new View(); view.Size = new Size(100.5f, 200, 0);

This way to set the property is prohibited

Copy
view.Size.Width = 100.5f; //This does not guarantee a proper operation
API Level: 5
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
C#
Copy
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

Copy
var view = new View(); view.Size2D = new Size2D(100, 200);

This way to set the property is prohibited

Copy
view.Size2D.Width = 100; //This does not guarantee a proper operation
API Level: 3
View Source

SizeHeight

Gets or sets the size height of the view.

Declaration
C#
Copy
public float SizeHeight { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "SizeHeight", 500.0f);
API Level: 3
View Source

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
C#
Copy
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

Copy
var text = new TextField(); text.SizeModeFactor = new Vector3(1.0f, 0.45f, 1.0f);

This way to set the property is prohibited

Copy
text.SizeModeFactor.Width = 1.0f; //This does not guarantee a proper operation
API Level: 3
View Source

SizeScalePolicy

Gets or sets the policy to use when setting size with size negotiation.
Defaults to SizeScalePolicyType.UseSizeSet.

Declaration
C#
Copy
public SizeScalePolicyType SizeScalePolicy { get; set; }
Property Value
Type Description
SizeScalePolicyType
API Level: 3
View Source

SizeWidth

Gets or sets the size width of the view.

Declaration
C#
Copy
public float SizeWidth { get; set; }
Property Value
Type Description
Single
Remarks

Animatable - This property can be animated using Animation class.

Copy
animation.AnimateTo(view, "SizeWidth", 500.0f);

API Level: 3
View Source

State

The current state of the view.

Declaration
C#
Copy
public View.States State { get; set; }
Property Value
Type Description
View.States
API Level: 3
View Source

StyleName

The StyleName, type string. The value indicates DALi style name defined in json theme file.

Declaration
C#
Copy
public string StyleName { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

SubState

The current sub state of the view.

Declaration
C#
Copy
public View.States SubState { get; set; }
Property Value
Type Description
View.States
API Level: 3
View Source

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
C#
Copy
public bool ThemeChangeSensitive { get; set; }
Property Value
Type Description
Boolean
API Level: 9
View Source

Tooltip

Displays a tooltip

Declaration
C#
Copy
public PropertyMap Tooltip { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

TooltipText

Displays a tooltip as a text.

Declaration
C#
Copy
public string TooltipText { get; set; }
Property Value
Type Description
String
API Level: 3
View Source

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
C#
Copy
public Offset TouchAreaOffset { get; set; }
Property Value
Type Description
Offset
Remarks

This is based on the top left x, y coordinates.
For example)

Copy
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 |
+---------------------+

View Source

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
C#
Copy
public TransitionOptions TransitionOptions { get; set; }
Property Value
Type Description
TransitionOptions
API Level: 9
View Source

UpdateAreaHint

Declaration
C#
Copy
public Vector4 UpdateAreaHint { get; set; }
Property Value
Type Description
Vector4
View Source

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
C#
Copy
public View UpFocusableView { get; set; }
Property Value
Type Description
View
API Level: 3
View Source

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
C#
Copy
protected ViewStyle ViewStyle { get; }
Property Value
Type Description
ViewStyle
View Source

Visibility

Retrieves the visibility flag of the view.

Declaration
C#
Copy
public bool Visibility { get; }
Property Value
Type Description
Boolean
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.

Copy
animation.AnimateTo(view, "Visibility", false);

API Level: 3
View Source

Weight

The weight of the View, used to share available space in a layout with siblings.

Declaration
C#
Copy
public float Weight { get; set; }
Property Value
Type Description
Single
API Level: 6
View Source

WidthForHeight

Gets or sets the status of whether the width size is dependent on the height size.

Declaration
C#
Copy
public bool WidthForHeight { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

WidthResizePolicy

Gets or sets the width resize policy to be used.

Declaration
C#
Copy
public ResizePolicyType WidthResizePolicy { get; set; }
Property Value
Type Description
ResizePolicyType
API Level: 3
View Source

WidthSpecification

The required policy for this dimension, LayoutParamPolicies values or exact value.

Declaration
C#
Copy
public int WidthSpecification { get; set; }
Property Value
Type Description
Int32
Examples
Copy
// 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;
API Level: 6
View Source

WorldColor

Gets the view's world color.

Declaration
C#
Copy
public Vector4 WorldColor { get; }
Property Value
Type Description
Vector4
API Level: 3
View Source

WorldOrientation

Gets or sets the world orientation of the view.

Declaration
C#
Copy
public Rotation WorldOrientation { get; }
Property Value
Type Description
Rotation
API Level: 3
View Source

WorldPosition

Gets or sets the world position of the view.

Declaration
C#
Copy
public Vector3 WorldPosition { get; }
Property Value
Type Description
Vector3
API Level: 3
View Source

WorldScale

Gets the world scale of the view.

Declaration
C#
Copy
public Vector3 WorldScale { get; }
Property Value
Type Description
Vector3
API Level: 3

Methods

View Source

AccessibilityCalculateStates()

Declaration
C#
Copy
protected virtual AccessibilityStates AccessibilityCalculateStates()
Returns
Type Description
AccessibilityStates
View Source

AccessibilityDoAction(String)

Declaration
C#
Copy
protected virtual bool AccessibilityDoAction(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Boolean
View Source

AccessibilityGetActionCount()

Declaration
C#
Copy
protected virtual int AccessibilityGetActionCount()
Returns
Type Description
Int32
View Source

AccessibilityGetActionName(Int32)

Declaration
C#
Copy
protected virtual string AccessibilityGetActionName(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
String
View Source

AccessibilityGetDescription()

Declaration
C#
Copy
protected virtual string AccessibilityGetDescription()
Returns
Type Description
String
View Source

AccessibilityGetName()

Declaration
C#
Copy
protected virtual string AccessibilityGetName()
Returns
Type Description
String
View Source

AccessibilityIsScrollable()

Declaration
C#
Copy
protected virtual bool AccessibilityIsScrollable()
Returns
Type Description
Boolean
View Source

AccessibilityScrollToChild(View)

Declaration
C#
Copy
protected virtual bool AccessibilityScrollToChild(View child)
Parameters
Type Name Description
View child
Returns
Type Description
Boolean
View Source

Add(View)

Adds a child view to this view.

Declaration
C#
Copy
public override void Add(View child)
Parameters
Type Name Description
View child
Overrides
See Also
API Level: 4
View Source

AddRenderer(Renderer)

Declaration
C#
Copy
public uint AddRenderer(Renderer renderer)
Parameters
Type Name Description
Renderer renderer
Returns
Type Description
UInt32
API Level: 3
View Source

AnimateBackgroundColor(Object, Int32, Int32, Nullable<AlphaFunction.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
C#
Copy
public Animation AnimateBackgroundColor(object destinationValue, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialValue = null)
Parameters
Type Name Description
Object destinationValue
Int32 startTime
Int32 endTime
Nullable<AlphaFunction.BuiltinFunctions> alphaFunction
Object initialValue
Returns
Type Description
Animation
API Level: 3
View Source

AnimateColor(String, Object, Int32, Int32, Nullable<AlphaFunction.BuiltinFunctions>, Object)

Creates an animation to animate the mixColor of the named visual.

Declaration
C#
Copy
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
Int32 startTime
Int32 endTime
Nullable<AlphaFunction.BuiltinFunctions> alphaFunction
Object initialColor
Returns
Type Description
Animation
API Level: 3
View Source

AppendAccessibilityRelation(View, AccessibilityRelationType)

Creates relation between objects.

Declaration
C#
Copy
public void AppendAccessibilityRelation(View second, AccessibilityRelationType relation)
Parameters
Type Name Description
View second

Object which will be in relation.

AccessibilityRelationType relation

Relation type.

View Source

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
C#
Copy
public virtual void ApplyStyle(ViewStyle viewStyle)
Parameters
Type Name Description
ViewStyle viewStyle
API Level: 9
View Source

CalculateScreenPosition()

Calculate the screen position of the view.

Declaration
C#
Copy
public Vector2 CalculateScreenPosition()
Returns
Type Description
Vector2
Remarks

This is a hidden API(inhouse API) only for internal purpose.

View Source

CalculateScreenPositionSize()

Calculate the screen position and size of the view.

Declaration
C#
Copy
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.

View Source

CheckResourceReady()

Declaration
C#
Copy
protected virtual bool CheckResourceReady()
Returns
Type Description
Boolean
View Source

ClearAccessibilityHighlight()

Clears accessibility highlight.

Declaration
C#
Copy
public bool ClearAccessibilityHighlight()
Returns
Type Description
Boolean

True if cleared, otherwise false when it is not possible

View Source

ClearAccessibilityRelations()

Removes all previously appended relations.

Declaration
C#
Copy
public void ClearAccessibilityRelations()
View Source

ClearBackground()

Clears the background.

Declaration
C#
Copy
public void ClearBackground()
API Level: 3
View Source

CreateViewStyle()

Create Style, it is abstract function and must be override.

Declaration
C#
Copy
protected virtual ViewStyle CreateViewStyle()
Returns
Type Description
ViewStyle
View Source

Dispose(Boolean)

Declaration
C#
Copy
protected override void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing
Overrides
View Source

Dispose(DisposeTypes)

you can override it to clean-up your own resources.

Declaration
C#
Copy
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

DisposeTypes

Overrides
API Level: 3
View Source

DoAction(Int32, Int32, 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
C#
Copy
public void DoAction(int propertyIndexOfVisual, int propertyIndexOfActionId, PropertyValue attributes)
Parameters
Type Name Description
Int32 propertyIndexOfVisual

The Property index of the visual.

Int32 propertyIndexOfActionId

The action to perform. See Visual to find the supported actions.

PropertyValue attributes

Optional attributes for the action.

API Level: 5
View Source

EmitAccessibilityEvent(AccessibilityPropertyChangeEvent)

Emits accessibility property changed event.

Declaration
C#
Copy
public void EmitAccessibilityEvent(AccessibilityPropertyChangeEvent changeEvent)
Parameters
Type Name Description
AccessibilityPropertyChangeEvent changeEvent

Property changed event

View Source

EmitAccessibilityStateChangedEvent(AccessibilityState, Boolean)

Emits accessibility states changed event.

Declaration
C#
Copy
public void EmitAccessibilityStateChangedEvent(AccessibilityState state, bool equal)
Parameters
Type Name Description
AccessibilityState state

Accessibility state

Boolean equal

True if the state is set or enabled, otherwise false

View Source

EmitScrollFinishedEvent()

Emits accessibility scroll finished event.

Declaration
C#
Copy
public void EmitScrollFinishedEvent()
View Source

EmitScrollStartedEvent()

Emits accessibility scroll started event.

Declaration
C#
Copy
public void EmitScrollStartedEvent()
View Source

EmitTextCursorMovedEvent(Int32)

Emits accessibility text cursor moved event.

Declaration
C#
Copy
public void EmitTextCursorMovedEvent(int cursorPosition)
Parameters
Type Name Description
Int32 cursorPosition

The new cursor position

View Source

EmitTextDeletedEvent(Int32, Int32, String)

Emits accessibility text deleted event.

Declaration
C#
Copy
public void EmitTextDeletedEvent(int cursorPosition, int length, string content)
Parameters
Type Name Description
Int32 cursorPosition

Text cursor position

Int32 length

Text length

String content

Inserted text content

View Source

EmitTextInsertedEvent(Int32, Int32, String)

Emits accessibility text inserted event.

Declaration
C#
Copy
public void EmitTextInsertedEvent(int cursorPosition, int length, string content)
Parameters
Type Name Description
Int32 cursorPosition

Text cursor position

Int32 length

Text length

String content

Inserted text content

View Source

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
C#
Copy
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.

Precondition: The view has been initialized.
View Source

FindChildByID(UInt32)

Search through this View's hierarchy for a View with the given unique ID. The View itself is also considered in the search.

Declaration
C#
Copy
public View FindChildByID(uint id)
Parameters
Type Name Description
UInt32 id

The ID of the View to find

Returns
Type Description
View

A View if found or a null if not

View Source

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
C#
Copy
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.

API Level: 3
Precondition: The view has been initialized.
View Source

FindDescendantByID(UInt32)

Search through this View's hierarchy for a View with the given unique ID.

Declaration
C#
Copy
public View FindDescendantByID(uint id)
Parameters
Type Name Description
UInt32 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.

API Level: 9
View Source

GetAccessibilityReadingInfoTypes()

Gets accessibility reading information.

Declaration
C#
Copy
public AccessibilityReadingInfoTypes GetAccessibilityReadingInfoTypes()
Returns
Type Description
AccessibilityReadingInfoTypes

Reading information type

View Source

GetAccessibilityRelations()

Gets accessibility collection connected with the current object.

Declaration
C#
Copy
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

View Source

GetAccessibilityStates()

Gets Accessibility States.

Declaration
C#
Copy
public AccessibilityStates GetAccessibilityStates()
Returns
Type Description
AccessibilityStates

Accessibility States

View Source

GetChildAnimatableAt(UInt32)

Retrieves a child view as Animatable by index.

Declaration
C#
Copy
public Animatable GetChildAnimatableAt(uint index)
Parameters
Type Name Description
UInt32 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.

View Source

GetChildAt(UInt32)

Retrieves a child view by index.

Declaration
C#
Copy
public override View GetChildAt(uint index)
Parameters
Type Name Description
UInt32 index
Returns
Type Description
View
Overrides
See Also
API Level: 4
View Source

GetChildCount()

Retrieves the number of children held by the view.

Declaration
C#
Copy
public override uint GetChildCount()
Returns
Type Description
UInt32
Overrides
See Also
API Level: 4
View Source

GetHeightForWidth(Single)

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
C#
Copy
public float GetHeightForWidth(float width)
Parameters
Type Name Description
Single width

The width to use.

Returns
Type Description
Single

The height based on the width.

API Level: 3
View Source

GetLayer()

Gets the parent layer of this view.If a view has no parent, this method does not do anything.

Declaration
C#
Copy
public Layer GetLayer()
Returns
Type Description
Layer

The parent layer of view

API Level: 5
Precondition: The view has been initialized.
View Source

GetPadding(PaddingType)

Return the value of padding for the view.

Declaration
C#
Copy
public void GetPadding(PaddingType paddingOut)
Parameters
Type Name Description
PaddingType paddingOut

the value of padding for the view

API Level: 3
View Source

GetParent()

Gets the views parent.

Declaration
C#
Copy
public override Container GetParent()
Returns
Type Description
Container
Overrides
See Also
API Level: 4
View Source

GetRelayoutSize(DimensionType)

Return the amount of size allocated for relayout.

Declaration
C#
Copy
public float GetRelayoutSize(DimensionType dimension)
Parameters
Type Name Description
DimensionType dimension

The dimension to retrieve.

Returns
Type Description
Single

Return the size.

API Level: 3
View Source

GetRendererAt(UInt32)

Declaration
C#
Copy
public Renderer GetRendererAt(uint index)
Parameters
Type Name Description
UInt32 index
Returns
Type Description
Renderer
API Level: 3
View Source

GetStyleName()

Retrieves the name of the style to be applied to the view (if any).

Declaration
C#
Copy
public string GetStyleName()
Returns
Type Description
String

A string matching a style, or an empty string.

API Level: 3
View Source

GetWidthForHeight(Single)

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
C#
Copy
public float GetWidthForHeight(float height)
Parameters
Type Name Description
Single height

The height to use.

Returns
Type Description
Single

The width based on the height.

API Level: 3
View Source

GrabAccessibilityHighlight()

Grabs accessibility highlight.

Declaration
C#
Copy
public bool GrabAccessibilityHighlight()
Returns
Type Description
Boolean

True if cleared, otherwise false when it is not possible

View Source

HandleControlStateOnTouch(Touch)

The touch event handler for ControlState. Please change ControlState value by touch state if needed.

Declaration
C#
Copy
protected virtual bool HandleControlStateOnTouch(Touch touch)
Parameters
Type Name Description
Touch touch
Returns
Type Description
Boolean
View Source

HasFocus()

Queries whether the view has a focus.

Declaration
C#
Copy
public bool HasFocus()
Returns
Type Description
Boolean

True if this view has a focus.

API Level: 3
View Source

Hide()

Hides the view.

Declaration
C#
Copy
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.

API Level: 3
View Source

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
C#
Copy
protected virtual bool HitTest(Touch touch)
Parameters
Type Name Description
Touch touch
Returns
Type Description
Boolean
View Source

InitializeStyle(ViewStyle)

Apply initial style to the view.

Declaration
C#
Copy
protected virtual void InitializeStyle(ViewStyle style = null)
Parameters
Type Name Description
ViewStyle style
View Source

IsResourceReady()

Queries if all resources required by a view are loaded and ready.

Declaration
C#
Copy
public bool IsResourceReady()
Returns
Type Description
Boolean
Remarks

Most resources are only loaded when the control is placed on the stage.

API Level: 3
View Source

LookAt(Vector3, Vector3, Vector3, Vector3)

Rotate the view look at specific position. It will change the view's orientation property.

Declaration
C#
Copy
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

View Source

Lower()

Lower the view below the previous sibling view.

Declaration
C#
Copy
public void Lower()
API Level: 9
View Source

LowerBelow(View)

Lowers the view to below the target view.

Declaration
C#
Copy
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.

API Level: 9
View Source

LowerToBottom()

Lowers the view to the bottom of all views.

Declaration
C#
Copy
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.

API Level: 3
View Source

NotifyAccessibilityStatesChange(AccessibilityStates, AccessibilityStatesNotifyMode)

Notifies sending notifications about the current states to accessibility clients.

Declaration
C#
Copy
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.

View Source

ObjectDump()

Declaration
C#
Copy
public void ObjectDump()
View Source

OnAccessibilityActivated()

This method is called when the control accessibility is activated.
Derived classes should override this to perform custom accessibility activation.

Declaration
C#
Copy
protected virtual bool OnAccessibilityActivated()
Returns
Type Description
Boolean

True if this control can perform accessibility activation.

View Source

OnAccessibilityReadingCancelled()

This method is called when reading is cancelled.

Declaration
C#
Copy
protected virtual bool OnAccessibilityReadingCancelled()
Returns
Type Description
Boolean

True if information was served.

View Source

OnAccessibilityReadingPaused()

This method is called when reading was paused.

Declaration
C#
Copy
protected virtual bool OnAccessibilityReadingPaused()
Returns
Type Description
Boolean

True if information was served.

View Source

OnAccessibilityReadingResumed()

This method is called when reading is resumed.

Declaration
C#
Copy
protected virtual bool OnAccessibilityReadingResumed()
Returns
Type Description
Boolean

True if information was served.

View Source

OnAccessibilityReadingSkipped()

This method is called when reading is skipped.

Declaration
C#
Copy
protected virtual bool OnAccessibilityReadingSkipped()
Returns
Type Description
Boolean

True if information was served.

View Source

OnAccessibilityReadingStopped()

This method is called when reading is stopped.

Declaration
C#
Copy
protected virtual bool OnAccessibilityReadingStopped()
Returns
Type Description
Boolean

True if information was served.

View Source

OnControlStateChanged(View.ControlStateChangedEventArgs)

Called after the View's ControlStates changed.

Declaration
C#
Copy
protected virtual void OnControlStateChanged(View.ControlStateChangedEventArgs controlStateChangedInfo)
Parameters
Type Name Description
View.ControlStateChangedEventArgs controlStateChangedInfo

The information including state changed variables.

View Source

OnEnabled(Boolean)

Internal callback of enabled property changes. Inherited view can override this method to implements enabled property changes.

Declaration
C#
Copy
protected virtual void OnEnabled(bool enabled)
Parameters
Type Name Description
Boolean enabled
View Source

OnThemeChanged(Object, ThemeChangedEventArgs)

Declaration
C#
Copy
protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
Parameters
Type Name Description
Object sender
ThemeChangedEventArgs e
View Source

Raise()

Raise view above the next sibling view.

Declaration
C#
Copy
public void Raise()
API Level: 9
View Source

RaiseAbove(View)

Raises the view to above the target view.

Declaration
C#
Copy
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.

API Level: 9
View Source

RaiseToTop()

Raises the view above all other views.

Declaration
C#
Copy
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.

API Level: 3
View Source

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
C#
Copy
public void RegisterDefaultLabel()
View Source

RegisterHitTestCallback()

Register custom HitTest function for this view.

Declaration
C#
Copy
protected void RegisterHitTestCallback()
Remarks

This is a hidden API(inhouse API) only for internal purpose.

See Also
View Source

ReleaseSwigCPtr(Runtime.InteropServices.HandleRef)

Declaration
C#
Copy
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type Name Description
Tizen.System.Runtime.InteropServices.HandleRef swigCPtr
Overrides
View Source

Remove(View)

Removes a child view from this View. If the view was not a child of this view, this is a no-op.

Declaration
C#
Copy
public override void Remove(View child)
Parameters
Type Name Description
View child
Overrides
See Also
API Level: 4
View Source

RemoveAccessibilityRelation(View, AccessibilityRelationType)

Removes accessibility relation.

Declaration
C#
Copy
public void RemoveAccessibilityRelation(View second, AccessibilityRelationType relation)
Parameters
Type Name Description
View second

Object which will be removed in relation

AccessibilityRelationType relation

Relation type

View Source

RemoveRenderer(UInt32)

Declaration
C#
Copy
public void RemoveRenderer(uint index)
Parameters
Type Name Description
UInt32 index
API Level: 3
View Source

RemoveRenderer(Renderer)

Declaration
C#
Copy
public void RemoveRenderer(Renderer renderer)
Parameters
Type Name Description
Renderer renderer
API Level: 3
View Source

RotateBy(Degree, Vector3)

Declaration
C#
Copy
public void RotateBy(Degree angle, Vector3 axis)
Parameters
Type Name Description
Degree angle
Vector3 axis
View Source

RotateBy(Radian, Vector3)

Declaration
C#
Copy
public void RotateBy(Radian angle, Vector3 axis)
Parameters
Type Name Description
Radian angle
Vector3 axis
View Source

RotateBy(Rotation)

Declaration
C#
Copy
public void RotateBy(Rotation relativeRotation)
Parameters
Type Name Description
Rotation relativeRotation
View Source

ScaleBy(Vector3)

Declaration
C#
Copy
public void ScaleBy(Vector3 relativeScale)
Parameters
Type Name Description
Vector3 relativeScale
View Source

ScreenToLocal(out Single, out Single, Single, Single)

Converts screen coordinates into the view's coordinate system using the default camera.

Declaration
C#
Copy
public bool ScreenToLocal(out float localX, out float localY, float screenX, float screenY)
Parameters
Type Name Description
Single localX

On return, the X-coordinate relative to the view.

Single localY

On return, the Y-coordinate relative to the view.

Single screenX

The screen X-coordinate.

Single screenY

The screen Y-coordinate.

Returns
Type Description
Boolean

True if the conversion succeeded.

Remarks

The view coordinates are relative to the top-left(0.0, 0.0, 0.5).

API Level: 3
Precondition: The view has been initialized.
View Source

SetAccessibilityReadingInfoTypes(AccessibilityReadingInfoTypes)

Sets accessibility reading information.

Declaration
C#
Copy
public void SetAccessibilityReadingInfoTypes(AccessibilityReadingInfoTypes type)
Parameters
Type Name Description
AccessibilityReadingInfoTypes type

Reading information type

View Source

SetColorMode(ColorMode)

Declaration
C#
Copy
public void SetColorMode(ColorMode colorMode)
Parameters
Type Name Description
ColorMode colorMode
View Source

SetDefaultAllowOnlyOwnTouch(Boolean)

If set to true, the AllowOnlyOwnTouch property value is set to true when all Views are created.

Declaration
C#
Copy
public static void SetDefaultAllowOnlyOwnTouch(bool enable)
Parameters
Type Name Description
Boolean enable

Sets value of AllowOnlyOwnTouch property

View Source

SetDefaultGrabTouchAfterLeave(Boolean)

If set to true, the GrabTouchAfterLeave property value is set to true when all Views are created.

Declaration
C#
Copy
public static void SetDefaultGrabTouchAfterLeave(bool enable)
Parameters
Type Name Description
Boolean enable

Sets value of GrabTouchAfterLeave property

View Source

SetPadding(PaddingType)

Set the padding for the view.

Declaration
C#
Copy
public void SetPadding(PaddingType padding)
Parameters
Type Name Description
PaddingType padding

Padding for the view.

API Level: 3
View Source

SetPosition(Single, Single)

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
C#
Copy
public void SetPosition(float x, float y)
Parameters
Type Name Description
Single x

The new x position

Single y

The new y position

Remarks

This is a hidden API(inhouse API) only for internal purpose.

View Source

SetPosition(Single, Single, Single)

Sets the position of the View. The coordinates are relative to the View's parent.

Declaration
C#
Copy
public void SetPosition(float x, float y, float z)
Parameters
Type Name Description
Single x

The new x position

Single y

The new y position

Single z

The new z position

Remarks

This is a hidden API(inhouse API) only for internal purpose.

View Source

SetPosition(Vector3)

Sets the position of the View. The coordinates are relative to the View's parent.

Declaration
C#
Copy
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.

View Source

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
C#
Copy
public void SetSizeModeFactor(Vector3 factor)
Parameters
Type Name Description
Vector3 factor

A Vector3 representing the relative factor to be applied to each axis.

API Level: 3
Precondition: The view has been initialized.
View Source

SetStyleName(String)

Sets the name of the style to be applied to the view.

Declaration
C#
Copy
public void SetStyleName(string styleName)
Parameters
Type Name Description
String styleName

A string matching a style described in a stylesheet.

API Level: 3
View Source

Show()

Shows the view.

Declaration
C#
Copy
public void Show()
Remarks

This is an asynchronous method.

API Level: 3
View Source

Unparent()

Removes a view from its parent view or layer. If a view has no parent, this method does nothing.

Declaration
C#
Copy
public void Unparent()
API Level: 4
Precondition: The (child) view has been initialized.
View Source

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
C#
Copy
public void UnregisterDefaultLabel()
View Source

UnregisterHitTestCallback()

Unregister custom HitTest function.

Declaration
C#
Copy
protected void UnregisterHitTestCallback()
Remarks

This is a hidden API(inhouse API) only for internal purpose.

Events

View Source

AccessibilityActivated

Accessibility is activated.

Declaration
C#
Copy
public event EventHandler AccessibilityActivated
Event Type
Type Description
EventHandler
View Source

AccessibilityDescriptionRequested

AccessibilityDescription is requested.

Declaration
C#
Copy
public event EventHandler<GetDescriptionEventArgs> AccessibilityDescriptionRequested
Event Type
Type Description
EventHandler<GetDescriptionEventArgs>
View Source

AccessibilityGestureInfoReceived

AccessibilityGestureInfo is received.

Declaration
C#
Copy
public event EventHandler<GestureInfoEventArgs> AccessibilityGestureInfoReceived
Event Type
Type Description
EventHandler<GestureInfoEventArgs>
View Source

AccessibilityNameRequested

AccessibilityName is requested.

Declaration
C#
Copy
public event EventHandler<GetNameEventArgs> AccessibilityNameRequested
Event Type
Type Description
EventHandler<GetNameEventArgs>
View Source

AccessibilityReadingCancelled

AccessibilityReading is cancelled.

Declaration
C#
Copy
public event EventHandler AccessibilityReadingCancelled
Event Type
Type Description
EventHandler
View Source

AccessibilityReadingPaused

AccessibilityReading is paused.

Declaration
C#
Copy
public event EventHandler AccessibilityReadingPaused
Event Type
Type Description
EventHandler
View Source

AccessibilityReadingResumed

AccessibilityReading is resumed.

Declaration
C#
Copy
public event EventHandler AccessibilityReadingResumed
Event Type
Type Description
EventHandler
View Source

AccessibilityReadingSkipped

AccessibilityReading is skipped.

Declaration
C#
Copy
public event EventHandler AccessibilityReadingSkipped
Event Type
Type Description
EventHandler
View Source

AccessibilityReadingStopped

AccessibilityReading is stopped.

Declaration
C#
Copy
public event EventHandler AccessibilityReadingStopped
Event Type
Type Description
EventHandler
View Source

AccessibilityValueTextRequested

Declaration
C#
Copy
public event EventHandler<View.AccessibilityValueTextRequestedEventArgs> AccessibilityValueTextRequested
Event Type
Type Description
EventHandler<View.AccessibilityValueTextRequestedEventArgs>
View Source

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
C#
Copy
public event EventHandler AddedToWindow
Event Type
Type Description
EventHandler
API Level: 3
View Source

BackKeyPressed

An event for getting notice when physical back key is pressed.
This event is emitted BackKey is up.

Declaration
C#
Copy
public event EventHandler BackKeyPressed
Event Type
Type Description
EventHandler
View Source

ChildAdded

Event when a child is added.

Declaration
C#
Copy
public event EventHandler<View.ChildAddedEventArgs> ChildAdded
Event Type
Type Description
EventHandler<View.ChildAddedEventArgs>
API Level: 5
View Source

ChildRemoved

Event when a child is removed.

Declaration
C#
Copy
public event EventHandler<View.ChildRemovedEventArgs> ChildRemoved
Event Type
Type Description
EventHandler<View.ChildRemovedEventArgs>
API Level: 5
View Source

ControlStateChangedEvent

The event that is triggered when the View's ControlState is changed.

Declaration
C#
Copy
public event EventHandler<View.ControlStateChangedEventArgs> ControlStateChangedEvent
Event Type
Type Description
EventHandler<View.ControlStateChangedEventArgs>
View Source

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
C#
Copy
public event EventHandler FocusGained
Event Type
Type Description
EventHandler
API Level: 3
View Source

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
C#
Copy
public event EventHandler FocusLost
Event Type
Type Description
EventHandler
API Level: 3
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.HoverEventArgs, bool> HoverEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.HoverEventArgs, Boolean>
API Level: 3
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.TouchEventArgs, bool> InterceptTouchEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.TouchEventArgs, Boolean>
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.WheelEventArgs, bool> InterceptWheelEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.WheelEventArgs, Boolean>
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.KeyEventArgs, bool> KeyEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.KeyEventArgs, Boolean>
API Level: 3
View Source

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
C#
Copy
public event EventHandler<View.LayoutDirectionChangedEventArgs> LayoutDirectionChanged
Event Type
Type Description
EventHandler<View.LayoutDirectionChangedEventArgs>
API Level: 4
View Source

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
C#
Copy
public event EventHandler Relayout
Event Type
Type Description
EventHandler
API Level: 3
View Source

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
C#
Copy
public event EventHandler RemovedFromWindow
Event Type
Type Description
EventHandler
API Level: 3
View Source

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
C#
Copy
public event EventHandler ResourcesLoaded
Event Type
Type Description
EventHandler
API Level: 3
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.TouchEventArgs, bool> TouchEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.TouchEventArgs, Boolean>
API Level: 3
View Source

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
C#
Copy
public event EventHandler<View.VisibilityChangedEventArgs> VisibilityChanged
Event Type
Type Description
EventHandler<View.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.

API Level: 3
View Source

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
C#
Copy
public event EventHandlerWithReturnType<object, View.WheelEventArgs, bool> WheelEvent
Event Type
Type Description
EventHandlerWithReturnType<Object, View.WheelEventArgs, Boolean>
API Level: 3

Implements

Extension Methods