Trabajar con marcadores

Los marcadores identifican en un documento Microsoft Word las ubicaciones o fragmentos que usted nombra e identifica para referencia futura. Por ejemplo, puede utilizar un marcador para identificar el texto que desea revisar más adelante. En lugar de desplazarse por el documento para localizar el texto, puede acceder a él utilizando el cuadro de diálogo Marcador.

Las acciones que se pueden realizar con marcadores usando Aspose.Words son las mismas que puedes realizar usando Microsoft Word. Puede insertar un nuevo marcador, eliminarlo, moverse a un marcador, obtener o establecer el nombre de un marcador, obtener o configurar el texto incluido en él.

Insertar un marcador

Utilice StartBookmark y EndBookmark para crear un marcador marcando su inicio y final, respectivamente. No olvide pasar el mismo nombre de marcador a ambos métodos. Los marcadores de un documento pueden superponerse y abarcar cualquier rango. Los marcadores mal formados o con nombres duplicados se ignorarán cuando se guarde el documento.

Todos los espacios en blanco en los marcadores fueron reemplazados por guiones bajos. Esta restricción proviene de los formatos Microsoft Word, ya que los marcadores en formatos Word como DOCX o DOC no pueden tener espacios en blanco. Sin embargo, PDF permite dichos marcadores. Ahora, si necesita utilizar marcadores en esquemas PDF o XPS, puede utilizarlos con espacios en blanco.

El siguiente ejemplo de código muestra cómo crear un nuevo marcador:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_WorkingWithBookmarks();

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

builder.StartBookmark("My Bookmark");
builder.Writeln("Text inside a bookmark.");

builder.StartBookmark("Nested Bookmark");
builder.Writeln("Text inside a NestedBookmark.");
builder.EndBookmark("Nested Bookmark");

builder.Writeln("Text after Nested Bookmark.");
builder.EndBookmark("My Bookmark");


PdfSaveOptions options = new PdfSaveOptions();
options.OutlineOptions.BookmarksOutlineLevels.Add("My Bookmark", 1);
options.OutlineOptions.BookmarksOutlineLevels.Add("Nested Bookmark", 2);

dataDir = dataDir + "Create.Bookmark_out.pdf";
doc.Save(dataDir, options);

Obtener marcadores

A veces es necesario obtener una colección de marcadores para recorrer los marcadores o para otros fines. Utilice la propiedad Node.Range expuesta por cualquier nodo de documento que devuelva un objeto Range que represente la parte del documento contenida en este nodo. Utilice este objeto para recuperar un BookmarkCollection y luego utilice el indexador de colección para obtener un marcador específico.

El siguiente ejemplo de código muestra cómo obtener marcadores de una colección de marcadores:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_WorkingWithBookmarks();

Document doc = new Document(dataDir + "Bookmarks.doc");

// By index.
Bookmark bookmark1 = doc.Range.Bookmarks[0];
           
// By name.
Bookmark bookmark2 = doc.Range.Bookmarks["Bookmark2"];

Puede descargar el archivo de muestra de este ejemplo desde Aspose.Words GitHub.

El siguiente ejemplo de código muestra cómo obtener o establecer un nombre y texto de marcador:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_WorkingWithBookmarks();

Document doc = new Document(dataDir + "Bookmark.doc");

// Use the indexer of the Bookmarks collection to obtain the desired bookmark.
Bookmark bookmark = doc.Range.Bookmarks["MyBookmark"];

// Get the name and text of the bookmark.
string name = bookmark.Name;
string text = bookmark.Text;

// Set the name and text of the bookmark.
bookmark.Name = "RenamedBookmark";
bookmark.Text = "This is a new bookmarked text.";

Puede descargar el archivo de muestra de este ejemplo desde Aspose.Words GitHub.

El siguiente ejemplo de código muestra cómo marcar una tabla:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// Create empty document
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Table table = builder.StartTable();

// Insert a cell
builder.InsertCell();

// Start bookmark here after calling InsertCell
builder.StartBookmark("MyBookmark");

builder.Write("This is row 1 cell 1");

// Insert a cell
builder.InsertCell();
builder.Write("This is row 1 cell 2");

builder.EndRow();

// Insert a cell
builder.InsertCell();
builder.Writeln("This is row 2 cell 1");

