Back to Devexpress

TdxPDFForm.GetCheckBoxField(string) Method

vcl-dxpdfform-dot-tdxpdfform-dot-getcheckboxfield-x28-system-dot-string-x29.md

latest1.5 KB
Original Source

TdxPDFForm.GetCheckBoxField(string) Method

Returns a checkbox field by its name on the form.

Declaration

delphi
function GetCheckBoxField(const AFullName: string): TdxPDFCheckBoxField;

Parameters

NameTypeDescription
AFullNamestring

The name of a checkbox field.

|

Returns

TypeDescription
TdxPDFCheckBoxField

The checkbox field with the specified name (AFullName).

|

Exceptions

TypeDescription
EListError

The “Item not found” exception occurs if the form has no field with the specified name (AFullName).

| | EInvalidCast |

The “Invalid class typecast” exception occurs if the field with the specified name is not a checkbox.

|

Remarks

The TryGetCheckBoxField function is a safe alternative to GetCheckBoxField.

See Also

GetField(string)

TdxPDFForm Class

TdxPDFForm Members

dxPDFForm Unit