Class FloatingShapeBase

Represents a base for all shape elements in the RadSpreadsheet.

Inheritance
System.Object
FloatingShapeBase
SpreadsheetComment
FloatingResizableShapeBase
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Shapes
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class FloatingShapeBase : ICopyable<FloatingShapeBase>

Properties

Description

Gets or sets the description of the shape.

Declaration
public string Description { get; set; }
Property Value
System.String

The description of the shape.

FloatingShapeType

Gets the type of the shape.

Declaration
public abstract FloatingShapeType FloatingShapeType { get; }
Property Value
FloatingShapeType

Id

Gets the id of the shape, which is unique for the worksheet it belongs to.

Declaration
public int Id { get; }
Property Value
System.Int32

The id of the shape.

LockAspectRatio

Gets or sets the value indicating whether the aspect ratio between the width and height should remain constant.

Declaration
public bool LockAspectRatio { get; set; }
Property Value
System.Boolean

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

Name

Gets or sets the name of the shape.

Declaration
public string Name { get; set; }
Property Value
System.String

The name of the shape.

Worksheet

Gets the worksheet assigned to the shape.

Declaration
public Worksheet Worksheet { get; }
Property Value
Worksheet

The worksheet.

Methods

OnShapeChanged()

Called when the value of any of the shape properties is changed.

Declaration
protected void OnShapeChanged()

SetHeight(Boolean, Double, Boolean)

Sets the height of the shape.

Declaration
public void SetHeight(bool respectLockAspectRatio, double height, bool adjustCellIndex = false)
Parameters
System.Boolean respectLockAspectRatio

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

The new height.
System.Boolean adjustCellIndex

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

SetWidth(Boolean, Double, Boolean)

Sets the width of the shape.

Declaration
public void SetWidth(bool respectLockAspectRatio, double width, bool adjustCellIndex = false)
Parameters
System.Boolean respectLockAspectRatio

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

The new width.
System.Boolean adjustCellIndex

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

Events

ShapeChanged

Occurs when the value of any of the shape properties is changed.

Declaration
public event EventHandler ShapeChanged
Event Type
System.EventHandler