WebDocumentViewerBuilder.SearchSettings(Action<SearchSettings>) Method

Allows you to specify the Web Document Viewer‘s search settings.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

Assembly: DevExpress.AspNetCore.Reporting.v24.1.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public WebDocumentViewerBuilder SearchSettings(
    Action<SearchSettings> configure
)

VB.NET

Public Function SearchSettings(
    configure As Action(Of SearchSettings)
) As WebDocumentViewerBuilder

Parameters

Name	Type	Description
configure	Action<SearchSettings>	A delegate method that includes search settings.

Returns

Type	Description
WebDocumentViewerBuilder	A WebDocumentViewerBuilder object that can be used to further configure the Document Viewer.

Remarks

The SearchSettings method allows you to hide search actions or disable asynchronous search for the Web Document Viewer.

This property provides access to the following properties:

SearchEnabled

Allows you to hide the search actions.

UseAsyncSearch

Specifies whether the Web Document Viewer uses asynchronous search.

The following code snippet shows how to hide search actions in an ASP.NET Core application:

@{
    var viewerRender = Html.DevExpress().WebDocumentViewer("DocumentViewer")
        .SearchSettings(s => s.SearchEnabled = false)
        .Height("100%")
        .Bind(new TestReport());
    @viewerRender.RenderHtml()
}

Note

If you bind the Web Document Viewer control to a WebDocumentViewerModel object, use the WebDocumentViewerSettingsBase.SearchSettings property instead.