Class Image

    Definition

    Namespace:
    ElmSharp
    Assembly:
    ElmSharp.dll

    The Image is a widget that allows one to load and display an image file on it, be it from a disk file or from a memory region. Inherits Widget.

    [Obsolete("This has been deprecated in API12")]
    public class Image : Widget, IAccessibleObject
    Inheritance
    object
    EvasObject
    AccessibleObject
    Widget
    Image
    Derived
    Icon
    Icon
    Implements
    IAccessibleObject

    Constructors

    View Source

    Image(EvasObject)

    Creates and initializes a new instance of the Image class.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public Image(EvasObject parent)
    Parameters
    Type Name Description
    EvasObject parent

    The parent is a given container, which will be attached by the image as a child. It's EvasObject type.

    Properties

    View Source

    BackgroundColor

    Sets the background color.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public override Color BackgroundColor { set; }
    Property Value
    Type Description
    Color
    Overrides
    Widget.BackgroundColor
    View Source

    BorderCenterFillMode

    Sets or gets if the center part of the given image object (not the border) should be drawn.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public ImageBorderFillMode BorderCenterFillMode { get; set; }
    Property Value
    Type Description
    ImageBorderFillMode
    Remarks

    When rendering, the image may be scaled to fit the size of the image object. This function sets if the center part of the scaled image is to be drawn or left completely blank, or forced to be solid. Very useful for frames and decorations.

    View Source

    CanFillOutside

    Sets or gets whether the image fills the entire object area, when keeping the aspect ratio.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool CanFillOutside { get; set; }
    Property Value
    Type Description
    bool
    View Source

    CanScaleDown

    Sets or gets whether the object is down resizable.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool CanScaleDown { get; set; }
    Property Value
    Type Description
    bool
    View Source

    CanScaleUp

    Sets or gets whether the object is up resizable.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool CanScaleUp { get; set; }
    Property Value
    Type Description
    bool
    View Source

    Color

    Sets or gets the image color.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public override Color Color { get; set; }
    Property Value
    Type Description
    Color
    Overrides
    EvasObject.Color
    View Source

    File

    Gets the file that is used as an image.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public string File { get; }
    Property Value
    Type Description
    string
    View Source

    ImageObject

    Gets the inlined image object of the image widget. This property allows one to get the underlying EvasObject of type Image from this elementary widget. It can be useful to do things like save the image to a file, etc.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public EvasImage ImageObject { get; }
    Property Value
    Type Description
    EvasImage
    Remarks

    Be careful not to manipulate it, as it is under the control of the widget.

    View Source

    IsAnimated

    Sets or gets whether an image object (which supports animation) is to animate itself.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsAnimated { get; set; }
    Property Value
    Type Description
    bool
    View Source

    IsAnimatedAvailable

    Gets whether an image object supports animation.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsAnimatedAvailable { get; }
    Property Value
    Type Description
    bool
    View Source

    IsAnimationPlaying

    Sets or gets whether an image object is under animation.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsAnimationPlaying { get; set; }
    Property Value
    Type Description
    bool
    Remarks

    An image object, even if it supports animation, will be displayed by default without animation. To actually start playing any image object's animation, IsAnimated should be TRUE before setting this property true.

    View Source

    IsEditable

    Sets or gets whether the image is 'editable'.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsEditable { get; set; }
    Property Value
    Type Description
    bool
    View Source

    IsFixedAspect

    Sets or gets whether the original aspect ratio of the image should be kept on resize.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsFixedAspect { get; set; }
    Property Value
    Type Description
    bool
    View Source

    IsOpaque

    Sets or gets whether the alpha channel data is being used on the given image object.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsOpaque { get; set; }
    Property Value
    Type Description
    bool
    View Source

    IsScaling

    Sets or gets whether scaling is disabled on the object.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsScaling { get; set; }
    Property Value
    Type Description
    bool
    View Source

    IsSmooth

    Sets or gets the smooth effect for an image.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool IsSmooth { get; set; }
    Property Value
    Type Description
    bool
    View Source

    ObjectSize

    Gets the current size of the image.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public Size ObjectSize { get; }
    Property Value
    Type Description
    Size
    View Source

    Orientation

    Sets or gets the image orientation.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public ImageOrientation Orientation { get; set; }
    Property Value
    Type Description
    ImageOrientation
    View Source

    PrescaleSize

    Sets or gets the prescale size for the image.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public int PrescaleSize { get; set; }
    Property Value
    Type Description
    int

    Methods

    View Source

    CreateHandle(EvasObject)

    Sets the content at a part of a given container widget.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    protected override IntPtr CreateHandle(EvasObject parent)
    Parameters
    Type Name Description
    EvasObject parent

    The parent is a given container, which will be attached by the image as a child. It's EvasObject type.

    Returns
    Type Description
    System.IntPtr

    The new object, otherwise null if it cannot be created.

    Overrides
    EvasObject.CreateHandle(EvasObject)
    View Source

    GetPartColor(string)

    Gets the color of the Color class for a given widget.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public override Color GetPartColor(string part)
    Parameters
    Type Name Description
    string part

    The name of the Color class.

    Returns
    Type Description
    Color

    The color object.

    Overrides
    Widget.GetPartColor(string)
    View Source

    Load(byte*, long)

    Sets a location in the memory to be used as an image object's source bitmap.

    Declaration
    [Obsolete("This method will be removed. Use Load(Stream stream) instead.")]
    public bool Load(byte* img, long size)
    Parameters
    Type Name Description
    byte* img

    The binary data that is used as an image source.

    long size

    The size of the binary data blob img.

    Returns
    Type Description
    bool

    (true = success, false = error)

    Remarks

    This function is handy when the contents of an image file are mapped into the memory, for example, the format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary). This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds.

    View Source

    Load(Stream)

    Sets the stream that is used as the image's source.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool Load(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream that is used as an image source.

    Returns
    Type Description
    bool

    (true = success, false = error)

    View Source

    Load(string)

    Sets the file that is used as the image's source.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool Load(string file)
    Parameters
    Type Name Description
    string file

    The path to the file that is used as an image source.

    Returns
    Type Description
    bool

    (true = success, false = error)

    View Source

    Load(Uri)

    Sets the URI that is used as the image's source.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public bool Load(Uri uri)
    Parameters
    Type Name Description
    System.Uri uri

    The URI to the file that is used as an image source.

    Returns
    Type Description
    bool

    (true = success, false = error)

    View Source

    LoadAsync(Stream, CancellationToken)

    Sets the stream that is used as the image's source with async.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public Task<bool> LoadAsync(Stream stream, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream that is used as an image source.

    System.Threading.CancellationToken cancellationToken

    The cancellation token.

    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><bool>

    (true = success, false = error)

    View Source

    LoadAsync(string, CancellationToken)

    Sets the file that is used as the image's source with async.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public Task<bool> LoadAsync(string file, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string file

    The path to the file that is used as an image source.

    System.Threading.CancellationToken cancellationToken

    The cancellation token.

    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><bool>

    (true = success, false = error)

    View Source

    LoadAsync(Uri, CancellationToken)

    Sets the URI that is used as the image's source with async.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public Task<bool> LoadAsync(Uri uri, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.Uri uri

    The URI to the file that is used as an image source.

    System.Threading.CancellationToken cancellationToken

    The cancellation token.

    Returns
    Type Description
    System.Threading.Tasks.Task<TResult><bool>

    (true = success, false = error)

    View Source

    SetBorder(int, int, int, int)

    Sets the dimensions for an image object's border, a region which is not scaled together with its center ever.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public void SetBorder(int left, int right, int top, int bottom)
    Parameters
    Type Name Description
    int left

    The border's left width.

    int right

    The border's right width.

    int top

    The border's top width.

    int bottom

    The border's bottom width.

    View Source

    SetPartColor(string, Color)

    Sets the color of the Color class for a given widget.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public override void SetPartColor(string part, Color color)
    Parameters
    Type Name Description
    string part

    The name of the Color class.

    Color color

    The struct of the Color class.

    Overrides
    Widget.SetPartColor(string, Color)

    Events

    View Source

    Clicked

    Clicked will be triggered when the image is clicked.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public event EventHandler Clicked
    Event Type
    Type Description
    System.EventHandler
    View Source

    LoadingCompleted

    LoadingCompleted will be triggered when the image is loaded completely.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public event EventHandler LoadingCompleted
    Event Type
    Type Description
    System.EventHandler
    View Source

    LoadingFailed

    Clicked will be triggered when the image fails to load.

    Declaration
    [Obsolete("This has been deprecated in API12")]
    public event EventHandler LoadingFailed
    Event Type
    Type Description
    System.EventHandler

    Implements

    IAccessibleObject

    Extension Methods

    RotaryEventExtensions.Activate(EvasObject)
    RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)
    RotaryEventExtensions.Deactivate(EvasObject)
    RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX