StiBookmarksV2Helper Class

Namespace: Stimulsoft.Report.Engine

A class helps with bookmarks.

Methods

Method Returns Description
Add static void Adds a bookmark manually. When adding the IsManualBookmark flag is set. This flag gives a signal to the report generator that search should be done in a reductive mode (direct comparison of BookmarkValue).
CreateBookmark static (+1 overloads) StiBookmark Creates a new bookmark.
GetBookmark static StiBookmark  
GetTreeNodeFromBookmarks static TreeNode Returns an object of the TreeNode type from the StiBookmark object.
Pack static void  
PrepareBookmark static void Prepares a bookmark and all of its child bookmarks for showing.

Method Details

Add static

Add(bookmark: StiBookmark, name: string): void

Adds a bookmark manually. When adding the IsManualBookmark flag is set. This flag gives a signal to the report generator that search should be done in a reductive mode (direct comparison of BookmarkValue).

Parameters

CreateBookmark static

CreateBookmark(text: string): StiBookmark

Creates a new bookmark.

Parameters

  • text (string) — Tree text.

Returns StiBookmark

CreateBookmark(text: string, componentGuid: string): StiBookmark

Creates a new bookmark.

Parameters

  • text (string) — Tree text.
  • componentGuid (string)

Returns StiBookmark

GetBookmark static

GetBookmark(bookmark: StiBookmark, name: string): StiBookmark

Parameters

Returns StiBookmark

GetTreeNodeFromBookmarks static

GetTreeNodeFromBookmarks(bookmark: StiBookmark): TreeNode

Returns an object of the TreeNode type from the StiBookmark object.

Parameters

  • bookmark (StiBookmark) — StiBookmark to form TreeNode.

Returns TreeNode — Formed TreeNode.

Pack static

Pack(bookmark: StiBookmark): void

Parameters

PrepareBookmark static

PrepareBookmark(bookmark: StiBookmark): void

Prepares a bookmark and all of its child bookmarks for showing.

Parameters