Class BookMarkManager

Namespace: Alternet.Editor.TextSource

Assembly: Alternet.Editor.v9.dll

Represents a class used to manage bookmarks across multiple documents.

public class BookMarkManager

Inheritance: object

BookMarkManager

Properties

SharedBookMarks

Methods

BlockDeleting(Rectangle, string): Removes all bookmarks within specified text range.

CanMoveToNextBookMark(int): Indicates whether it is possible to move to the next un-indexed bookmark.

CanMoveToPreviousBookMark(int): Indicates whether it is possible to move to the previous un-indexed bookmark.

Clear(): Removes all bookmarks from the bookmarks collection.

Clear(int, string): Removes all bookmarks for the specified Bookmarks group in the specified document.

Clear(string): Removes all bookmarks from the specified document.

ClearBookMark(int): Finds the bookmark with specified index and removes it from bookmarks collection.

ClearBookMark(int, int, int, string): Finds the bookmark by given index and group in a given line in the specified document and removes its from bookmark collection.

ClearBookMarkByIndex(int, string)

ClearBookMarks(int, int, string): Finds the bookmark by given group in a given line in the specified document and removes it from the bookmark collection.

ClearUnnumberedBookMarks(string): Removes all un-indexed bookmarks from the specified document.

FindBookMark(int, int, int, string): Locates the bookmark with specified index within the specified line in the specified document.

FindBookMark(int, int, string): Locates the bookmark within the specified line in the specified document.

FindBookMark(int, string): Locates the bookmark with specified index in the specified document.

FindBookMark(string, string): Locates the bookmark with specified Name in the specified document.

FindByIndex(int)

FindByLine(int, string)

FindSource(string, bool)

GetBookMark(Point, Point, int, string): Finds the first item in the bookmark collection located within the specified scope and associated with specified group in the specified document.

GetBookMark(int, int, string): Finds the first item in the bookmark collection located within the specified text line and associated with specified group in the specified document.

GetBookMarkCount(): Gets number of the all bookmarks stored in the manager. Number of all bookmarks.

GetBookMarkCount(int, string): Gets number of the bookmarks associated with specified group in the specified document.

GetBookMarks(Point, Point, int, string, IList<IBookMark>): Finds all items in the bookmark collection located within the specified scope and associated with specified group in the specified document.

GetBookMarks(int, string, IList<IBookMark>): Finds all items in the bookmark collection associated with specified group in the specified document.

GetCurrentBookMark(int): Finds the first item in the bookmark collection associated with specified group.

GetImages(int): Gets image list associated with the group.

GetImagesScaled(int): Gets image list associated with the group, scaled for DPI.

GetNextBookMarkIndex(int, bool)

GetZIndex(int): Receives Z-index of specified group.

GotoBookMark(int): Finds the bookmark with specified index and navigates to its location.

GotoBookMarkIndex(int, bool)

GotoNextBookMark(): Moves to the location of the next un-indexed bookmark in the all documents.

GotoNextBookMark(int): Moves to the location of the next un-indexed bookmark in the all documents.

GotoPrevBookMark(): Moves to the location of the previous un-indexed bookmark in the all documents.

GotoPrevBookMark(int): Moves to the location of the previous un-indexed bookmark in the all documents.

InternalFindBookMark(int, int, int, string)

InternalFindBookMark(int, int, string)

InternalSet(Point, int, int, int, string, string, string, object, string)

LoadFile(string): Loads bookmark content from the specified file.

LoadStream(Stream): Loads bookmark content from the specified stream.

NextBookMark(int, string): Returns the minimal possible value of the bookmark Index property of the new bookmark.

OnActivate(string, ref ITextSource): Raises Activate event with specified parameters.

OnBookMarkAdded(IBookMark): Raises BookMarkAdded event with specified bookmark.

OnBookMarkImageChanged(IBookMark, int): Raises BookMarkImageChanged event with specified parameters.

OnBookMarkPositionChanged(IBookMark, Point): Raises BookMarkPositionChanged event with specified parameters.

OnBookMarkRemoved(IBookMark): Raises BookMarkRemoved event with specified bookmark.

OnClick(IBookMark): Raises Click event with specified bookmark.

OnDoubleClick(IBookMark): Raises DoubleClick event with specified bookmark.

OnShowTooltip(ref string, IBookMark): Raises ShowToolTip event with specified parameters.

PositionChanged(int, int, int, int, string): Updates all bookmarks in the specified document starting from specified position.

Register(ITextSource)

RegisterImages(ImageList, int)

SaveFile(string): Saves bookmark content to the specific file.

SaveStream(Stream): Saves bookmark content to the specific stream.

SetBookMark(Point, int, int, int, string, string, string, object, string): Sets the bookmark with specified parameters.

SetZIndex(int, int): Sets Z-index for specified group.

ShouldDelete(IBookMark, Rectangle)

ToggleBookMark(Point, int, int, int, string, string, string, object, string): Sets or removes bookmark with specified parameters.

Unregister(ITextSource)

UpdateCurrentIndexes()

UpdatePosition(int, int, int, int, IBookMark)

Events

Activate: Occurs when edit control gets focus.

BookMarkAdded: Occurs when new bookmark added.

BookMarkImageChanged: Occurs when bookmark image changed.

BookMarkPositionChanged: Occurs when bookmark position changed.

BookMarkRemoved: Occurs when bookmark removed.

Click: Occurs when bookmark is clicked.

DoubleClick: Occurs when bookmark is double clicked.

ShowToolTip: Occurs when bookmark about to show its tooltip.