Class View

    Definition

    Namespace:
    Tizen.NUI.BaseComponents
    Assembly:
    Tizen.NUI.dll

    View is the base class for all views.

    public class View : Container, IDisposable
    Inheritance
    object
    BaseHandle
    Animatable
    Container
    View
    Derived
    Tizen.NUI.BaseComponents.CameraView
    Tizen.NUI.BaseComponents.CameraView
    Tizen.NUI.BaseComponents.CameraView
    Tizen.NUI.BaseComponents.CameraView
    Tizen.NUI.BaseComponents.CameraView
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    FlexContainer
    Tizen.NUI.BaseComponents.GLView
    Tizen.NUI.BaseComponents.GLView
    Tizen.NUI.BaseComponents.GLView
    Tizen.NUI.BaseComponents.GLView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    ImageView
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    Scrollable
    TableView
    TableView
    TableView
    TableView
    TableView
    TableView
    TableView
    TableView
    TableView
    TableView
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextEditor
    TextField
    TextField
    TextField
    TextField
    TextField
    TextField
    TextField
    TextField
    TextField
    TextField
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    TextLabel
    Tizen.NUI.BaseComponents.VectorGraphics.CanvasView
    Tizen.NUI.BaseComponents.VectorGraphics.CanvasView
    Tizen.NUI.BaseComponents.VectorGraphics.CanvasView
    Tizen.NUI.BaseComponents.VectorGraphics.CanvasView
    Tizen.NUI.BaseComponents.VectorGraphics.CanvasView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    VideoView
    Tizen.NUI.BaseComponents.WebView
    Tizen.NUI.BaseComponents.WebView
    Tizen.NUI.BaseComponents.WebView
    Tizen.NUI.BaseComponents.WebView
    Tizen.NUI.BaseComponents.WebView
    Tizen.NUI.Extension.RiveAnimationView
    Tizen.NUI.Extension.RiveAnimationView
    Tizen.NUI.Extension.RiveAnimationView
    Tizen.NUI.Extension.RiveAnimationView
    Tizen.NUI.Extension.RiveAnimationView
    Tizen.NUI.Scene3D.Camera
    Tizen.NUI.Scene3D.Camera
    Tizen.NUI.Scene3D.Camera
    Tizen.NUI.Scene3D.Camera
    Tizen.NUI.Scene3D.Model
    Tizen.NUI.Scene3D.Model
    Tizen.NUI.Scene3D.Model
    Tizen.NUI.Scene3D.Model
    Tizen.NUI.Scene3D.SceneView
    Tizen.NUI.Scene3D.SceneView
    Tizen.NUI.Scene3D.SceneView
    Tizen.NUI.Scene3D.SceneView
    Button
    Button
    Popup
    Popup
    ProgressBar
    ProgressBar
    ScrollBar
    ScrollBar
    Slider
    Slider
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    ViewWrapper
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    WidgetView
    Implements
    System.IDisposable

    Constructors

    View Source

    View()

    Creates a new instance of a view.

    Declaration
    public View()

    Properties

    View Source

    AlignSelf

    The Child property of FlexContainer.
    The alignment of the flex item along the cross axis, which, if set, overides the default alignment for all items in the container.

    Declaration
    public int AlignSelf { get; set; }
    Property Value
    Type Description
    int
    View Source

    Background

    The background of view.

    Declaration
    public PropertyMap Background { get; set; }
    Property Value
    Type Description
    PropertyMap
    View Source

    BackgroundColor

    The mutually exclusive with BACKGROUND_IMAGE and BACKGROUND type Vector4.

    Declaration
    public Color BackgroundColor { get; set; }
    Property Value
    Type Description
    Color
    View Source

    BackgroundImage

    The mutually exclusive with BACKGROUND_COLOR and BACKGROUND type Map.

    Declaration
    public string BackgroundImage { get; set; }
    Property Value
    Type Description
    string
    View Source

    CellHorizontalAlignment

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

    Declaration
    public HorizontalAlignmentType CellHorizontalAlignment { get; set; }
    Property Value
    Type Description
    HorizontalAlignmentType
    View Source

    CellIndex

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

    Declaration
    public Vector2 CellIndex { get; set; }
    Property Value
    Type Description
    Vector2
    View Source

    CellVerticalAlignment

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

    Declaration
    public VerticalAlignmentType CellVerticalAlignment { get; set; }
    Property Value
    Type Description
    VerticalAlignmentType
    View Source

    ChildCount

    Get the number of children held by the view.

    Declaration
    public uint ChildCount { get; }
    Property Value
    Type Description
    uint
    View Source

    ClippingMode

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

    Declaration
    public ClippingModeType ClippingMode { get; set; }
    Property Value
    Type Description
    ClippingModeType
    View Source

    ColumnSpan

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

    Declaration
    public float ColumnSpan { get; set; }
    Property Value
    Type Description
    float
    View Source

    CurrentPosition

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

    Declaration
    public Position CurrentPosition { get; }
    Property Value
    Type Description
    Position
    View Source

    CurrentSize

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

    Declaration
    public Size2D CurrentSize { get; }
    Property Value
    Type Description
    Size2D
    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
    public View DownFocusableView { get; set; }
    Property Value
    Type Description
    View
    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
    public DrawModeType DrawMode { get; set; }
    Property Value
    Type Description
    DrawModeType
    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
    public float Flex { get; set; }
    Property Value
    Type Description
    float
    View Source

    FlexMargin

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

    Declaration
    public Vector4 FlexMargin { get; set; }
    Property Value
    Type Description
    Vector4
    View Source

    Focusable

    Whether the view should be focusable by keyboard navigation.

    Declaration
    public bool Focusable { get; set; }
    Property Value
    Type Description
    bool
    View Source

    HeightForWidth

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

    Declaration
    public bool HeightForWidth { get; set; }
    Property Value
    Type Description
    bool
    View Source

    HeightResizePolicy

    Gets or sets the height resize policy to be used.

    Declaration
    public ResizePolicyType HeightResizePolicy { get; set; }
    Property Value
    Type Description
    ResizePolicyType
    View Source

    HierarchyDepth

    Gets the depth in the hierarchy for the view.

    Declaration
    public int HierarchyDepth { get; }
    Property Value
    Type Description
    int
    View Source

    ID

    Gets the view's ID. Readonly

    Declaration
    public uint ID { get; }
    Property Value
    Type Description
    uint
    View Source

    InheritLayoutDirection

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

    Declaration
    public bool InheritLayoutDirection { get; set; }
    Property Value
    Type Description
    bool
    View Source

    InheritOrientation

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

    Declaration
    public bool InheritOrientation { get; set; }
    Property Value
    Type Description
    bool
    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
    public bool InheritPosition { get; set; }
    Property Value
    Type Description
    bool
    View Source

    InheritScale

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

    Declaration
    public bool InheritScale { get; set; }
    Property Value
    Type Description
    bool
    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
    public bool IsOnWindow { get; }
    Property Value
    Type Description
    bool
    View Source

    LayoutDirection

    Gets/Sets the layout Direction.

    Declaration
    public ViewLayoutDirectionType LayoutDirection { get; set; }
    Property Value
    Type Description
    ViewLayoutDirectionType
    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
    public bool LeaveRequired { get; set; }
    Property Value
    Type Description
    bool
    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
    public View LeftFocusableView { get; set; }
    Property Value
    Type Description
    View
    View Source

    Margin

    Gets or sets the Margin for use in layout.

    Declaration
    public Extents Margin { get; set; }
    Property Value
    Type Description
    Extents
    View Source

    MaximumSize

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

    Declaration
    public Size2D MaximumSize { get; set; }
    Property Value
    Type Description
    Size2D
    View Source

    MinimumSize

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

    Declaration
    public Size2D MinimumSize { get; set; }
    Property Value
    Type Description
    Size2D
    View Source

    Name

    Gets or sets the view's name.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string
    View Source

    NaturalSize2D

    Returns the natural size (Size2D) of the view.

    Declaration
    public Size2D NaturalSize2D { get; }
    Property Value
    Type Description
    Size2D
    Remarks

    Deriving classes stipulate the natural size and by default a view has a zero natural size.

    View Source

    Opacity

    Retrieves and sets the view's opacity.

    Declaration
    public float Opacity { get; set; }
    Property Value
    Type Description
    float
    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
    public Rotation Orientation { get; set; }
    Property Value
    Type Description
    Rotation
    Remarks

    This is an asynchronous method.

    View Source

    Padding

    Gets or sets the padding for use in layout.

    Declaration
    public Extents Padding { get; set; }
    Property Value
    Type Description
    Extents
    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
    public Position ParentOrigin { get; set; }
    Property Value
    Type Description
    Position
    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
    public Position PivotPoint { get; set; }
    Property Value
    Type Description
    Position
    View Source

    Position

    Gets or sets the position of the view.
    By default, sets the position vector between the parent origin and pivot point (default).
    If the position inheritance is disabled, sets the world position.

    Declaration
    public Position Position { get; set; }
    Property Value
    Type Description
    Position
    View Source

    Position2D

    Sets the position of the view for X and Y.
    By default, sets the position vector between the parent origin and the pivot point (default).
    If the position inheritance is disabled, sets the world position.

    Declaration
    public Position2D Position2D { get; set; }
    Property Value
    Type Description
    Position2D
    View Source

    PositionUsesPivotPoint

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

    Declaration
    public bool PositionUsesPivotPoint { get; set; }
    Property Value
    Type Description
    bool
    Remarks

    If false, then the top-left of the view is used for the position. Setting this to false will allow scaling or rotation around the anchor-point without affecting the view's position.

    View Source

    PositionX

    Gets or sets the position X of the view.

    Declaration
    public float PositionX { get; set; }
    Property Value
    Type Description
    float
    View Source

    PositionY

    Gets or sets the position Y of the view.

    Declaration
    public float PositionY { get; set; }
    Property Value
    Type Description
    float
    View Source

    PositionZ

    Gets or sets the position Z of the view.

    Declaration
    public float PositionZ { get; set; }
    Property Value
    Type Description
    float
    View Source

    RendererCount

    Gets the number of renderers held by the view.

    Declaration
    public uint RendererCount { get; }
    Property Value
    Type Description
    uint
    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
    public View RightFocusableView { get; set; }
    Property Value
    Type Description
    View
    View Source

    RowSpan

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

    Declaration
    public float RowSpan { get; set; }
    Property Value
    Type Description
    float
    View Source

    Scale

    Gets or sets the scale factor applied to the view.

    Declaration
    public Vector3 Scale { get; set; }
    Property Value
    Type Description
    Vector3
    View Source

    ScaleX

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

    Declaration
    public float ScaleX { get; set; }
    Property Value
    Type Description
    float
    View Source

    ScaleY

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

    Declaration
    public float ScaleY { get; set; }
    Property Value
    Type Description
    float
    View Source

    ScaleZ

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

    Declaration
    public float ScaleZ { get; set; }
    Property Value
    Type Description
    float
    View Source

    ScreenPosition

    Retrieves the screen postion of the view.

    Declaration
    public Vector2 ScreenPosition { get; }
    Property Value
    Type Description
    Vector2
    View Source

    Sensitive

    Gets or sets the status of whether the view should emit touch or hover signals.

    Declaration
    public bool Sensitive { get; set; }
    Property Value
    Type Description
    bool
    View Source

    SiblingOrder

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

    Declaration
    public int SiblingOrder { get; set; }
    Property Value
    Type Description
    int
    Remarks

    Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0. Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order. The values set by this property will likely change.

    View Source

    Size2D

    Sets the size of a view for the width and the height.
    Geometry can be scaled to fit within this area.
    This does not interfere with the view's scale factor.
    The views default depth is the minimum of width and height.

    Declaration
    public Size2D Size2D { get; set; }
    Property Value
    Type Description
    Size2D
    View Source

    SizeHeight

    Gets or sets the size height of the view.

    Declaration
    public float SizeHeight { get; set; }
    Property Value
    Type Description
    float
    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
    public Vector3 SizeModeFactor { get; set; }
    Property Value
    Type Description
    Vector3
    View Source

    SizeScalePolicy

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

    Declaration
    public SizeScalePolicyType SizeScalePolicy { get; set; }
    Property Value
    Type Description
    SizeScalePolicyType
    View Source

    SizeWidth

    Gets or sets the size width of the view.

    Declaration
    public float SizeWidth { get; set; }
    Property Value
    Type Description
    float
    View Source

    State

    The current state of the view.

    Declaration
    public View.States State { get; set; }
    Property Value
    Type Description
    View.States
    View Source

    StyleName

    The StyleName, type string.

    Declaration
    public string StyleName { get; set; }
    Property Value
    Type Description
    string
    View Source

    SubState

    The current sub state of the view.

    Declaration
    public View.States SubState { get; set; }
    Property Value
    Type Description
    View.States
    View Source

    Tooltip

    Displays a tooltip

    Declaration
    public PropertyMap Tooltip { get; set; }
    Property Value
    Type Description
    PropertyMap
    View Source

    TooltipText

    Displays a tooltip as a text.

    Declaration
    public string TooltipText { set; }
    Property Value
    Type Description
    string
    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
    public View UpFocusableView { get; set; }
    Property Value
    Type Description
    View
    View Source

    Visibility

    Retrieves the visibility flag of the view.

    Declaration
    public bool Visibility { get; }
    Property Value
    Type Description
    bool
    Remarks

    If the view is not visible, then the view and its children will not be rendered. This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true.

    View Source

    WidthForHeight

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

    Declaration
    public bool WidthForHeight { get; set; }
    Property Value
    Type Description
    bool
    View Source

    WidthResizePolicy

    Gets or sets the width resize policy to be used.

    Declaration
    public ResizePolicyType WidthResizePolicy { get; set; }
    Property Value
    Type Description
    ResizePolicyType
    View Source

    WorldColor

    Gets the view's world color.

    Declaration
    public Vector4 WorldColor { get; }
    Property Value
    Type Description
    Vector4
    View Source

    WorldOrientation

    Gets or sets the world orientation of the view.

    Declaration
    public Rotation WorldOrientation { get; }
    Property Value
    Type Description
    Rotation
    View Source

    WorldPosition

    Gets or sets the world position of the view.

    Declaration
    public Vector3 WorldPosition { get; }
    Property Value
    Type Description
    Vector3
    View Source

    WorldScale

    Gets the world scale of the view.

    Declaration
    public Vector3 WorldScale { get; }
    Property Value
    Type Description
    Vector3

    Methods

    View Source

    Add(View)

    Adds a child view to this view.

    Declaration
    public override void Add(View child)
    Parameters
    Type Name Description
    View child
    Overrides
    Container.Add(View)
    See Also
    Add(View)
    View Source

    AddRenderer(Renderer)

    Declaration
    public uint AddRenderer(Renderer renderer)
    Parameters
    Type Name Description
    Renderer renderer
    Returns
    Type Description
    uint
    View Source

    AnimateBackgroundColor(object, int, int, BuiltinFunctions?, object)

    Creates an animation to animate the background color visual. If there is no background visual, creates one with transparent black as it's mixColor.

    Declaration
    public Animation AnimateBackgroundColor(object destinationValue, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialValue = null)
    Parameters
    Type Name Description
    object destinationValue
    int startTime
    int endTime
    AlphaFunction.BuiltinFunctions? alphaFunction
    object initialValue
    Returns
    Type Description
    Animation
    View Source

    AnimateColor(string, object, int, int, BuiltinFunctions?, object)

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

    Declaration
    public Animation AnimateColor(string targetVisual, object destinationColor, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialColor = null)
    Parameters
    Type Name Description
    string targetVisual
    object destinationColor
    int startTime
    int endTime
    AlphaFunction.BuiltinFunctions? alphaFunction
    object initialColor
    Returns
    Type Description
    Animation
    View Source

    ClearBackground()

    Clears the background.

    Declaration
    public void ClearBackground()
    View Source

    Dispose(DisposeTypes)

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

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

    DisposeTypes

    Overrides
    Container.Dispose(DisposeTypes)
    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
    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.

    View Source

    GetChildAt(uint)

    Retrieves a child view by index.

    Declaration
    public override View GetChildAt(uint index)
    Parameters
    Type Name Description
    uint index
    Returns
    Type Description
    View
    Overrides
    Container.GetChildAt(uint)
    See Also
    GetChildAt(uint)
    View Source

    GetChildCount()

    Retrieves the number of children held by the view.

    Declaration
    public override uint GetChildCount()
    Returns
    Type Description
    uint
    Overrides
    Container.GetChildCount()
    See Also
    GetChildCount()
    View Source

    GetHeightForWidth(float)

    Calculates the height of the view given a width.
    The natural size is used for default calculation.
    Size 0 is treated as aspect ratio 1:1.

    Declaration
    public float GetHeightForWidth(float width)
    Parameters
    Type Name Description
    float width

    The width to use.

    Returns
    Type Description
    float

    The height based on the width.

    View Source

    GetPadding(PaddingType)

    Return the value of padding for the view.

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

    the value of padding for the view

    View Source

    GetParent()

    Gets the views parent.

    Declaration
    public override Container GetParent()
    Returns
    Type Description
    Container
    Overrides
    Container.GetParent()
    See Also
    GetParent()
    View Source

    GetRelayoutSize(DimensionType)

    Return the amount of size allocated for relayout.

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

    The dimension to retrieve.

    Returns
    Type Description
    float

    Return the size.

    View Source

    GetRendererAt(uint)

    Declaration
    public Renderer GetRendererAt(uint index)
    Parameters
    Type Name Description
    uint index
    Returns
    Type Description
    Renderer
    View Source

    GetStyleName()

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

    Declaration
    public string GetStyleName()
    Returns
    Type Description
    string

    A string matching a style, or an empty string.

    View Source

    GetWidthForHeight(float)

    Calculates the width of the view given a height.
    The natural size is used for default calculation.
    Size 0 is treated as aspect ratio 1:1.

    Declaration
    public float GetWidthForHeight(float height)
    Parameters
    Type Name Description
    float height

    The height to use.

    Returns
    Type Description
    float

    The width based on the height.

    View Source

    HasFocus()

    Queries whether the view has a focus.

    Declaration
    public bool HasFocus()
    Returns
    Type Description
    bool

    True if this view has a focus.

    View Source

    Hide()

    Hides the view.

    Declaration
    public void Hide()
    Remarks

    This is an asynchronous method. If the view is hidden, then the view and its children will not be rendered. This is regardless of the individual visibility of the children, i.e., the view will only be rendered if all of its parents are shown.

    View Source

    IsResourceReady()

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

    Declaration
    public bool IsResourceReady()
    Returns
    Type Description
    bool
    Remarks

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

    View Source

    LowerToBottom()

    Lowers the view to the bottom of all views.

    Declaration
    public void LowerToBottom()
    Remarks

    The sibling order of views within the parent will be updated automatically. Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion.

    View Source

    RaiseToTop()

    Raises the view above all other views.

    Declaration
    public void RaiseToTop()
    Remarks

    Sibling order of views within the parent will be updated automatically. Once a raise or lower API is used, that view will then have an exclusive sibling order independent of insertion.

    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
    public override void Remove(View child)
    Parameters
    Type Name Description
    View child
    Overrides
    Container.Remove(View)
    See Also
    Remove(View)
    View Source

    RemoveRenderer(uint)

    Declaration
    public void RemoveRenderer(uint index)
    Parameters
    Type Name Description
    uint index
    View Source

    RemoveRenderer(Renderer)

    Declaration
    public void RemoveRenderer(Renderer renderer)
    Parameters
    Type Name Description
    Renderer renderer
    View Source

    ScreenToLocal(out float, out float, float, float)

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

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

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

    float localY

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

    float screenX

    The screen X-coordinate.

    float screenY

    The screen Y-coordinate.

    Returns
    Type Description
    bool

    True if the conversion succeeded.

    Remarks

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

    View Source

    SetPadding(PaddingType)

    Set the padding for the view.

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

    Padding for the view.

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

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

    View Source

    SetStyleName(string)

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

    Declaration
    public void SetStyleName(string styleName)
    Parameters
    Type Name Description
    string styleName

    A string matching a style described in a stylesheet.

    View Source

    Show()

    Shows the view.

    Declaration
    public void Show()
    Remarks

    This is an asynchronous method.

    View Source

    Unparent()

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

    Declaration
    public void Unparent()

    Events

    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
    public event EventHandler AddedToWindow
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandler FocusGained
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandler FocusLost
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandlerWithReturnType<object, View.HoverEventArgs, bool> HoverEvent
    Event Type
    Type Description
    EventHandlerWithReturnType<object, View.HoverEventArgs, bool>
    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
    public event EventHandlerWithReturnType<object, View.KeyEventArgs, bool> KeyEvent
    Event Type
    Type Description
    EventHandlerWithReturnType<object, View.KeyEventArgs, bool>
    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
    public event EventHandler<View.LayoutDirectionChangedEventArgs> LayoutDirectionChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><View.LayoutDirectionChangedEventArgs>
    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
    public event EventHandler Relayout
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandler RemovedFromWindow
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandler ResourcesLoaded
    Event Type
    Type Description
    System.EventHandler
    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
    public event EventHandlerWithReturnType<object, View.TouchEventArgs, bool> TouchEvent
    Event Type
    Type Description
    EventHandlerWithReturnType<object, View.TouchEventArgs, bool>
    View Source

    VisibilityChanged

    An event for visibility change which can be used to subscribe or unsubscribe the event handler.
    This signal is emitted when the visible property of this or a parent view is changed.

    Declaration
    public event EventHandler<View.VisibilityChangedEventArgs> VisibilityChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><View.VisibilityChangedEventArgs>
    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
    public event EventHandlerWithReturnType<object, View.WheelEventArgs, bool> WheelEvent
    Event Type
    Type Description
    EventHandlerWithReturnType<object, View.WheelEventArgs, bool>

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX