FieldNoteRef

FieldNoteRef class

Implementa el campo NOTEREF.

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

public class FieldNoteRef : Field

Constructores

Nombre	Descripción
FieldNoteRef()	Constructor predeterminado

Propiedades

Nombre	Descripción
BookmarkName { get; set; }	Obtiene o establece el nombre del marcador.
DisplayResult { get; }	Obtiene el texto que representa el resultado del campo mostrado.
End { get; }	Obtiene el nodo que representa el final del campo.
Format { get; }	Obtiene un`FieldFormat`objeto que proporciona acceso tipificado al formato del campo.
InsertHyperlink { get; set; }	Obtiene o establece si se debe insertar un hipervínculo al párrafo marcado.
InsertReferenceMark { get; set; }	Inserta la marca de referencia con el mismo formato de carácter que el estilo Referencia de nota al pie o Referencia de nota final
InsertRelativePosition { get; set; }	Obtiene o establece si se debe insertar una posición relativa del párrafo marcado.
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.
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 ser`nulo` .
Start { get; }	Obtiene el nodo que representa el inicio del campo.
virtual Type { get; }	Obtiene el tipo de campo de Microsoft Word.

Métodos

Nombre	Descripció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, devuelve`nulo` .
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 la marca de la nota al pie o nota final que está marcada por el marcador especificado.

Ejemplos

Muestra cómo realizar referencias cruzadas de notas al pie con el campo NOTEREF.

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

builder.Write("CrossReference: ");

FieldNoteRef field = (FieldNoteRef)builder.InsertField(FieldType.FieldNoteRef, false); // <--- no actualizar el campo
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();

//Este campo sólo funciona en versiones anteriores de Microsoft Word.
doc.Save(ArtifactsDir + "Field.NOTEREF.doc");

Muestra cómo insertar campos NOTEREF y modificar su apariencia.

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

    // Crea un marcador con una nota al pie a la que hará referencia el campo NOTEREF.
    InsertBookmarkWithFootnote(builder, "MyBookmark1", "Contents of MyBookmark1", "Footnote from MyBookmark1");

    // Este campo NOTEREF mostrará el número de la nota al pie dentro del marcador referenciado.
    // Establecer la propiedad InsertHyperlink nos permite saltar al marcador presionando Ctrl + clic en el campo en Microsoft Word.
    Assert.AreEqual(" NOTEREF  MyBookmark2 \\h",
        InsertFieldNoteRef(builder, "MyBookmark2", true, false, false, "Hyperlink to Bookmark2, with footnote number ").GetFieldCode());

    // Cuando se utiliza el indicador \p, después del número de nota al pie, el campo también muestra la posición del marcador en relación con el campo.
    // Bookmark1 está encima de este campo y contiene la nota al pie número 1, por lo que el resultado será "1 arriba" en la actualización.
    Assert.AreEqual(" NOTEREF  MyBookmark1 \\h \\p",
        InsertFieldNoteRef(builder, "MyBookmark1", true, true, false, "Bookmark1, with footnote number ").GetFieldCode());

    // Bookmark2 está debajo de este campo y contiene la nota al pie número 2, por lo que el campo mostrará "2 debajo".
    // La bandera \f hace que el número 2 aparezca en el mismo formato que la etiqueta del número de nota al pie en el texto real.
    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>
/// Utiliza un generador de documentos para insertar un campo NOTEREF con propiedades especificadas.
/// </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>
/// Utiliza un generador de documentos para insertar un marcador con nombre y una nota al pie al final.
/// </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();
}

Ver también

class Field
espacio de nombres Aspose.Words.Fields
asamblea Aspose.Words

FieldNextIf Class FieldNumChars Class