// Insert a cell
builder.InsertCell();
builder.Writeln("This is row 2 cell 2");

builder.EndRow();

builder.EndTable();
// End of bookmark
builder.EndBookmark("MyBookmark");

dataDir = dataDir + "Bookmark.Table_out.doc";
doc.Save(dataDir);

Si cambia el nombre de un marcador a un nombre que ya existe en el documento, no se generará ningún error y solo se almacenará el primer marcador cuando guarde el documento.

Tenga en cuenta que algunos marcadores del documento están asignados a campos de formulario. Moverse a dicho marcador e insertar texto allí inserta el texto en el código de campo del formulario. Aunque esto no invalidará el campo del formulario, el texto insertado no será visible porque pasa a formar parte del código del campo.

El siguiente ejemplo de código muestra cómo acceder a las columnas de la tabla marcada:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// Create empty document
Document doc = new Document(dataDir + "Bookmark.Table_out.doc");
foreach (Bookmark bookmark in doc.Range.Bookmarks)
{
    Console.WriteLine("Bookmark: {0}{1}", bookmark.Name, bookmark.IsColumn ? " (Column)" : "");
    if (bookmark.IsColumn)
    {
        Row row = bookmark.BookmarkStart.GetAncestor(NodeType.Row) as Row;
        if (row != null && bookmark.FirstColumn < row.Cells.Count)
            Console.WriteLine(row.Cells[bookmark.FirstColumn].GetText().TrimEnd(ControlChar.CellChar));
    }
}

Mover a un marcador

Si necesita insertar contenido enriquecido (no solo texto sin formato) en un marcador, debe usar MoveToBookmark para mover el cursor al marcador y luego usar métodos y propiedades DocumentBuilder’s para insertar contenido.

Mostrar Ocultar contenido de marcador

Todo el marcador (incluido el contenido marcado) se puede encapsular dentro de la parte Verdadero del campo IF usando Aspose.Words. Puede ser de tal manera que el campo IF contenga un campo de combinación anidado en la expresión (A la izquierda del operador) y, dependiendo del valor del campo de combinación, el campo IF muestra u oculta el contenido del marcador en el documento de Word.

El siguiente ejemplo de código muestra cómo mostrar/ocultar marcadores:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_WorkingWithBookmarks();

Document doc = new Document(dataDir + "Bookmarks.doc");
ShowHideBookmarkedContent(doc, "Bookmark2", false);
doc.Save(dataDir + "Updated_Document.doc");

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
public static void ShowHideBookmarkedContent(Document doc, String bookmarkName, bool showHide)
{
    DocumentBuilder builder = new DocumentBuilder(doc);
    Bookmark bm = doc.Range.Bookmarks[bookmarkName];

    builder.MoveToDocumentEnd();
    // {IF "{MERGEFIELD bookmark}" = "true" "" ""}
    Field field = builder.InsertField("IF \"", null);
    builder.MoveTo(field.Start.NextSibling);
    builder.InsertField("MERGEFIELD " + bookmarkName + "", null);
    builder.Write("\" = \"true\" ");
    builder.Write("\"");
    builder.Write("\"");
    builder.Write(" \"\"");

    Node currentNode = field.Start;
    bool flag = true;
    while (currentNode != null && flag)
    {
        if (currentNode.NodeType == NodeType.Run)
            if (currentNode.ToString(SaveFormat.Text).Trim().Equals("\""))
                flag = false;

        Node nextNode = currentNode.NextSibling;

        bm.BookmarkStart.ParentNode.InsertBefore(currentNode, bm.BookmarkStart);
        currentNode = nextNode;
    }

    Node endNode = bm.BookmarkEnd;
    flag = true;
    while (currentNode != null && flag)
    {
        if (currentNode.NodeType == NodeType.FieldEnd)
            flag = false;

        Node nextNode = currentNode.NextSibling;

        bm.BookmarkEnd.ParentNode.InsertAfter(currentNode, endNode);
        endNode = currentNode;
        currentNode = nextNode;
    }

    doc.MailMerge.Execute(new String[] { bookmarkName }, new Object[] { showHide });

    //MailMerge can be avoided by using the following
    //builder.MoveToMergeField(bookmarkName);
    //builder.Write(showHide ? "true" : "false");
}