Aspose::Words::Markup::SdtListItemCollection class

SdtListItemCollection class

Provides access to SdtListItem elements of a structured document tag. To learn more, visit the Structured Document Tags or Content Control documentation article.

class SdtListItemCollection : public System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Words::Markup::SdtListItem>>

Methods

Method	Description
Add(const System::SharedPtr<Aspose::Words::Markup::SdtListItem>&)	Adds an item to this collection.
begin()
begin() const
cbegin() const
cend() const
Clear()	Clears all items from this collection.
end()
end() const
get_Count()	Gets number of items in the collection.
get_SelectedValue()	Specifies currently selected value in this list. Null value allowed, meaning that no currently selected entry is associated with this list item collection.
GetEnumerator() override	Returns an enumerator object that can be used to iterate over all items in the collection.
GetType() const override
idx_get(int32_t)	Returns a SdtListItem object given its zero-based index in the collection.
Is(const System::TypeInfo&) const override
RemoveAt(int32_t)	Removes a list item at the specified index.
set_SelectedValue(const System::SharedPtr<Aspose::Words::Markup::SdtListItem>&)	Setter for Aspose::Words::Markup::SdtListItemCollection::get_SelectedValue.
static Type()
virtualizeBeginConstIterator() const override
virtualizeBeginIterator() override
virtualizeEndConstIterator() const override
virtualizeEndIterator() override

Typedefs

Typedef	Description
const_iterator
iterator
iterator_holder_type
virtualized_iterator
virtualized_iterator_element

Examples

Shows how to work with drop down-list structured document tags.

auto doc = MakeObject<Document>();
auto tag = MakeObject<StructuredDocumentTag>(doc, SdtType::DropDownList, MarkupLevel::Block);
doc->get_FirstSection()->get_Body()->AppendChild(tag);

// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SharedPtr<SdtListItemCollection> listItems = tag->get_ListItems();
listItems->Add(MakeObject<SdtListItem>(u"Value 1"));

ASSERT_EQ(listItems->idx_get(0)->get_DisplayText(), listItems->idx_get(0)->get_Value());

// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems->Add(MakeObject<SdtListItem>(u"Item 2", u"Value 2"));
listItems->Add(MakeObject<SdtListItem>(u"Item 3", u"Value 3"));
listItems->Add(MakeObject<SdtListItem>(u"Item 4", u"Value 4"));

ASSERT_EQ(4, listItems->get_Count());

// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems->set_SelectedValue(listItems->idx_get(3));

ASSERT_EQ(u"Value 4", listItems->get_SelectedValue()->get_Value());

// Enumerate over the collection and print each element.
{
    SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<SdtListItem>>> enumerator = listItems->GetEnumerator();
    while (enumerator->MoveNext())
    {
        if (enumerator->get_Current() != nullptr)
        {
            std::cout << "List item: " << enumerator->get_Current()->get_DisplayText() << ", value: " << enumerator->get_Current()->get_Value()
                      << std::endl;
        }
    }
}

// Remove the last list item.
listItems->RemoveAt(3);

ASSERT_EQ(3, listItems->get_Count());

// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems->set_SelectedValue(listItems->idx_get(1));

doc->Save(ArtifactsDir + u"StructuredDocumentTag.ListItemCollection.docx");

// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems->Clear();

ASSERT_EQ(0, listItems->get_Count());

Aspose::Words::Markup::SdtListItemCollection class

SdtListItemCollection class

Methods

Typedefs

Examples

See Also