Class BookMark

Namespace: Alternet.Editor.TextSource

Assembly: Alternet.Editor.v9.dll

BookMark class is used to store individual bookmark in bookmarks collection of Edit control. IBookMark

public class BookMark : IBookMark

Inheritance: object

BookMark

Implements: IBookMark

Derived: LineStyle

Remarks

Implements IBookMark interface.

Constructors

BookMark(): Initializes a new instance of the BookMark class with default settings.

BookMark(int): Initializes a new instance of the BookMark class with specified settings.

BookMark(int, int, int): Initializes a new instance of the BookMark class with specified Pos, Index and Line values.

BookMark(int, int, int, int, int, string): Initializes a new instance of the BookMark class with specified Pos, Line, Index, Group, Name, Description, Url, ImageIndex, FileName and Tag values.

BookMark(int, int, int, int, int, string, string, string, string, object): Initializes a new instance of the BookMark class with specified Pos, Line, Index, Group, ImageIndex, Name, Description, Url, ImageIndex, FileName and Tag values.

BookMark(int, int, int, string, string, string): Initializes a new instance of the BookMark class with specified Pos, Line, Index, Name, Description and Url values.

BookMark(int, int, int, string, string, string, int, string, object): Initializes a new instance of the BookMark class with specified Pos, Line, Index, Name, Description, Url, ImageIndex, FileName and Tag values.

BookMark(int, string): Initializes a new instance of the BookMark class with specified Line and FileName values.

Properties

Description: Gets or sets bookmark description.

FileName: Gets or sets a file name associated with this IBookMark.

Group: When implemented by a class, gets or sets a group associated with this IBookMark.

ImageIndex: Gets or sets an image index associated with this IBookMark.

Index: Gets an integer value that specifies an ordinal index of the bookmark. Line Pos

Line: Gets position of the bookmark within the text. 0 corresponds to the first line, 1 to second the line, and so on. Pos Index

Name: Gets or sets name of the bookmark.

Pos: Gets position of the bookmark within the text line. 0 corresponds to the first character in a line, 1 to the second character, and so on. Line Index

Position: Gets position of the bookmark within the text (index of character and line). Corresponds to Pos and Line properties. Pos Line Index

Tag: Gets or sets user-defined data associated with this IBookMark.

Url: Gets or sets bookmark url.

ZIndex: When implemented by a class, gets or sets an z-index associated with this IBookMark.

Methods

Assign(IBookMark): Copies the contents of another bookmark object to the bookmark.

OnDescriptionChanged()

OnFileNameChanged()

OnGroupChanged()

OnImageIndexChanged()

OnNameChanged()

OnTagChanged()

OnUrlChanged()

OnZIndexChanged()

ShouldSerializeDescription(): Indicates whether the Description should be persisted.

ShouldSerializeFileName(): Indicates whether the FileName should be persisted.

ShouldSerializeGroup(): Indicates whether the Group should be persisted.

ShouldSerializeImageIndex(): Indicates whether the ImageIndex should be persisted.

ShouldSerializeIndex(): Indicates whether the Index should be persisted.

ShouldSerializeLine(): Indicates whether the Line should be persisted.

ShouldSerializeName(): Indicates whether the Name should be persisted.

ShouldSerializePos(): Indicates whether the Pos should be persisted.

ShouldSerializeUrl(): Indicates whether the Url should be persisted.

ShouldSerializeZIndex(): Indicates whether the ZIndex should be persisted.