insert_combo_box method

insert_combo_box(name, items, selected_index)

Inserts a combobox form field at the current position.

def insert_combo_box(self, name: str, items: List[str], selected_index: int):
    ...

Parameter	Type	Description
name	str	The name of the form field. Can be an empty string. The value longer than 20 characters will be truncated.
items	List[str]	The items of the ComboBox. Maximum is 25 items.
selected_index	int	The index of the selected item in the ComboBox.

Remarks

If you specify a name for the form field, then a bookmark is automatically created with the same name.

Returns

The form field node that was just inserted.

Examples

Shows how to create form fields.

builder = aw.DocumentBuilder()
# Form fields are objects in the document that the user can interact with by being prompted to enter values.
# We can create them using a document builder, and below are two ways of doing so.
# 1 -  Basic text input:
builder.insert_text_input('My text input', aw.fields.TextFormFieldType.REGULAR, '', 'Enter your name here', 30)
# 2 -  Combo box with prompt text, and a range of possible values:
items = ['-- Select your favorite footwear --', 'Sneakers', 'Oxfords', 'Flip-flops', 'Other']
builder.insert_paragraph()
builder.insert_combo_box('My combo box', items, 0)
builder.document.save(file_name=ARTIFACTS_DIR + 'DocumentBuilder.CreateForm.docx')

Shows how to insert a combo box form field into a document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Insert a form that prompts the user to pick one of the items from the menu.
builder.write('Pick a fruit: ')
items = ['Apple', 'Banana', 'Cherry']
builder.insert_combo_box('DropDown', items, 0)
doc.save(file_name=ARTIFACTS_DIR + 'DocumentBuilder.InsertComboBox.docx')

See Also

• module aspose.words
• class DocumentBuilder