IdxRichEditSubDocument Members

Exposes the basic functionality related to document elements.

Properties

Name	Description
Bookmarks	Provides access to the collection of bookmarks in a document.
Fields	Provides access to the collection of document fileds.
Hyperlinks	Provides access to the collection of hyperlinks in a document.
Images	Provides access to the collection of both inline and floating images in a document.
Length	Returns the current document length (in characters).
PageBackColor	Specifies the page background color.
Paragraphs	Provides access to a collection of paragraphs.
Range	Provides access to the current document’s range.
Shapes	Provides access to the collection of shapes (including floating images and text boxes) in a subdocument.
ShowPageBackground	Specifies if the page background color is displayed.
Tables	Provides access to the collection of tables in the document.

Methods

Name	Description
AddParagraphsToList(IdxRichEditDocumentRange,IdxRichEditNumberingList,Integer)
AddParagraphToList(IdxRichEditParagraph,IdxRichEditNumberingList,Integer)
AddParagraphToList(IdxRichEditParagraph,Integer,Integer)
AppendDocumentContent(IdxRichEditDocumentRange,TdxRichEditInsertOptions)
AppendDocumentContent(IdxRichEditDocumentRange)
AppendDocumentContent(TStream,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions)
AppendDocumentContent(TStream,TdxRichEditDocumentFormat,string)
AppendDocumentContent(TStream,TdxRichEditDocumentFormat)
AppendDocumentContent(string,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions)
AppendDocumentContent(string,TdxRichEditDocumentFormat,string)
AppendDocumentContent(string,TdxRichEditDocumentFormat)
AppendImage(TGraphic)	Inserts a specified inline picture to the end of a subdocument.
AppendParagraph	Inserts an empty paragraph to the end of a subdocument.
AppendRtfText(string,TdxRichEditInsertOptions)	Appends a formatted text string to the end of a subdocument.
AppendSingleLineText(string)	Adds a single line of text to the end of a subdocument.
AppendText(string)	Adds the specified text string to the end of a subdocument.
BeginUpdate	Stops document redraw operations until an EndUpdate procedure call.
BeginUpdateCharacters(IdxRichEditDocumentPosition,Integer)	Starts to update character properties of the document range defined by its length and position in a document.
BeginUpdateCharacters(IdxRichEditDocumentRange)	Starts to update character properties of the specified document range.
BeginUpdateCharacters(Integer,Integer)	Starts to update character properties of the document range defined by its length and position in a document.
BeginUpdateParagraphs(IdxRichEditDocumentRange)	Starts to update the properties of one or more paragraphs to which the specified document range belongs.
BeginUpdateRangePermissions
CancelUpdateRangePermissions(IdxRichEditRangePermissionCollection)
CreateBookmark(IdxRichEditDocumentPosition,Integer,string)
CreateBookmark(IdxRichEditDocumentRange,string)	Creates a bookmark for the specified document range.
CreateHyperlink(IdxRichEditDocumentPosition,Integer)
CreateHyperlink(IdxRichEditDocumentRange)	Creates a hyperlink for the specified document range.
CreatePosition(Integer)
CreateRange(IdxRichEditDocumentPosition,Integer)
CreateRange(Integer,Integer)
Delete(IdxRichEditDocumentRange)	Deletes the specified text range from the document.
EndUpdate	Applies all changes made after a BeginUpdate procedure call and unlocks document updates.
EndUpdateCharacters(IdxRichEditCharacterProperties)	Applies the character property changes initiated by a BeginUpdateCharacters function call.
EndUpdateParagraphs(IdxRichEditParagraphProperties)	Applies the pending paragraph property changes initiated by a BeginUpdateParagraphs function call.
EndUpdateRangePermissions(IdxRichEditRangePermissionCollection)
FindAll(TRegEx,IdxRichEditDocumentRange)
FindAll(string,TdxRichEditSearchOptions,IdxRichEditDocumentRange)
GetBookmarks	Returns the current document’s bookmark collection.
GetFields	Returns the current document’s field collection.
GetHyperlinks	Returns the current document’s hyperlink collection.
GetImages
GetImages(IdxRichEditDocumentRange)
GetLength	Returns the document’s absolute length (in characters).
GetOpenXmlBytes(IdxRichEditDocumentRange)	Returns the content of the specified document range in Office Open XML (DOCX) format.
GetPageBackColor	Returns the current page background color.
GetParagraph(IdxRichEditDocumentPosition)	Returns the paragraph encompassing the specified document position.
GetParagraphs
GetParagraphs(IdxRichEditDocumentRange)
GetRange
GetRtfText(IdxRichEditDocumentRange)
GetShapes
GetShapes(IdxRichEditDocumentRange)
GetShowPageBackground
GetSubDocumentType	Returns the current subdocument type.
GetTables
GetText(IdxRichEditDocumentRange,TdxRichEditTextFragmentOptions)
GetText(IdxRichEditDocumentRange)
InsertDocumentContent(IdxRichEditDocumentPosition,IdxRichEditDocumentRange,TdxRichEditInsertOptions)
InsertDocumentContent(IdxRichEditDocumentPosition,IdxRichEditDocumentRange)
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,TdxRichEditInsertOptions)
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions)
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat,string)
InsertDocumentContent(IdxRichEditDocumentPosition,TStream,TdxRichEditDocumentFormat)
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,TdxRichEditInsertOptions)
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,string,TdxRichEditInsertOptions)
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat,string)
InsertDocumentContent(IdxRichEditDocumentPosition,string,TdxRichEditDocumentFormat)
InsertImage(IdxRichEditDocumentPosition,TGraphic)	Inserts an inline picture at the specified position in the parent document.
InsertParagraph(IdxRichEditDocumentPosition,TdxRichEditInsertOptions)
InsertParagraph(IdxRichEditDocumentPosition)
InsertPicture(IdxRichEditDocumentPosition,TGraphic)	Inserts a floating picture at the specified position within the document.
InsertRtfText(IdxRichEditDocumentPosition,string,TdxRichEditInsertOptions)
InsertSingleLineText(IdxRichEditDocumentPosition,string)
InsertTable(IdxRichEditDocumentPosition,Integer,Integer,TdxRichEditAutoFitBehaviorType,Integer)
InsertText(IdxRichEditDocumentPosition,string)	Inserts a text string at the specified position within the document.
InsertTextBox(IdxRichEditDocumentPosition)	Inserts a floating text box at the specified position within the document.
RemoveBookmark(IdxRichEditBookmark)	Removes the specified bookmark from a subdocument.
RemoveHyperlink(IdxRichEditHyperlink)	Removes the specified hyperlink from a subdocument.
RemoveNumberingFromParagraph(IdxRichEditParagraph)
RemoveNumberingFromParagraphs(IdxRichEditDocumentRange)
Replace(IdxRichEditDocumentRange,string)	Replaces the specified document range with a provided text string.
ReplaceAll(TRegEx,string,IdxRichEditDocumentRange)
ReplaceAll(string,string,TdxRichEditSearchOptions,IdxRichEditDocumentRange)
SelectAll	Selects everything within the current document.
SelectBookmark(IdxRichEditBookmark)	Selects a document range associated with the specified bookmark.
SetPageBackColor(TdxAlphaColor)
SetShowPageBackground(Boolean)
StartSearch(TRegEx,IdxRichEditDocumentRange)
StartSearch(string,TdxRichEditSearchOptions,TdxRichEditSearchDirection,IdxRichEditDocumentRange)