Table of Contents

Class CaretInfo

Namespace
Alternet.UI
Assembly
Alternet.UI.Common.dll

Contains methods and properties which help to work with internally painted caret.

public class CaretInfo : BaseObject, IBaseObject
Inheritance
CaretInfo
Implements

Properties

BottomOverlayRect

Gets bottom overlay rectangle.

BottomOverlayVisible

Gets or sets whether bottom overlay image is painted.

Color

Gets or sets caret color. If null, CaretColor will be used.

ContainerFocused

Gets whether caret container is focused. This doesn't change container's focused state.

IsDisposed

Gets disposed state.

OverlayColor

Get or sets overlay image color. If null, DefaultOverlayColor will be used.

OverlayImage

Gets or sets overlay image. If not specified, DefaultOverlayImage is used.

OverlaySize

Gets or sets overlay image size.

Position

Gets caret position.

Rect

Gets caret rectangle.

SafeOverlayImage

Gets overlay image which is actually used. This is calculated property.

Size

Gets caret size.

TopAndBottomOverlayVisible

Gets or sets whether top and bottom overlay images are visible.

TopOrBottomOverlayVisible

Gets whether top or bottom overlay image is visible.

TopOverlayRect

Gets top overlay rectangle.

TopOverlayVisible

Gets or sets whether top overlay image is painted.

Visible

Gets whether caret is visible.

Methods

AddToUpdateRegion(RectI)

Adds rectangle to the caret update region.

AddToUpdateRegion(RectI, RectI)

Adds two rectangles to the caret update region.

GetOverlayRect(PointI)

Gets overlay rectangle for the specified center point.

OverlayChanged(bool)

Called when overlay image related properties are changed.

Paint(AbstractControl, PaintEventArgs)

Paints caret.

ResetUpdateRegion()

Resets the caret update region.