ListItems.addSeparator Method

Parent Object: ListItems
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/ListItems.h>

Description

Adds a separator to the list. This is not supported for button rows.

Syntax

"listItems_var" is a variable referencing a ListItems object.
returnValue = listItems_var.addSeparator(beforeIndex)
"listItems_var" is a variable referencing a ListItems object.

#include <Core/UserInterface/ListItems.h>

returnValue = listItems_var->addSeparator(beforeIndex);

Return Value

Type Description
ListItem Returns the new ListControlItem or null in the case of a failure.

Parameters

Name Type Description
beforeIndex integer The position of the item within the list. This value indicates the index of the current item to insert this new item just before. For example, a value of 0 will insert it before the first item in the list. An index of -1 will position the button at the bottom of the list.

Version

Introduced in version June 2015