Back to Devexpress

IdxRichEditSubDocument.Delete(IdxRichEditDocumentRange) Method

vcl-dxrichedit-dot-nativeapi-dot-idxricheditsubdocument-dot-delete-x28-dxrichedit-dot-nativeapi-dot-idxricheditdocumentrange-x29.md

latest2.8 KB
Original Source

IdxRichEditSubDocument.Delete(IdxRichEditDocumentRange) Method

Deletes the specified text range from the document.

Declaration

delphi
procedure Delete(const ARange: IdxRichEditDocumentRange);

Parameters

NameTypeDescription
ARangeIdxRichEditDocumentRange

The deleted document range.

|

Remarks

Call the Delete procedure to delete a document range.

Code Example: Delete Selected Text

The following code example deletes all selected text ranges:

delphi
var
  ADocument: IdxRichEditDocument;
  I: Integer;
begin
  ADocument := dxRichEditControl1.Document;
  ADocument.BeginUpdate;
  for I := ADocument.Selections.Count - 1 downto 0 do // Iterates through all selected document ranges
    ADocument.Delete(ADocument.Selections[I]);
  ADocument.EndUpdate; // Applies all pending changes to the document and unlocks document updates
end;
cpp
_di_IdxRichEditDocument ADocument;
  // ...
  ADocument = dxRichEditControl1->Document;
  ADocument->BeginUpdate(); // Locks the document updates and starts recording an edit user action
  for(int i = ADocument->Selections->Count - 1; i >= 0; i--) // Iterates through all selected document ranges
    ADocument->Delete(ADocument->Selections[I]);
  ADocument->EndUpdate(); // Applies all pending changes to the document and unlocks document updates

See Also

IdxRichEditSubDocument.AppendRtfText

IdxRichEditSubDocument.AppendSingleLineText

IdxRichEditSubDocument.AppendText

IdxRichEditSubDocument.InsertRtfText

IdxRichEditSubDocument.InsertSingleLineText

IdxRichEditSubDocument.InsertText

IdxRichEditSubDocument Interface

IdxRichEditSubDocument Members

dxRichEdit.NativeApi Unit