Class AssistViewSettings

Represents the AI Assist View settings for SmartPdfViewer.

Inheritance

System.Object

AssistViewSettings

Implements

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.Maui.SmartPdfViewer

Assembly: Syncfusion.Maui.SmartPdfViewer.dll

Syntax

public class AssistViewSettings : Object, INotifyPropertyChanged

Constructors

AssistViewSettings()

Declaration

public AssistViewSettings()

Properties

InitialPromptSettings

Gets or sets the settings used to configure the initial behavior of the Assist View, including the initial prompt, suggested prompts, and document scope used for overview generation.

Declaration

public InitialPromptSettings InitialPromptSettings { get; set; }

Property Value

Type
InitialPromptSettings

IsEnabled

Gets or sets a value indicating whether the Assist View feature is available in the PDF Viewer.

Declaration

public bool IsEnabled { get; set; }

Property Value

Type
System.Boolean

Remarks

When set to false, the Assist View UI and related AI interactions are disabled.

Examples

MaxRetryAttempts

Gets or sets the maximum number of retry attempts for failed AI requests.

Declaration

public int MaxRetryAttempts { get; set; }

Property Value

Type
System.Int32

Remarks

Retries are performed automatically until the limit is reached.

Examples

MinimumDocumentLength

Gets or sets the minimum number of characters required in a document before AI processing is enabled.

Declaration

public int MinimumDocumentLength { get; set; }

Property Value

Type
System.Int32

Examples

PdfViewerAssistViewTemplates

Gets or sets the collection of templates used to customize Assist View UI elements, such as the banner displayed at the top of the Assist View panel.

Declaration

public PdfViewerAssistViewTemplates PdfViewerAssistViewTemplates { get; set; }

Property Value

Type
PdfViewerAssistViewTemplates

Placeholder

Gets or sets the placeholder text displayed in the Assist View input area.

Declaration

public string Placeholder { get; set; }

Property Value

Type
System.String

Remarks

Used to provide guidance about the expected input format.

Examples

Prompt

Gets or sets the prompt used to guide AI-generated responses within the Assist View.

Declaration

public string Prompt { get; set; }

Property Value

Type
System.String

Remarks

The prompt can be dynamically modified during runtime.

Examples

ShowPromptSuggestions

Gets or sets a value indicating whether prompt suggestions are displayed in the Assist View panel.

Declaration

public bool ShowPromptSuggestions { get; set; }

Property Value

Type
System.Boolean

Examples

StreamResponse

Gets or sets a value indicating whether AI responses are streamed incrementally to the user.

Declaration

public bool StreamResponse { get; set; }

Property Value

Type
System.Boolean

Remarks

When enabled, users can view generated content in real time as it is received.

Examples

Timeout

Gets or sets the maximum duration, in seconds, to wait for an AI response.

Declaration

public int Timeout { get; set; }

Property Value

Type
System.Int32

Remarks

Requests exceeding the timeout period are automatically cancelled.

Examples

Methods

OnPropertyChanged(String)

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName	The name of the changed property.

Events

PromptChanged

Occurs when the prompt text is modified by the user.

Declaration

public event EventHandler<string> PromptChanged

Event Type

Type
System.EventHandler<System.String>

Remarks

Allows applications to monitor and react to prompt changes.

PropertyChanged

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged