The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

SubDocument.GetText(DocumentRange, PlainTextDocumentExporterOptions, TextFragmentOptions) Method

Returns the plain text of the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.2.Core.dll

Declaration

string GetText(
    DocumentRange range,
    PlainTextDocumentExporterOptions options,
    TextFragmentOptions getTextOptions
)
Function GetText(
    range As DocumentRange,
    options As PlainTextDocumentExporterOptions,
    getTextOptions As TextFragmentOptions
) As String
string GetText(
    DocumentRange range,
    PlainTextDocumentExporterOptions options,
    TextFragmentOptions getTextOptions
)
Function GetText(
    range As DocumentRange,
    options As PlainTextDocumentExporterOptions,
    getTextOptions As TextFragmentOptions
) As String
string GetText(
    DocumentRange range,
    PlainTextDocumentExporterOptions options,
    TextFragmentOptions getTextOptions
)
Function GetText(
    range As DocumentRange,
    options As PlainTextDocumentExporterOptions,
    getTextOptions As TextFragmentOptions
) As String

Parameters

Name Type Description
range DocumentRange

A DocumentRange object, specifying the range in the document for which the plain text representation is obtained.

options PlainTextDocumentExporterOptions

A PlainTextDocumentExporterOptions instance, containing options for plain text export.

getTextOptions TextFragmentOptions

A TextFragmentOptions object.

Parameters

Name Type Description
range DocumentRange

A DocumentRange object, specifying the range in the document for which the plain text representation is obtained.

options PlainTextDocumentExporterOptions

A PlainTextDocumentExporterOptions instance, containing options for plain text export.

getTextOptions TextFragmentOptions

A TextFragmentOptions object.

Parameters

Name Type Description
range DocumentRange

A DocumentRange object, specifying the range in the document for which the plain text representation is obtained.

options PlainTextDocumentExporterOptions

A PlainTextDocumentExporterOptions instance, containing options for plain text export.

getTextOptions TextFragmentOptions

A TextFragmentOptions object.

Returns

Type Description
String

A String value, containing the text of the specified range.

Returns

Type Description
String

A String value, containing the text of the specified range.

Returns

Type Description
String

A String value, containing the text of the specified range.

Remarks

Use this method to get a plain text representation of any part of the document. This method overload triggers export-related events as described in the following table:

Event Description
RichEditControl.BeforeExport Does not occur.
RichEditControl.AfterExport Does not occur.
Note

If you operate with a selection range, the GetText method should be combined with a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception "Error: specified document position or range belongs to other document or subdocument" being thrown.

For an example of use, refer to another SubDocument.GetText method overloads.

See Also