GetEffectiveValue

ListLevel.GetEffectiveValue method

Informa la representación de cadena delListLevelobjeto para el index especificado del elemento de la lista. Los parámetros especifican elNumberStyle y un formato opcional string usado cuandoCustom está especificado.

public static string GetEffectiveValue(int index, NumberStyle numberStyle, 
    string customNumberStyleFormat)
ParámetroEscribeDescripción
indexInt32El índice del elemento de la lista (debe estar en el rango de 1 a 32767).
numberStyleNumberStyleElNumberStyle delListLevel objeto.
customNumberStyleFormatStringLa cadena de formato opcional utilizada cuandoCustom se especifica (por ejemplo, “a, ç, ĝ, …”). En otros casos, este parámetro debe sernulo o vacío.

Valor_devuelto

La representación de cadena delListLevel objeto, descrito por elnumberStyle parámetro y elcustomNumberStyleFormat parámetro, en el elemento de la lista en la posición determinada por elindex parámetro.

Excepciones

excepcióncondición
ArgumentExceptioncustomNumberStyleFormat esnulo o vacío cuando elnumberStyle es personalizado.-o- customNumberStyleFormat no esnulo o vacío cuando elnumberStyle no es personalizado.-o- customNumberStyleFormat no es válido.
ArgumentOutOfRangeExceptionEl índice está fuera de rango.

Ejemplos

Muestra cómo obtener el formato de una lista con el estilo de número personalizado.

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

// Podemos obtener el valor para el índice especificado del elemento de la lista.
Assert.AreEqual("iv", ListLevel.GetEffectiveValue(4, NumberStyle.LowercaseRoman, null));
Assert.AreEqual("005", ListLevel.GetEffectiveValue(5, NumberStyle.Custom, customNumberStyleFormat));

Ver también

ListLevel.GetHashCode