StiBookmarksV1Helper Class
Namespace: Stimulsoft.Report.Engine
A class that helps with bookmarks.
Methods
| Method | Returns | Description |
|---|---|---|
Add static |
void | |
AddBookmarks static |
void | |
CreateBookmark static (+1 overloads) |
StiBookmark | Creates a new bookmark. |
GetBookmark static |
StiBookmark | |
GetTreeNode 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
Parameters
- bookmark (StiBookmark)
- name (string)
AddBookmarks static
AddBookmarks(bookmark: StiBookmark, treeNode: TreeNode): void
Parameters
- bookmark (StiBookmark)
- treeNode (TreeNode)
CreateBookmark static
CreateBookmark(text: string, parentComponent: object): StiBookmark
Creates a new bookmark.
Parameters
- text (string) — Tree text.
- parentComponent (object)
Returns StiBookmark
CreateBookmark(text: string, bookmarkText: string, parentComponent: object): StiBookmark
Creates a new bookmark.
Parameters
- text (string) — Tree text.
- bookmarkText (string) — Boormark text.
- parentComponent (object)
Returns StiBookmark
GetBookmark static
GetBookmark(bookmark: StiBookmark, name: string): StiBookmark
Parameters
- bookmark (StiBookmark)
- name (string)
Returns StiBookmark
GetTreeNode static
GetTreeNode(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
- bookmark (StiBookmark)
PrepareBookmark static
PrepareBookmark(bookmark: StiBookmark): void
Prepares a bookmark and all of its child bookmarks for showing.
Parameters
- bookmark (StiBookmark) — Bookmark for preparing.