Version

FormattedTextEditInfo Class Members

The following tables list the members exposed by FormattedTextEditInfo.

Public Properties
 NameDescription
Public PropertyEditorBackward pointer to the FormattedLinkEditor instance.  
Public PropertyIsIMECompositionActiveGets the value which determines whether an IME composition is currently being edited by the user.  
Public PropertySelectionLengthLength of the selection.  
Public PropertySelectionStartStart of the selection.  
Public Methods
 NameDescription
Public MethodApplyStyleApplies the specified style to the current selection.  
Public MethodBeginUndoTransactionBegins a transaction for the undo stack that optionally takes a snapshot.  
Public MethodCanMakeSelectionIntoLinkReturns true if the current selection can be made into a link.  
Public MethodCanPerformActionReturns true if the specified action can be performed based on the current state of the control.  
Public MethodClearAllStyleAttributesClears all the style attributes on the selected contents.  
Public MethodClearStyleAttributesOverloaded. Clears the specified style attributes on the selected contents.  
Public MethodClearUndoRedoHistoryClears the Undo/Redo history of the editor  
Public MethodCopyCopies the selected content.  
Public MethodCutPerforms a Cut operation on the selected content. Cut operation involves copying the selected contents into the clipboard and then deleting them.  
Public MethodDecodeImageDecodes the specified image data that was encoded using EncodeImage into an image.  
Public MethodDeletePerforms the 'Delete' edit operation. If some contents are selected then the selection is deleted. Otherwise the next item (character, image etc...) at current caret position is deleted. This method emulates Delete key press.  
Public MethodDisposeDisposes the object.  
Public MethodEncodeImageEncodes the specified image into a string that can be embedded inside the formatted text. The returned value can be assigned to the 'data' attribute of the 'img' tag to embedd the image directly inside the formatted text value.  
Public MethodEndUndoTransactionEnds an undo transaction and optionally stores the undo snapshot in memory (if any).  
Public MethodFindTextReports the zero-based index of the first occurrence of the specified string in the editor's current text. The search starts from the current selection.  
Public Methodstatic (Shared in Visual Basic)FormatStringFromFontStyleReturns a string which can be used by the ApplyStyle method to apply a font style, i.e., bold, italic, etc.  
Public MethodGetCaretLocationReturns the location of the caret at the specified caret position.  
Public MethodGetCaretPositionFromMouseLocationGets the caret position closest to the specified mouse location.  
Public MethodGetCurrentStyleReturns the current style. If some contents are selected, this will be the style attributes that are common to all of the selected contents. If nothing is selected, then gets the state style attributes. State style attributes are those state attributes that are maintained as a result of toggling bold, italic etc... when nothing is selected. These state style attributes are cleared when the caret is moved since when the caret is moved, the attributes of the content where the caret is moved into are assumed as the current state attributes.  
Public MethodGetFirstCharPositionFromLineReturns the total number of lines in the control. This does account for word wrapping, but only accounts for inline objects.  
Public MethodGetLineCountReturns the total number of lines in the control. This does account for word wrapping, but only accounts for inline objects.  
Public MethodGetLineNumberReturns the 1-based index of the line to which the specified caret position belongs. This will work only if the caret position is associated with an inline object. If not then this method will return -1.  
Public MethodGetSelectedValueAsStringGets the selected value as formatted text. If nothing is selected, returns empty string.  
Public MethodGetSubstringOverloaded. Retrieves a substring from this controls text, similar to the System.String.Substring(System.Int32) method. The substring starts at a specified character position.  
Public MethodInsertValueInserts the specified value at the caret position. If the value cannot be inserted, an exception is thrown.  
Public MethodMakeSelectionIntoLinkMakes the current selection into a link. The specified value is the anchor tag that specifies link.  
Public MethodPastePastes the contents of the clipboard at the caret position.  
Public MethodPerformActionPerforms the specified action and returns true if the action can be performed.  
Public MethodResolveDefaultAppearanceResolves the default appearance. This is the appearance as specified by the owner without any style information provided by the xml tags.  
Public MethodResolveSelectedNodeAppearancesResolves the appearance of each of the selected nodes.  
Public MethodSelectAllSelects the entire contents of the editor.  
Public MethodShowFontDialogDisplays the font dialog changing the font.  
Public MethodShowImageDialogDisplays the image dialog.  
Public MethodShowLinkDialogDisplays the link dialog.  
See Also