Aspose::Words::Lists::ListLevel::GetEffectiveValue method

ListLevel::GetEffectiveValue method

Reports the string representation of the ListLevel object for the specified index of the list item. Parameters specify the NumberStyle and an optional format string used when Custom is specified.

static System::String Aspose::Words::Lists::ListLevel::GetEffectiveValue(int32_t index, Aspose::Words::NumberStyle numberStyle, const System::String &customNumberStyleFormat)
ParameterTypeDescription
indexint32_tThe index of the list item (must be in the range from 1 to 32767).
numberStyleAspose::Words::NumberStyleThe NumberStyle of the ListLevel object.
customNumberStyleFormatconst System::String&The optional format string used when Custom is specified (e.g. “a, ç, ĝ, …”). In other cases, this parameter must be null or empty.

ReturnValue

The string representation of the ListLevel object, described by the numberStyle parameter and the customNumberStyleFormat parameter, in the list item at the position determined by the index parameter.

Examples

Shows how to get the format for a list with the custom number style.

auto doc = MakeObject<Document>(MyDir + u"List with leading zero.docx");

SharedPtr<ListLevel> listLevel = doc->get_FirstSection()->get_Body()->get_Paragraphs()->idx_get(0)->get_ListFormat()->get_ListLevel();

String customNumberStyleFormat = String::Empty;

if (listLevel->get_NumberStyle() == NumberStyle::Custom)
{
    customNumberStyleFormat = listLevel->get_CustomNumberStyleFormat();
}

ASSERT_EQ(u"001, 002, 003, ...", customNumberStyleFormat);

// We can get value for the specified index of the list item.
ASSERT_EQ(u"iv", ListLevel::GetEffectiveValue(4, NumberStyle::LowercaseRoman, nullptr));
ASSERT_EQ(u"005", ListLevel::GetEffectiveValue(5, NumberStyle::Custom, customNumberStyleFormat));

See Also

Aspose::Words::Lists::ListLevel::Type method