FieldAutoNum

FieldAutoNum class

Implémente le champ AUTONUM.

public class FieldAutoNum : Field

Constructeurs

Nom La description
FieldAutoNum() Default_Constructor

Propriétés

Nom La description
DisplayResult { get; } Obtient le texte qui représente le résultat du champ affiché.
End { get; } Obtient le nœud qui représente la fin du champ.
Format { get; } Obtient unFieldFormat objet qui fournit un accès typé au formatage du champ.
IsDirty { get; set; } Obtient ou définit si le résultat actuel du champ n’est plus correct (périmé) en raison d’autres modifications apportées au document.
IsLocked { get; set; } Obtient ou définit si le champ est verrouillé (ne doit pas recalculer son résultat).
LocaleId { get; set; } Obtient ou définit le LCID du champ.
Result { get; set; } Obtient ou définit le texte qui se trouve entre le séparateur de champ et la fin du champ.
Separator { get; } Obtient le nœud qui représente le séparateur de champs. Peut être null.
SeparatorCharacter { get; set; } Obtient ou définit le caractère séparateur à utiliser.
Start { get; } Obtient le nœud qui représente le début du champ.
virtual Type { get; } Obtient le type de champ Microsoft Word.

Méthodes

Nom La description
GetFieldCode() Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur). Le code de champ et le résultat du champ des champs enfants sont inclus.
GetFieldCode(bool) Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur).
Remove() Supprime le champ du document. Renvoie un nœud juste après le champ. Si la fin du champ est le dernier enfant de son nœud parent, renvoie son paragraphe parent. Si le champ est déjà supprimé, renvoie nul .
Unlink() Effectue la dissociation du champ.
Update() Effectue la mise à jour du champ. Lance si le champ est déjà mis à jour.
Update(bool) Effectue une mise à jour du champ. Lance si le champ est déjà mis à jour.

Remarques

Insère un numéro automatique.

Exemples

Montre comment numéroter des paragraphes à l’aide de champs de numérotation automatique.

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

// Chaque champ AUTONUM affiche la valeur actuelle d'un nombre cumulé de champs AUTONUM,
// nous permettant de numéroter automatiquement les éléments comme une liste numérotée.
// Ce champ affichera un nombre "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.");

// Le caractère séparateur, qui apparaît dans le champ result immédiatement après le nombre, est un point par défaut.
// Si nous laissons cette propriété nulle, notre deuxième champ AUTONUM affichera "2". dans le document.
Assert.IsNull(field.SeparatorCharacter);

// Nous pouvons définir cette propriété pour appliquer le premier caractère de sa chaîne comme nouveau caractère de séparation.
// Dans ce cas, notre champ AUTONUM affichera désormais "2 :".
field.SeparatorCharacter = ":";

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

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

Voir également