// Copyright © 2020 The CefSharp Authors. All rights reserved. // // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file. using CefSharp.Internals; namespace CefSharp.JavascriptBinding { /// /// Javascript Binding Settings /// public class JavascriptBindingSettings : FreezableBase { private bool alwaysInterceptAsynchronously; private bool legacyBindingEnabled; private string jsBindingGlobalObjectName; private bool jsBindingApiEnabled = true; /// /// The Javascript methods that CefSharp provides in relation to JavaScript Binding are /// created using a Global (window) Object. Settings this property allows you to disable /// the creation of this object. Features like EvaluateScriptAsPromiseAsync that rely on /// the creation of this object will no longer function. /// public bool JavascriptBindingApiEnabled { get { return jsBindingApiEnabled; } set { ThrowIfFrozen(); jsBindingApiEnabled = value; } } /// /// The Javascript methods that CefSharp provides in relation to JavaScript Binding are /// created using a Global (window) Object. Settings this property allows you to customise /// the name of this object. If not specified then both cefSharp and CefSharp objects will /// be created e.g. cefSharp.bindObjectAsync, CefSharp.BindObjectAsync. /// If specified then your custom name will be used, if the name starts with a lowercase letter /// then all the functions will be lowercase, e.g. myObjName.bindObjectAsync otherwise /// the functions will start with a uppercase letter e.g. MyObjName.BindObjectAsync /// /// /// This object is also accessible through the window property. e.g. window.cefSharp.bindObjectAsync /// public string JavascriptBindingApiGlobalObjectName { get { return jsBindingGlobalObjectName; } set { ThrowIfFrozen(); if (!StringCheck.IsLettersAndNumbers(value)) { //TODO: See if there's a better suited Exception class for this. throw new System.Exception("invalid or illegal characters used for binding property names. Alphanumeric and underscores characters only."); } jsBindingGlobalObjectName = value; } } /// /// Objects registered using /// will be automatically bound when a V8Context is created. (Soon as the Javascript /// context is created for a browser). This behaviour is like that seen with Javascript /// Binding in version 57 and earlier. /// public bool LegacyBindingEnabled { get { return legacyBindingEnabled; } set { ThrowIfFrozen(); legacyBindingEnabled = value; } } /// /// When using an /// the /// method is call for all methods (the default is to call InterceptAsync only for methods that return a Task). /// This only applies when is of type /// public bool AlwaysInterceptAsynchronously { get { return alwaysInterceptAsynchronously; } set { ThrowIfFrozen(); alwaysInterceptAsynchronously = value; } } } }