Show / Hide Table of Contents

Namespace Sdl.DesktopEditor.EditorApi

Classes

ActiveRowChangedEventArgs

Information passed in the ActiveRowChanged event.

AfterEditControlsCreatedEventArgs

Event arguments used when the edit controls have been created by the ISideBySideEditor.

AfterInitialUpdateEventArgs

Arguments passed in the AfterInitialUpdate event.

ChangeNotAllowedException

Base class of exceptions thrown when attempting to change an object that must not be changed.

ContentHeightChangedEventArgs

Arguments passed in the ContentHeightChanged event.

ContentNodeIterator

Helper class to iterate over content nodes in the editor API.

ContentRange

Spans a set of content in a document. Used when performing operations on the document content.

CustomColumnContentChangedEventArgs

Information communicated from a custom column implementation when one or more of its cells have changed.

DocumentContentChangedEventArgs

Information about a change in document content

DocumentPropertiesChangedEventArgs

Information passed in the UpdateDocumentProperties(IDocumentProperties) event.

EditControlEventArgs

Optional base class for event args relating to an edit control. Holds a reference to the edit control.

EditException

Exception that may be thrown by operations in the editor API.

EditOperationAbortedEventArgs

Information about an aborted edit operation.

EditOperationCompletingEventArgs

Information passed in the EditOperationCompleting event.

FilePropertiesChangedEventArgs

Information passed in the FilePropertiesChanged event.

FocusedControlChangedEventArgs

Information passed to the FocusedControlChanged event.

FormattingBuilderVisitor

Framework node visitor that compiles a formattings stack representing the current formatting for a node.

FrameworkDocumentContentChangedEventArgs

Information passed to the ContentChanged event, including information about the exact edit operations affecting the document.

FrameworkNodeWrapperVisitor

Visitor used to build framework wrapper nodes for markup data items.

InvalidEditOperationException

Exception thrown by API clients handling the EditOperationCompleting event to prevent interactive editing operations from completing.

MarkupDataNodeFinder

Helper class that can be used with Find(Predicate<INode>, Boolean) to locate markup data nodes.

MouseEnteringNodeEventArgs

Information passed to the MouseEnteringNode event.

MouseLeavingNodeEventArgs

Argument type passed in the MouseLeavingNode event.

MouseOverTextMarksChangedEventArgs

Information sent with the event that is fired when the mouse moves over a text mark or a group of text marks. See MouseEnteringTextMarks and MouseLeavingTextMarks.

OverwriteModeChangedEventArgs

Event arguments used when the user changes the overwrite mode in the edit control.

ParagraphUnitPropertiesChangedEventArgs

Information passed in the ParagraphUnitPropertiesChanged event.

PersistentScrollInfoChangedEventArgs

Arguments passed in the PersistentScrollInfoChanged event.

RowChangedEventArgs

Information passed in events that involves changes to a row.

RowsChangedEventArgs

Information passed in events that involve changes to collections of rows in the edit control, e.g. HighlightedRowsChanged.

SegmentPropertiesChangedEventArgs

Information passed in the SegmentPropertiesChanged event.

SelectionChangedEventArgs

Arguments passed in the SelectionChanged event.

SourceEditingModeEndedEventArgs

Event arguments used when a source editing operation is ened.

SourceEditingModeStartedEventArgs

Event arguments used when a source editing operation is ened.

UndoBufferContentChangedEventArgs

Information about a change in the undo buffer.

Interfaces

IAbstractContainerNode

A node in the document that can contain other nodes.

IAbstractContentNode

Abstract base for all "leaf nodes" in the API. These are the nodes that can represent actual content items in the edit control.

IAbstractEditOperation

Base interface implemented by edit operations.

IAbstractFrameworkDocument

Base interface for documents used by filter framework specific edit controls.

IAbstractFrameworkEditControl

Base interface for filter framework specific edit controls such as the IFrameworkEditControl and the ISegmentEditControl.

IAbstractNode

