FieldIncludeText

FieldIncludeText class

Implémente le champ INCLUDETEXT.

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

public class FieldIncludeText : Field

Constructeurs

NomLa description
FieldIncludeText()Default_Constructor

Propriétés

NomLa description
BookmarkName { get; set; }Obtient ou définit le nom du signet dans le document à inclure.
DisplayResult { get; }Obtient le texte qui représente le résultat du champ affiché.
Encoding { get; set; }Obtient ou définit l’encodage appliqué aux données dans le fichier référencé.
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.
LockFields { get; set; }Obtient ou définit s’il faut empêcher la mise à jour des champs du document inclus.
MimeType { get; set; }Obtient ou définit le type MIME du fichier référencé.
NamespaceMappings { get; set; }Obtient ou définit les mappages d’espace de noms pour les requêtes XPath.
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 .
SourceFullName { get; set; }Obtient ou définit l’emplacement du document à l’aide d’un IRI.
Start { get; }Obtient le nœud qui représente le début du champ.
TextConverter { get; set; }Obtient ou définit le nom du convertisseur de texte pour le format du fichier inclus.
virtual Type { get; }Obtient le type de champ Microsoft Word.
XPath { get; set; }Obtient ou définit XPath pour la partie souhaitée du fichier XML.
XslTransformation { get; set; }Obtient ou définit l’emplacement de la transformation XSL pour formater les données XML.

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 tout ou partie du texte et des graphiques contenus dans un autre document.

Exemples

Montre comment créer un champ INCLUDETEXT et définir ses propriétés.

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

    // Vous trouverez ci-dessous deux manières d'utiliser les champs INCLUDETEXT pour afficher le contenu d'un fichier XML dans le système de fichiers local.
    // 1 - Effectuer une transformation XSL sur un document XML :
    FieldIncludeText fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
    fieldIncludeText.XslTransformation = MyDir + "CD collection XSL transformation.xsl";

    builder.Writeln();

    // 2 - Utiliser un XPath pour récupérer des éléments spécifiques d'un document XML :
    fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
    fieldIncludeText.NamespaceMappings = "xmlns:n='myNamespace'";
    fieldIncludeText.XPath = "/catalog/cd/title";

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

/// <summary>
/// Utilisez un générateur de documents pour insérer un champ INCLUDETEXT avec des propriétés personnalisées.
/// </summary>
public FieldIncludeText CreateFieldIncludeText(DocumentBuilder builder, string sourceFullName, bool lockFields, string mimeType, string textConverter, string encoding)
{
    FieldIncludeText fieldIncludeText = (FieldIncludeText)builder.InsertField(FieldType.FieldIncludeText, true);
    fieldIncludeText.SourceFullName = sourceFullName;
    fieldIncludeText.LockFields = lockFields;
    fieldIncludeText.MimeType = mimeType;
    fieldIncludeText.TextConverter = textConverter;
    fieldIncludeText.Encoding = encoding;

    return fieldIncludeText;
}

Voir également

FieldIncludePicture Class FieldIndex Class