Class

RadPictureBoxElement

Initializes a new instance of the RadPictureBoxElement class.

Declaration

public RadPictureBoxElement()

Gets or sets a value indicating whether to show animations when showing and hiding panels. Note that animations are applied only when PanelDisplayMode is set to OnMouseHover.

Declaration

public bool AllowPanelAnimations { get; set; }

Property Value

Gets the bottom panel element. This panel allows adding buttons label and other elements in three collections - left, center and right items.

Declaration

public PictureBoxHorizontalPanelElement BottomPanel { get; }

Property Value

Gets the element that is responsible for painting the image.

Declaration

public PictureBoxCanvasElement CanvasElement { get; }

Property Value

Gets the context menu.

Declaration

public RadContextMenuDropDown ContextMenu { get; }

Property Value

Gets or sets a value indicating whether to display context menu on right mouse click.

Declaration

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

Property Value

Gets the context menu related properties.

Declaration

public PictureBoxContextMenuProperties ContextMenuProperties { get; }

Property Value

Gets or sets the raster image which is displayed when the Image and SvgImage properties are not specified.

Declaration

public Image DefaultImage { get; set; }

Property Value

Gets or sets the vector image which is displayed when the Image and SvgImage properties are not specified.

Declaration

public RadSvgImage DefaultSvgImage { get; set; }

Property Value

Gets or sets the text which is displayed when the Image and SvgImage properties are not specified.

Declaration

public string DefaultText { get; set; }

Property Value

Gets the horizontal scrollbar element.

Declaration

public RadScrollBarElement HorizontalScrollBar { get; }

Property Value

Gets or sets the alignment of the image on the drawing surface. Default is TopLeft. Note that this property is respected only when the ImageLayout is set to None.

Declaration

public override ContentAlignment ImageAlignment { get; set; }

Property Value

Overrides LightVisualElement.ImageAlignment

Gets or sets the dialog responsible for image editing.

Declaration

public PictureBoxImageEditorDialog ImageEditorDialog { get; set; }

Property Value

Gets the left panel element. This panel allows adding buttons label and other elements in three collections - top, center and bottom items.

Declaration

public PictureBoxVerticalPanelElement LeftPanel { get; }

Property Value

Gets the element that holds the image visible when there is no image(raster or vector) assigned.

Declaration

public LightVisualElement NoPictureImageElement { get; }

Property Value

Gets the StackLayoutPanel that is displayed when there is no image(raster or vector) assigned.

Declaration

public StackLayoutPanel NoPictureStack { get; }

Property Value

Gets the element that holds the text visible when there is no image(raster or vector) assigned.

Declaration

public LightVisualElement NoPictureTextElement { get; }

Property Value

Gets or sets a value indicating how the panels are displayed. The possible options are: always or on mouse hover.

Declaration

public PictureBoxPanelDisplayMode PanelDisplayMode { get; set; }

Property Value

Gets or sets a value indicating how the panels are positioned.

Declaration

public PictureBoxPanelOverflowMode PanelOverflowMode { get; set; }

Property Value

Specifies how the image is positioned on the element.

Declaration

public virtual RadImageLayout RadImageLayout { get; set; }

Property Value

Determines if users can only view the image with no interaction: zoom and context menu are not available when read only is true.

Declaration

[Browsable(true)]
public bool ReadOnly { get; set; }

Property Value

Gets the right panel element. This panel allows adding buttons label and other elements in three collections - top, center and bottom items.

Declaration

public PictureBoxVerticalPanelElement RightPanel { get; }

Property Value

Gets or sets a value indicating whether to display scrollbars when the displayed image is larger than the element.

Declaration

public bool ShowScrollBars { get; set; }

Property Value

Gets the top panel element. This panel allows adding buttons label and other elements in three collections - left, center and right items.

Declaration

public PictureBoxHorizontalPanelElement TopPanel { get; }

Property Value

Gets the vertical scrollbar element.

Declaration

public RadScrollBarElement VerticalScrollBar { get; }

Property Value

