AddShape(PSShape,Int32,Int32,Int32,Int32,Boolean) Method

Adds a shape to the drawing container for the sheet at the specified row and column with the offset from the top-left of the cell.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Overridable Function AddShape( _
   ByVal shape As PSShape, _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowPixelOffset As Integer, _
   ByVal columnPixelOffset As Integer, _
   ByVal attachedToCell As Boolean _
) As Integer

'Usage
 
Dim instance As SheetView
Dim shape As PSShape
Dim row As Integer
Dim column As Integer
Dim rowPixelOffset As Integer
Dim columnPixelOffset As Integer
Dim attachedToCell As Boolean
Dim value As Integer
 
value = instance.AddShape(shape, row, column, rowPixelOffset, columnPixelOffset, attachedToCell)

public virtual int AddShape( 
   PSShape shape,
   int row,
   int column,
   int rowPixelOffset,
   int columnPixelOffset,
   bool attachedToCell
)

Parameters

shape: Shape to add
row: Row index at which to add the shape. The row parameter must be greater than or equal to 0 and less than the sheetview's row count.
column: Column index at which to add the shape. The column parameter must be greater than or equal to 0 and less than the sheetview's column count.
rowPixelOffset: The distance between the top boundary of the shape and the top of the specified row. The rowPixelOffset parameter must be greater than or equal to 0.
columnPixelOffset: The distance between the left boundary of the shape and the left edge of the specified column. The columnPixelOffset parameter must be greater than or equal to 0.
attachedToCell: Indicates whether the top-left edge of the shape stays within the cell specified by the parameters. If attachedToCell is false, when the specified rowPixelOffset or columnPixelOffset is greater than or equal to the specified row or column's height or width, the top-left vertex of the shape's boundary moves to the next visible row or column so that the distance between the top-left vertex and the top-left of the specified row or column is equal to rowPixelOffset or columnPixelOffset.

Example

This example adds a shape.

FarPoint.Win.Spread.DrawingSpace.ArrowShape arrow = new FarPoint.Win.Spread.DrawingSpace.ArrowShape();
arrow.Parent = fpSpread1;
fpSpread1.ActiveSheet.AddShape(arrow, 2, 2, 5, 5, true);

Visual Basic

Dim arrow As New FarPoint.Win.Spread.DrawingSpace.ArrowShape()
arrow.Parent = FpSpread1
FpSpread1.ActiveSheet.AddShape(arrow, 2, 2, 3, 3, 4, 4, 6, 6, False)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

SheetView Class
SheetView Members
Overload List