TextFieldList.set Method

Module: TextFieldList

Definition

Sets an item of the TextFieldList object.

Python

set(self, index: int, text_field_item: TextField) -> None

Parameters

index int

in Index of the TextField item to set.

text_field_item TextField

in TextField item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

void set(int index, TextField textFieldItem)

Parameters

index int

in Index of the TextField item to set.

textFieldItem TextField

in TextField item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public void Set(int index, TextField textFieldItem)

Parameters

index int

in Index of the TextField item to set.

textFieldItem TextField

in TextField item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public void set(int index, TextField textFieldItem) throws DocumentException

Parameters

index int

in Index of the TextField item to set.

textFieldItem TextField

in TextField item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public func set(index: Int32, textFieldItem: TextField) throws

Parameters

index Int32

in Index of the TextField item to set.

textFieldItem TextField

in TextField item to set.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentTextFieldList_Set (
    ID3_DOCUMENT_TEXT_FIELD_LIST hTextFieldList,
    int index,
    ID3_DOCUMENT_TEXT_FIELD hTextFieldItem)

Parameters

hTextFieldList ID3_DOCUMENT_TEXT_FIELD_LIST

in Handle to the TextFieldList object.

index int

in Index of the TextField item to set.

hTextFieldItem ID3_DOCUMENT_TEXT_FIELD

in TextField item to set.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.