StartColumnBookmark

DocumentBuilder.StartColumnBookmark method

Marks the current position in the document as a column bookmark start. The position must be in a table cell.

public BookmarkStart StartColumnBookmark(string bookmarkName)
ParameterTypeDescription
bookmarkNameStringName of the bookmark.

Return Value

The bookmark start node that was just created.

Remarks

A column bookmark covers one or more columns in a range of rows. To create a valid bookmark you need to call both StartColumnBookmark and EndColumnBookmark with the same bookmarkName parameter.

Badly formed bookmarks or bookmarks with duplicate names will be ignored when the document is saved.

The actual position of the inserted BookmarkStart node may differ from the current document builder position.

Examples

Shows how to create a column bookmark.

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

builder.StartTable();

builder.InsertCell();
// Cells 1,2,4,5 will be bookmarked.
builder.StartColumnBookmark("MyBookmark_1");
// Badly formed bookmarks or bookmarks with duplicate names will be ignored when the document is saved.
builder.StartColumnBookmark("MyBookmark_1");
builder.StartColumnBookmark("BadStartBookmark");
builder.Write("Cell 1");

builder.InsertCell();
builder.Write("Cell 2");

builder.InsertCell();
builder.Write("Cell 3");

builder.EndRow();

builder.InsertCell();
builder.Write("Cell 4");

builder.InsertCell();
builder.Write("Cell 5");
builder.EndColumnBookmark("MyBookmark_1");
builder.EndColumnBookmark("MyBookmark_1");

builder.InsertCell();
builder.Write("Cell 6");

builder.EndRow();
builder.EndTable();

doc.Save(ArtifactsDir + "Bookmarks.CreateColumnBookmark.docx");

See Also

DocumentBuilder.StartBookmark DocumentBuilder.StartEditableRange