Gets the properties responsible for the zoom operations.

Declaration

public PictureBoxZoomProperties ZoomProperties { get; }

Property Value

Arranges the RadPictureBoxElement to its final location. The element must call the Arrange method of each of its children.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Remarks

Declaration

protected virtual SizeF CalculateZoomOffset(double newZoomFactor, SizeF newCanvasSize)

Parameters

Returns

Declaration

protected virtual bool CanStartPan()

Returns

Removes the image and/or svg image.

Declaration

public virtual void ClearImage()

Copies the displayed image into the clipboard.

Declaration

public virtual void CopyImage()

Declaration

protected virtual PictureBoxHorizontalPanelElement CreateBottomPanel()

Returns

Declaration

protected virtual PictureBoxCanvasElement CreateCanvasElement()

Returns

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Declaration

protected virtual RadContextMenuDropDown CreateContextMenu()

Returns

Declaration

protected virtual PictureBoxContextMenuProperties CreateContextMenuProperties()

Returns

Declaration

protected virtual RadScrollBarElement CreateHorizontalScrollBarElement()

Returns

Declaration

protected virtual PictureBoxVerticalPanelElement CreateLeftPanel()

Returns

Declaration

protected virtual LightVisualElement CreateNoPictureImageElement()

Returns

Declaration

protected virtual StackLayoutPanel CreateNoPictureStack()

Returns

Declaration

protected virtual LightVisualElement CreateNoPictureTextElement()

Returns

Declaration

protected virtual PictureBoxVerticalPanelElement CreateRightPanel()

Returns

Declaration

protected virtual PictureBoxHorizontalPanelElement CreateTopPanel()

Returns

Declaration

protected virtual RadScrollBarElement CreateVerticalScrollBarElement()

Returns

Declaration

protected virtual PictureBoxZoomProperties CreateZoomProperties()

Returns

Copies the displayed image into the clipboard and clears the displayed image.

Declaration

public virtual void CutImage()

Disposes of managed resources including cached images and SVG images when the element is being disposed.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Edits the image using a RadImageEditor displayed in a PictureBoxImageEditorDialog.

Declaration

public void EditImage()

Declaration

protected virtual void EnableContextMenuItems()

Hides the panels.

Declaration

public virtual void HidePanels(bool animate = true)

Parameters

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 LightVisualElement.InitializeFields()

Opens an OpenFileDialog which allows the user to choose an image.

Declaration

public virtual void LoadImage()

Measures the desired size of the element by calculating the space needed for content, padding, and borders.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Handles the bounds changed event by updating the fill primitive implementation and invoking the base class handler.

Declaration

protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides UIItemBase.OnBoundsChanged(RadPropertyChangedEventArgs)

Raises the ContextMenuClosed event.

Declaration

protected virtual void OnContextMenuClosed()

Raises the ContextMenuClosing event.

Declaration

protected virtual void OnContextMenuClosing(CancelEventArgs args)

Parameters

Declaration

protected virtual void OnContextMenuItemClick(object sender, EventArgs e)

Parameters

Raises the ContextMenuOpened event.

Declaration

protected virtual void OnContextMenuOpened()

Raises the ContextMenuOpening event.

Declaration

protected virtual void OnContextMenuOpening(CancelEventArgs args)

Parameters

Declaration

[Obsolete("Override OnImageLoaded(ImageKind, LoadImageContext, string) instead.")]
protected virtual void OnImageLoaded()

Declaration

protected virtual void OnImageLoaded(ImageKind imageKind, LoadImageContext loadContext, string filePath = null)

Parameters

Declaration

protected virtual void OnImageSaved()

Called when a mouse button is pressed down over the item.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Called when the mouse moves over the item, handling highlight and border highlight effects.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides LightVisualElement.OnMouseMove(MouseEventArgs)

Called when a mouse button is released over the item.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseUp(MouseEventArgs)

Raises the MouseWheel event.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadElement.OnMouseWheel(MouseEventArgs)

Declaration

protected virtual void OnPanChanged()

Declaration

