Class ShapeObject

Represents a shape object.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
ShapeObject
Implements
Inherited Members
Namespace: FastReport
Assembly: FastReport.Base.dll
Syntax
public class ShapeObject : ReportComponentBase, IFRSerializable
Remarks

Use the ShapeKind property to specify a shape. To set the width, style and color of the shape's border, use the Border.Width, Border.Style and Border.Color properties.

Constructors

ShapeObject()

Initializes a new instance of the ShapeObject class with default settings.

Declaration
public ShapeObject()

Properties

Curve

Gets or sets a shape curvature if ShapeKind is RoundRectangle.

Declaration
public float Curve { get; set; }
Property Value
Type Description
System.Single
Remarks

0 value means automatic curvature.

DashPattern

Gets or sets collection of values for custom dash pattern.

Declaration
public FloatCollection DashPattern { get; set; }
Property Value
Type Description
FloatCollection
Remarks

Each element should be a non-zero positive number. If the number is negative or zero, that number is replaced by one.

Shape

Gets or sets a shape kind.

Declaration
public ShapeKind Shape { get; set; }
Property Value
Type Description
ShapeKind

Methods

Assign(Base)

Copies the contents of another, similar object.

Declaration
public override void Assign(Base source)
Parameters
Type Name Description
Base source

Source object to copy the contents from.
Overrides
Remarks

Call Assign to copy the properties from another object of the same type. The standard form of a call to Assign is

destination.Assign(source);

which tells the destination object to copy the contents of the source object to itself. In this method, all child objects are ignored. If you want to copy child objects, use the AssignAll method.

See Also

Draw(FRPaintEventArgs)

Declaration
public override void Draw(FRPaintEventArgs e)
Parameters
Type Name Description
FRPaintEventArgs e
Overrides

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

Implements