Class SfImageEditor
Represents ImageEditor class
Inheritance
System.Object
SfImageEditor
Assembly: Syncfusion.SfImageEditor.iOS.dll
Syntax
public class SfImageEditor : UIView
Constructors
SfImageEditor()
Declaration
SfImageEditor(CGRect)
Declaration
public SfImageEditor(CGRect frame)
Parameters
Type |
Name |
Description |
CoreGraphics.CGRect |
frame |
|
SfImageEditor(IntPtr)
Declaration
public SfImageEditor(IntPtr handle)
Parameters
Type |
Name |
Description |
System.IntPtr |
handle |
|
Properties
ActualImageRenderedBounds
Declaration
public Rectangle ActualImageRenderedBounds { get; }
Property Value
Type |
System.Drawing.Rectangle |
ColorPalette
Gets or Sets the ColorPalette collection for toolbar.
Declaration
public ObservableCollection<UIColor> ColorPalette { get; set; }
Property Value
Type |
System.Collections.ObjectModel.ObservableCollection<UIKit.UIColor> |
DefaultSelectedColorIndex
Gets or sets the ColorPalette selected Index value
Declaration
public int DefaultSelectedColorIndex { get; set; }
Property Value
EffectValue
Gets or sets the value to apply the image effects.
Declaration
public float EffectValue { get; set; }
Property Value
EnableAutoSelectText
Gets or sets the selection of edit text is enabled or not.
Declaration
public bool EnableAutoSelectText { get; set; }
Property Value
EnableZooming
Gets or Sets value to enable the zooming.
Declaration
public bool EnableZooming { get; set; }
Property Value
Frame
Declaration
public override CGRect Frame { get; set; }
Property Value
Image
Gets or Sets the Image for the ImageEditor
Declaration
public UIImage Image { get; set; }
Property Value
ImageEffect
Gets or sets the effect of the image.
Declaration
public ImageEffect ImageEffect { get; set; }
Property Value
IsImageEdited
Get the value to indicate the Image is edited or not.
Declaration
public bool IsImageEdited { get; }
Property Value
IsImageZoomed
Gets a value that indicates whether editor image is zoomed or not. It is a read-only property.
Declaration
public bool IsImageZoomed { get; }
Property Value
IsSelected
Gets a value indicating whether any shape or text is selected.
Declaration
public bool IsSelected { get; }
Property Value
MaximumZoomLevel
Gets or Sets the maximum zoom level.
Declaration
public nfloat MaximumZoomLevel { get; set; }
Property Value
OriginalImageSize
Declaration
public Size OriginalImageSize { get; }
Property Value
PanningMode
Gets or sets the PanningMode to zoom the image in single or two finger.
Declaration
public PanningMode PanningMode { get; set; }
Property Value
RotatableElements
Gets or sets rotatable elements in the editor
Declaration
public ImageEditorElements RotatableElements { get; set; }
Property Value
Gets or Sets ToolBarSettings value
Declaration
public ToolbarSettings ToolBarSettings { get; set; }
Property Value
ZoomLevel
Gets or sets the zoom level of the editor image.
Declaration
public double ZoomLevel { get; set; }
Property Value
Methods
add_BeginReset(BeginResetEventHandler)
Declaration
public void add_BeginReset(BeginResetEventHandler value)
Parameters
add_EndReset(EndResetEventHandler)
Declaration
public void add_EndReset(EndResetEventHandler value)
Parameters
add_ImageLoaded(ImageLoadedEventHandler)
Declaration
public void add_ImageLoaded(ImageLoadedEventHandler value)
Parameters
add_ImageSaved(ImageSavedEventHandler)
Declaration
public void add_ImageSaved(ImageSavedEventHandler value)
Parameters
add_ImageSaving(ImageSavingEventHandler)
Declaration
public void add_ImageSaving(ImageSavingEventHandler value)
Parameters
add_ItemSelected(ItemSelectedEventHandler)
Declaration
public void add_ItemSelected(ItemSelectedEventHandler value)
Parameters
add_ItemUnselected(ItemUnselectedEventHandler)
Declaration
public void add_ItemUnselected(ItemUnselectedEventHandler value)
Parameters
AddCustomView(UIView, CustomViewSettings)
Declaration
public void AddCustomView(UIView view, CustomViewSettings customViewSettings = null)
Parameters
AddShape(ShapeType, PenSettings)
Declaration
public void AddShape(ShapeType shapeType, PenSettings penSettings = null)
Parameters
AddText(String, TextSettings)
Declaration
public void AddText(string text = "Enter Text", TextSettings textSettings = null)
Parameters
Type |
Name |
Description |
System.String |
text |
Text
|
TextSettings |
textSettings |
Textsettings
|
ApplyImageEffect(ImageEffect, Single)
ApplyImageFilters method is used to apply the image effects without using Toolbar
Declaration
public void ApplyImageEffect(ImageEffect effect, float amount)
Parameters
Type |
Name |
Description |
ImageEffect |
effect |
|
System.Single |
amount |
float
|
AwakeFromNib()
Declaration
public override void AwakeFromNib()
BringForward()
Declaration
public void BringForward()
BringToFront()
Declaration
public void BringToFront()
ClearAnnotations()
Clear the shapes/text added on the image.
Declaration
public void ClearAnnotations()
Crop(Rectangle, Boolean)
/// Crops the image based on the specified bounds.
Declaration
public void Crop(Rectangle rect = null, bool isEllipse = false)
Parameters
Type |
Name |
Description |
System.Drawing.Rectangle |
rect |
Bounds to crop the image.(Optional).
|
System.Boolean |
isEllipse |
True to crop in elliptical shape, false otherwise.(Optional).
|
Delete()
Declaration
Flip(FlipDirection)
Method to perform flip functionality
Declaration
public void Flip(FlipDirection direction)
Parameters
GetStream()
Declaration
public Task<Stream> GetStream()
Returns
Type |
System.Threading.Tasks.Task<System.IO.Stream> |
LoadEdits(Stream)
Declaration
public void LoadEdits(Stream jsonStream)
Parameters
Type |
Name |
Description |
System.IO.Stream |
jsonStream |
|
Redo()
Declaration
remove_BeginReset(BeginResetEventHandler)
Declaration
public void remove_BeginReset(BeginResetEventHandler value)
Parameters
remove_EndReset(EndResetEventHandler)
Declaration
public void remove_EndReset(EndResetEventHandler value)
Parameters
remove_ImageLoaded(ImageLoadedEventHandler)
Declaration
public void remove_ImageLoaded(ImageLoadedEventHandler value)
Parameters
remove_ImageSaved(ImageSavedEventHandler)
Declaration
public void remove_ImageSaved(ImageSavedEventHandler value)
Parameters
remove_ImageSaving(ImageSavingEventHandler)
Declaration
public void remove_ImageSaving(ImageSavingEventHandler value)
Parameters
remove_ItemSelected(ItemSelectedEventHandler)
Declaration
public void remove_ItemSelected(ItemSelectedEventHandler value)
Parameters
remove_ItemUnselected(ItemUnselectedEventHandler)
Declaration
public void remove_ItemUnselected(ItemUnselectedEventHandler value)
Parameters
Reset()
Declaration
Rotate()
Declaration
Save(String, CGSize)
Declaration
public void Save(string format = null, CGSize size = null)
Parameters
Type |
Name |
Description |
System.String |
format |
|
CoreGraphics.CGSize |
size |
|
SaveEdits()
Declaration
public Stream SaveEdits()
Returns
SelectShape(Int32)
To select the annotation added on image programatically using its unique ID.
Declaration
public void SelectShape(int ID)
Parameters
Type |
Name |
Description |
System.Int32 |
ID |
The unique ID.
|
SendBackward()
Declaration
public void SendBackward()
SendToBack()
Declaration
To visible or hide the toolbar items
Declaration
public void SetToolbarItemVisibility(string name, bool isVisible)
Parameters
Type |
Name |
Description |
System.String |
name |
The parameter contains the toolbar item name
|
System.Boolean |
isVisible |
The parameter to check the toolbar item visible or not
|
Tilt(Double)
To rotate the image from -45 to 45 degree in preview state. To crop the preview rotation, call Crop() method of SfImageEditor.
Declaration
public void Tilt(double angle)
Parameters
Type |
Name |
Description |
System.Double |
angle |
Angle to which image has to be tilted. It must range from -45 to +45 degrees.
|
ToggleCropping()
Declaration
public void ToggleCropping()
ToggleCropping(Boolean, Int32)
Enables the cropping preview sub toolbar items. Specify selectedIndex value to customize default selection of cropping preview toolbar item.
Declaration
public void ToggleCropping(bool showToolbarItems, int selectedIndex = 0)
Parameters
Type |
Name |
Description |
System.Boolean |
showToolbarItems |
Enable or disable cropping preview toolbar items.
|
System.Int32 |
selectedIndex |
Change the default cropping selection preview toolbar item.
|
ToggleCropping(RectangleF)
Declaration
public void ToggleCropping(RectangleF rect)
Parameters
Type |
Name |
Description |
System.Drawing.RectangleF |
rect |
|
ToggleCropping(RectangleF, Boolean)
Enables the cropping preview on the image with the specified rectangle bounds. Specify isEllipse as true to crop in elliptical shape.the cropping preview on the image with the specified rectangle bounds. Specify isEllipse as true to crop in elliptical shape.
Declaration
public void ToggleCropping(RectangleF rect, bool isEllipse)
Parameters
Type |
Name |
Description |
System.Drawing.RectangleF |
rect |
Bounds of the cropping preview on the image.
|
System.Boolean |
isEllipse |
True to crop in elliptical shape, false otherwise.
|
ToggleCropping(Single, Single, Boolean)
Enables a cropping preview on the image with the specified ratio.
Declaration
public void ToggleCropping(float arg1, float arg2, bool isEllipse = false)
Parameters
Type |
Name |
Description |
System.Single |
arg1 |
x ratio.
|
System.Single |
arg2 |
y ratio.
|
System.Boolean |
isEllipse |
Shape of the cropping, either in elliptical or rectangular format.
|
Undo()
Declaration
Events
BeginReset
Declaration
public event BeginResetEventHandler BeginReset
Event Type
EndReset
Declaration
public event EndResetEventHandler EndReset
Event Type
ImageEdited
The event raised when the Image is Edited
Declaration
public event EventHandler<ImageEditedEventArgs> ImageEdited
Event Type
ImageLoaded
Declaration
public event ImageLoadedEventHandler ImageLoaded
Event Type
ImageSaved
Declaration
public event ImageSavedEventHandler ImageSaved
Event Type
ImageSaving
Declaration
public event ImageSavingEventHandler ImageSaving
Event Type
ItemSelected
Declaration
public event ItemSelectedEventHandler ItemSelected
Event Type
ItemUnselected
Declaration
public event ItemUnselectedEventHandler ItemUnselected
Event Type