TCustomGutterObject Class

TCustomGutterObject is a base class of gutter objects and bookmarks.

TCustomGutterObject = class(TCollectionItem);

File

ecSyntMemo

Description

Use gutter object to display image on the gutter and to highlight specified line(s).

Each gutter object may be associated with the single line or with multiple lines using OnCheckLine event handle.

To assign image to the gutter object use ImageIndex property. Images may be specified by the ImageList property or by the TGutter.Images. Position of the image may be adjusted using Band and Margin property. Hint property specifies hint that will be displayed when mouse cursor is over an image.

To specify line highlighting use BgColor, ForeColor and SelInvertColors.

Group

Classes

Topics

Topic	Description
TCustomGutterObject Methods	The methods of the TCustomGutterObject class are listed here.
TCustomGutterObject Properties	The properties of the TCustomGutterObject class are listed here.
TCustomGutterObject Events	The events of the TCustomGutterObject class are listed here.

Legend

	Method
	virtual
	protected
	Property
	Event

TCustomGutterObject Events

TCustomGutterObject Events	Description
OnCheckLine	Occurs when gutter object is checked to be associated with the specified line.
OnClick	Occurs when the user clicks the gutter object's image (left mouse button).

TCustomGutterObject Methods

TCustomGutterObject Methods	Description
Assign	Copies the contents of another, similar object.
CheckLine	Checks whether gutter object is associated with the specified line.
Create	Creates and initializes a TCustomGutterObject instance.
CreateObj	Creates an instance of the gutter object.
Destroy	Destroys an instance of TCustomGutterObject.

TCustomGutterObject Properties

TCustomGutterObject Properties	Description
Band	Specifies position of the image on the guter.
BgColor	Specifies back ground color of line highlighting.
Cursor	Specifies cursor which selected when mouse is over gutter image.
ForeColor	Specifies fore ground color of line highlighting.
Hint	Contains the text string that can appear when the user moves the mouse over the image.
ImageIndex	Determines which image appears on the gutter.
ImageList	Lists the images that can appear on the gutter.
Line	Specifies line where gutter object is placed.
Margin	Specifies offset of the image.
Name	Specifies name of the gutter object.
PopupMenu	Identifies the pop-up menu associated with the gutter object.
SelInvertColors	Specifies whether style of the marked block (selected block) will be formed using line highlighting colors.
SubLine	Specifies sub-line where to show gutter icon. If this property is equal to -1 gutter icon will be displayed at the center of whole line height.
Tag	Stores an integer value as part of a gutter object.

Links

Classes, Legend, Members, Topics, TCustomGutterObject Methods, TCustomGutterObject Properties, TCustomGutterObject Events, TCustomGutterObject Events, TCustomGutterObject Methods, TCustomGutterObject Properties

Contents | Index

What do you think about this topic? Send feedback!