FieldAutoNumOut

FieldAutoNumOut class

Implémente le champ AUTONUMOUT.

Pour en savoir plus, visitez leTravailler avec des champs article documentaire.

public class FieldAutoNumOut : Field

Constructeurs

NomLa description
FieldAutoNumOut()Default_Constructor

Propriétés

NomLa 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 situé entre le séparateur de champ et la fin du champ.
Separator { get; }Obtient le nœud qui représente le séparateur de champ. Peut êtrenul .
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

NomLa 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 child de son nœud parent, renvoie son paragraphe parent. Si le champ est déjà supprimé, renvoienul .
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 au format plan.

Exemples

Montre comment numéroter les paragraphes à l’aide des champs AUTONUMOUT.

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

// Les champs AUTONUMOUT affichent un nombre qui s'incrémente à chaque champ AUTONUMOUT.
// Contrairement aux champs AUTONUM, les champs AUTONUMOUT utilisent le schéma de numérotation hiérarchique,
// que l'on peut définir dans Microsoft Word via Format -> Balles et amp; Numérotation -> "Contour numéroté".
// Cela nous permet de numéroter automatiquement les éléments comme une liste numérotée.
// Les champs LISTNUM sont une alternative plus récente aux champs AUTONUMOUT.
// Ce champ affichera "1.".
builder.InsertField(FieldType.FieldAutoNumOutline, true);
builder.Writeln("\tParagraph 1.");

// Ce champ affichera "2.".
builder.InsertField(FieldType.FieldAutoNumOutline, true);
builder.Writeln("\tParagraph 2.");

foreach (FieldAutoNumOut field in doc.Range.Fields.Where(f => f.Type == FieldType.FieldAutoNumOutline))
    Assert.AreEqual(" AUTONUMOUT ", field.GetFieldCode());

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

Voir également