Class Bookmark

Represents a class that provides Bookmark.

Inheritance

System.Object

Bookmark

Implements

System.IComparable

IBookmark

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Edit.Utils

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class Bookmark : IComparable, IBookmark

Constructors

Bookmark(StreamsWrapper, IPositionConverter, IParsePoint, IParsePoint)

Initializes a new instance of the Bookmark class.

Declaration

public Bookmark(StreamsWrapper wrapper, IPositionConverter converter, IParsePoint point, IParsePoint endPoint)

Parameters

Type	Name	Description
StreamsWrapper	wrapper	Underlying StreamsWrapper.
IPositionConverter	converter	IPositionConverter.
IParsePoint	point	Point, bookmark is associated with.
IParsePoint	endPoint	ParsePoint situated at the end of the bookmarked line.

Bookmark(StreamsWrapper, IPositionConverter, IParsePoint, IParsePoint, Int32)

Initializes a new instance of the Bookmark class.

Declaration

public Bookmark(StreamsWrapper wrapper, IPositionConverter converter, IParsePoint point, IParsePoint endPoint, int index)

Parameters

Type	Name	Description
StreamsWrapper	wrapper	Underlying StreamsWrapper.
IPositionConverter	converter	IPositionConverter.
IParsePoint	point	Point, bookmark is associated with.
IParsePoint	endPoint	ParsePoint situated at the end of the bookmarked line.
System.Int32	index	Fast access index of the bookmark.

Properties

BookmarkBrush

Gets or sets the brush info object that is using for painting bookmarks.

Declaration

public BrushInfo BookmarkBrush { get; set; }

Property Value

Type
BrushInfo

BorderColor

Gets or sets color of bookmark border.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

BrushDefault

Gets or sets a default brush info value.

Declaration

public static BrushInfo BrushDefault { get; set; }

Property Value

Type
BrushInfo

EndPoint

Gets or sets the parse point situated at the end of the bookmarked line.

Declaration

public IParsePoint EndPoint { get; set; }

Property Value

Type
IParsePoint

Index

Gets the fast access index of bookmark.

Declaration

public int Index { get; }

Property Value

Type
System.Int32

Line

Gets bookmark location in text.

Declaration

public int Line { get; }

Property Value

Type
System.Int32

Point

Gets or sets the parse point where bookmark is connected to.

Declaration

public IParsePoint Point { get; set; }

Property Value

Type
IParsePoint

XPBrushInfo

Gets the brush used to draw bookmarks when XP style is used.

Declaration

public BrushInfo XPBrushInfo { get; }

Property Value

Type
BrushInfo

Methods

CompareTo(Object)

Compares two bookmarks by offsets of their parsepoints.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	Bookmark object or IParsePoint.

Returns

Type	Description
System.Int32	Standard CompareTo result.

PaintBookmark(Graphics, Rectangle, IntPtr, Boolean, Boolean)

Draws bookmark.

Declaration

public virtual void PaintBookmark(Graphics g, Rectangle rect, IntPtr wndHandle, bool bUseXPStyle, bool bForPrint)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics to be used for drawing.
System.Drawing.Rectangle	rect
System.IntPtr	wndHandle	Handle of window to draw at.
System.Boolean	bUseXPStyle	Indicates whether XP style must be used.
System.Boolean	bForPrint	Indicates whether g is printer's graphics.

PaintBookmarkHelper(Graphics, Rectangle, IntPtr, Boolean)

Helps to paint bookmark.

Declaration

public static void PaintBookmarkHelper(Graphics g, Rectangle rect, IntPtr wndHandle, bool bUseXPStyle)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics.
System.Drawing.Rectangle	rect	Rectangle for bookmark.
System.IntPtr	wndHandle	Handle of window.
System.Boolean	bUseXPStyle	Indicates whether XP style should be used.

PaintBookmarkHelper(Graphics, Rectangle, IntPtr, Boolean, Boolean, Int32, BrushInfo, BrushInfo, Color)

Helps to paint bookmark.

Declaration

public static void PaintBookmarkHelper(Graphics g, Rectangle rect, IntPtr wndHandle, bool bUseXPStyle, bool bForPrint, int index, BrushInfo fakeXPBrushBookmarks, BrushInfo defaultBrushInfo, Color frameBorderColor)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics.
System.Drawing.Rectangle	rect	Rectangle for bookmark.
System.IntPtr	wndHandle	Handle of window.
System.Boolean	bUseXPStyle	Indicates whether XP style should be used.
System.Boolean	bForPrint	Indicates whether drawing is being performed for printing.
System.Int32	index	Index of bookmark.
BrushInfo	fakeXPBrushBookmarks	Brush for emulating XP style.
BrushInfo	defaultBrushInfo	Default brush.
System.Drawing.Color	frameBorderColor	Color for border.

Implements

System.IComparable

IBookmark