IDocumentPointer Interface

Provides access to the document cursor.

Definition

Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0

C#
public interface IDocumentPointer

VB

Public Interface IDocumentPointer

C++
public interface class IDocumentPointer

F#
type IDocumentPointer = interface end

AutoScrolling	If true then the document is automatically scrolled to the cursor position inside SetLocation(Point).
CurrentAction	Determines current action used during the work with a cursor.
CurrentLocation	Current physical location of the cursor. May differ from PhysicalLocation during operations determined by CurrentAction.
DrawingLocation	Location of the cursor with page offset added to it. The page offset is specified by means of SetPageOffset(DocumentPage).
IsMouseDown	Determines whether the mouse button is currently pressed.
IsVisible	Determines whether current document cursor is visible on the document or not.
Location	Location of the cursor.
PhysicalLocation	Physical location of the cursor.
SelectedBounds	Bounds of the currently selected ranges.

GetRectangle	Returns a rectangle based on physical cursor locations.
Hide	If the cross is shown, redraws the area where it is located in order to remove it. Also, if there are any selected elements then safely removes the selection.
Invalidate	Invalidates a cursor on the document.
ScrollToCursor	Scrolls a document to the cursor position.
SetLocation	Sets the cursor location. If the specified value differs from the current value of PhysicalLocation then does the following: Sets PhysicalLocation, Location and CurrentLocation properties to value. Calls RefreshUI(). Scrolls to cursor if AutoScrolling is true and there is no current region in the document. If the specified value is equal to the current value of PhysicalLocation then does not change the location properties and only invalidates the cursor.
SetPageOffset	Moves the cursor to the specified page preserving its relative location on the page.