TDrawingRichString.ToRichString Method
Overloads
- TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont)
- TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont)
- TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont, TFunc<string, TRichString>)
- TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont, TFunc<string, TRichString>, Boolean)
TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont)
Converts this TDrawingRichString into a TRichString. Note that the conversion is not perfect as a TDrawingRichString has different information from a TRichString.
Syntax
Unit: FlexCel.Core
function TDrawingRichString.ToRichString(const xls: TCoreExcelFile; ShapeThemeFont: IShapeFont): TRichString; overload;
Parameters
<-> |
Parameter |
Type |
Description |
const |
xls |
TCoreExcelFile |
Excel file with the fonts. |
|
ShapeThemeFont |
IShapeFont |
Theme font used by default when no formatting is specified. Set it to null to use the default. |
See also
TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont)
Converts this TDrawingRichString into a TRichString. Note that the conversion is not perfect as a TDrawingRichString has different information from a TRichString.
Syntax
Unit: FlexCel.Core
function TDrawingRichString.ToRichString(const xls: TCoreExcelFile; ShapeThemeFont: IShapeFont; const DefaultFont: TFlxFont): TRichString; overload;
Parameters
<-> |
Parameter |
Type |
Description |
const |
xls |
TCoreExcelFile |
Excel file with the fonts. |
|
ShapeThemeFont |
IShapeFont |
Theme font used by default when no formatting is specified. Set it to null to use the default. |
const |
DefaultFont |
TFlxFont |
Font to be used by default. If left null, the default font for the workbook will be used. |
See also
TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont, TFunc<string, TRichString>)
Converts this TDrawingRichString into a TRichString. Note that the conversion is not perfect as a TDrawingRichString has different information from a TRichString.
Syntax
Unit: FlexCel.Core
function TDrawingRichString.ToRichString(const xls: TCoreExcelFile; ShapeThemeFont: IShapeFont; const DefaultFont: TFlxFont; const FieldReplacer: TFunc<string, TRichString>): TRichString; overload;
Parameters
<-> |
Parameter |
Type |
Description |
const |
xls |
TCoreExcelFile |
Excel file with the fonts. |
|
ShapeThemeFont |
IShapeFont |
Theme font used by default when no formatting is specified. Set it to null to use the default. |
const |
DefaultFont |
TFlxFont |
Font to be used by default. If left null, the default font for the workbook will be used. |
const |
FieldReplacer |
TFunc<string, TRichString> |
Use this lambda function to replace text in fields. It will take the field name as a parameter, and you need to return the field value in the result. Set it to null if you don't want to replace fields. |
See also
TDrawingRichString.ToRichString(TCoreExcelFile, IShapeFont, TFlxFont, TFunc<string, TRichString>, Boolean)
Converts this TDrawingRichString into a TRichString. Note that the conversion is not perfect as a TDrawingRichString has different information from a TRichString.
Syntax
Unit: FlexCel.Core
function TDrawingRichString.ToRichString(const xls: TCoreExcelFile; ShapeThemeFont: IShapeFont; const DefaultFont: TFlxFont; const FieldReplacer: TFunc<string, TRichString>; const UppercaseIfAllCaps: Boolean): TRichString; overload;
Parameters
<-> |
Parameter |
Type |
Description |
const |
xls |
TCoreExcelFile |
Excel file with the fonts. |
|
ShapeThemeFont |
IShapeFont |
Theme font used by default when no formatting is specified. Set it to null to use the default. |
const |
DefaultFont |
TFlxFont |
Font to be used by default. If left null, the default font for the workbook will be used. |
const |
FieldReplacer |
TFunc<string, TRichString> |
Use this lambda function to replace text in fields. It will take the field name as a parameter, and you need to return the field value in the result. Set it to null if you don't want to replace fields. |
const |
UppercaseIfAllCaps |
Boolean |
If true and the style of the TDrawingRichString is all-caps, this will return the string converted to uppercase. Because a RichString doesn't have information about all-caps. |
See also