protected virtual void OnPanelDisplayModeChanged()

Declaration

protected virtual void OnPanelOverflowModeChanged()

Notifies for a change in the Parent value.

Declaration

protected override void OnParentChanged(RadElement previousParent)

Parameters

Overrides RadElement.OnParentChanged(RadElement)

Handles property change events by invalidating the fill cache and invoking the base class property change handler.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration

protected virtual void OnRadImageLayoutChanged()

Declaration

protected virtual void OnZoomChanged()

Fires the ZoomGesture event.

Declaration

protected override void OnZoomGesture(ZoomGestureEventArgs args)

Parameters

Overrides RadItem.OnZoomGesture(ZoomGestureEventArgs)

Pastes an image from the clipboard.

Declaration

public virtual void PasteImage()

Declaration

protected virtual void ProcessMouseWheelScroll(MouseEventArgs e, RadScrollBarElement scrollBar)

Parameters

Declaration

protected virtual void ResetPanAndZoom()

Opens a SaveFileDialog which allows the user to save the displayed image.

Declaration

public virtual void SaveImage()

This method is not relevant for this class.

Declaration

public override void SetAllLocalValuesAsDefault(bool recursive)

Parameters

Overrides RadElement.SetAllLocalValuesAsDefault(bool)

Gets a value indicating, whether a child will be arranged during the ArrangeOverride.

Declaration

protected override bool ShouldArrangeChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldArrangeChild(RadElement)

Shows the panels.

Declaration

public virtual void ShowPanels(bool animate = true)

Parameters

Declaration

protected virtual void UnwireParentControl()

Declaration

protected virtual void UpdatePanels(bool animate = true)

Parameters

Declaration

protected virtual void UpdateParentControl()

Declaration

protected virtual void UpdatePictureElementPanZoomAndSize()

Declaration

protected virtual void WireParentControl()

Performs a zoom operation by given steps count.

Declaration

public void Zoom(int step, Point? pivotPoint = null)

Parameters

Performs a zoom-in operation with one step, according to the ZoomProperties.ZoomStep value.

Declaration

public void ZoomIn()

Performs a zoom-in operation with several steps, according to the ZoomProperties.ZoomStep value.

Declaration

public void ZoomIn(int steps)

Parameters

Performs a zoom-out operation with one step, according to the ZoomProperties.ZoomStep value.

Declaration

public void ZoomOut()

Performs a zoom-out operation with several steps, according to the ZoomProperties.ZoomStep value.

Declaration

public void ZoomOut(int steps)

Parameters

Occurs when the context menu is closed.

Declaration

public event EventHandler ContextMenuClosed

Event Value

Occurs when the context menu is closing.

Declaration

public event CancelEventHandler ContextMenuClosing

Event Value

Occurs when an item in the context menu is clicked.

Declaration

public event HandledEventHandler ContextMenuItemClick

Event Value

Occurs when the context menu is opened.

Declaration

public event EventHandler ContextMenuOpened

Event Value

Occurs when the context menu is opening.

Declaration

public event CancelEventHandler ContextMenuOpening

Event Value

Occurs when the image has been edited by the ImageEditorDialog and the user has accepted the changes. Can be handled. Note that this event fill be fired always when the user clicks the OK button of the dialog, even if there are no changes in the image.

Declaration

public event PictureBoxImageEditedEventHandler ImageEdited

Event Value

Occurs when the image is about to be edited in the ImageEditorDialog. Cancellable.

Declaration

public event PictureBoxImageEditorOpeningEventHandler ImageEditorOpening

Event Value

Occurs when a raster or vector(SVG) image has been loaded by the user.

Declaration

public event EventHandler ImageLoaded

Event Value

Occurs when the displayed image has been saved by the user.

Declaration

public event EventHandler ImageSaved

Event Value

Occurs when the PositionOffset property of PictureBoxCanvasElement is changed.

Declaration

public event EventHandler PanChanged

Event Value

Raised after the ZoomFactor is changed.

Declaration

public event EventHandler ZoomChanged

Event Value