Table of Contents

Class BookMarks

Namespace
Alternet.Editor.TextSource
Assembly
Alternet.Editor.v9.dll

Represents a collection of the BookMark objects.

public class BookMarks : SortList<IBookMark>, IList, ICollection, IReadOnlyList<IBookMark>, IReadOnlyCollection<IBookMark>, ISortList<IBookMark>, IBookMarks, IList<IBookMark>, ICollection<IBookMark>, IEnumerable<IBookMark>, IEnumerable
Inheritance
BookMarks
Implements
Extension Methods

Constructors

BookMarks()

Initializes a new instance of the BookMarksclass with default settings.

BookMarks(ITextSource)

Initializes a new instance of the BookMarks class with a specified owner.

Properties

FileName
Position
Shared

Specifies if bookmarks should be shared across all documents.

Methods

Assign(IBookMarks)

Copies the contents of the another BookMarks collection to the bookmark collection.

BlockDeleting(Rectangle)

Removes all bookmarks within specified rectangle.

Clear()

Removes all bookmarks from the bookmarks collection.

ClearAllBookMarks()

Removes all bookmarks from the bookmarks collection.

ClearAllUnnumberedBookmarks()

Removes all unnumbered bookmarks from the bookmarks collection.

ClearBookMark(int)

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

ClearBookMark(int, int)

Finds the bookmark by given index in a given line and removes its from bookmark collection.

ClearBookMark(int, int, int)

Finds the bookmark by given index and group in a given line and removes its from bookmark collection.

ClearBookMarkByIndex(int)

Removes the bookmark from bookmarks collection at the specified index. Updates state of the TextSource owning this collection.

ClearBookMarks()

Removes all bookmarks.

ClearBookMarks(int)

Removes all bookmarks from the specified line.

ClearBookMarks(int, int)

Removes all bookmarks from the specified line for specified Group.

ClearBookMarksByGroup(int)

Removes all bookmarks for the specified Bookmarks group.

ClearUnnumberedBookMarks()

Removes all Unnumbered Bookmarks.

FindBookMark(int)

Locates the bookmark with specified Index.

FindBookMark(int, out Point)

Locates the bookmark with specified Index.

FindBookMark(int, int)

Locates the bookmark with specified index within the specified line.

FindBookMark(int, int, int)

Locates the bookmark with specified index within the specified line.

FindBookMark(string)

Locates the bookmark with specified Name.

FindByIndex(int)
FindByLine(int)
GetBookMark(Point, Point)

Finds the first bookmark in the BookMarks collection that locates within the specified range.

GetBookMark(Point, Point, int)

Finds the first item in the bookmark collection located within the specified scope and associated with specified group.

GetBookMark(int)

Finds the first bookmark in the BookMarks collection located within the specified text line.

GetBookMark(int, int)

Finds the first item in the bookmark collection located within the specified text line and associated with specified group.

GetBookMarks(IList<IBookMark>)

Finds all items in the bookmark collection.

GetBookMarks(Point, Point, IList<IBookMark>)

Finds all bookmarks in the BookMarks collection located within the specified range.

GetBookMarks(Point, Point, int, IList<IBookMark>)

Finds all items in the bookmark collection located within the specified scope and associated with specified group.

GetBookMarks(int, IList<IBookMark>)

Finds all items in the bookmark collection associated with specified group.

GetImages(int)

Returns image list by its group.

GetImagesScaled(int)

Returns image list by its group, scaled for DPI.

GotoBookMark(int)

Moves caret to the location of the bookmark in the text source.

GotoNextBookMark()

Moves to the location of the next unnumbered bookmark in the text source.

GotoNextBookMark(int)

Moves to the location of the next unnumbered bookmark in the text source.

GotoPrevBookMark()

Moves caret to the location of the previous unnumbered bookmark in the text source.

GotoPrevBookMark(int)

Moves caret to the location of the previous unnumbered bookmark in the text source.

InternalClear(int)
InternalClearLine(int)
InternalFind(int, int)
InternalFind(int, int, int)
InternalGet(Point, Point, IList<IBookMark>, IComparer)
InternalGet(Point, Point, IComparer)
InternalGet(Point, Point, int)
InternalGet(Point, Point, int, IList<IBookMark>)
InternalGet(int)
InternalGet(int, int)
InternalSet(IBookMark)
InternalSet(int, int)
InternalSet(int, int, int)
LoadFile(string)

Loads bookmark content from the specified file.

LoadStream(Stream)

Loads bookmark content from the specified stream.

NewBookMark(int, int, int)
NextBookMark()

Returns the minimal possible value of the bookmark Index property of the new bookmark.

NextBookMark(int)

Returns the minimal possible value of the bookmark Index property of the new bookmark.

OnClick(IBookMark)

Raises OnClick event.

OnDoubleClick(IBookMark)

Raises OnDoubleClick event.

OnSharedChaging()
OnSharedChagned()
OnShowTooltip(ref string, IBookMark)

Raises OnShowTooltip event.

PositionChanged(int, int, int, int)

Updates all bookmarks starting from specified position.

PositionChanged(int, int, int, int, IComparer<IBookMark>, IComparer<IBookMark>)
SaveFile(string)

Saves bookmark content to the specific file.

SaveStream(Stream)

Saves bookmark content to the specific stream.

SetBookMark(IBookMark)

Sets the bookmark specified by bookMark parameter.

SetBookMark(Point, int)

Sets the bookmark with specified index to the position specified by Point parameter.

SetBookMark(Point, int, int, int)

Sets the bookmark with specified parameters.

SetBookMark(Point, int, int, int, string, string, string)

Sets the bookmark with specified parameters.

SetBookMark(Point, int, int, int, string, string, string, object)

Sets the bookmark with specified parameters.

SetBookMark(Point, int, string, string, string)

Sets the bookmark with specified index, name, description and url to the position specified by Point parameter.

SetBookMark(Point, int, string, string, string, int, string, object, bool)

Sets the bookmark with specified index, name, description and url to the position specified by Point parameter.

SetBookMark(int, int)

Sets the bookmark with specified index to the position specified by line parameter.

SetBookMark(int, int, int, int)

Sets the bookmark with specified parameters.

SetForcedMarker(Point, int, string, string, string, int, string, object)
ShouldDelete(IBookMark, Rectangle)
ToggleBookMark()

Sets or removes an unnumbered bookmark on the current line.

ToggleBookMark(IBookMark)

Sets or removes bookmark specified by bookMark parameter.

ToggleBookMark(Point, int)

Sets or removes bookmark with specified index at the specified line.

ToggleBookMark(Point, int, int, int)

Sets or removes bookmark with specified parameters.

ToggleBookMark(Point, int, int, int, string, string, string)

Sets or removes bookmark with specified parameters.

ToggleBookMark(Point, int, int, int, string, string, string, object)

Sets or removes bookmark with specified parameters.

ToggleBookMark(Point, int, string, string, string)

Sets or removes bookmark with specified index at the specified line.

ToggleBookMark(Point, int, string, string, string, int, string, object)

Sets or removes bookmark with specified index at the specified line.

ToggleBookMark(int)

Sets or removes bookmark with specified index at the current line.

ToggleBookMark(int, int)

Sets or removes bookmark with specified index at the specified line.

ToggleBookMark(int, int, int)

Sets or removes bookmark with specified parameters.

ToggleBookMark(int, int, int, int)

Sets or removes bookmark with specified parameters.

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

Events

Click

Occurs when Bookmark is being clicked.

DoubleClick

When implemented by a class, occurs when Bookmark is being double clicked.

ShowToolTip

Occurs when Bookmark Tooltip needs to be displayed.