Table of Contents

Class Options

Namespace
The.Web.Composition
Assembly
Instagile.Web.Client.dll
public class Options
Inheritance
Options
Inherited Members

Properties

AccountManagement

Controls the built-in administration commands on user account pages.

public AccountManagementOptions AccountManagement { get; }

Property Value

AccountManagementOptions

AppName

Application name override. If not set, the name of the entry point assembly is used.

public string? AppName { get; set; }

Property Value

string

AppVersion

Application version override. If not set, the informational version of the entry point assembly is used.

public string? AppVersion { get; set; }

Property Value

string

Caching 

public CachingOptions Caching { get; }

Property Value

CachingOptions

CalculateOnServer

If true, property calculations and entity save callbacks are delegated to an RPC endpoint.

public bool CalculateOnServer { get; set; }

Property Value

bool

ConcurrentMutation

Controls behavior when concurrent access to an EntityContext is detected from different threads.

public ConcurrentAccessMode ConcurrentMutation { get; set; }

Property Value

ConcurrentAccessMode

Culture

Culture used for display and data conversions.

public CultureInfo Culture { get; set; }

Property Value

CultureInfo

DisableAuthorisation

Performs only authentication checks, not role checks. Improves performance at the cost of flexibility.

public bool DisableAuthorisation { get; set; }

Property Value

bool

Documents 

public DocumentOptions Documents { get; }

Property Value

DocumentOptions

EnvironmentName

Application deployment type. Defaults to Production.

public string EnvironmentName { get; set; }

Property Value

string

ExportBatchSize

Larger batches reduce the number of entitystore calls (which incur latency) at the cost of memory.

public int ExportBatchSize { get; set; }

Property Value

int

ExportFormats

Output formats available to ExportService

public List<IExportFormat> ExportFormats { get; }

Property Value

List<IExportFormat>

ForceSectionFieldHeaders

If true, the first field in each edit section renders with its own header like every other field, rather than bare.

public bool ForceSectionFieldHeaders { get; set; }

Property Value

bool

ImportBatchSize

Larger batches reduce entitystore latency at the cost of bandwidth and memory.

public int ImportBatchSize { get; set; }

Property Value

int

ImportMaxThreadCount

Higher threadcount improves speed (cancelling out calculated-property latency) but uses more memory.

public int ImportMaxThreadCount { get; set; }

Property Value

int

ImportRetriesPerBatch

Import can retry failed writes to mitigate an overloaded database or network.

public uint ImportRetriesPerBatch { get; set; }

Property Value

uint

ImportUnbatched

For debugging.

public bool ImportUnbatched { get; set; }

Property Value

bool

ListRowHeight

List-view row heights in pixels for optimising virtualisation.

public Options.RowHeight ListRowHeight { get; set; }

Property Value

Options.RowHeight

Mail 

public MailOptions Mail { get; }

Property Value

MailOptions

MaxImageBytes

Size limit for uploaded image processing - documents larger than this can be treated as files, but not displayed or manipulated

public long MaxImageBytes { get; set; }

Property Value

long

MaxUploadBytes

Size limit for uploaded documents (files and images)

public long MaxUploadBytes { get; set; }

Property Value

long

PermitAnonymousAuthentication

If true, allows HTTP Anonymous method.

public bool PermitAnonymousAuthentication { get; set; }

Property Value

bool

PersistenceTimeout

Deadline for entitystore reads and writes, applied when the caller doesn't supply its own cancellation token.

public TimeSpan PersistenceTimeout { get; set; }

Property Value

TimeSpan

ProgressDelay

Timeout period before displaying progress bars for long running operations.

public TimeSpan ProgressDelay { get; set; }

Property Value

TimeSpan

RPC 

public RPCOptions RPC { get; }

Property Value

RPCOptions

ReminderRefreshInterval

The interval at which each circuit refreshes its personal reminder counts.

public TimeSpan ReminderRefreshInterval { get; set; }

Property Value

TimeSpan

ReplaceSmartPunctuation

If true, many Unicode punctuation marks like “smart quotes” will be replaced with their "dumb" ANSI-compliant versions when assigned to String and Text attributes.

public bool ReplaceSmartPunctuation { get; set; }

Property Value

bool

RequireTenancySpecification

If set, SpecifyTenancy(Tenancy) must be called to set the requested level of tenant access. (Otherwise, it may not be used).

public bool RequireTenancySpecification { get; set; }

Property Value

bool

Scrambling 

public ScramblingOptions Scrambling { get; }

Property Value

ScramblingOptions

SearchDelay

Timeout period before activating instant search.

public TimeSpan SearchDelay { get; set; }

Property Value

TimeSpan

StreamDownloadsUsingFSA

Use the File System Access API - no client buffering, but network locations not supported.

public bool StreamDownloadsUsingFSA { get; set; }

Property Value

bool

SyncReads

If set to true, throws exceptions on non-async I/O. Required in environments that don't support blocking or threading.

public SyncIOMode SyncReads { get; set; }

Property Value

SyncIOMode

TimeZone

Zone used for Instant values and RelativeDate queries.

public TimeZoneInfo TimeZone { get; set; }

Property Value

TimeZoneInfo

TimeZoneId

Zone used for Instant values and RelativeDate queries.

public string TimeZoneId { get; set; }

Property Value

string

UserRegistration 

public UserRegistrationOptions UserRegistration { get; }

Property Value

UserRegistrationOptions

WrapPrerenderState

Serialise EntityState using JSON-over-MsgPack - turn this on if compatibility issues are discovered.

public bool WrapPrerenderState { get; set; }

Property Value

bool