FieldIncludeText

FieldIncludeText class

Implementa il campo INCLUDETEXT.

Per saperne di più, visita ilLavorare con i campi articolo di documentazione.

public class FieldIncludeText : Field

Costruttori

NomeDescrizione
FieldIncludeText()Default_Costruttore

Proprietà

NomeDescrizione
BookmarkName { get; set; }Ottiene o imposta il nome del segnalibro nel documento da includere.
DisplayResult { get; }Ottiene il testo che rappresenta il risultato del campo visualizzato.
Encoding { get; set; }Ottiene o imposta la codifica applicata ai dati nel file a cui si fa riferimento.
End { get; }Ottiene il nodo che rappresenta la fine del campo.
Format { get; }Ottiene unFieldFormatoggetto che fornisce accesso tipizzato alla formattazione del campo.
IsDirty { get; set; }Ottiene o imposta se il risultato corrente del campo non è più corretto (obsoleto) a causa di altre modifiche apportate al documento.
IsLocked { get; set; }Ottiene o imposta se il campo è bloccato (non dovrebbe ricalcolare il suo risultato).
LocaleId { get; set; }Ottiene o imposta l’LCID del campo.
LockFields { get; set; }Ottiene o imposta se impedire l’aggiornamento dei campi nel documento incluso.
MimeType { get; set; }Ottiene o imposta il tipo MIME del file a cui si fa riferimento.
NamespaceMappings { get; set; }Ottiene o imposta i mapping degli spazi dei nomi per le query XPath.
Result { get; set; }Ottiene o imposta il testo compreso tra il separatore di campo e la fine del campo.
Separator { get; }Ottiene il nodo che rappresenta il separatore di campo. Può esserenull .
SourceFullName { get; set; }Ottiene o imposta la posizione del documento utilizzando un IRI.
Start { get; }Ottiene il nodo che rappresenta l’inizio del campo.
TextConverter { get; set; }Ottiene o imposta il nome del convertitore di testo per il formato del file incluso.
virtual Type { get; }Ottiene il tipo di campo di Microsoft Word.
XPath { get; set; }Ottiene o imposta XPath per la parte desiderata del file XML.
XslTransformation { get; set; }Ottiene o imposta la posizione della trasformazione XSL per formattare i dati XML.

Metodi

NomeDescrizione
GetFieldCode()Restituisce il testo tra l’inizio del campo e il separatore di campo (o la fine del campo se non c’è un separatore). Sono inclusi sia il codice di campo che il risultato del campo dei campi figlio.
GetFieldCode(bool)Restituisce il testo tra l’inizio del campo e il separatore di campo (o la fine del campo se non c’è separatore).
Remove()Rimuove il campo dal documento. Restituisce un nodo subito dopo il campo. Se la fine del campo è l’ultimo nodo figlio del suo nodo padre, restituisce il paragrafo padre. Se il campo è già stato rimosso, restituiscenull .
Unlink()Esegue lo scollegamento del campo.
Update()Esegue l’aggiornamento del campo. Genera un’eccezione se il campo è già in fase di aggiornamento.
Update(bool)Esegue un aggiornamento di campo. Genera un’eccezione se il campo è già in fase di aggiornamento.

Osservazioni

Inserisce tutto o parte del testo e della grafica contenuti in un altro documento.

Esempi

Mostra come creare un campo INCLUDETEXT e impostarne le proprietà.

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

    // Di seguito sono riportati due modi per utilizzare i campi INCLUDETEXT per visualizzare il contenuto di un file XML nel file system locale.
    // 1 - Esegui una trasformazione XSL su un documento 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 - Utilizzare un XPath per acquisire elementi specifici da un documento 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>
/// Utilizzare un generatore di documenti per inserire un campo INCLUDETEXT con proprietà personalizzate.
/// </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;
}

Guarda anche

FieldIncludePicture Class FieldIndex Class