com.spire.xls.core
Interface IRichTextString

All Superinterfaces:

IOptimizedUpdate

All Known Implementing Classes:

RichText, RichTextObject, RichTextShape, RTFStringArray

public interface IRichTextString
extends IOptimizedUpdate

Represents a Rich Text String that can be used to apply several styles inside a single cell.

Method Summary

void	append(java.lang.String text, IFont font) Appends rich text string with specified text and font.
void	clear() Clears text and formatting.
void	clearFormatting() Clears string formatting.
IFont	getFont(int index) Returns font which is applied to character at the specified position.
java.lang.String	getRtfText() Returns text in rtf format.
java.lang.String	getText() Gets / sets text of the string.
boolean	isFormatted() Indicates whether rich text string has formatting runs.
void	setFont(int iStartPos, int iEndPos, IFont font) Sets font for range of characters.
void	setText(java.lang.String value) Gets / sets text of the string.

Methods inherited from interface com.spire.xls.core.interfacess.IOptimizedUpdate

beginUpdate, endUpdate

Method Detail

getFont

IFont getFont(int index)

Returns font which is applied to character at the specified position.

Parameters:

index - Character index.

Returns:

Font which is applied to character at the specified position.

setFont

void setFont(int iStartPos,
             int iEndPos,
             IFont font)

Sets font for range of characters.

Parameters:

iStartPos - First character of the range.

iEndPos - Last character of the range.

font - Font to set.

clearFormatting

void clearFormatting()

Clears string formatting.

clear

void clear()

Clears text and formatting.

append

void append(java.lang.String text,
            IFont font)

Appends rich text string with specified text and font.

Parameters:

text - Text to append.

font - Font to use.

getText

java.lang.String getText()

Gets / sets text of the string.

setText

void setText(java.lang.String value)

Gets / sets text of the string.

getRtfText

java.lang.String getRtfText()

Returns text in rtf format. Read-only.

isFormatted

boolean isFormatted()

Indicates whether rich text string has formatting runs. Read-only.