FieldAutoNum

FieldAutoNum class

Implementa el campo AUTONUM.

Para obtener más información, visite elTrabajar con campos Artículo de documentación.

public class FieldAutoNum : Field

Constructores

NombreDescripción
FieldAutoNum()Constructor predeterminado

Propiedades

NombreDescripción
DisplayResult { get; }Obtiene el texto que representa el resultado del campo mostrado.
End { get; }Obtiene el nodo que representa el final del campo.
Format { get; }Obtiene unFieldFormatobjeto que proporciona acceso tipificado al formato del campo.
IsDirty { get; set; }Obtiene o establece si el resultado actual del campo ya no es correcto (obsoleto) debido a otras modificaciones realizadas al documento.
IsLocked { get; set; }Obtiene o establece si el campo está bloqueado (no debe recalcular su resultado).
LocaleId { get; set; }Obtiene o establece el LCID del campo.
Result { get; set; }Obtiene o establece el texto que está entre el separador de campo y el final del campo.
Separator { get; }Obtiene el nodo que representa el separador de campo. Puede sernulo .
SeparatorCharacter { get; set; }Obtiene o establece el carácter separador que se utilizará.
Start { get; }Obtiene el nodo que representa el inicio del campo.
virtual Type { get; }Obtiene el tipo de campo de Microsoft Word.

Métodos

NombreDescripción
GetFieldCode()Devuelve el texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador). Se incluyen tanto el código de campo como el resultado de campo de los campos secundarios.
GetFieldCode(bool)Devuelve el texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador).
Remove()Elimina el campo del documento. Devuelve un nodo justo después del campo. Si el final del campo es el último hijo de su nodo padre, devuelve su párrafo padre. Si el campo ya se ha eliminado, devuelvenulo .
Unlink()Realiza la desvinculación del campo.
Update()Realiza la actualización del campo. Se lanza una excepción si el campo ya se está actualizando.
Update(bool)Realiza una actualización de campo. Se lanza una excepción si el campo ya se está actualizando.

Observaciones

Inserta un número automático.

Ejemplos

Muestra cómo numerar párrafos utilizando campos de numeración automática.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Cada campo AUTONUM muestra el valor actual de un recuento continuo de campos AUTONUM,
// permitiéndonos numerar automáticamente elementos como una lista numerada.
//Este campo mostrará un número "1".
FieldAutoNum field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 1.");

Assert.AreEqual(" AUTONUM ", field.GetFieldCode());

field = (FieldAutoNum)builder.InsertField(FieldType.FieldAutoNum, true);
builder.Writeln("\tParagraph 2.");

// El carácter separador, que aparece en el campo resultado inmediatamente después del número, es un punto por defecto.
// Si dejamos esta propiedad nula, nuestro segundo campo AUTONUM mostrará "2." en el documento.
Assert.IsNull(field.SeparatorCharacter);

//Podemos configurar esta propiedad para aplicar el primer carácter de su cadena como el nuevo carácter separador.
// En este caso, nuestro campo AUTONUM ahora mostrará "2:".
field.SeparatorCharacter = ":";

Assert.AreEqual(" AUTONUM  \\s :", field.GetFieldCode());

doc.Save(ArtifactsDir + "Field.AUTONUM.docx");

Ver también

FieldAuthor Class FieldAutoNumLgl Class