AddShape(PSShape) Method

Adds a shape to the drawing container for the sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Overridable Function AddShape( _
   ByVal shape As PSShape _
) As Integer

'Usage
 
Dim instance As SheetView
Dim shape As PSShape
Dim value As Integer
 
value = instance.AddShape(shape)

public virtual int AddShape( 
   PSShape shape
)

Parameters

shape: Shape to add

Return Value

Integer index of the shape in the list of shapes

Remarks

The index of the shape is the number in the shapes list that the shape was added. If you add a shape by the same name as a shape already in the container, the return value is the index of the replaced shape.

Example

This example adds a shape on the sheet.

FarPoint.Win.Spread.DrawingSpace.ArrowShape a = new FarPoint.Win.Spread.DrawingSpace.ArrowShape();
fpSpread1.ActiveSheet.AddShape(a);

Visual Basic

Dim a As New FarPoint.Win.Spread.DrawingSpace.ArrowShape
FpSpread1.ActiveSheet.AddShape(a)

Requirements

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

Reference

SheetView Class
SheetView Members
Overload List