TecEmbeddedObjects Class

Special text source with custom formatting and embedded objects support.

TecEmbeddedObjects = class(TSyntTextSource, IecExternalFormatter, IecSyntMemoPlugIn2);

File

ecEmbObj

Description

TecEmbeddedObjects represents text source with additional features:

1. Custom formatting.

2. Embedded objects.

Group

Classes

Topics

Topic	Description
IecExternalFormatter Methods	The methods of the IecExternalFormatter class are listed here.

IecSyntMemoPlugIn2 Interface

Topic	Description
IecSyntMemoPlugIn2 Methods	The methods of the IecSyntMemoPlugIn2 class are listed here.

IecSyntClient Interface

Topic	Description
IecSyntClient Methods	The methods of the IecSyntClient class are listed here.

TSyntTextSource Class

Topic	Description
TSyntTextSource Methods	The methods of the TSyntTextSource class are listed here.
TSyntTextSource Properties	The properties of the TSyntTextSource class are listed here.

TecEmbeddedObjects Class

Topic	Description
TecEmbeddedObjects Methods	The methods of the TecEmbeddedObjects class are listed here.
TecEmbeddedObjects Properties	The properties of the TecEmbeddedObjects class are listed here.

Legend

	Method
	virtual
	protected
	private
	Property
	read only

IecExternalFormatter Methods

IecExternalFormatter Methods	Description
AnalyzeToPos	Says to analyze text up to the position APos.
GetStyleList	Adds entries to list of styles at the CurPos position.

IecSyntMemoPlugIn2 Interface

IecSyntMemoPlugIn2 Interface	Description
ScrollPosChanged	Called when scrolling position is changed.

IecSyntClient Interface

IecSyntClient Interface	Description
Finished	Called when syntax analysis is finished.
FormatChanged	Called when styles of syntax analyzer is changed.

TSyntTextSource Class

TSyntTextSource Class	Description
AddClient	Adds client.
CaretPosToStrPos	Converts (X, Y) position of the caret to zero-based text position.
Create	Creates and initializes a TSyntTextSource instance.
Destroy	Destroys an instance of TSyntTextSource.
Finished	Called when syntax analysis is finished.
FormatChanged	Called when styles of syntax analyzer is changed.
LineLength	Returns length of the line.
RemoveClient	Removes client.
StrPosToCaretPos	Returns caret position for the given text position.

TecEmbeddedObjects Class

TecEmbeddedObjects Class	Description
Add	Adds embedded object and returns it's position in list.
AddClient	This is AddClient, a member of class TecEmbeddedObjects.
CanPaste	Indicates whether the Windows clipboard contains data that can be pasted by any registered object classes.
CaretPosToStrPos	This is CaretPosToStrPos, a member of class TecEmbeddedObjects.
ChangePosition	Moves embedded object to new position in text.
ClearFormatting	Clears custom formatting.
Create	Creates and initializes a TecEmbeddedObjects instance.
Delete	Deletes embedded object at specified index.
Destroy	Destroys an instance of TecEmbeddedObjects.
FormatRange	Formats specified text range with Style.
GetObjectsInRange	Creates list of embedded objects in specified text range.
GetStyleList	This is GetStyleList, a member of class TecEmbeddedObjects.
HasFormatting	Indicates whether text storage has custom formatting.
IndexOf	Returns index of specified embedded object in list.
InsertControl	Inserts control at specified position in text. Control will be displayed only in editor specified by ControlSite property.
InsertIcon	Creates and inserts objects of class TecEmbeddedImageIdx to the specified position in text.
InsertPicture	Creates and inserts objects of class TecEmbeddedImage to the specified position in text.
LineLength	This is LineLength, a member of class TecEmbeddedObjects.
LoadFormatting	Loads custom formatting.
ObjectAtCaret	Returns index of embedded object at specified position in text.
ObjectCaretPos	Returns caret position of the embedded object at the specified index.
ObjectsAtLine	Creates and fills list of embedded objects at specified line.
Paste	Creates embedded object, pastes its data from clipboard and inserts to the current caret position of the editor.
PriorAt	Returns index of embedded object at with position less or equal to Pos.
RangeStyle	Applies style to the specified text range.
Remove	Removes embedded object.
RemoveClient	This is RemoveClient, a member of class TecEmbeddedObjects.
SaveFormatting	Saves custom formatting.
StrPosToCaretPos	This is StrPosToCaretPos, a member of class TecEmbeddedObjects.
UpdateControls	Updates position and visibility of embedded controls.

TSyntTextSource Properties

TSyntTextSource Class

TSyntTextSource Class	Description
Lines	Contains text.
ReadOnly	Determines whether the user can change the text of the all syntax memo controls linked to the text source.
SyntaxAnalyzer	Associated syntactical analyzer.
SyntObj	Provides access to syntax objects.

TecEmbeddedObjects Class

TecEmbeddedObjects Class	Description
ControlSite	Specifies editor where embedded controls will be placed. This editor must be linked to this text source, i.e. its TextSource property must be set on this text source.
Count	Indicates number of embedded objects.
FormatEnabled	Specifies whether custom formatting is enabled.
HasControls	Specifies whether text source contains embedded controls.
ImageList	Specifies image list associated with the text source.
Items	Lists the embedded objects.

Links

Classes, Legend, Members, Topics, TecEmbeddedObjects Methods, TecEmbeddedObjects Properties, IecExternalFormatter Methods, TSyntTextSource Properties

Contents | Index

What do you think about this topic? Send feedback!