SubDocument.GetRtfAsync(Interval, CancellationToken) Method
In This Article
Returns the specified interval’s content in Rich Text Format (RTF).
Namespace: DevExpress.Blazor.RichEdit
Assembly: DevExpress.Blazor.RichEdit.v24.2.dll
NuGet Package: DevExpress.Blazor.RichEdit
#Declaration
C#
public ValueTask<string> GetRtfAsync(
Interval interval,
CancellationToken cancellationToken = default(CancellationToken)
)
#Parameters
Name | Type | Description |
---|---|---|
interval | Interval | The source RTF text interval. |
#Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
cancellation |
Cancellation |
null | An object that propagates a cancellation notification. |
#Returns
Type | Description |
---|---|
Value |
A structure that stores an awaitable result of an asynchronous operation. The awaitable result is an RTF text string. |
#Remarks
The following code snippet performs the following steps:
- Calls the GetIntervalAsync(CancellationToken) method to access a sub-document’s interval. This interval corresponds to the document header.
- Passes the returned interval to the
GetRtfAsync
method to get the header’s RTF text. - Saves the obtained text to the
header.rtf
file.
Razor
<DxRichEdit @ref="@richEdit" />
@code {
DxRichEdit richEdit { get; set; }
string pathRtf { get; set; } = @"C:\Temp\header.rtf";
protected async override Task OnAfterRenderAsync(bool firstRender) {
if (firstRender) {
Section section = await richEdit.DocumentAPI.Sections.GetAsync(0);
SubDocument header = await section.GetHeaderAsync(HeaderFooterType.Primary, true);
Interval interval = await header.GetIntervalAsync();
string headerContent = await header.GetRtfAsync(interval);
await File.WriteAllTextAsync(pathRtf, headerContent);
}
await base.OnAfterRenderAsync(firstRender);
}
}
To get RTF text from an interval specified with the startPosition
and length
parameters, use the GetRtfAsync(Int32, Int32, CancellationToken) method.
See Also