New to Telerik Document ProcessingStart a free 30-day trial

Abstract base for all floating shape elements positioned over worksheet cells with anchoring, providing shared identity, naming, and geometry management.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Shapes

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

C#
public abstract class FloatingShapeBase

Inheritance: objectFloatingShapeBase

Derived Classes: SpreadsheetCommentFloatingResizableShapeBase

Events

Raised when any shape property changes, signaling that dependent UI or layout should refresh.

C#
public event EventHandler ShapeChanged

Methods

Raises the ShapeChanged event, notifying subscribers of property modifications.

C#
protected void OnShapeChanged()

Resizes the shape to the specified height via command, optionally preserving aspect ratio and adjusting anchor position to maintain visual top-left corner.

C#
public void SetHeight(bool respectLockAspectRatio, double height, bool adjustCellIndex = false)
Parameters:respectLockAspectRatiobool

A value indicating whether the aspect ratio lock should be respected.

heightdouble

The new height.

adjustCellIndexbool

A value indicating whether the top cell index and offset of the image should be adjusted.

Resizes the shape to the specified width via command, optionally preserving aspect ratio and adjusting anchor position to maintain visual top-left corner.

C#
public void SetWidth(bool respectLockAspectRatio, double width, bool adjustCellIndex = false)
Parameters:respectLockAspectRatiobool

A value indicating whether the aspect ratio lock should be respected.

widthdouble

The new width.

adjustCellIndexbool

A value indicating whether the top cell index and offset of the image should be adjusted.

Properties

Text description for accessibility and metadata purposes; changes are executed via command for undo support.

C#
public string Description { get; set; }
Property Value:

The description of the shape.

Discriminates the shape category (Image, Chart, Note, Comment) to enable type-specific handling.

C#
public abstract FloatingShapeType FloatingShapeType { get; }

Unique identifier within the owning worksheet, assigned at creation and invariant during the shape's lifetime.

C#
public int Id { get; }
Property Value:

The id of the shape.

Controls whether resizing operations maintain the original width-to-height ratio, preventing distortion when set to true.

C#
public bool LockAspectRatio { get; set; }
Property Value:

The value indicating whether the aspect ratio between the width and height should remain constant.

User-assigned name for the shape, useful for identification and scripting; changes are executed via command for undo support.

C#
public string Name { get; set; }
Property Value:

The name of the shape.

Worksheet that owns this shape, establishing the coordinate system and command context.

C#
public Worksheet Worksheet { get; }
Property Value:

The worksheet.