FieldCitation

FieldCitation class

Implémente le champ CITATION.

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

public class FieldCitation : Field

Constructeurs

NomLa description
FieldCitation()Default_Constructor

Propriétés

NomLa description
AnotherSourceTag { get; set; }Obtient ou définit une valeur qui correspond àÉtiqueter valeur de l’élément d’une autre source à inclure dans la citation.
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.
FormatLanguageId { get; set; }Obtient ou définit l’ID de langue utilisé conjointement avec le style bibliographique spécifié pour formater la citation dans le document.
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.
PageNumber { get; set; }Obtient ou définit un numéro de page associé à la citation.
Prefix { get; set; }Obtient ou définit un préfixe ajouté à la citation.
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 .
SourceTag { get; set; }Obtient ou définit une valeur qui correspond àÉtiqueter valeur de l’élément de la source à insérer.
Start { get; }Obtient le nœud qui représente le début du champ.
Suffix { get; set; }Obtient ou définit un suffixe ajouté à la citation.
SuppressAuthor { get; set; }Obtient ou définit si les informations sur l’auteur sont supprimées de la citation.
SuppressTitle { get; set; }Obtient ou définit si les informations sur le titre sont supprimées de la citation.
SuppressYear { get; set; }Obtient ou définit si les informations sur l’année sont supprimées de la citation.
virtual Type { get; }Obtient le type de champ Microsoft Word.
VolumeNumber { get; set; }Obtient ou définit un numéro de volume associé à la citation.

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 le contenu duSource élément avec un spécifiéÉtiqueter élément utilisant un style bibliographique.

Exemples

Montre comment travailler avec les champs CITATION et BIBLIOGRAPHIE.

// Ouvre un document contenant des sources bibliographiques que l'on peut trouver dans
// Microsoft Word via les références -> Citations et amp; Bibliographie -> Gérer les sources.
Document doc = new Document(MyDir + "Bibliography.docx");
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Text to be cited with one source.");

// Créez une citation avec uniquement le numéro de page et l'auteur du livre référencé.
FieldCitation fieldCitation = (FieldCitation)builder.InsertField(FieldType.FieldCitation, true);

// Nous faisons référence aux sources en utilisant leurs noms de balises.
fieldCitation.SourceTag = "Book1";
fieldCitation.PageNumber = "85";
fieldCitation.SuppressAuthor = false;
fieldCitation.SuppressTitle = true;
fieldCitation.SuppressYear = true;

Assert.AreEqual(" CITATION  Book1 \\p 85 \\t \\y", fieldCitation.GetFieldCode());

// Créez une citation plus détaillée qui cite deux sources.
builder.InsertParagraph();
builder.Write("Text to be cited with two sources.");
fieldCitation = (FieldCitation)builder.InsertField(FieldType.FieldCitation, true);
fieldCitation.SourceTag = "Book1";
fieldCitation.AnotherSourceTag = "Book2";
fieldCitation.FormatLanguageId = "en-US";
fieldCitation.PageNumber = "19";
fieldCitation.Prefix = "Prefix ";
fieldCitation.Suffix = " Suffix";
fieldCitation.SuppressAuthor = false;
fieldCitation.SuppressTitle = false;
fieldCitation.SuppressYear = false;
fieldCitation.VolumeNumber = "VII";

Assert.AreEqual(" CITATION  Book1 \\m Book2 \\l en-US \\p 19 \\f \"Prefix \" \\s \" Suffix\" \\v VII", fieldCitation.GetFieldCode());

// On peut utiliser un champ BIBLIOGRAPHIE pour afficher toutes les sources du document.
builder.InsertBreak(BreakType.PageBreak);
FieldBibliography fieldBibliography = (FieldBibliography)builder.InsertField(FieldType.FieldBibliography, true);
fieldBibliography.FormatLanguageId = "5129";

Assert.AreEqual(" BIBLIOGRAPHY  \\l 5129", fieldBibliography.GetFieldCode());

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.CITATION.docx");

Voir également