#include <PdfField.h>
Inherits PoDoFo::PdfField.
List of all members.
Detailed Description
A textfield in a PDF file.
Users can enter text into a text field. Single and multi line text is possible, as well as richtext. The text can be interpreted as path to a file which is going to be submitted.
Constructor & Destructor Documentation
PoDoFo::PdfTextField::PdfTextField |
( |
PdfAnnotation * |
pWidget, |
|
|
PdfAcroForm * |
pParent | |
|
) |
| | |
PoDoFo::PdfTextField::PdfTextField |
( |
PdfPage * |
pPage, |
|
|
const PdfRect & |
rRect, |
|
|
PdfAcroForm * |
pParent | |
|
) |
| | |
PoDoFo::PdfTextField::PdfTextField |
( |
const PdfField & |
rhs |
) |
|
Create a PdfTextField from a PdfField
- Parameters:
-
Raises an error if PdfField::GetType() != ePdfField_TextField
Member Function Documentation
pdf_long PoDoFo::PdfTextField::GetMaxLen |
( |
|
) |
const |
- Returns:
- the max length of this textfield in characters or -1 if no max length was specified
PdfString PoDoFo::PdfTextField::GetText |
( |
|
) |
const |
- Returns:
- the text contents of this text field
bool PoDoFo::PdfTextField::IsCombs |
( |
|
) |
const [inline] |
- Returns:
- true if the text field is divided in to equal combs
bool PoDoFo::PdfTextField::IsFileField |
( |
|
) |
const [inline] |
- Returns:
- true if the contents are treated as filename
bool PoDoFo::PdfTextField::IsMultiLine |
( |
|
) |
const [inline] |
- Returns:
- true if this text field can contain multiple lines of text
bool PoDoFo::PdfTextField::IsPasswordField |
( |
|
) |
const [inline] |
- Returns:
- true if this field is a password field that does not echo entered characters on the screen
bool PoDoFo::PdfTextField::IsRichText |
( |
|
) |
const [inline] |
- Returns:
- true if this is a richtext text field
bool PoDoFo::PdfTextField::IsScrollBarsEnabled |
( |
|
) |
const [inline] |
- Returns:
- true if scrollbars are enabled for this text field
bool PoDoFo::PdfTextField::IsSpellcheckingEnabled |
( |
|
) |
const [inline] |
- Returns:
- true if spellchecking is enabled for this text field
void PoDoFo::PdfTextField::SetCombs |
( |
bool |
bCombs |
) |
[inline] |
Divide the text field into max-len equal combs.
- Parameters:
-
| bCombs | if true enable division into combs |
By default coms are disabled. Requires the max len property to be set.
- See also:
- SetMaxLen
void PoDoFo::PdfTextField::SetFileField |
( |
bool |
bFile |
) |
[inline] |
Create a file selection field. The entered contents are treated as filename to a file whose contents are submitted as the value of the field.
- Parameters:
-
| bFile | if true the contents are treated as a pathname to a file to submit |
void PoDoFo::PdfTextField::SetMaxLen |
( |
pdf_long |
nMaxLen |
) |
|
Sets the max length in characters of this textfield
- Parameters:
-
| nMaxLen | the max length of this textfields in characters |
void PoDoFo::PdfTextField::SetMultiLine |
( |
bool |
bMultiLine |
) |
[inline] |
Create a multi-line text field that can contains multiple lines of text.
- Parameters:
-
| bMultiLine | if true a multi line field is generated, otherwise the text field can contain only a single line of text. |
The default is to create a single line text field.
void PoDoFo::PdfTextField::SetPasswordField |
( |
bool |
bPassword |
) |
[inline] |
Create a password text field that should not echo entered characters visibly to the screen.
- Parameters:
-
| bPassword | if true a password field is created |
The default is to create no password field
void PoDoFo::PdfTextField::SetRichText |
( |
bool |
bRichText |
) |
[inline] |
Creates a richtext field.
- Parameters:
-
| bRichText | if true creates a richtext field |
By default richtext is disabled.
void PoDoFo::PdfTextField::SetScrollBarsEnabled |
( |
bool |
bScroll |
) |
[inline] |
Enable/disable scrollbars for this text field
- Parameters:
-
| bScroll | if true scrollbars will be enabled |
Text fields have scrollbars by default
void PoDoFo::PdfTextField::SetSpellcheckingEnabled |
( |
bool |
bSpellcheck |
) |
[inline] |
Enable/disable spellchecking for this text field
- Parameters:
-
| bSpellcheck | if true spellchecking will be enabled |
Text fields are spellchecked by default
void PoDoFo::PdfTextField::SetText |
( |
const PdfString & |
rsText |
) |
|
Sets the text contents of this text field.
- Parameters:
-
| rsText | the text of this field |