Base interface for all nodes in the editor document content and document fragment content.

IBilingualDocument

Contains all the data required to display a document in the side-by-side edit control.

IBookmarkNode

A leaf node representing a temporary bookmark.

IChangeableBookmarkNode

A changeable bookmark node, e.g. as used in a document fragment.

IChangeableCommentContainerNode

A changeable comment container node

IChangeableContainerNode

A container node that is part of a document fragment and which can be freely changed directly through the APIs.

IChangeableDocumentContainerNode

A changeable document container node - should currently not be used anywhere, except if the document start/end node is copied into a document fragment.

IChangeableFileContainerNode

A changeable file container node, e.g. as used in a document fragment.

IChangeableLocationMarkerNode

A changeable location marker node, e.g. as used in a document fragment.

IChangeableLockedContentContainerNode

A changeable locked content node, e.g. as used in a document fragment.

IChangeableMarkerContainerNode

A changeable generic marker container node, e.g. as used in a document fragment.

IChangeableNode

A node in a document fragment, which can be freely moved around and changed directly using the API (as opposed to nodes that appear inside a document).

IChangeableParagraphUnitContainerNode

A changeable ParagraphUnit node, e.g. as used in a document fragment.

IChangeablePlaceholderTagNode

A changeable placeholder tag node, e.g. as used in a document fragment.

IChangeableRevisionMarkerContainerNode

A changeable revision marker container node.

IChangeableSegmentContainerNode

A changeable segment container node, e.g. as used in a document fragment.

IChangeableStartEndNode

A changeable start/end node, e.g. as used in a document fragment.

IChangeableTagPairContainerNode

A changeable tag pair node, e.g. as used in a document fragment.

IChangeableTextNode

A changeable text node, e.g. as used in a document fragment.

IChangeGhostStatusOperation

Represents an operation that changed the ghost status of a start/end node.

IChangeTextOperation

Represents an edit operation that changed the text in a text node.

Interface representing a self-executing command in the undo buffer. This command type is responsible for controlling its own execution and un-execution. This command will be stored and executed at the highest commander level. The commander will call the Do() and Undo() methods as required - they should not be called before adding to the undo buffer.

ICommentContainerNode

Node that provides access to a comment marker

IContentSelection

The currently selected content in the edit control.

The selection is represented by two positions: From and Upto, where the from position is the start of the selection and the upto position is the active end of the selection, i.e. the end that typically moves when the user presses Shift + arrow keys, or selects text using the mouse.

When no content is selected the from and upto positions are the same. This can be tested through the IsEmpty property of the selection.

The selection can be made empty by explicitly calling CollapseToFrom() and CollapseToUpto().

The from position does not need to be before the upto position. This can happen e.g. if the user selects text starting from the right and moving left in the document. In such cases the selection is said to be reversed. This can be tested through the IsReversed property of the selection.

The from and upto positions of the selection can be swapped by calling the Reverse() method. Calling the Normalize() method ensures that the from position in the selection is not after the upto position, by testing if the selection is reversed and in that case reversing it.

The selection can be explicitly moved through the methods Move(Move, Boolean) and MoveTo(Position, Boolean).

The selection is never null but may not always be valid. Use IsValid to test whether the selection is in a safe state to use.

IControl

This interface provides access to the Windows forms Control implementation.

ICustomColumn

Base interface implemented by custom columns that can appear to the left and right of an edit control.

IDeleteNodeOperation

Represents an edit operation that deleted a node.

IDocument

The document is the container for all data displayed in the editor.

IDocumentContainerNode

The root container node in a document.

IDocumentFragment

A "disconnected" piece of document content that can be manipulated as a standalone unit without affecting the actual document content.

IEditControl

The edit control root interface. Provides access to the selection, the Undo buffer and a number of properties that control the display and behaviour of the editor.

IEditOperationVisitor

Visitor interface for edit operations.

IFileContainerNode

Container node that spans the entire content of a file, as represented in the editor.

