Table of Contents

Interface IBookMarks

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

Represents properties and methods to provide an indexed access to individual IBookMark object.

public interface IBookMarks : IList<IBookMark>, ICollection<IBookMark>, IEnumerable<IBookMark>, IEnumerable
Extension Methods

Properties

Shared

When implemented by a class, specifies if bookmarks should be shared across all documents.

Methods

Assign(IBookMarks)

When implemented by a class, copies the contents from another IBookMarks object.

BlockDeleting(Rectangle)

When implemented by a class, removes all bookmarks within specified rectangle.

ClearAllBookMarks()

When implemented by a class, removes all items from the bookmark collection.

ClearAllUnnumberedBookmarks()

When implemented by a class, removes all unnumbered bookmarks from the bookmarks collection.

ClearBookMark(int)

When implemented by a class, finds the bookmark by given index and removes its from bookmark collection.

ClearBookMark(int, int)

When implemented by a class, finds the bookmark by given index in a given line and removes its from bookmark collection.

ClearBookMarks(int)

When implemented by a class, removes all bookmarks from the specified line.

FindBookMark(int)

When implemented by a class, finds the bookmark with specified Index property within bookmark collection.

FindBookMark(int, out Point)

When implemented by a class, finds the bookmark with specified Index property within bookmark collection.

FindBookMark(int, int)

When implemented by a class, finds the bookmark with specified Index in a specific line within bookmark collection.

FindBookMark(string)

When implemented by a class, finds the bookmark with specified Name property within bookmark collection.

GetBookMark(Point, Point)

When implemented by a class, finds the first item in the bookmark collection located within the specified scope.

GetBookMark(int)

When implemented by a class, finds the first item in the bookmark collection located within the specified text line.

GetBookMarks(IList<IBookMark>)

When implemented by a class, finds all items in the bookmark collection.

GetBookMarks(Point, Point, IList<IBookMark>)

When implemented by a class, finds all items in the bookmark collection located within the specified scope.

GetImages(int)

When implemented by a class, returns image list by its group.

GetImagesScaled(int)

Returns image list by its group, scaled for DPI.

GotoBookMark(int)

When implemented by a class, moves Edit control's caret to the location of the specified bookmark.

GotoNextBookMark()

When implemented by a class, moves Edit control's caret to the location of the next unnumbered bookmark.

GotoPrevBookMark()

When implemented by a class, moves Edit control's caret to the location of the previous unnumbered bookmark.

LoadFile(string)

When implemented by a class, loads bookmark content from the specified file.

LoadStream(Stream)

When implemented by a class, loads bookmark content from the specified stream.

NextBookMark()

When implemented by a class, returns the minimal possible value of the bookmark's Index property of the new bookmark.

OnClick(IBookMark)

When implemented by a class, raises OnClick event.

OnDoubleClick(IBookMark)

When implemented by a class, raises OnDoubleClick event.

OnShowTooltip(ref string, IBookMark)

When implemented by a class, raises OnShowTooltip event.

PositionChanged(int, int, int, int)

When implemented by a class, updates all bookmarks starting from specified position.

SaveFile(string)

When implemented by a class, saves bookmark content to the specific file.

SaveStream(Stream)

When implemented by a class, saves bookmark content to the specific stream.

SetBookMark(IBookMark)

When implemented by a class, sets bookmark specified by bookMark parameter.

SetBookMark(Point, int)

When implemented by a class, sets the bookmark with specified index to the specified position.

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

When implemented by a class, sets the bookmark with specified index, name, description and url to the position specified by Point parameter.

SetBookMark(int, int)

When implemented by a class, sets the bookmark with specified index to the position specified by Line parameter.

ToggleBookMark()

When implemented by a class, toggles (sets or removes) an unnumbered bookmark on the current line in the control's text.

ToggleBookMark(IBookMark)

When implemented by a class, toggles (sets or removes) specified bookmark.

ToggleBookMark(Point, int)

When implemented by a class, toggles (sets or removes) bookmark with specified Index property at the specified position.

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

When implemented by a class, toggles (sets or removes) the bookmark with specified index, name, description and url to the position specified by Point parameter.

ToggleBookMark(int)

When implemented by a class, toggles (sets or removes) bookmark with specified Index property at the current line.

ToggleBookMark(int, int)

When implemented by a class, toggles (sets or removes) bookmark with specified Index property at the specified line.

Events

Click

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

DoubleClick

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

ShowToolTip

When implemented by a class, occurs when Bookmark Tooltip needs to be displayed.