GetEffectiveValue

ListLevel.GetEffectiveValue method

Сообщает строковое представлениеListLevelобъект для указанного index элемента списка. Параметры определяютNumberStyle и необязательный формат string , используемый, когдаCustom указано.

public static string GetEffectiveValue(int index, NumberStyle numberStyle, 
    string customNumberStyleFormat)
ПараметрТипОписание
indexInt32Индекс элемента списка (должен быть в диапазоне от 1 до 32767).
numberStyleNumberStyleNumberStyle принадлежащийListLevel объект.
customNumberStyleFormatStringНеобязательная строка формата, используемая, когдаCustom указан (например, “a, ç, ĝ, …”). В остальных случаях этот параметр должен бытьнулевой или пусто.

Возвращаемое значение

Строковое представлениеListLevel объект, описанныйnumberStyle параметр and customNumberStyleFormat параметр, в элементе списка в позиции, определяемойindex параметр.

Исключения

исключениеусловие
ArgumentExceptioncustomNumberStyleFormat являетсянулевой или пусто, когдаnumberStyle является пользовательским.-или- customNumberStyleFormat не являетсянулевой или пусто, когдаnumberStyle не является пользовательским.-или- customNumberStyleFormat неверно.
ArgumentOutOfRangeExceptionиндекс выходит за пределы допустимого диапазона.

Примеры

Показывает, как получить формат списка с пользовательским числовым стилем.

Document doc = new Document(MyDir + "List with leading zero.docx");

ListLevel listLevel = doc.FirstSection.Body.Paragraphs[0].ListFormat.ListLevel;

string customNumberStyleFormat = string.Empty;

if (listLevel.NumberStyle == NumberStyle.Custom)
    customNumberStyleFormat = listLevel.CustomNumberStyleFormat;

Assert.AreEqual("001, 002, 003, ...", customNumberStyleFormat);

// Мы можем получить значение по указанному индексу элемента списка.
Assert.AreEqual("iv", ListLevel.GetEffectiveValue(4, NumberStyle.LowercaseRoman, null));
Assert.AreEqual("005", ListLevel.GetEffectiveValue(5, NumberStyle.Custom, customNumberStyleFormat));

Смотрите также

ListLevel.GetHashCode