Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Introducedin
8.4

...

8.4
Description

Excerpt

Sets a list of bookmarks to be removed from the document.

Signature
C#
C#
 public void BookmarksToRemove(string [] bookmarks)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Sub BookmarksToRemove(bookmarks as string())
{signature}
{parameters}
{param:bookmarks}An array of strings containing the names of all the bookmarks to be removed{param}

{exceptions}
{exception:SAException}{{BookmarksToRemove}} will throw this exception if a bookmark in the list has been set as a [Repeat Block|WordTemplate.SetRepeatBlock]{exception}
{exception:NullArgumentException}{{BookmarksToRemove}} will throw this exception if {{bookmarks}} is null.{exception}


{remarks}
*This feature is available in OOXML files (DOCX/DOCM) only.*

Removing a bookmark will remove anything that is inside that bookmark.

{remarks}
{example}
{code:csharp|title=C#}
Parameters
Param
bookmarks
bookmarks

An array of strings containing the names of all the bookmarks to be removed

Exceptions
Exception
SAException
SAException

BookmarksToRemove will throw this exception if a bookmark in the list has been set as a Repeat Block

Exception
NullArgumentException
NullArgumentException

BookmarksToRemove will throw this exception if bookmarks is null.

Remarks

This feature is available in OOXML files (DOCX/DOCM) only.

Removing a bookmark will remove anything that is inside that bookmark.

Example
Code Block
csharp
csharp
titleC#


WordTemplate wt = new WordTemplate();
wt.Open(@"c:\templates\Template.docx");
string [] bookmarks = {"Bookmark1", "AroundTable"};
wt.BookmarksToRemove(bookmarks);
wt.Process();
wt.Save(@"c:\reports\Report.docx");
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Dim wt As New WordTemplate()
wt.Open("c:\templates\Template.docx")
Dim bookmarks = New String() {"Bookmark1", "AroundTable"};
wt.BookmarksToRemove(bookmarks);
wt.Process()
wt.Save("c:\reports\Report.docx")
{code} {example}