Overview and description of Leadtools Document Editor classes, enumerations, and interfaces.
Class | Description | |
---|---|---|
Attribute | Represents a single instance of an attribute. | |
Attributes | Defines an Attribute collection. | |
BlockPiece | Represents a significant structural component such as paragraphs, tables, or any other block piece element. | |
Cell | Represents an instance of a cell. | |
ChordBinding | Represents a chord binding, a series of bindings that must be executed in a particular order. | |
ContextModule | This module is responsible for presenting contextual data about the current state of the Document Editor. This entails returning styling information for Runs. | |
DocumentEditor | Provides support for editing Documents in a browser | |
DocumentSearch | Defines a DocumentSearch object. | |
EditableContent | Represents an instance of the editable content in the current editor. | |
EditableDocument | Defines the data for the document that is editable. | |
EditingEngine | Defines the engine instance to use for document editing. | |
EditingModule | Defines a disposable editing module. | |
EditPosition | An EditPosition describes a specific location in a document. | |
EditRange | An EditRange describes a range of positions in a document. The location is only valid in context with the current state of the document at the time. | |
EngineModule | The EngineModule is responsible for interoping with the EditingEngine to apply operations to the document. | |
EngineOptions | Represents the options needed to handle the history tracking and records. | |
HistoryManager | A class represents the functionality to handle redo and undo operations occurred. | |
HistoryModule | Extends the EditingModule with additional fields and methods. | |
HistoryRecord | Holds all information pertaining to a single History entry. | |
ImageEngine | Defines the properties and methods of the ImageEngine Object. | |
ImagePiece | Defines the ImagePiece object which extends the ObjectPiece class. | |
InternalImage | Defines an InternalImage collection which implements ObjectLineContent. | |
KeyboardModule | Defines a KeyboardModule collection. | |
LayoutService | Defines a LayoutService collection. | |
List | Defines a List collection that implements Attributor. | |
ListLevel | Defines a ListLevel collection that implements Attributor. | |
ListManager | Defines a List Manager collection. | |
Marginal | Represents an editable portion of content that is situated in the margin, such as headers and footers. | |
MarginalManager | Handles marginal information for the current EditingEngine context. | |
Marginals | Holds all marginal objects pertaining to the document , obtained from the MarginalManager Object. | |
MovementModule | Handles cursor movement and selection in the DocumentEditor Object. | |
ObjectPiece | Represents an external resource that is present in the document. | |
OutputImage | Represents an image with a ContentType type and an ObjectContractType objectType. | |
OutputLine | Represents the line that an OutputImage will be on. | |
OutputParagraph | Defines an OutputParagraph collection. | |
ParagraphBlock | Defines a BlockPiece collection. | |
Piece | The base class of all piece objects. | |
PieceManager | Manages the keys for a Piece object's validators. | |
PieceStructure | Controls the number, order, and position of all the Piece objects within a document. | |
PrintingModule | Allows the DocumentEditor to print its current document. | |
QueryManager | Searches for and retrieves the data of blocks, paragraphs, and sections from the document. | |
QueryOptions | Determines which data populates the QueryResults object. | |
RecordOperation | Records an operation performed in a document. | |
StandardBinding | Represents a simple keybinding. This consists of modifier keys, for example: ctrl, shift, alt, meta + a keycode. | |
StandardKeyboardEvent | Extends the IKeyboardEvent interface with additional properties and fields. | |
TableBlock | Extends BlockPiece adding more properties and methods. | |
TableEngine | Defines an engine for editing tables, rows, columns, and cells in a document. | |
TextBuffer | Holds all of the text content of a document along with any text added after the document is opened. | |
TextEngine | Defines the methods and properties for the TextEngine object. | |
TextPiece | Defines a text piece in the editor's content. | |
TreeNode | Defines a tree structure of nodes for this editor. |
Interface | Description | |
---|---|---|
AttributeData | Contains data for the Attribute. | |
Attributor | Provides the editor's frame work for the Attributes collection. | |
AttrKeyValidator | Provides the editor's frame work for the AttrKeyValidator-Validator collection. | |
BlockContent | Provides the editor's frame work for the BlockContent-children collection. | |
CellBorder | Describes the cell border for the cell. | |
CellCoordinate | Describes the location of the active cell in the table. | |
CellData_2 | Describes the cell data context for the editor. | |
CellFormatData | Defines the cell format in the current editor. | |
CellPoint | Describes the cell point location in the current editor. | |
Cloneable | Defines a contract for implementing a cloneable object. | |
CommonContract | Defines a common contract for this editor to keep consistency between objects. | |
Disposable | Defines a contract for implementing a disposable object. | |
DocumentEditorIniData | Defines the editor's initial data. | |
Font | Describes the font context for the editor. | |
FontData | Describes the font context for the editor. | |
IEngineOptions | Represents the options needed to handle the history tracking and records. | |
IKeyboardEvent | Interface describing the structure of a Keyboard event. | |
ImageContract | Defines the properties for implementors of the ImageContract Interface. | |
ImageData | Defines the properties for implementors of the ImageData Interface. | |
InternalLineContent | Defines the properties and methods of the InternalLineContent Interface for implementation. | |
ListData_2 | Defines the list data in the current editor. | |
ListLevelRecordData | Defines the list level record data in the current editor. | |
MarginalOptions | Contains creation options for the Marginal Object. | |
MovementData | Describes a point in the document, such as the cursor location. | |
ObjectLineContent | Represents the spacing its content, such as a table or image, is taking up. | |
OutputLineContent | Defines the output line content in the current editor. | |
OutputObjectContent | Defines the output object content, which is extending OutputLineContent, in the current editor. | |
OutputParagraphSearchResult | Defines the output paragraph search result in the current editor. The sub-elements bound to the search are result and compressed. | |
ParagraphContentContract | Defines the paragraph content contract in the current editor. The sub-elements bound to the paragraph are type and contract. | |
ParagraphContract | Defines the paragraph contract in the current editor. The sub-elements bound are:- font- alignment- lineSpacing- FfirstLineIndent- rightIndent- leftIndent- spaceAfter- spaceBefore- content- tabStops- anchoredImages | |
QueryResults | Contains the retrieved data from calling the QueryManager's methods. | |
Rect | Defines the properties and methods for implementors for a rectangle object. | |
SearchResult | Defines the properties and methods for implementors of a search result object for a DocumentSearch Object. | |
SerializedAttribute | Defines the properties and methods for implementors for a serialized Attribute object. | |
SerializedBlockPiece | Provides the editor's frame work to implement a serialized BlockPiece object which is used to define. | |
SerializedEngine | Defines the properties and methods for implementors of a serialized EditingEngine interface. | |
SerializedList | Defines the properties and methods for implementors of a serialized List interface. | |
SerializedListLevel | Defines the properties and methods for implementors of a serialized ListLevel interface. | |
SerializedPiece | Defines the properties and methods for implementors of the serialized Piece Interface. | |
StandardBindingOptions | Constructor options for the StandardBinding class. | |
StructLocation | Defines the properties for implementors of the StructLocation, being the document structure, Interface. | |
TableData | Defines the properties and methods for the implementors of the TableData Interface. |
Enumeration | Description | |
---|---|---|
ActiveMarginalFlag | Bitwise flag describing which page header and footer regions should be used for the document. | |
ActiveRegion | Describes the current region in the active document. | |
AlignmentType | Describes how the content should be aligned. | |
AttributeType | Defines the attribute type in the current editor. Used in ensuring an attribute collection is a specified type for typescript or consistency. | |
BlockType | Defines the block type in the document. | |
BorderRegion | Defines the border region to style. | |
BorderStyle | Defines the border style for the element. | |
CellStatus | Defines the cell status type in the current editor. | |
ColumnLocation | Defines the column location in the table. | |
ContentType | Defines the content type for this object. | |
EditorEvent | Defines the type of editor event. | |
EditRegion | Defines the edit region for the document. | |
ImageStyle | Defines the inline, breakText, and wrapText properties. | |
KeyCode | Virtual representation of key codes. This should help with cross browser/platform compatibility. | |
ListBulletPresets | Defines the list bullet presets in the current editor. | |
MarginalPosition | Represents which page the marginal should be used on. | |
MarginalType | Represents the Marginal type. | |
ObjectContractType | Represents what the type the object is, being either a table or an image. | |
ObjectType | Represents the type of an ObjectPiece object. | |
Orientation | Describes the orientation of the document. | |
PieceType | Defines the Piece type. | |
RecordType | Defines the operation type for a RecordOperation object. | |
RowLocation | Defines the row location relative to a specified cell for a TableBlock object's methods. | |
ScriptType | Describes the script type for the text. | |
StrikethroughType | Describes the type of strikethrough line that should be used. | |
TableAlignment | Describes the table alignment. | |
TreeNodeColor | Defines the color of the tree structure. | |
UnderlineType | Defines the underline type to use for the text. | |
ViewMode | Defines whether the editor allows content editing. |