[]
DEMOS DOCS API BLOG SUPPORT PRICING DOWNLOAD
(Showing Draft Content)

FarPoint.Win.Spread.SheetView.AddShape

AddShape Method

AddShape(PSShape)

Adds a shape to the drawing container for the sheet.

Declaration
public virtual int AddShape(PSShape shape)
Public Overridable Function AddShape(shape As PSShape) As Integer
Parameters
Type Name Description
PSShape shape

Shape to add
Returns
Type Description
int

AddShape(PSShape, int, int)

Adds a shape to the drawing container for the sheet at the specified row and column.

Declaration
public virtual int AddShape(PSShape shape, int row, int column)
Public Overridable Function AddShape(shape As PSShape, row As Integer, column As Integer) As Integer
Parameters
Type Name Description
PSShape shape

Shape to add
int row

Row index at which to add shape
int column

Column index at which to add shape
Returns
Type Description
int

AddShape(PSShape, int, int, int, int, bool)

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.

Declaration
public virtual int AddShape(PSShape shape, int row, int column, int rowPixelOffset, int columnPixelOffset, bool attachedToCell)
Public Overridable Function AddShape(shape As PSShape, row As Integer, column As Integer, rowPixelOffset As Integer, columnPixelOffset As Integer, attachedToCell As Boolean) As Integer
Parameters
Type Name Description
PSShape shape

Shape to add
int 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.
int 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.
int 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.
int 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.
bool 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.
Returns
Type Description
int

AddShape(PSShape, int, int, int, int, int, int, int, int, bool)

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

Declaration
public virtual int AddShape(PSShape shape, int fromRow, int fromColumn, int fromRowPixelOffset, int fromColumnPixelOffset, int toRow, int toColumn, int toRowPixelOffset, int toColumnPixelOffset, bool attachedToCell)
Public Overridable Function AddShape(shape As PSShape, fromRow As Integer, fromColumn As Integer, fromRowPixelOffset As Integer, fromColumnPixelOffset As Integer, toRow As Integer, toColumn As Integer, toRowPixelOffset As Integer, toColumnPixelOffset As Integer, attachedToCell As Boolean) As Integer
Parameters
Type Name Description
PSShape shape

Shape to add
int fromRow

Row index at which to add the shape. The fromRow parameter must be greater than or equal to 0 and less than the sheetview's row count.
int fromColumn

Column index at which to add the shape. The fromColumn parameter must be greater than or equal to 0 and less than the sheetview's column count.
int fromRowPixelOffset

The distance between the top boundary of the shape and the top of the specified row. The fromRowPixelOffset parameter must be greater than or equal to 0.
int fromColumnPixelOffset

The distance between the left boundary of the shape and the left of the specified column. The fromColumnPixelOffset parameter must be greater than or equal to 0.
int toRow

Row index that specifies the bottom boundary of the shape. The toRow parameter must be greater than or equal to fromRow and less than the sheetview's row count.
int toColumn

Column index that specifies the right boundary of the shape. The toColumn parameter must be greater than or equal to fromColumn and less than the sheetview's column count.
int toRowPixelOffset

The distance between the bottom boundary of the shape and the top of toRow. The toRowPixelOffset parameter must be greater than or equal to 0. If toRow is equal to fromRow, toRowPixelOffset must be greater than fromRowPixelOffset.
int toColumnPixelOffset

The distance between the right boundary of the shape and the left of toColumn. The toColumnPixelOffset parameter must be greater than or equal to 0. If toColumn is equal to fromColumn, toColumnPixelOffset must be greater than fromColumnPixelOffset.
bool attachedToCell

Indicates whether the top-left edge of the shape must stay within the cell specified by the fromRow and fromColumn parameters and whether the bottom-right edge of the shape must stay within the cell specified by the toRow and toColumn parameters. If attachedToCell is false, when fromRowPixelOffset, fromColumnPixelOffset, toRowPixelOffset, or toColumnPixelOffset is greater than or equal to the toRow, toColumn, fromRow, or fromColumn's height or width, the top-left or bottom-right vertex of the shape boundary moves to the next row or column. This ensures that the distance between the top-left or bottom-right vertex and the top, left, bottom, or right of the specified row or column is equal to fromRowPixelOffset, fromColumnPixelOffset, toRowPixelOffset, or toColumnPixelOffset.
Returns
Type Description
int