Class

PDFTextArea


Description

A standard editable text area which can contain multiple lines of text.

Methods

Name

Parameters

Returns

Shared

Constructor

pageNumber As Integer, x As Integer, y As Integer, width As Integer, height As Integer, name As String, Optional Text As String = ""

Property descriptions


PDFTextArea.AllowSpellChecking

AllowSpellChecking As Boolean

If True, words that are believed to be misspelled are underlined.


PDFTextArea.FontSize

FontSize As Integer

The size of the text of the control.


PDFTextArea.Height

Height As Integer

The height of the control.


PDFTextArea.MaximumCharactersAllowed

MaximumCharactersAllowed As Integer

The maximum number of characters allowed.


PDFTextArea.Name

Name As String

The name of the control.


PDFTextArea.Page

Page As Integer

The number of the page upon which the control was created.

This property is read-only.


PDFTextArea.ReadOnly

ReadOnly As Boolean

If True, the text of the control cannot be modified.


PDFTextArea.Text

Text As String

The text displayed.

Assigning a string to the Text property replaces the entire contents of the control.


PDFTextArea.Width

Width As Integer

The width of the control.


PDFTextArea.X

X As Integer

The location on the X axis of the upper-left corner of the control.


PDFTextArea.Y

Y As Integer

The location on the Y axis of the upper-left corner of the control.

Method descriptions


PDFTextArea.Constructor

Constructor(pageNumber As Integer, x As Integer, y As Integer, width as Integer, height As Integer, name As String, Optional Text As String = "")

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Returns a new PDFTextArea based upon the values passed.

Notes

No border is provided. If you want one, draw a rectangle around the control.

Compatibility

Desktop, console, web and iOS project types on all supported operating systems.

See also

PDFTextControl parent class; PDFTextControl and PDFTextField classes.