FieldNoteRef

FieldNoteRef class

Implémente le champ NOTEREF.

Pour en savoir plus, visitez leTravailler avec les champs article de documentation.

public class FieldNoteRef : Field

Constructeurs

Nom	La description
FieldNoteRef()	Default_Constructor

Propriétés

Nom	La description
BookmarkName { get; set; }	Obtient ou définit le nom du signet.
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 un`FieldFormat`objet qui fournit un accès typé au formatage du champ.
InsertHyperlink { get; set; }	Obtient ou définit s’il faut insérer un lien hypertexte vers le paragraphe marqué d’un signet.
InsertReferenceMark { get; set; }	Insère la marque de référence avec le même formatage de caractères que le style Référence de note de bas de page ou Référence de note de fin.
InsertRelativePosition { get; set; }	Obtient ou définit s’il faut insérer une position relative du paragraphe marqué d’un signet.
IsDirty { get; set; }	Obtient ou définit si le résultat actuel du champ n’est plus correct (obsolète) 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; }	Récupère le nœud représentant le séparateur de champ. Peut être`nul` .
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 du 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 immédiatement 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é, renvoie`nul` .
Unlink()	Effectue la dissociation du champ.
Update()	Effectue la mise à jour du champ. Lève une requête si le champ est déjà en cours de mise à jour.
Update(bool)	Effectue une mise à jour du champ. L’erreur est générée si le champ est déjà en cours de mise à jour.

Remarques

Insère la marque de la note de bas de page ou de fin marquée par le signet spécifié.

Exemples

Montre comment référencer les notes de bas de page avec le champ NOTEREF.

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

builder.Write("CrossReference: ");

FieldNoteRef field = (FieldNoteRef)builder.InsertField(FieldType.FieldNoteRef, false); // <--- ne pas mettre à jour le champ
field.BookmarkName = "CrossRefBookmark";
field.InsertHyperlink = true;
field.InsertReferenceMark = true;
field.InsertRelativePosition = false;
builder.Writeln();

builder.StartBookmark("CrossRefBookmark");
builder.Write("Hello world!");
builder.InsertFootnote(FootnoteType.Footnote, "Cross referenced footnote.");
builder.EndBookmark("CrossRefBookmark");
builder.Writeln();

doc.UpdateFields();

// Ce champ ne fonctionne que dans les anciennes versions de Microsoft Word.
doc.Save(ArtifactsDir + "Field.NOTEREF.doc");

Montre comment insérer des champs NOTEREF et modifier leur apparence.

public void FieldNoteRef()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Créez un signet avec une note de bas de page à laquelle le champ NOTEREF fera référence.
    InsertBookmarkWithFootnote(builder, "MyBookmark1", "Contents of MyBookmark1", "Footnote from MyBookmark1");

    // Ce champ NOTEREF affichera le numéro de la note de bas de page à l'intérieur du signet référencé.
    // La définition de la propriété InsertHyperlink nous permet d'accéder au signet en appuyant sur Ctrl + en cliquant sur le champ dans Microsoft Word.
    Assert.AreEqual(" NOTEREF  MyBookmark2 \\h",
        InsertFieldNoteRef(builder, "MyBookmark2", true, false, false, "Hyperlink to Bookmark2, with footnote number ").GetFieldCode());

    // Lorsque vous utilisez l'indicateur \p, après le numéro de note de bas de page, le champ affiche également la position du signet par rapport au champ.
    // Bookmark1 est au-dessus de ce champ et contient la note de bas de page numéro 1, donc le résultat sera « 1 au-dessus » lors de la mise à jour.
    Assert.AreEqual(" NOTEREF  MyBookmark1 \\h \\p",
        InsertFieldNoteRef(builder, "MyBookmark1", true, true, false, "Bookmark1, with footnote number ").GetFieldCode());

    // Le signet 2 se trouve sous ce champ et contient la note de bas de page numéro 2, le champ affichera donc « 2 ci-dessous ».
    // L'indicateur \f fait apparaître le numéro 2 dans le même format que l'étiquette du numéro de note de bas de page dans le texte réel.
    Assert.AreEqual(" NOTEREF  MyBookmark2 \\h \\p \\f",
        InsertFieldNoteRef(builder, "MyBookmark2", true, true, true, "Bookmark2, with footnote number ").GetFieldCode());

    builder.InsertBreak(BreakType.PageBreak);
    InsertBookmarkWithFootnote(builder, "MyBookmark2", "Contents of MyBookmark2", "Footnote from MyBookmark2");

    doc.UpdatePageLayout();
    doc.UpdateFields();
    doc.Save(ArtifactsDir + "Field.NOTEREF.docx");
}

/// <summary>
/// Utilise un générateur de documents pour insérer un champ NOTEREF avec des propriétés spécifiées.
/// </summary>
private static FieldNoteRef InsertFieldNoteRef(DocumentBuilder builder, string bookmarkName, bool insertHyperlink, bool insertRelativePosition, bool insertReferenceMark, string textBefore)
{
    builder.Write(textBefore);

    FieldNoteRef field = (FieldNoteRef)builder.InsertField(FieldType.FieldNoteRef, true);
    field.BookmarkName = bookmarkName;
    field.InsertHyperlink = insertHyperlink;
    field.InsertRelativePosition = insertRelativePosition;
    field.InsertReferenceMark = insertReferenceMark;
    builder.Writeln();

    return field;
}

/// <summary>
/// Utilise un générateur de documents pour insérer un signet nommé avec une note de bas de page à la fin.
/// </summary>
private static void InsertBookmarkWithFootnote(DocumentBuilder builder, string bookmarkName, string bookmarkText, string footnoteText)
{
    builder.StartBookmark(bookmarkName);
    builder.Write(bookmarkText);
    builder.InsertFootnote(FootnoteType.Footnote, footnoteText);
    builder.EndBookmark(bookmarkName);
    builder.Writeln();
}

Voir également

class Field
espace de noms Aspose.Words.Fields
Assemblée Aspose.Words

FieldNextIf Class FieldNumChars Class