com.grapecity.documents.excel.drawing

Interface ITextRange

public interface ITextRange

Represents the text frame in the IShape.

Method Summary

Modifier and Type	Method and Description
ITextRange	add() Adds text to the specified collection.
ITextRange	add(java.lang.String newText) Adds text to the specified collection.
ITextRange	add(java.lang.String newText, int position) Adds text to the specified collection.
void	delete() Deletes from parent.
ITextRange	get(int index) Gets the ITextRange with the specified index.
int	getCount() Returns the number of objects in the collection.
IFontFormat	getFont() Returns the IFontFormat object that represents character formatting for the IFontFormat object.
int	getIndex() Returns the index in the collection.
ITextRange	getParagraphs() Get the paragraphs of ITextRange
ITextRange	getRuns() Get the runs of ITextRange
java.lang.String	getText() Gets a String value that represents the text in a text range.
TextRangeType	getType() Returns the type of ITextRange.
void	setText(java.lang.String value) Sets a String value that represents the text in a text range.

Method Detail

getText

java.lang.String getText()

Gets a String value that represents the text in a text range.

setText

void setText(java.lang.String value)

Sets a String value that represents the text in a text range.

getFont

IFontFormat getFont()

Returns the IFontFormat object that represents character formatting for the IFontFormat object.

getParagraphs

ITextRange getParagraphs()

Get the paragraphs of ITextRange

This method is only used in TextRangeType.Body; otherwise, it throws InvalidOperateExecption.

getRuns

ITextRange getRuns()

Get the runs of ITextRange

This method is only used in TextRangeType.Paragraph; otherwise, it throws InvalidOperateExecption.

get

ITextRange get(int index)

Gets the ITextRange with the specified index.

Parameters:

index - The index.ITextRange

getCount

int getCount()

Returns the number of objects in the collection.

getIndex

int getIndex()

Returns the index in the collection.

getType

TextRangeType getType()

Returns the type of ITextRange.

add

ITextRange add(java.lang.String newText)

Adds text to the specified collection.

Parameters:

newText - The new text.

Returns:

The new ITextRange. This property is only used in Body and Paragraph. Use this property on Body and it will add a paragraph with a run. Use this property on Paragraph and it will add a run.

add

ITextRange add()

Adds text to the specified collection.

add

ITextRange add(java.lang.String newText,
               int position)

Adds text to the specified collection.

Parameters:

newText - The new text.

position - The position that you want to insert.

Returns:

The new ITextRange. This property is only used in Body and Paragraph. Use this property on Body and it will add a paragraph with a run. Use this property on Paragraph and it will add a run.

delete

void delete()

Deletes from parent.