cohtml.Net.SystemSettings

Settings for a System.

Inherits from SystemIDisposable

Public Classes

Name
classFallBackFormats

Public Functions

Name
virtual voidDispose()
SystemSettings()

Public Properties

Name
SystemSettings.FallBackFormatsFormats
ResourceHandlerResourceHandler
Resource handler for loading assets.
IDataStorageHandlerDataStorageHandler
Data storage handler used for saving and loading persistent data.
ILocalizationManagerLocalizationManagerInstance
Optional localization manager. This object MUST outlive the System. Any HTML element created with the data-l10n-id attribute will get its text content replaced by the value returned from this object’s ILocalizationManager.Translate method.
ITextTransformationManagerTextTransformationManager
Optional text transformation manager used to support modifying text in a locale-aware way. CSS properties like text-transform require this interface to be set and implemented to work.
CachedResourcesWatermarksCachedImagesSettings
Controls the low and high watermarks used when deciding when to prune the image cache.
CachedResourcesWatermarksCachedSVGsSettings
global.System.IntPtrUserData
Passed to the OnUserImageDropped callback.
intDebuggerPort
Sets the port where the Debugger can connect to inspect the active Views. Set it to <= 0 to disable debugging.
boolEnableDebugger
Enable/Disable the Debugger during the lifetime of the program. If enabled it may influence application performance, make sure it is not enabled during benchmarking.
boolAsynchronousResourceRequestCalls
Enabled by default. When enabled, each resource request will post a job in the work queue. The IAsyncResourceHandler callbacks will be invoked on a worker thread. This asynchronous behavior allows the client to easily implement resource reading functionality without having to deal with multithreading and yet achieving non-blocking resource reading. When disabled, the IAsyncResourceHandler callbacks will be invoked on the UI thread, and its a client’s responsibility to schedule any potential blocking operations to achieve asynchronous resource loading and avoid stalling the UI thread. To make efficient use of the abort resource notifications, this option should be disabled.
stringGenericFontFamilyNameFont
This options sets the family name of the font that will be used when a generic font family is encountered. Generic font families are “serif”, “sans-serif”, “monospace”, etc. When a font name for the generic family is not specified Cohtml will use the default family name specified by LibraryParams.DefaultStyleFontFamily.
LastResortFontModeLastResortFontMode
Cohtml uses an embedded font as a last resort font fallback. This option controls how the last resort font is visualized. By default Cohtml will render ASCII printable characters from the last resort font when no other suitable font is found and a square symbol for unresolved unicode characters. The default option is suitable for visualizing simple texts without loading any fonts. FF_Squares will render squares for all characters for which a suitable font was not found which can aid developers to recognize when their font fallback setup isn’t working properly. FF_None will disable the last resort font visualization.

Protected Attributes

Name
boolswigCMemOwn

Public Functions Documentation

function Dispose

virtual void Dispose()

function SystemSettings

SystemSettings()

Public Property Documentation

property Formats

SystemSettings.FallBackFormats Formats;

property ResourceHandler

ResourceHandler ResourceHandler;

Resource handler for loading assets.

property DataStorageHandler

IDataStorageHandler DataStorageHandler;

Data storage handler used for saving and loading persistent data.

property LocalizationManagerInstance

ILocalizationManager LocalizationManagerInstance;

Optional localization manager. This object MUST outlive the System. Any HTML element created with the data-l10n-id attribute will get its text content replaced by the value returned from this object’s ILocalizationManager.Translate method.

property TextTransformationManager

ITextTransformationManager TextTransformationManager;

Optional text transformation manager used to support modifying text in a locale-aware way. CSS properties like text-transform require this interface to be set and implemented to work.

property CachedImagesSettings

CachedResourcesWatermarks CachedImagesSettings;

Controls the low and high watermarks used when deciding when to prune the image cache.

property CachedSVGsSettings

CachedResourcesWatermarks CachedSVGsSettings;

property UserData

global.System.IntPtr UserData;

Passed to the OnUserImageDropped callback.

property DebuggerPort

int DebuggerPort;

Sets the port where the Debugger can connect to inspect the active Views. Set it to <= 0 to disable debugging.

property EnableDebugger

bool EnableDebugger;

Enable/Disable the Debugger during the lifetime of the program. If enabled it may influence application performance, make sure it is not enabled during benchmarking.

property AsynchronousResourceRequestCalls

bool AsynchronousResourceRequestCalls;

Enabled by default. When enabled, each resource request will post a job in the work queue. The IAsyncResourceHandler callbacks will be invoked on a worker thread. This asynchronous behavior allows the client to easily implement resource reading functionality without having to deal with multithreading and yet achieving non-blocking resource reading. When disabled, the IAsyncResourceHandler callbacks will be invoked on the UI thread, and its a client’s responsibility to schedule any potential blocking operations to achieve asynchronous resource loading and avoid stalling the UI thread. To make efficient use of the abort resource notifications, this option should be disabled.

property GenericFontFamilyNameFont

string GenericFontFamilyNameFont;

This options sets the family name of the font that will be used when a generic font family is encountered. Generic font families are “serif”, “sans-serif”, “monospace”, etc. When a font name for the generic family is not specified Cohtml will use the default family name specified by LibraryParams.DefaultStyleFontFamily.

property LastResortFontMode

LastResortFontMode LastResortFontMode;

Cohtml uses an embedded font as a last resort font fallback. This option controls how the last resort font is visualized. By default Cohtml will render ASCII printable characters from the last resort font when no other suitable font is found and a square symbol for unresolved unicode characters. The default option is suitable for visualizing simple texts without loading any fonts. FF_Squares will render squares for all characters for which a suitable font was not found which can aid developers to recognize when their font fallback setup isn’t working properly. FF_None will disable the last resort font visualization.

Protected Attributes Documentation

variable swigCMemOwn

bool swigCMemOwn;