IFind

This interface provides functionality for searching the document, for example, a "find and replace" feature.

IFindProperties

Properties used to describe the search that is being performed.

IFrameworkDocument

Document used with IFrameworkEditControl. Represents source or target content in a bilingual document.

IFrameworkEditControl

Source or target language edit control in the ISideBySideEditor control.

IInsertNodeOperation

Represents an edit operation that inserted a node.

IInteractiveCustomColumn

Interface implemented by custom columns in the edit control that support user interaction.

ILayoutSynchronizer

Ensures the synchronization of rows between multiple components. This is used, for example, to synchronise the rows in the source and target edit controls within the side-by-side editor.

ILocationMarkerNode

Framework specific locaiton marker node.

ILockedContentContainerNode

An IAbstractContainerNode implementation to hold locked content and allow it to be processed like any other container node.

IMarkupDataNode

An editor API node that directly represents a markup data item in the filter framework.

INode

Common interface implemented by all filter framework specific nodes in the editor.

INodeFactory

Factory used to create new editor nodes through the document fragment in the editor API.

INodeVisitor

Visitor interface for all types of filter framework editor specific nodes.

IOtherMarkerContainerNode

Framework specific container node representing a custom marker.

IParagraphUnitContainerNode

A ParagraphUnit in the editor.

IPlaceholderNode

A standalone placeholder leaf node in the editor.

IPlaceholderTagNode

Placeholder tag in the editor.

IRevisionMarkerContainerNode

A bilingual API revision marker in the editor.

IRowInfo

Information associated with a row in the edit control. A row is a layout concept that is independent of, but related to, the structure of the document. For example, a row can be related to a segment in the document or it could be related to the content between the start of a paragraph and the start of the first segment. It could also relate to the content between segments.

The layout engine in the edit control works on a row-by-row basis and will update the layout of rows as they become invalid. Rows can also be visible or hidden, depending on different settings and display filters, or whether they only contain content that the user should never see (e.g. segment and paragraph tags).

ISegmentContainerNode

Source or target language segment in the editor.

ISegmentDocument

Data container used with ISegmentEditControl.

ISegmentEditControl

Edit control for displaying and (optionally) editing content of a markup data container, such as a segment.

ISideBySideEditor

The side-by-side editor control that coordinates things between the source and target language edit controls that appear side by side inside this control.

IStartEndNode

A start or end node in a IAbstractContainerNode.

ISynchronizableCell

Describes a piece of document content (a segment, a paragraph unit, ...) that can be passed to the Layout Synchronizer. Typically this content is represented by some kind of cell in the layout.

ISynchronizableLayout

A control must implement this interface if synchronized scrolling of rows between this control and other controls through the is required.

ITagPainter

Interface implemented by components that provide customized rendering of tags in the edit control.

ITagPaintingProperties

This interface provides the properties used when painting tags in the document.

ITagPairContainerNode

A tag pair in the editor.

ITextIterator

This iterator can be used to iterate in a text editing fashion in the edit control.

ITextMark

Represents a mark for a range of content in an edit control. Marks are used to highlight specific areas of document content in the edit control. For example, spelling errors and comments use marks to draw users attention to those areas.

ITextMarkPainter

Draw marks for ranges of content an edit control.

ITextNode

A piece of text in the editor API.

ITreeNode<NodeType, ContainerType>

Generic tree node. Provides accessors to Parent and Sibling nodes.

IUndoBuffer

Information about the undo/redo commands for content changes in the edit control.

IUndoCommand

Base interface for commands that are added to the undo buffer. A command is any operation that the undo buffer must be aware of and manage.

Delegates

ContentRange.ReductionAllowedTest

This delegat defines the method signature used by the ReduceRanges(List<ContentRange>, ContentRange.ReductionAllowedTest) helper to determine if two ranges that have the same parent can be merged.

Namespace Sdl.DesktopEditor.EditorApi

Classes

Interfaces

Enums

Delegates