TextArea Class

Allows you to access and manipulate text.

Declaration

public class TextArea extends OfficeTextArea

Remarks

A new shape’s text area initially contains an empty paragraph to keep the presentation document valid. This is the first paragraph in the collection returned by the getParagraphs() method.

To specify the text area content, add TextParagraph objects to the collection returned by the TextArea.getParagraphs() method.

To split a paragraph into runs (spans of text that share the same formatting), add TextRun objects to the collection returned by the TextParagraph.getRuns() method.

You can also use TextArea.setText(), TextParagraph.setText(), and TextRun.setText() methods to specify text content.

Tip

Use the \r\n character sequence to split the string value into paragraphs or runs.

Refer to the following help topic for additional information: Modify Shape Text and Content in Presentations.

Inherited Members

deepClone()

notifyChange(Object sender, String propertyName)

findText(String text)

findText(String text, TextSearchOptions options)

getLevel1ParagraphProperties()

getLevel2ParagraphProperties()

getLevel3ParagraphProperties()

getLevel4ParagraphProperties()

getLevel5ParagraphProperties()

getLevel6ParagraphProperties()

getLevel7ParagraphProperties()

getLevel8ParagraphProperties()

getLevel9ParagraphProperties()

getParagraphProperties()

getParagraphs()

getText()

modifyTextProperties(TextRange range, TextProperties properties)

modifyTextProperties(List<TextRange> ranges, TextProperties properties)

removeText(TextRange range)

removeText(List<TextRange> ranges)

replaceText(TextRange range, String newText)

replaceText(String oldText, String newText)

replaceText(String oldText, String newText, TextSearchOptions options)

replaceText(List<TextRange> ranges, String newText)

setLevel1ParagraphProperties(TextParagraphProperties value)

setLevel2ParagraphProperties(TextParagraphProperties value)

setLevel3ParagraphProperties(TextParagraphProperties value)

setLevel4ParagraphProperties(TextParagraphProperties value)

setLevel5ParagraphProperties(TextParagraphProperties value)

setLevel6ParagraphProperties(TextParagraphProperties value)

setLevel7ParagraphProperties(TextParagraphProperties value)

setLevel8ParagraphProperties(TextParagraphProperties value)

setLevel9ParagraphProperties(TextParagraphProperties value)

setParagraphProperties(TextParagraphProperties value)

setText(String value)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

OfficeObject

OfficeTextArea

TextArea

Constructors

TextArea() Constructor

Initializes a new instance of the TextArea class.

Declaration

public TextArea()

TextArea(String text, TextParagraphProperties paragraphProperties) Constructor

Initializes a new instance of the TextArea class with specified settings.

Declaration

public TextArea(String text, TextParagraphProperties paragraphProperties)

Parameters

Name	Type	Description
text	String	The initial content of the text area.
paragraphProperties	TextParagraphProperties	Paragraph properties applied to the text area.

TextArea(String text) Constructor

Initializes a new instance of the TextArea class with specified settings.

Declaration

public TextArea(String text)

Parameters

Name	Type	Description
text	String	The initial content of the text area.

Methods

deepClone() Method

Returns a deep copy of this TextArea instance.

Declaration

public TextArea deepClone()

Returns

Type	Description
TextArea	A deep copy of this TextArea.

getProperties() Method

Returns the text area properties.

Declaration

public TextAreaProperties getProperties()

Returns

Type	Description
TextAreaProperties	Text area properties.

setProperties(TextAreaProperties value) Method

Sets the text area properties.

Declaration

public void setProperties(TextAreaProperties value)

Parameters

Name	Type	Description
value	TextAreaProperties	Text area properties.