Class ShapeSettings

Represents the settings of a shape in the SfImageEditor.

Inheritance

System.Object

ShapeSettings

Namespace: Syncfusion.Blazor.ImageEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class ShapeSettings : Object

Remarks

The GetShapesAsync() method is used to get the shapes settings to perform SelectShapeAsync(String) and DeleteShapeAsync(String).

Constructors

ShapeSettings()

Declaration

public ShapeSettings()

Properties

ArrowHead

Gets or sets the head type of an arrow shape in the SfImageEditor.

Declaration

public Nullable<ImageEditorArrowHeadType> ArrowHead { get; set; }

Property Value

Type	Description
System.Nullable<ImageEditorArrowHeadType>	A ImageEditorArrowHeadType value that specifies head type of arrow shape.

Remarks

This property is available for the arrow shape and for the other shapes the value should be null.

ArrowTail

Gets or sets the tail type of an arrow shape in the SfImageEditor.

Declaration

public Nullable<ImageEditorArrowHeadType> ArrowTail { get; set; }

Property Value

Type	Description
System.Nullable<ImageEditorArrowHeadType>	A ImageEditorArrowHeadType value that specifies tail type of arrow shape.

Remarks

This property is available for the arrow shape and for the other shapes the value should be null.

BorderRadius

Gets or sets the radius of the shape in the SfImageEditor.

Declaration

public Nullable<double> BorderRadius { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the radius of the shape.

Remarks

This property is available only when the rectangle annotation is processed.

Color

Gets or sets the font color of the text shape in the SfImageEditor.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the font color of the text shape.

Remarks

This property is available only when the text shape is processed.

Degree

Gets or sets the degree of rotated shape in the SfImageEditor.

Declaration

public Nullable<double> Degree { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the degree of rotated shape.

Remarks

This property is available for the shapes including rectangle, ellipse, and image and for the other shapes the value should be null.

EndX

Gets or sets the end X position of the line / arrow shape in the SfImageEditor.

Declaration

public Nullable<double> EndX { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the end X position of the line / arrow shape.

Remarks

This property is available for the arrow and line shapes and for the other shapes the value should be null.

EndY

Gets or sets the end Y position of the line / arrow shape in the SfImageEditor.

Declaration

public Nullable<double> EndY { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the end Y position of the line / arrow shape.

Remarks

This property is available for the arrow and line shapes and for the other shapes the value should be null.

FillColor

Gets or sets the fill color of the shape in the SfImageEditor.

Declaration

public string FillColor { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the fill color of the shape.

FontFamily

Gets or sets the font family of the text shape in the SfImageEditor.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the font family of the text shape.

Remarks

This property is available only when the text shape is processed.

FontSize

Gets or sets the font size of the text shape in the SfImageEditor.

Declaration

public Nullable<double> FontSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the font size of the text shape.

Remarks

This property is available only when the text shape is processed.

FontStyle

Gets or sets the font styles of the text shape in the SfImageEditor.

Declaration

public string[] FontStyle { get; set; }

Property Value

Type	Description
System.String[]	A string array value that specifies the font styles of the text shape.

Remarks

This property is available only when the text shape is processed.

Height

Gets or sets the height of the shape in the SfImageEditor.

Declaration

public Nullable<double> Height { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the height of the shape.

ID

Gets or sets the id of the shape in the SfImageEditor.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the id of the shape.

ImageData

Returns the URL or image data associated with the image annotation in the SfImageEditor.

Declaration

public string ImageData { get; set; }

Property Value

Type	Description
System.String	The URL or image data of the image annotation. The default value is null.

Remarks

This property is relevant only for image annotations. It holds the URL or image data that corresponds to the image annotation within the SfImageEditor. Other annotation types such as Rectangle, Line, Ellipse, Path, and Arrow do not utilize this property and will have a null value.

Index

Gets or sets the index of the shape to be placed on an image in the SfImageEditor.

Declaration

public Nullable<int> Index { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	An integer value that specifies the index of the shape to be placed on the image.

Length

Gets or sets the length of the shape in the SfImageEditor.

Declaration

public Nullable<double> Length { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the length of the shape.

Remarks

This property is available only when the line and arrow shape is processed.

Opacity

Gets or sets the opacity value of the image shape in the SfImageEditor.

Declaration

public Nullable<double> Opacity { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the opacity value of the image shape.

Remarks

This property is available only for the image shape and for the other shapes it should be null.

Points

Gets or sets the points of the freehand draw in the SfImageEditor.

Declaration

public ImageEditorPoint[] Points { get; set; }

Property Value

Type	Description
ImageEditorPoint[]	An ImageEditorPoint array value that specifies the points to be freehand drawn.

Remarks

This property is available only when the freehand annotation is processed.

Radius

Gets or sets the radius of the shape in the SfImageEditor.

Declaration

public Nullable<double> Radius { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the radius of the shape.

Remarks

This property is available only when the ellipse shape is processed.

RadiusX

Gets or sets the width radius of the ellipse shape in the SfImageEditor.

Declaration

public Nullable<double> RadiusX { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the width radius of the ellipse shape.

Remarks

This property is available for the ellipse shape and for the other shapes the value should be null.

RadiusY

Gets or sets the height radius of the ellipse shape in the SfImageEditor.

Declaration

public Nullable<double> RadiusY { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the height radius of the ellipse shape.

Remarks

This property is available for the ellipse shape and for the other shapes the value should be null.

StartX

Gets or sets the x-coordinate of the start point in the SfImageEditor.

Declaration

public double StartX { get; set; }

Property Value

Type	Description
System.Double	A double value that specifies the x-coordinate of the start point.

StartY

Gets or sets the y-coordinate of the start point in the SfImageEditor.

Declaration

public double StartY { get; set; }

Property Value

Type	Description
System.Double	A double value that specifies the y-coordinate of the start point.

StrokeColor

Gets or sets the stroke color of the shape in the SfImageEditor.

Declaration

public string StrokeColor { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the stroke color of the shape.

StrokeWidth

Gets or sets the stroke width of the shape in the SfImageEditor.

Declaration

public Nullable<int> StrokeWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	A int value that specifies the stroke width of the shape.

Text

Gets or sets the text content of the text shape in the SfImageEditor.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string value that specifies the text content of the text shape.

Remarks

This property is available only when the text shape is processed.

Type

Gets or sets the type of the shape in the SfImageEditor.

Declaration

public ShapeType Type { get; set; }

Property Value

Type	Description
ShapeType	An Enum value that specifies the type of the shape such as Rectangle, Ellipse, Line, Arrow, Text, and Freehand Draw.

Width

Gets or sets the width of the shape in the SfImageEditor.

Declaration

public Nullable<double> Width { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	A double value that specifies the width of the shape.