Class LoadAsyncSettings

Represents the asynchronous document loading settings for the control SfRichTextBoxAdv.

Inheritance
System.Object
LoadAsyncSettings
Namespace: Syncfusion.UI.Xaml.RichTextBoxAdv
Assembly: Syncfusion.SfRichTextBoxAdv.UWP.dll
Syntax
public class LoadAsyncSettings : DependencyObject

Constructors

LoadAsyncSettings()

Initializes a new instance of the LoadAsyncSettings class.

Declaration
public LoadAsyncSettings()

Fields

IncrementalPageLoadCountProperty

Identifies the IncrementalPageLoadCount dependency property.

Declaration
public static readonly DependencyProperty IncrementalPageLoadCountProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the IncrementalPageLoadCount dependency property.

InitialPageLoadCountProperty

Identifies the InitialPageLoadCount dependency property.

Declaration
public static readonly DependencyProperty InitialPageLoadCountProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the InitialPageLoadCount dependency property.

ShowPageNumberProperty

Identifies the ShowPageNumber dependency property.

Declaration
public static readonly DependencyProperty ShowPageNumberProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

The identifier for the ShowPageNumber dependency property.

Properties

IncrementalPageLoadCount

Gets or sets the number of pages to be incrementally loaded after initial pages loaded, during asynchronous document loading operation.

Declaration
public int IncrementalPageLoadCount { get; set; }
Property Value
Type Description
System.Int32

The number of pages to be incrementally loaded after initial pages loaded, during asynchronous document loading operation. The Default value is 3.
Remarks

This property will have impact only in Pages layout type.

Examples

The following code example demonstrates how to define asynchronous loading settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
        <!-- Defines page loading settings -->
        <RichTextBoxAdv:LoadAsyncSettings InitialPageLoadCount="2" IncrementalPageLoadCount="1" />
    </RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>
// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();

//Defines the asycnhronous loading settings.
LoadAsyncSettings loadAsyncSettings = new LoadAsyncSettings();
loadAsyncSettings.InitialPageLoadCount = 2;
loadAsyncSettings.IncrementalPageLoadCount = 1;


richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings;

/// ' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the asycnhronous loading settings.
Dim loadAsyncSettings As New LoadAsyncSettings()
loadAsyncSettings.InitialPageLoadCount = 2
loadAsyncSettings.IncrementalPageLoadCount = 1

richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings

InitialPageLoadCount

Gets or sets the number of pages to be loaded initially during asynchronous document loading operation.

Declaration
public int InitialPageLoadCount { get; set; }
Property Value
Type Description
System.Int32

The number of pages to be loaded initially during asynchronous document loading operation. The Default value is 5.
Remarks

This property will have impact only in Pages layout type.

Examples

The following code example demonstrates how to define asynchronous loading settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
        <!-- Defines page loading settings -->
        <RichTextBoxAdv:LoadAsyncSettings InitialPageLoadCount="2" IncrementalPageLoadCount="1" />
    </RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>
// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();

//Defines the asycnhronous loading settings.
LoadAsyncSettings loadAsyncSettings = new LoadAsyncSettings();
loadAsyncSettings.InitialPageLoadCount = 2;
loadAsyncSettings.IncrementalPageLoadCount = 1;


richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings;

/// ' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the asycnhronous loading settings.
Dim loadAsyncSettings As New LoadAsyncSettings()
loadAsyncSettings.InitialPageLoadCount = 2
loadAsyncSettings.IncrementalPageLoadCount = 1

richTextBoxAdv.LoadAsyncSettings = loadAsyncSettings

ShowPageNumber

Gets or sets a value indicating whether the loading page number popup is visible in the SfRichTextBoxAdv control. The default value is true.

Declaration
public bool ShowPageNumber { get; set; }
Property Value
Type Description
System.Boolean

True, if loading page number popup is visible; Otherwise false.
Examples

The following code example demonstrates how to define asynchronous loading settings for a SfRichTextBoxAdv control.

<RichTextBoxAdv:SfRichTextBoxAdv x:Name="richTextBoxAdv" LayoutType="Pages">
    <RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
        <!-- Defines page loading settings -->
        <RichTextBoxAdv:LoadAsyncSettings ShowPageNumber="false" />
    </RichTextBoxAdv:SfRichTextBoxAdv.LoadAsyncSettings>
</RichTextBoxAdv:SfRichTextBoxAdv>
// Defines the control.
SfRichTextBoxAdv richTextBoxAdv = new SfRichTextBoxAdv();

//Defines the asycnhronous loading settings.
richTextBoxAdv.LoadAsyncSettings.ShowPageNumber = false;

/// ' Defines the control.
Dim richTextBoxAdv As New SfRichTextBoxAdv()

'Defines the asycnhronous loading settings.
richTextBoxAdv.LoadAsyncSettings.ShowPageNumber = false

Extension Methods