Class ViewStyle

    Definition

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

    The base class of style attributes for a view. This class provides a base for defining styles that can be applied to views.

    public class ViewStyle : BindableObject, IDynamicResourceHandler, IDisposable
    Inheritance
    object
    BindableObject
    ViewStyle
    Derived
    ImageViewStyle
    TextEditorStyle
    TextFieldStyle
    TextLabelStyle
    ControlStyle
    Implements
    IDynamicResourceHandler
    IDisposable

    Constructors

    View Source

    ViewStyle()

    Create an empty style instance. This constructor initializes an empty style object for a view.

    Declaration
    public ViewStyle()
    View Source

    ViewStyle(ViewStyle)

    Declaration
    public ViewStyle(ViewStyle viewAttributes)
    Parameters
    Type Name Description
    ViewStyle viewAttributes

    Properties

    View Source

    BackgroundColor

    Gets or sets the color of the background of view. The mutually exclusive with "BackgroundImage". Setting it overwrites existing "BackgroundImage".

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

    BackgroundImage

    Gets or sets the image resource url of the background of view. The mutually exclusive with "BackgroundColor". Setting it overwrites existing "BackgroundColor".

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

    BackgroundImageBorder

    View BackgroundBorder

    Declaration
    public Selector<Rectangle> BackgroundImageBorder { get; set; }
    Property Value
    Type Description
    Selector<Rectangle>
    View Source

    BorderlineColor

    The color for the borderline of the View.

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

    BorderlineColorSelector

    The color selector for the borderline of the View.

    Declaration
    public Selector<Color> BorderlineColorSelector { get; set; }
    Property Value
    Type Description
    Selector<Color>
    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.

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

    BorderlineWidth

    The width for the borderline of the View.

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

    BoxShadow

    Describes a box shaped shadow drawing for a View.

    Declaration
    public Selector<Shadow> BoxShadow { get; set; }
    Property Value
    Type Description
    Selector<Shadow>
    View Source

    ClippingMode

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

    Color

    Color

    Declaration
    public Selector<Color> Color { get; set; }
    Property Value
    Type Description
    Selector<Color>
    View Source

    CornerRadius

    The radius for the rounded corners of the View. 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.

    Declaration
    public Vector4 CornerRadius { get; set; }
    Property Value
    Type Description
    Vector4
    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
    public VisualTransformPolicyType? CornerRadiusPolicy { get; set; }
    Property Value
    Type Description
    VisualTransformPolicyType?
    View Source

    DrawMode

    Declaration
    public DrawModeType? DrawMode { get; set; }
    Property Value
    Type Description
    DrawModeType?
    View Source

    Focusable

    Declaration
    public bool? Focusable { get; set; }
    Property Value
    Type Description
    bool?
    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 view will not be focused. Note : Default value is true.

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

    HeightForWidth

    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

    ImageShadow

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

    Declaration
    public Selector<ImageShadow> ImageShadow { get; set; }
    Property Value
    Type Description
    Selector<ImageShadow>
    Remarks

    If BoxShadow is not null, the ImageShadow value will be ignored.

    View Source

    IncludeDefaultStyle

    The flag that is used when creating a component with this style. If the value is true, it will include default component style defined in the default theme.

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

    IsEnabled

    Flag to decide View can be enabled user interaction or not.

    Declaration
    public bool? IsEnabled { get; set; }
    Property Value
    Type Description
    bool?
    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

    Opacity

    Defines view's opacity value. This property allows you to specify different opacity values for various states of the view, such as normal, pressed, focused, etc.

    Declaration
    public Selector<float?> Opacity { get; set; }
    Property Value
    Type Description
    Selector<float?>
    View Source

    Orientation

    Declaration
    public Rotation Orientation { get; set; }
    Property Value
    Type Description
    Rotation
    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 pivot 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 pivot point.
    A view's orientation is the rotation from its default orientation, the rotation is centered around its pivot point.

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

    Position

    Gets or sets the position of the view.

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

    Position2D

    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.

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

    PositionX

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

    PositionY

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

    Size

    Sets the size of a view for the width, the height, and the depth.

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

    Size2D

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

    SizeHeight

    Gets or sets the 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

    SizeWidth

    Gets or sets the width of the view.

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

    SolidNull

    Allow null properties when merging it into other Theme. If the value is true, the null properties reset target properties of the other ViewStyle with same key when merge. It is used in Merge(string), Merge(Theme). It is also used in GetStyle(string) when the Theme has a parent and needs to merge. Please note that it is false by default.

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

    ThemeChangeSensitive

    The ThemeChangeSensitive value of the View.

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

    WidthForHeight

    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?

    Methods

    View Source

    Clone()

    Create a cloned ViewStyle.

    Declaration
    public ViewStyle Clone()
    Returns
    Type Description
    ViewStyle
    View Source

    CopyFrom(BindableObject)

    Copy properties of other ViewStyle to this.

    Declaration
    public override void CopyFrom(BindableObject other)
    Parameters
    Type Name Description
    BindableObject other

    The other BindableProperty merge to this.

    Overrides
    BindableObject.CopyFrom(BindableObject)
    View Source

    Dispose()

    Releases all resources used by the ViewStyle instance. The Dispose method releases all resources used by the ViewStyle instance.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Releases unmanaged and optionally managed resources.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    If it true, the method has been called by a user's code to release both managed and unmanaged resources. Otherwise the method has been called by the finalizer to release only unmanaged resources.

    View Source

    GetOrCreateValue<T>(IStyleProperty)

    Declaration
    protected virtual T GetOrCreateValue<T>(IStyleProperty styleProperty)
    Parameters
    Type Name Description
    IStyleProperty styleProperty
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T
    View Source

    GetValue(IStyleProperty)

    Declaration
    protected virtual object GetValue(IStyleProperty styleProperty)
    Parameters
    Type Name Description
    IStyleProperty styleProperty
    Returns
    Type Description
    object
    View Source

    OnPropertyChangedWithData(BindableProperty)

    Method that is called when a bound property is changed.

    Declaration
    protected override void OnPropertyChangedWithData(BindableProperty property)
    Parameters
    Type Name Description
    BindableProperty property
    Overrides
    BindableObject.OnPropertyChangedWithData(BindableProperty)
    View Source

    SetValue(IStyleProperty, object)

    Declaration
    protected virtual void SetValue(IStyleProperty styleProperty, object value)
    Parameters
    Type Name Description
    IStyleProperty styleProperty
    object value

    Implements

    IDynamicResourceHandler
    IDisposable

    Extension Methods

    ViewStyleExtension.Merge<TOut>(TOut, TOut)
    EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)
    Extensions.LoadFromXaml<TXaml>(TXaml, string)
    Extensions.LoadFromXaml<TXaml>(TXaml, Type)
    Extensions.LoadFromXamlFile<TXaml>(TXaml, string)
    BindableObjectExtensions.SetBinding(BindableObject, BindableProperty, string, BindingMode, IValueConverter, string)
    • View Source
    Back to top Copyright © 2016-2025 Samsung
    Generated by DocFX