Class BookmarksHelper

Represents a class that implements bookmarks support for the EditControl.

Inheritance

System.Object

BookmarksHelper

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.Implementation

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class BookmarksHelper

Constructors

BookmarksHelper(StreamEditControl)

Initializes a new instance of the BookmarksHelper class.

Declaration

public BookmarksHelper(StreamEditControl control)

Parameters

Type	Name	Description
StreamEditControl	control	StreamEditControl.

Properties

BaseStream

Parent control's parser basestream.

Declaration

protected StreamsWrapper BaseStream { get; }

Property Value

Type
StreamsWrapper

Bookmarks

Gets the read-only copy of the bookmarks collection.

Declaration

public BookmarksCollection Bookmarks { get; }

Property Value

Type
BookmarksCollection

CurrentLine

Gets current line index.

Declaration

protected int CurrentLine { get; }

Property Value

Type
System.Int32

CursorManager

Parent control's cursor manager.

Declaration

protected CursorManager CursorManager { get; }

Property Value

Type
CursorManager

CustomBookmarks

Gets the read-only copy of the custom bookmarks collection.

Declaration

public CustomBookmarksCollection CustomBookmarks { get; }

Property Value

Type
CustomBookmarksCollection

Parser

Parent control's parser.

Declaration

protected RenderableLexemParser Parser { get; }

Property Value

Type
RenderableLexemParser

PositionConverter

Parent control's position converter.

Declaration

protected IPositionConverter PositionConverter { get; }

Property Value

Type
IPositionConverter

Methods

BookmarkAdd(Int32)

Sets bookmark at the specified line.

Declaration

public IBookmark BookmarkAdd(int line)

Parameters

Type	Name	Description
System.Int32	line	Line index.

Returns

Type	Description
IBookmark	IBookmark.

BookmarkClear()

Clears all bookmarks.

Declaration

[Command("Edit.Bookmarks.Clear")]
[KeysBinding]
public virtual void BookmarkClear()

BookmarkClear(Boolean)

Clears all bookmarks.

Declaration

public virtual void BookmarkClear(bool clearCustom)

Parameters

Type	Name	Description
System.Boolean	clearCustom

BookmarkGet(Int32)

Get bookmark at the specified line.

Declaration

public IBookmark BookmarkGet(int line)

Parameters

Type	Name	Description
System.Int32	line	Line index.

Returns

Type	Description
IBookmark	IBookmark.

BookmarkNext()

Moves the cursor position towards the next bookmark in EditControl.

Declaration

[Command("Edit.Bookmarks.Next")]
[KeysBinding]
[KeysBinding]
public void BookmarkNext()

BookmarkPrevious()

Moves the cursor position towards the previous bookmark in EditControl.

Declaration

[Command("Edit.Bookmarks.Previous")]
[KeysBinding]
[KeysBinding]
public void BookmarkPrevious()

BookmarkRemove(Int32)

Removes bookmark at the specified line.

Declaration

public void BookmarkRemove(int line)

Parameters

Type	Name	Description
System.Int32	line	Line index.

BookmarkToggle()

Sets bookmark to the current line for quick access to any part of the contents in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle")]
[KeysBinding]
[KeysBinding]
public void BookmarkToggle()

DrawBookmark(RenderedLine, Graphics, IntPtr, Boolean, Boolean)

Draws rectangle with plus or minus sign in the collapsers area if line supports collapsing.

Declaration

public void DrawBookmark(RenderedLine line, Graphics g, IntPtr wndHandle, bool bUseXPStyle, bool bForPrint)

Parameters

Type	Name	Description
RenderedLine	line	Line, to draw sign for.
System.Drawing.Graphics	g	Graphics object, where sign can be drawn.
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.

GetCustomBookmark(Int32)

Gets custom bookmark for the line.

Declaration

public ICustomBookmark GetCustomBookmark(int iLine)

Parameters

Type	Name	Description
System.Int32	iLine	Number of the line to be checked for the bookmark.

Returns

Type	Description
ICustomBookmark	ICustomBookmark interface to the line's bookmarks or null if there is no custom bookmarks on a line.

GetNextSearchableCustomBookmark(IParsePoint)

Gets next searchable custom bookmark.

Declaration

protected int GetNextSearchableCustomBookmark(IParsePoint point)

Parameters

Type	Name	Description
IParsePoint	point	Start point for search.

Returns

Type	Description
System.Int32	Index of found bookmark.

GetPreviousSearchableCustomBookmark(IParsePoint)

Gets previous searchable custom bookmark.

Declaration

protected int GetPreviousSearchableCustomBookmark(IParsePoint point)

Parameters

Type	Name	Description
IParsePoint	point	Start point for search.

Returns

Type	Description
System.Int32	Index of found bookmark.

RemoveCustomBookmark(Int32, BookmarkPaintEventHandler)

Removes the custom bookmark from the specified line.

Declaration

public void RemoveCustomBookmark(int iLine, BookmarkPaintEventHandler painter)

Parameters

Type	Name	Description
System.Int32	iLine	Physical line index.
BookmarkPaintEventHandler	painter	Paint handler.

