Class Position

Class that represents a graphic object position within a WorkSheet

Inheritance
System.Object
Position
Namespace: IronXL.Drawing
Assembly: IronXL.dll
Syntax
public class Position : Object

Position locates a graphic object, such as an image, on a worksheet by naming the cells it is attached to. When a developer adds a picture to a sheet and needs it to sit over a specific range rather than float at an arbitrary point, this object pins it to the grid: it defines the top-left and bottom-right cell corners that bound the object and how tightly it follows those cells as the sheet changes.

A Position describes where a drawing anchors within the worksheet's coordinate system. It carries the top, bottom, left, and right cell coordinates of the object and the anchoring behavior that ties it to them, so reading a position tells you which cells a graphic covers and adjusting one moves or resizes the graphic in cell terms. It belongs to the image-handling step of a workbook workflow, after a sheet exists and a drawing is being placed or inspected.

The coordinates come in two complementary forms. TopRowIndex and BottomRowIndex set the first and last rows as 0-based indexes, while LeftColumnIndex and RightColumnIndex do the same for columns; a value of 0 maps to Excel's row 1 or column A. For columns, LeftColumnLetter and RightColumnLetter offer the same bounds as letters such as "A", an alternative to the numeric index for code that thinks in spreadsheet terms. AnchorType is an AnchorType value that decides whether the object moves and sizes with its cells, moves but does not size, or stays fixed. Set the corner coordinates to bound the object and the anchor type to control how it reacts when rows or columns are inserted or resized.

using IronXL.Drawing;

// position obtained from a worksheet image
position.LeftColumnIndex = 0;
position.TopRowIndex = 0;
position.RightColumnIndex = 3;
position.BottomRowIndex = 5;

The worksheet images how-to covers placing and removing pictures, the worksheet images example shows a worked file, and the manage worksheets how-to sets up the sheet a graphic sits on.

Properties

AnchorType

Gets or sets the way in which the image is anchored to the WorkSheet cells.

Declaration
public AnchorType AnchorType { get; set; }
Property Value
Type Description
AnchorType
See Also

BottomRowIndex

Returns the 0-based index of the last row the graphic object is "attached" to.

e.g. if BottomRowIndex equals 0, Excel row coordinate will equal 1

Declaration
public int BottomRowIndex { get; set; }
Property Value
Type Description
System.Int32

LeftColumnIndex

Returns the 0-based index of the first column the graphic object is "attached" to.

e.g. if Col1 equals 0, Excel column coordinate will equal "A"

Declaration
public int LeftColumnIndex { get; set; }
Property Value
Type Description
System.Int32

LeftColumnLetter

Gets or sets the left column letter, e.g. "A"

This property is an alternative way to set column coordinates. Also take a look at LeftColumnIndex.

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

The left column letter.

RightColumnIndex

Returns the 0-based index of the last column the graphic object is "attached" to.

e.g. if RightColumnIndex equals 0, Excel column coordinate will equal "A"

Declaration
public int RightColumnIndex { get; set; }
Property Value
Type Description
System.Int32

RightColumnLetter

Gets or sets the left column letter, e.g. "A"

This property is an alternative way to set column coordinates. Also take a look at RightColumnIndex.

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

The right column letter.

TopRowIndex

Returns the 0-based index of the first row the graphic object is "attached" to.

e.g. if TopRowIndex equals 0, Excel row coordinate will equal 1

Declaration
public int TopRowIndex { get; set; }
Property Value
Type Description
System.Int32