GetEffectiveValue

ListLevel.GetEffectiveValue method

Meldet die Zeichenfolgendarstellung vonListLevelObjekt für den angegebenen index des Listenelements. Parameter geben die anNumberStyle und ein optionales Format string , das verwendet wird, wennCustom angegeben ist.

public static string GetEffectiveValue(int index, NumberStyle numberStyle, 
    string customNumberStyleFormat)
ParameterTypBeschreibung
indexInt32Der Index des Listenelements (muss im Bereich von 1 bis 32767 liegen).
numberStyleNumberStyleDieNumberStyle desListLevel Objekt.
customNumberStyleFormatStringDie optionale Formatzeichenfolge, die verwendet wird, wennCustom angegeben ist (z. B. „a, ç, ĝ, …“). In anderen Fällen muss dieser Parameter angegeben werdenNull oder leer.

Rückgabewert

Die String-Darstellung vonListLevel Objekt, beschrieben durch dienumberStyle Parameter and thecustomNumberStyleFormat Parameter, im Listenelement an der durch den definierten Positionindex Parameter.

Ausnahmen

AusnahmeBedingung
ArgumentExceptioncustomNumberStyleFormat IstNull oder leer, wenn dienumberStyle ist benutzerdefiniert.-oder- customNumberStyleFormat ist nichtNull oder leer, wenn dienumberStyle ist nicht benutzerdefiniert.-oder- customNumberStyleFormat ist ungültig.
ArgumentOutOfRangeExceptionDer Index liegt außerhalb des zulässigen Bereichs.

Beispiele

Zeigt, wie man das Format für eine Liste mit dem benutzerdefinierten Zahlenstil erhält.

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);

// Wir können einen Wert für den angegebenen Index des Listenelements abrufen.
Assert.AreEqual("iv", ListLevel.GetEffectiveValue(4, NumberStyle.LowercaseRoman, null));
Assert.AreEqual("005", ListLevel.GetEffectiveValue(5, NumberStyle.Custom, customNumberStyleFormat));

Siehe auch

ListLevel.GetHashCode