Class

ImagePrimitive

Declaration

public ImagePrimitive()

Declaration

public static RadProperty ImageIndexProperty

Field Value

Declaration

public static RadProperty ImageKeyProperty

Field Value

Declaration

public static RadProperty ImageLayoutProperty

Field Value

Declaration

public static RadProperty ImageProperty

Field Value

Declaration

public static RadProperty ImageScalingProperty

Field Value

Declaration

public static RadProperty ScaleSizeProperty

Field Value

Declaration

public static RadProperty SvgImageProperty

Field Value

Declaration

public static RadProperty TransparentColorProperty

Field Value

Declaration

public static RadProperty UseSmallImageListProperty

Field Value

Gets actual index.

Declaration

[Browsable(false)]
public virtual int ActualIndex { get; }

Property Value

Gets or sets the image that is displayed.

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public Image Image { get; set; }

Property Value

Implements IImageElement.Image

Determines whether the Image or SvgImage property will be painted. Note that if SvgImage == null, this property will always return "ImageDrawType.Image".

Declaration

[Browsable(false)]
public ImageDrawType ImageDrawType { get; set; }

Property Value

Gets or sets the image list index value of the displayed image.

Declaration

[RelatedImageList("ElementTree.Control.ImageList")]
public int ImageIndex { get; set; }

Property Value

Implements IImageElement.ImageIndex

Gets or sets the key accessor for the image in the ImageList.

Declaration

[RelatedImageList("ElementTree.Control.ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }

Property Value

Implements IImageElement.ImageKey

Gets or sets the way ImagePrimitive will layout its image on the screen.

Declaration

public ImageLayout ImageLayout { get; set; }

Property Value

Gets or sets image scaling. Possible values are members of ImageScaling enumeration: None and SizeToFit.

Declaration

public ImageScaling ImageScaling { get; set; }

Property Value

Gets a value indicating whether the primitive has content.

Declaration

[Browsable(false)]
public override bool IsEmpty { get; }

Property Value

Overrides BasePrimitive.IsEmpty

Gets the Image that will be painted on the screen, with settings such as Opacity and Flip applied.

Declaration

[Browsable(false)]
public Image RenderImage { get; }

Property Value

Gets or sets the type of rotate/flip to be applied.

Declaration

public RotateFlipType RotateFlipType { get; set; }

Property Value

Gets or sets the desired size to be used when displaying the image. Works when ImageScalingMode is set to FitToSize.

Declaration

public Size ScaleSize { get; set; }

Property Value

Gets or sets the flag controlling whether the image primitive fills up the available area horizontally

Declaration

public override bool StretchHorizontally { get; set; }

Property Value

Overrides RadElement.StretchHorizontally

Gets or sets the flag controlling whether the image primitive fills up the available area vertically

Declaration

public override bool StretchVertically { get; set; }

Property Value

Overrides RadElement.StretchVertically

Gets or sets the image that is displayed.

Declaration

public RadSvgImage SvgImage { get; set; }

Property Value

Gets or sets the transparent color for the image

Declaration

[TypeConverter(typeof(RadColorEditorConverter))]
public Color TransparentColor { get; set; }

Property Value

Specifies whether the image should be taken from the SmallImageList or from the ImageList when the ImageIndex/ImageKey property is set.

Declaration

public bool UseSmallImageList { get; set; }

Property Value

Releases managed resources by clearing the property store and disposing value animators to prevent memory leaks.

Declaration

protected override void DisposeManagedResources()

Overrides RadElement.DisposeManagedResources()

Gets the IFilter instance that may be used to filter the properties, treated as Stylable for this element.

Declaration

public override Filter GetStylablePropertiesFilter()

Returns

Overrides RadElement.GetStylablePropertiesFilter()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration

protected override void InitializeFields()

Overrides BasePrimitive.InitializeFields()

Measures the space required by the RadElement

Used by the layout system.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadElement.MeasureOverride(SizeF)

Remarks

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Called when a property value has changed, allowing for custom response to property changes.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides VisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Called when the tunnel phase of a routed event occurs.

Declaration

protected override void OnTunnelEvent(RadElement sender, RoutedEventArgs args)

Parameters

Overrides RadElement.OnTunnelEvent(RadElement, RoutedEventArgs)

Notifies that the element has been successfully unloaded from an element tree. Allows inheritors to provide custom logic at this stage.

Declaration

protected override void OnUnloaded(ComponentThemableElementTree oldTree)

Parameters

Overrides RadElement.OnUnloaded(ComponentThemableElementTree)

Draws the primitive on the screen.

Declaration

public override void PaintPrimitive(IGraphics graphics, float angle, SizeF scale)

Parameters

Overrides BasePrimitive.PaintPrimitive(IGraphics, float, SizeF)

Determines whether the property defined by the provided property descriptor should be serialized.

Declaration

public override bool? ShouldSerializeProperty(PropertyDescriptor property)

Parameters

Returns

Overrides RadObject.ShouldSerializeProperty(PropertyDescriptor)