Class ImageFrameSettings

Represents the settings of a frame in the SfImageEditor.

Inheritance

System.Object

ImageFrameSettings

Namespace: Syncfusion.Blazor.ImageEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class ImageFrameSettings : Object

Constructors

ImageFrameSettings()

Declaration

public ImageFrameSettings()

Properties

BorderRadius

Gets or sets the border radius value of the frame as a percentage in the SfImageEditor.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>	An integer value that specifies the border radius of the frame. The border radius controls the curvature of the frame's corners or edges. It can be provided as an integer percentage (e.g., 10). The default border radius is typically zero, resulting in sharp corners.

Remarks

The BorderRadius value is applicable only to specific frame types such as Line and Bevel. It allows you to round the corners or edges of the frame, giving it a softer appearance. For other frame types, the border radius property is not used.

Color

Gets or sets the color of the frame in the SfImageEditor.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A string value specifying the color of the frame. The color can be provided in various formats, including named colors ("red", "blue") and hexadecimal notation ("#RRGGBB"). The default frame color is typically white.

Remarks

The frame color is used to define the outline color of the frame drawn on an image using the SfImageEditor. It helps distinguish the frame from the content of the image.

FrameLineStyle

Gets or sets the type of lines to be drawn for line-type frames on the image in the SfImageEditor.

Declaration

public Nullable<FrameLineStyle> FrameLineStyle { get; set; }

Property Value

Type	Description
System.Nullable<FrameLineStyle>	A FrameLineStyle enumeration value that specifies the type of line to be applied as a frame. The default value is Solid.

Remarks

The FrameLineStyle value is applicable only to Line frames. It allows you to customize the appearance of the lines used to create the frame. Different line types can give your frame a distinct visual style.

GradientColor

Gets or sets the gradient color of the frame in the SfImageEditor.

Declaration

public string GradientColor { get; set; }

Property Value

Type	Description
System.String	A string value specifying the gradient color of the frame. The color can be provided in various formats, including named colors ("red", "blue") and hexadecimal notation ("#RRGGBB"). The default gradient color is typically absent, resulting in a solid color frame.

Remarks

The gradient color can be used to give the frame a more dynamic and visually appealing appearance. When set, the frame will transition from the primary frame color to the gradient color, creating a gradient effect.

Inset

Gets or sets the inset value of the frame as a percentage in the SfImageEditor.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>	An integer value specifying the inset of the frame as a percentage. The inset value determines how far the frame is drawn inside the image boundaries. It can be provided as an integer percentage (e.g., 10). The default inset value is often set to zero.

Remarks

The inset value is applicable only to specific frame types such as Line, Inset, and Hook. It helps create an internal margin between the frame and the image's edges. For other frame types, inset is not used.

LineCount

Gets or sets the number of lines to be drawn on the image in the SfImageEditor.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>	An integer value that specifies the number of lines to be applied as a frame. The lines are drawn parallel to the image edges. Each line contributes to the frame's appearance, giving it a unique style. The default value is typically zero, resulting in no additional lines.

Remarks

The LineCount value is applicable only to Line frames. It enables you to create a distinctive frame effect by adding multiple parallel lines around the image's edges.

Offset

Gets or sets the offset value of the frame as a percentage in the SfImageEditor.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>	An integer value that specifies the offset of the frame as a percentage. The offset determines how far the line is positioned from another line in the image's boundaries. It can be provided as an integer percentage (e.g., 5). The default offset value is typically zero.

Remarks

The offset value is relevant for specific frame types such as Line and Inset. It allows you to control the position of the frame within the image. The offset is measured from the edge where the frame is applied towards the center of the image. Other frame types do not use the offset property.

Size

Gets or sets the size of the frame as a percentage in the SfImageEditor.

Declaration

public int Size { get; set; }

Property Value

Type	Description
System.Int32	An integer value specifying the size of the frame as a percentage. The size value indicates how much of the image's dimensions the frame occupies. It can be provided as an integer percentage (e.g., 20). The default frame size is often set to a reasonable percentage to maintain a balanced appearance.

Remarks

Adjusting the frame size allows you to control the width or thickness of the frame drawn on an image using the SfImageEditor. Smaller percentages result in thinner frames, while larger percentages result in thicker frames.

Type

Gets or sets the type of frame in the SfImageEditor.

Declaration

public FrameType Type { get; set; }

Property Value

Type	Description
FrameType	An enumeration value that specifies the type of the frame, such as None, Mat, Bevel, Line, Inset, and Hook.