Aspose::Words::Lists::ListCollection::GetListByListId method

ListCollection::GetListByListId method

Gets a list by a list identifier.

System::SharedPtr<Aspose::Words::Lists::List> Aspose::Words::Lists::ListCollection::GetListByListId(int32_t listId)
ParameterTypeDescription
listIdint32_tThe list identifier.

ReturnValue

Returns the list object. Returns null if a list with the specified identifier was not found.

Remarks

You don’t normally need to use this method. Most of the time you apply list formatting to paragraphs just by settings the List property of the ListFormat object.

Examples

Shows how to verify owner document properties of lists.

auto doc = MakeObject<Document>();

SharedPtr<ListCollection> lists = doc->get_Lists();

ASPOSE_ASSERT_EQ(doc, lists->get_Document());

SharedPtr<List> list = lists->Add(ListTemplate::BulletDefault);

ASPOSE_ASSERT_EQ(doc, list->get_Document());

std::cout << (String(u"Current list count: ") + lists->get_Count()) << std::endl;
std::cout << (String(u"Is the first document list: ") + (System::ObjectExt::Equals(lists->idx_get(0), list))) << std::endl;
std::cout << (String(u"ListId: ") + list->get_ListId()) << std::endl;
std::cout << (String(u"List is the same by ListId: ") + (System::ObjectExt::Equals(lists->GetListByListId(1), list))) << std::endl;

See Also

Aspose::Words::Lists::ListCollection::GetEnumerator method Aspose::Words::Lists::ListCollection::GetType method