Skip to main content

IdxRichEditDocument Methods

Exposes the Rich Edit control functionality.
Name Description
AddParagraphsToList(IdxRichEditDocumentRange,IdxRichEditNumberingList,Integer) Inherited from IdxRichEditSubDocument.
AddParagraphToList(IdxRichEditParagraph,IdxRichEditNumberingList,Integer) Inherited from IdxRichEditSubDocument.
AddParagraphToList(IdxRichEditParagraph,Integer,Integer) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(IdxRichEditDocumentRange,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(TStream,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(TStream,TdxRichEditDocumentFormat,string) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(TStream,TdxRichEditDocumentFormat) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(string,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(string,TdxRichEditDocumentFormat,string) Inherited from IdxRichEditSubDocument.
AppendDocumentContent(string,TdxRichEditDocumentFormat) Inherited from IdxRichEditSubDocument.
AppendImage(TGraphic) Inserts a specified inline picture to the end of a subdocument. Inherited from IdxRichEditSubDocument.
AppendParagraph Inserts an empty paragraph to the end of a subdocument. Inherited from IdxRichEditSubDocument.
AppendRtfText(string,TdxRichEditInsertOptions) Appends a formatted text string to the end of a subdocument. Inherited from IdxRichEditSubDocument.
AppendSection Appends a new section to the document.
AppendSingleLineText(string) Adds a single line of text to the end of a subdocument. Inherited from IdxRichEditSubDocument.
AppendText(string) Adds the specified text string to the end of a subdocument. Inherited from IdxRichEditSubDocument.
BeginUpdate Stops document redraw operations until an EndUpdate procedure call. Inherited from IdxRichEditSubDocument.
BeginUpdateCharacters(IdxRichEditDocumentPosition,Integer) Starts to update character properties of the document range defined by its length and position in a document. Inherited from IdxRichEditSubDocument.
BeginUpdateCharacters(IdxRichEditDocumentRange) Starts to update character properties of the specified document range. Inherited from IdxRichEditSubDocument.
BeginUpdateCharacters(Integer,Integer) Starts to update character properties of the document range defined by its length and position in a document. Inherited from IdxRichEditSubDocument.
BeginUpdateParagraphs(IdxRichEditDocumentRange) Starts to update the properties of one or more paragraphs to which the specified document range belongs. Inherited from IdxRichEditSubDocument.
BeginUpdateRangePermissions Inherited from IdxRichEditSubDocument.
CancelUpdateRangePermissions(IdxRichEditRangePermissionCollection) Inherited from IdxRichEditSubDocument.
ChangeActiveDocument(IdxRichEditSubDocument)
Copy
Copy(IdxRichEditDocumentRange) Copies the specified document range or selection(s) to the clipboard.
CreateBookmark(IdxRichEditDocumentPosition,Integer,string) Inherited from IdxRichEditSubDocument.
CreateBookmark(IdxRichEditDocumentRange,string) Creates a bookmark for the specified document range. Inherited from IdxRichEditSubDocument.
CreateHyperlink(IdxRichEditDocumentPosition,Integer) Inherited from IdxRichEditSubDocument.
CreateHyperlink(IdxRichEditDocumentRange) Creates a hyperlink for the specified document range. Inherited from IdxRichEditSubDocument.
CreateMailMergeOptions Creates a container for settings usable in mail merge operations.
CreateNewDocument Closes the opened document and creates a new blank document.
CreatePosition(Integer) Inherited from IdxRichEditSubDocument.
CreateRange(IdxRichEditDocumentPosition,Integer) Inherited from IdxRichEditSubDocument.
CreateRange(Integer,Integer) Inherited from IdxRichEditSubDocument.
Cut
Cut(IdxRichEditDocumentRange) Cuts the specified document range or selection(s) to the clipboard.
Delete(IdxRichEditDocumentRange) Deletes the specified text range from the document. Inherited from IdxRichEditSubDocument.
EndUpdate Applies all changes made after a BeginUpdate procedure call and unlocks document updates. Inherited from IdxRichEditSubDocument.
EndUpdateCharacters(IdxRichEditCharacterProperties) Applies the character property changes initiated by a BeginUpdateCharacters function call. Inherited from IdxRichEditSubDocument.
EndUpdateParagraphs(IdxRichEditParagraphProperties) Applies the pending paragraph property changes initiated by a BeginUpdateParagraphs function call. Inherited from IdxRichEditSubDocument.
EndUpdateRangePermissions(IdxRichEditRangePermissionCollection) Inherited from IdxRichEditSubDocument.
FindAll(TRegEx,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
FindAll(string,TdxRichEditSearchOptions,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetAbstractNumberingLists
GetActiveSubDocument
GetBookmarks Returns the current document’s bookmark collection. Inherited from IdxRichEditSubDocument.
GetCaretPosition Returns the caret position within the opened document.
GetCharacterStyles
GetDefaultCharacterProperties
GetDefaultParagraphProperties
GetDefaultTableProperties
GetDocBytes Returns the document’s content as a series of bytes in the DOC binary format.
GetFields Returns the current document’s field collection. Inherited from IdxRichEditSubDocument.
GetHyperlinks Returns the current document’s hyperlink collection. Inherited from IdxRichEditSubDocument.
GetImages Inherited from IdxRichEditSubDocument.
GetImages(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetIsDocumentProtected Returns a value indicating whether the document is protected from accidental modifications.
GetIsEmpty Returns a value indicating whether the document is empty.
GetLength Returns the document’s absolute length (in characters). Inherited from IdxRichEditSubDocument.
GetNumberingLists Returns the document’s numbering list collection.
GetOpenXmlBytes Returns the entire document content in Office OpenXML (DOCX) format.
GetOpenXmlBytes(IdxRichEditDocumentRange) Returns the content of the specified document range in Office Open XML (DOCX) format. Inherited from IdxRichEditSubDocument.
GetPageBackColor Returns the current page background color. Inherited from IdxRichEditSubDocument.
GetParagraph(IdxRichEditDocumentPosition) Returns the paragraph encompassing the specified document position. Inherited from IdxRichEditSubDocument.
GetParagraphs Inherited from IdxRichEditSubDocument.
GetParagraphs(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetParagraphStyles Returns the document’s paragraph style collection.
GetRange Inherited from IdxRichEditSubDocument.
GetRtfText Returns the entire document content as an RTF string.
GetRtfText(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetSection(IdxRichEditDocumentPosition) Returns the section that encompasses the specified position in the document.
GetSections Returns the document’s section collection.
GetSelection
GetSelections Returns the document’s selection collection.
GetShapes Inherited from IdxRichEditSubDocument.
GetShapes(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetShowPageBackground Inherited from IdxRichEditSubDocument.
GetSubDocumentType Returns the current subdocument type. Inherited from IdxRichEditSubDocument.
GetTables Inherited from IdxRichEditSubDocument.
GetTableStyles Returns the document’s style collection.
GetText Returns all text within the document as an unformatted text string.
GetText(IdxRichEditDocumentRange,TdxRichEditTextFragmentOptions) Inherited from IdxRichEditSubDocument.
GetText(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
GetUnit Returns the measurement unit used by the opened document.
GetVariables Returns the document’s variable collection.
HasEncryptionPassword Identifies if the opened document has an assigned encryption password.
InsertDocumentContent(IdxRichEditDocumentPosition,IdxRichEditDocumentRange,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,string) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,string) Inherited from IdxRichEditSubDocument.
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat) Inherited from IdxRichEditSubDocument.
InsertImage(IdxRichEditDocumentPosition,TGraphic) Inserts an inline picture at the specified position in the parent document. Inherited from IdxRichEditSubDocument.
InsertParagraph(IdxRichEditDocumentPosition,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertParagraph(IdxRichEditDocumentPosition) Inherited from IdxRichEditSubDocument.
InsertPicture(IdxRichEditDocumentPosition,TGraphic) Inserts a floating picture at the specified position within the document. Inherited from IdxRichEditSubDocument.
InsertRtfText(IdxRichEditDocumentPosition,string,TdxRichEditInsertOptions) Inherited from IdxRichEditSubDocument.
InsertSection(IdxRichEditDocumentPosition) Inserts a new section into the document at the specified position.
InsertSingleLineText(IdxRichEditDocumentPosition,string) Inherited from IdxRichEditSubDocument.
InsertTable(IdxRichEditDocumentPosition,Integer,Integer,TdxRichEditAutoFitBehaviorType,Integer) Inherited from IdxRichEditSubDocument.
InsertText(IdxRichEditDocumentPosition,string) Inserts a text string at the specified position within the document. Inherited from IdxRichEditSubDocument.
InsertTextBox(IdxRichEditDocumentPosition) Inserts a floating text box at the specified position within the document. Inherited from IdxRichEditSubDocument.
LoadDocument(TStream,TdxRichEditDocumentFormat,string) Imports a document from the specified stream.
LoadDocument(TStream,TdxRichEditDocumentFormat) Imports a document from the specified stream.
LoadDocument(string,TdxRichEditDocumentFormat,string) Imports a document from the specified file.
LoadDocument(string,TdxRichEditDocumentFormat) Imports a document from the specified file.
MailMerge(IdxRichEditDocument)
MailMerge(IdxRichEditMailMergeOptions,IdxRichEditDocument)
MailMerge(IdxRichEditMailMergeOptions,TStream,TdxRichEditDocumentFormat)
MailMerge(IdxRichEditMailMergeOptions,string,TdxRichEditDocumentFormat)
MailMerge(TStream,TdxRichEditDocumentFormat)
MailMerge(string,TdxRichEditDocumentFormat)
Paste
Paste(TdxRichEditDocumentFormat) Inserts the clipboard content into the opened document.
Protect(string) Enforces the opened document’s password protection from accidental changes.
RemoveBookmark(IdxRichEditBookmark) Removes the specified bookmark from a subdocument. Inherited from IdxRichEditSubDocument.
RemoveHyperlink(IdxRichEditHyperlink) Removes the specified hyperlink from a subdocument. Inherited from IdxRichEditSubDocument.
RemoveNumberingFromParagraph(IdxRichEditParagraph) Inherited from IdxRichEditSubDocument.
RemoveNumberingFromParagraphs(IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
Replace(IdxRichEditDocumentRange,string) Replaces the specified document range with a provided text string. Inherited from IdxRichEditSubDocument.
ReplaceAll(TRegEx,string,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
ReplaceAll(string,string,TdxRichEditSearchOptions,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
SaveDocument(TStream,TdxRichEditDocumentFormat) Exports the document to a stream.
SaveDocument(string,TdxRichEditDocumentFormat) Exports the document to a file.
SelectAll Selects everything within the current document. Inherited from IdxRichEditSubDocument.
SelectBookmark(IdxRichEditBookmark) Selects a document range associated with the specified bookmark. Inherited from IdxRichEditSubDocument.
SetCaretPosition(IdxRichEditDocumentPosition) Moves the caret to the specified position within the opened document.
SetDocBytes(TBytes) Replaces the document’s content with another document in the DOC binary format.
SetEncryptionPassword(string) Assigns an encryption password to the opened document.
SetOpenXmlBytes(TBytes) Replaces the document’s content with a series of bytes in the DOCX (OpenXML) document format.
SetPageBackColor(TdxAlphaColor) Inherited from IdxRichEditSubDocument.
SetRtfText(string) Replaces the current document’s content with the specified RTF-formatted string.
SetSelection(IdxRichEditDocumentRange)
SetShowPageBackground(Boolean) Inherited from IdxRichEditSubDocument.
SetText(string)
SetUnit(TdxRichEditDocumentUnit) Assigns a measurement unit to be used in the opened document.
StartSearch(TRegEx,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
StartSearch(string,TdxRichEditSearchOptions,TdxRichEditSearchDirection,IdxRichEditDocumentRange) Inherited from IdxRichEditSubDocument.
Unprotect Disables the document’s protection from accidental modifications.
See Also