SetCustomBookmark(Int32, BookmarkPaintEventHandler)

Creates a custom bookmark that allows the users to locate a section or a line of a document for quick access to any part of the contents

Declaration

public ICustomBookmark SetCustomBookmark(int iLine, BookmarkPaintEventHandler painter)

Parameters

Type	Name	Description
System.Int32	iLine	Physical line index.
BookmarkPaintEventHandler	painter	Paint handler.

Returns

Type
ICustomBookmark

SwitchIndexedBookmark(Int32)

Switches indexed bookmark in current line.

Declaration

protected void SwitchIndexedBookmark(int iIndex)

Parameters

Type	Name	Description
System.Int32	iIndex	Index of bookmark to switch.

SwitchIndexedBookmark0()

Switchs bookmark with index 0.

Declaration

[Command("Edit.Bookmarks.Switch0")]
[KeysBinding]
public virtual void SwitchIndexedBookmark0()

SwitchIndexedBookmark1()

Switchs bookmark with index 1.

Declaration

[Command("Edit.Bookmarks.Switch1")]
[KeysBinding]
public virtual void SwitchIndexedBookmark1()

SwitchIndexedBookmark2()

Switchs bookmark with index 2.

Declaration

[Command("Edit.Bookmarks.Switch2")]
[KeysBinding]
public virtual void SwitchIndexedBookmark2()

SwitchIndexedBookmark3()

Switchs bookmark with index 3.

Declaration

[Command("Edit.Bookmarks.Switch3")]
[KeysBinding]
public virtual void SwitchIndexedBookmark3()

SwitchIndexedBookmark4()

Switchs bookmark with index 4.

Declaration

[Command("Edit.Bookmarks.Switch4")]
[KeysBinding]
public virtual void SwitchIndexedBookmark4()

SwitchIndexedBookmark5()

Switchs bookmark with index 5.

Declaration

[Command("Edit.Bookmarks.Switch5")]
[KeysBinding]
public virtual void SwitchIndexedBookmark5()

SwitchIndexedBookmark6()

Switchs bookmark with index 6.

Declaration

[Command("Edit.Bookmarks.Switch6")]
[KeysBinding]
public virtual void SwitchIndexedBookmark6()

SwitchIndexedBookmark7()

Switchs bookmark with index 1.

Declaration

[Command("Edit.Bookmarks.Switch7")]
[KeysBinding]
public virtual void SwitchIndexedBookmark7()

SwitchIndexedBookmark8()

Switchs bookmark with index 8.

Declaration

[Command("Edit.Bookmarks.Switch8")]
[KeysBinding]
public virtual void SwitchIndexedBookmark8()

SwitchIndexedBookmark9()

Switchs bookmark with index 9.

Declaration

[Command("Edit.Bookmarks.Switch9")]
[KeysBinding]
public virtual void SwitchIndexedBookmark9()

ToggleIndexedBookmark(Int32)

Toggles indexed bookmark in current line.

Declaration

protected void ToggleIndexedBookmark(int iIndex)

Parameters

Type	Name	Description
System.Int32	iIndex

ToggleIndexedBookmark0()

Toggles cursor position towards the bookmark with index 0 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle0")]
[KeysBinding]
public virtual void ToggleIndexedBookmark0()

ToggleIndexedBookmark1()

Toggles cursor position towards the bookmark with index 1 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle1")]
[KeysBinding]
public virtual void ToggleIndexedBookmark1()

ToggleIndexedBookmark2()

Toggles bookmark with index 2.

Declaration

[Command("Edit.Bookmarks.Toggle2")]
[KeysBinding]
public virtual void ToggleIndexedBookmark2()

ToggleIndexedBookmark3()

Toggles cursor position towards the bookmark with index 3 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle3")]
[KeysBinding]
public virtual void ToggleIndexedBookmark3()

ToggleIndexedBookmark4()

Toggles cursor position towards the bookmark with index 4 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle4")]
[KeysBinding]
public virtual void ToggleIndexedBookmark4()

ToggleIndexedBookmark5()

Toggles cursor position towards the bookmark with index 5 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle5")]
[KeysBinding]
public virtual void ToggleIndexedBookmark5()

ToggleIndexedBookmark6()

Toggles cursor position towards the bookmark with index 6 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle6")]
[KeysBinding]
public virtual void ToggleIndexedBookmark6()

ToggleIndexedBookmark7()

Toggles cursor position towards the bookmark with index 7 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle7")]
[KeysBinding]
public virtual void ToggleIndexedBookmark7()

ToggleIndexedBookmark8()

Toggles cursor position towards the bookmark with index 8 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle8")]
[KeysBinding]
public virtual void ToggleIndexedBookmark8()

ToggleIndexedBookmark9()

Toggles cursor position towards the bookmark with index 9 in EditControl.

Declaration

[Command("Edit.Bookmarks.Toggle9")]
[KeysBinding]
public virtual void ToggleIndexedBookmark9()

Events

DrawLineMark

Occurs when line mark should be drawn.

Declaration

public event DrawLineMarkEventHandler DrawLineMark

Event Type

Type
DrawLineMarkEventHandler