C# Class OfficeOpenXml.ExcelCellBase

Base class containing cell address manipulating methods.

Show file Open project: pruiz/EPPlus Class Usage Examples

Public Methods

Method	Description
GetAddress ( int Row, bool AbsoluteRow, int Column, bool AbsoluteCol ) : string	Returns the AlphaNumeric representation that Excel expects for a Cell Address
GetAddress ( int Row, int Column ) : string	Returns the AlphaNumeric representation that Excel expects for a Cell Address
GetAddress ( int Row, int Column, bool Absolute ) : string	Returns the AlphaNumeric representation that Excel expects for a Cell Address
GetAddress ( int FromRow, int FromColumn, int ToRow, int ToColumn ) : string	Returns the AlphaNumeric representation that Excel expects for a Cell Address
GetAddress ( int FromRow, int FromColumn, int ToRow, int ToColumn, bool Absolute ) : string	Returns the AlphaNumeric representation that Excel expects for a Cell Address
GetFullAddress ( string worksheetName, string address ) : string	Get the full address including the worksheet name
IsValidCellAddress ( string cellAddress ) : bool	Checks that a cell address (e.g. A5) is valid.
TranslateFromR1C1 ( string value, int row, int col ) : string	Translates a R1C1 to an absolut address/Formula
TranslateToR1C1 ( string value, int row, int col ) : string	Translates a absolut address to R1C1 Format

Protected Methods

Method	Description
GetColumnLetter ( int iColumnNumber ) : string	Returns the character representation of the numbered column

Private Methods

Method	Description
AddToRowColumnTranslator ( string Address, int row, int col, int rowIncr, int colIncr ) : string	Adds or subtracts a row or column to an address
GetCellID ( int SheetID, int row, int col ) : ulong	Get the cellID for the cell.
GetRC ( string value, int OffsetValue, bool &fixedAddr ) : int	Get the offset value for RC format
GetRCFmt ( int v ) : string	Returns with brackets if the value is negative
GetRowCol ( string address, int &row, int &col, bool throwException ) : bool	Get the row/column for a Cell-address
GetRowColFromAddress ( string CellAddress, int &Row, int &Column ) : bool	Get the row/column for n Cell-address
GetRowColFromAddress ( string CellAddress, int &FromRow, int &FromColumn, int &ToRow, int &ToColumn ) : void	Get the row/columns for a Cell-address
SplitCellID ( ulong cellID, int &sheet, int &row, int &col ) : void	Get the sheet, row and column from the CellID
ToAbs ( string part, int row, int col, int rowIncr, int colIncr ) : string	Translates to absolute address
ToR1C1 ( string part, int row, int col, int rowIncr, int colIncr ) : string	Translate to R1C1
Translate ( string value, dlgTransl addressTranslator, int row, int col, int rowIncr, int colIncr ) : string	Translates betweein R1C1 or absolut addresses
UpdateFormulaReferences ( string Formula, int rowIncrement, int colIncrement, int afterRow, int afterColumn ) : string	Updates the Excel formula so that all the cellAddresses are incremented by the row and column increments if they fall after the afterRow and afterColumn. Supports inserting rows and columns into existing templates.

Method Details

GetAddress() public static method

Returns the AlphaNumeric representation that Excel expects for a Cell Address

public static GetAddress ( int Row, bool AbsoluteRow, int Column, bool AbsoluteCol ) : string
Row	int	The number of the row
AbsoluteRow	bool	Absolute row
Column	int	The number of the column in the worksheet
AbsoluteCol	bool	Absolute column
return	string

GetAddress() public static method

Returns the AlphaNumeric representation that Excel expects for a Cell Address

public static GetAddress ( int Row, int Column ) : string
Row	int	The number of the row
Column	int	The number of the column in the worksheet
return	string

GetAddress() public static method

Returns the AlphaNumeric representation that Excel expects for a Cell Address

public static GetAddress ( int Row, int Column, bool Absolute ) : string
Row	int	The number of the row
Column	int	The number of the column in the worksheet
Absolute	bool	Get an absolute address ($A$1)
return	string

GetAddress() public static method

Returns the AlphaNumeric representation that Excel expects for a Cell Address

public static GetAddress ( int FromRow, int FromColumn, int ToRow, int ToColumn ) : string
FromRow	int	From row number
FromColumn	int	From column number
ToRow	int	To row number
ToColumn	int	From column number
return	string

GetAddress() public static method

Returns the AlphaNumeric representation that Excel expects for a Cell Address

public static GetAddress ( int FromRow, int FromColumn, int ToRow, int ToColumn, bool Absolute ) : string
FromRow	int	From row number
FromColumn	int	From column number
ToRow	int	To row number
ToColumn	int	From column number
Absolute	bool	if true address is absolute (like $A$1)
return	string

GetColumnLetter() protected static method

Returns the character representation of the numbered column

protected static GetColumnLetter ( int iColumnNumber ) : string
iColumnNumber	int	The number of the column
return	string

GetFullAddress() public static method

Get the full address including the worksheet name

public static GetFullAddress ( string worksheetName, string address ) : string
worksheetName	string	The name of the worksheet
address	string	The address
return	string

IsValidCellAddress() public static method

Checks that a cell address (e.g. A5) is valid.

public static IsValidCellAddress ( string cellAddress ) : bool
cellAddress	string	The alphanumeric cell address
return	bool

TranslateFromR1C1() public static method

Translates a R1C1 to an absolut address/Formula

public static TranslateFromR1C1 ( string value, int row, int col ) : string
value	string	Address
row	int	Current row
col	int	Current column
return	string

TranslateToR1C1() public static method

Translates a absolut address to R1C1 Format

public static TranslateToR1C1 ( string value, int row, int col ) : string
value	string	R1C1 Address
row	int	Current row
col	int	Current column
return	string