TExcelFile.GetStringFromCell Method
Overloads
- TExcelFile.GetStringFromCell(string)
- TExcelFile.GetStringFromCell(Integer, Integer)
- TExcelFile.GetStringFromCell(Integer, Integer, Boolean)
- TExcelFile.GetStringFromCell(Integer, Integer, Integer, TUIColor)
- TExcelFile.GetStringFromCell(Integer, Integer, Integer, Integer, TUIColor)
- TExcelFile.GetStringFromCell(Integer, Integer, Integer, Integer, TUIColor, Boolean)
TExcelFile.GetStringFromCell(string)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers)
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const cellRef: string): TRichString; overload;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | cellRef | string | Cell reference in A1 notation. Something like A3, or Sheet1!$B$5 can be used here. |
Returns
A rich string with the cell value.
See also
TExcelFile.GetStringFromCell(Integer, Integer)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers) Conditional formats are not applied, you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style for that.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const row: Integer; const col: Integer): TRichString; overload;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | row | Integer | Cell Row (1 based). |
const | col | Integer | Cell Column (1 based) |
Returns
A rich string with the cell value.
See also
TExcelFile.GetStringFromCell(Integer, Integer, Boolean)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers) Conditional formats are not applied, you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style for that.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const row: Integer; const col: Integer; const ignorePrintErrors: Boolean): TRichString; overload;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | row | Integer | Cell Row (1 based). |
const | col | Integer | Cell Column (1 based) |
const | ignorePrintErrors | Boolean | If true, the string for an error like #DIV/0 will always by #DIV/0 instead of using the value of PrintErrors. Set it to true when the value is not for printing it. |
Returns
A rich string with the cell value.
See also
TExcelFile.GetStringFromCell(Integer, Integer, Integer, TUIColor)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers) Conditional formats are not applied, you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style for that.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const row: Integer; const col: Integer; var XF: Integer; var aColor: TUIColor): TRichString; overload;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | row | Integer | Cell Row (1 based). |
const | col | Integer | Cell Column (1 based) |
var | XF | Integer | The resulting XF for the cell. |
var | aColor | TUIColor | Resulting color of the string. If for example you define red for negative numbers, and the result is red, this will be returned on aColor. If there is not color info on the format, it will remain unchanged. |
Returns
A rich string with the cell value.
See also
TExcelFile.GetStringFromCell(Integer, Integer, Integer, Integer, TUIColor)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers) Conditional formats are not applied, you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style for that.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const sheet: Integer; const row: Integer; const col: Integer; var XF: Integer; var aColor: TUIColor): TRichString; overload;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | sheet | Integer | Sheet where the cell is (1 based). |
const | row | Integer | Cell Row (1 based). |
const | col | Integer | Cell Column (1 based) |
var | XF | Integer | The resulting XF for the cell. |
var | aColor | TUIColor | Resulting color of the string. If for example you define red for negative numbers, and the result is red, this will be returned on aColor. If there is not color info on the format, it will remain unchanged. |
Returns
A rich string with the cell value.
See also
TExcelFile.GetStringFromCell(Integer, Integer, Integer, Integer, TUIColor, Boolean)
This method will return a rich string that is formatted similar to the way Excel shows it. For example, if you have "1.0" on a cell, and the cell is formatted as exponential, this method will return "1.0e+1" It might also change the color depending on the value and format. (for example, red for negative numbers) Conditional formats are not applied, you need to call ConditionallyModifyFormat(TFlxFormat, Integer, Integer, Boolean, IDrawingConditionalFormat) to the cell style for that.
Syntax
Unit: FlexCel.Core
function TExcelFile.GetStringFromCell(const sheet: Integer; const row: Integer; const col: Integer; var XF: Integer; var aColor: TUIColor; const ignorePrintErrors: Boolean): TRichString; overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | sheet | Integer | Sheet where the cell is (1 based). |
const | row | Integer | Cell Row (1 based). |
const | col | Integer | Cell Column (1 based) |
var | XF | Integer | The resulting XF for the cell. |
var | aColor | TUIColor | Resulting color of the string. If for example you define red for negative numbers, and the result is red, this will be returned on aColor. If there is not color info on the format, it will remain unchanged. |
const | ignorePrintErrors | Boolean | If true, the string for an error like #DIV/0 will always by #DIV/0 instead of using the value of PrintErrors. Set it to true when the value is not for printing it. |
Returns
A rich string with the cell value.