FieldIncludeText

FieldIncludeText class

Implementa el campo INCLUDETEXT.

Para obtener más información, visite elTrabajar con campos Artículo de documentación.

public class FieldIncludeText : Field

Constructores

NombreDescripción
FieldIncludeText()Constructor predeterminado

Propiedades

NombreDescripción
BookmarkName { get; set; }Obtiene o establece el nombre del marcador en el documento que se incluirá.
DisplayResult { get; }Obtiene el texto que representa el resultado del campo mostrado.
Encoding { get; set; }Obtiene o establece la codificación aplicada a los datos dentro del archivo referenciado.
End { get; }Obtiene el nodo que representa el final del campo.
Format { get; }Obtiene unFieldFormatobjeto que proporciona acceso tipificado al formato del campo.
IsDirty { get; set; }Obtiene o establece si el resultado actual del campo ya no es correcto (obsoleto) debido a otras modificaciones realizadas al documento.
IsLocked { get; set; }Obtiene o establece si el campo está bloqueado (no debe recalcular su resultado).
LocaleId { get; set; }Obtiene o establece el LCID del campo.
LockFields { get; set; }Obtiene o establece si se debe evitar que se actualicen los campos del documento incluido.
MimeType { get; set; }Obtiene o establece el tipo MIME del archivo referenciado.
NamespaceMappings { get; set; }Obtiene o establece las asignaciones de espacios de nombres para consultas XPath.
Result { get; set; }Obtiene o establece el texto que está entre el separador de campo y el final del campo.
Separator { get; }Obtiene el nodo que representa el separador de campo. Puede sernulo .
SourceFullName { get; set; }Obtiene o establece la ubicación del documento utilizando un IRI.
Start { get; }Obtiene el nodo que representa el inicio del campo.
TextConverter { get; set; }Obtiene o establece el nombre del convertidor de texto para el formato del archivo incluido.
virtual Type { get; }Obtiene el tipo de campo de Microsoft Word.
XPath { get; set; }Obtiene o establece XPath para la parte deseada del archivo XML.
XslTransformation { get; set; }Obtiene o establece la ubicación de la transformación XSL para formatear datos XML.

Métodos

NombreDescripción
GetFieldCode()Devuelve el texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador). Se incluyen tanto el código de campo como el resultado de campo de los campos secundarios.
GetFieldCode(bool)Devuelve el texto entre el inicio del campo y el separador de campo (o el final del campo si no hay separador).
Remove()Elimina el campo del documento. Devuelve un nodo justo después del campo. Si el final del campo es el último hijo de su nodo padre, devuelve su párrafo padre. Si el campo ya se ha eliminado, devuelvenulo .
Unlink()Realiza la desvinculación del campo.
Update()Realiza la actualización del campo. Se lanza una excepción si el campo ya se está actualizando.
Update(bool)Realiza una actualización de campo. Se lanza una excepción si el campo ya se está actualizando.

Observaciones

Inserta todo o parte del texto y los gráficos contenidos en otro documento.

Ejemplos

Muestra cómo crear un campo INCLUDETEXT y configurar sus propiedades.

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

    A continuación se muestran dos formas de utilizar los campos INCLUDETEXT para mostrar el contenido de un archivo XML en el sistema de archivos local.
    // 1 - Realizar una transformación XSL en 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 - Utilice un XPath para tomar elementos específicos de 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>
/// Utilice un generador de documentos para insertar un campo INCLUDETEXT con propiedades personalizadas.
/// </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;
}

Ver también

FieldIncludePicture Class FieldIndex Class