GetEffectiveValue

ListLevel.GetEffectiveValue method

Indique la représentation sous forme de chaîne duListLevelobjet pour l’index spécifié de l’élément de liste. Les paramètres spécifient leNumberStyle et un format facultatif string utilisé lorsqueCustom est spécifié.

public static string GetEffectiveValue(int index, NumberStyle numberStyle, 
    string customNumberStyleFormat)
ParamètreTaperLa description
indexInt32L’index de l’élément de liste (doit être compris entre 1 et 32767).
numberStyleNumberStyleLeNumberStyle de laListLevel objet.
customNumberStyleFormatStringLa chaîne de format facultative utilisée lorsqueCustom est spécifié (par exemple “a, ç, ĝ, …”). Dans les autres cas, ce paramètre doit êtrenul ou vide.

Return_Value

La représentation sous forme de chaîne duListLevel objet, décrit par lenumberStyle paramètre and lecustomNumberStyleFormat paramètre, dans l’élément de liste à la position déterminée par leindex paramètre.

Exceptions

exceptioncondition
ArgumentExceptioncustomNumberStyleFormat estnul ou vide lorsque lenumberStyle est personnalisé.-or- customNumberStyleFormat n’est pasnul ou vide lorsque lenumberStyle n’est pas personnalisé.-or- customNumberStyleFormat n’est pas valide.
ArgumentOutOfRangeExceptionl’indice est hors de portée.

Exemples

Montre comment obtenir le format d’une liste avec le style de numéro personnalisé.

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

// Nous pouvons obtenir la valeur de l'index spécifié de l'élément de liste.
Assert.AreEqual("iv", ListLevel.GetEffectiveValue(4, NumberStyle.LowercaseRoman, null));
Assert.AreEqual("005", ListLevel.GetEffectiveValue(5, NumberStyle.Custom, customNumberStyleFormat));

Voir également