TdxSpreadSheetTextService.GetAsRTF(TdxSpreadSheetCell,string,Boolean) Method

Retrieves the specified cell object‘s formatted content as an RTF string.

Declaration

class function GetAsRTF(ACell: TdxSpreadSheetCell; var AValue: string; ARichEditCompatibility: Boolean): Boolean; overload; virtual;

Parameters

Name	Type
ACell	TdxSpreadSheetCell
AValue	string
ARichEditCompatibility	Boolean

Returns

Type
Boolean

Remarks

This class function accepts the source cell object as the ACell parameter and attempts to retrieve an RTF string as the AValue var parameter. The function returns True if an attempt is successful; otherwise – False. A cell object’s GetAsRTF function calls the registered spreadsheet text service’s GetAsRTF function via the dxSpreadSheetTextService global variable.

This GetAsRTF class function’s implementation is empty and always returns False, since the basic text service does not support formatted text. Each TdxSpreadSheetTextService class descendant that provides support for RTF strings has its own GetAsRTF implementation.