Floating objects exist independently of the cell grid and can be positioned freely at absolute locations on the worksheet. They include drawing shapes, images, and charts.

Namespace

using unvell.ReoGrid.Drawing;
using unvell.ReoGrid.Drawing.Shapes;

Class Hierarchy

FloatingObject
  └─ DrawingObject
      ├─ ShapeObject
      │   ├─ RectangleShape
      │   ├─ EllipseShape
      │   ├─ RoundedRectangleShape
      │   ├─ DiamondShape
      │   ├─ PieShape
      │   └─ BlockArcShape
      ├─ Line
      ├─ ImageObject
      └─ DrawingComponent
          └─ Chart (ColumnChart, BarChart, LineChart, etc.)

Adding Floating Objects

All floating objects are managed through the FloatingObjects collection on the worksheet:

var sheet = grid.CurrentWorksheet;

// Create a shape
var rect = new RectangleShape
{
    Location = new Graphics.Point(50, 50),
    Size = new Graphics.Size(200, 100),
    Text = "Hello ReoGrid",
};

// Add to worksheet
sheet.FloatingObjects.Add(rect);

Result:

FloatingObjects Collection

// Remove a specific shape
sheet.FloatingObjects.Remove(rect);

// Remove all floating objects
sheet.FloatingObjects.Clear();

// Iterate all floating objects
foreach (var obj in sheet.FloatingObjects)
{
    Console.WriteLine($"{obj.GetType().Name}: {obj.Bounds}");
}

// Count floating objects
int count = sheet.FloatingObjects.Count;

Common Properties (All Floating Objects)

All floating objects share these positioning and sizing properties:

// Position
rect.Location = new Graphics.Point(100, 200);

// Size
rect.Size = new Graphics.Size(300, 150);

// Both at once
rect.Bounds = new Graphics.Rectangle(100, 200, 300, 150);

// Individual properties
rect.X = 100;
rect.Width = 300;

DrawingObject Properties

Drawing objects add visual styling and transformation properties:

rect.RotateAngle = 45f;
rect.Visible = false;

Styling

Access the Style property to customize appearance:

IDrawingObjectStyle Properties

rect.Style.FillColor = Graphics.SolidColor.LightYellow;
rect.Style.LineColor = Graphics.SolidColor.Navy;
rect.Style.LineWidth = 2.0f;
rect.Style.LineStyle = Graphics.LineStyles.Dash;

LineStyles Enum

Shape Text Styling

Shapes (Rectangle, Ellipse, Diamond, etc.) support text via IDrawingShapeObjectStyle:

rect.Text = "Styled Shape";
rect.Style.TextColor = Graphics.SolidColor.DarkBlue;
rect.Style.HorizontalAlignment = Drawing.HorizontalAlignment.Center;
rect.Style.VerticalAlignment = Drawing.VerticalAlignment.Middle;

Line Cap Styling

Line objects support cap styles via IDrawingLineObjectStyle:

LineCapStyles Enum

Events

FloatingObject Events

Selection Events

rect.SelectionChanged += (s, e) =>
{
    Console.WriteLine($"Selected: {rect.IsSelected}");
};

Object Types

Drawing Shapes

Shapes with fill, outline, and text support. See Drawing Shapes for all shape types and their properties.

Floating Image

Display images on the worksheet. See Floating Image.

var image = Image.FromFile("photo.png");
var imgObj = new ImageObject(image)
{
    Location = new Graphics.Point(40, 30),
};
sheet.FloatingObjects.Add(imgObj);

Charts

Charts are also floating objects. See Chart for all chart types.

Interface Hierarchy

Related Topics

• Drawing Shapes — All shape types and styling
• Floating Image — Adding images to worksheets
• Chart — Chart types and data sources