Class FirefoxOptions

Namespace: OpenQA.Selenium.Firefox

Assembly: WebDriver.dll

Class to manage options specific to FirefoxDriver

public class FirefoxOptions : DriverOptions

Inheritance: object

DriverOptions

FirefoxOptions

Inherited Members: DriverOptions.BrowserName

DriverOptions.BrowserVersion

DriverOptions.PlatformName

DriverOptions.AcceptInsecureCertificates

DriverOptions.UseWebSocketUrl

DriverOptions.UnhandledPromptBehavior

DriverOptions.PageLoadStrategy

DriverOptions.Proxy

DriverOptions.UseStrictFileInteractability

DriverOptions.EnableDownloads

DriverOptions.ScriptTimeout

DriverOptions.PageLoadTimeout

DriverOptions.ImplicitWaitTimeout

DriverOptions.AddAdditionalOption(string, object)

DriverOptions.GetMergeResult(DriverOptions)

DriverOptions.SetLoggingPreference(string, LogLevel)

DriverOptions.ValidateCapabilityName(string)

DriverOptions.AddKnownCapabilityName(string, string)

DriverOptions.RemoveKnownCapabilityName(string)

DriverOptions.IsKnownCapabilityName(string)

DriverOptions.GetTypeSafeOptionName(string)

DriverOptions.GenerateLoggingPreferencesDictionary()

DriverOptions.GenerateDesiredCapabilities(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

FirefoxOptions options = new FirefoxOptions();

For use with FirefoxDriver:

FirefoxDriver driver = new FirefoxDriver(options);

For use with RemoteWebDriver:

RemoteWebDriver driver = new RemoteWebDriver(new Uri("http://localhost:4444/wd/hub"), options.ToCapabilities());

Remarks

Used with the marionette executable wires.exe.

Constructors

FirefoxOptions()

Initializes a new instance of the FirefoxOptions class.

public FirefoxOptions()

Properties

AndroidOptions

Gets or sets the options for automating Firefox on Android.

public FirefoxAndroidOptions AndroidOptions { get; set; }

Property Value

FirefoxAndroidOptions

BinaryLocation

Gets or sets the path and file name of the Firefox browser executable.

public override string BinaryLocation { get; set; }

Property Value

string

BrowserExecutableLocation

Gets or sets the path and file name of the Firefox browser executable.

[Obsolete("Use BinaryLocation property instead of BrowserExecutableLocation. This one will be removed soon.")]
public string BrowserExecutableLocation { get; set; }

Property Value

string

EnableDevToolsProtocol

Gets or sets a value indicating whether to enable the DevTools protocol for the launched browser.

public bool EnableDevToolsProtocol { get; set; }

Property Value

bool

LogLevel

Gets or sets the logging level of the Firefox driver.

public FirefoxDriverLogLevel LogLevel { get; set; }

Property Value

FirefoxDriverLogLevel

Profile

Gets or sets the FirefoxProfile object to be used with this instance.

public FirefoxProfile Profile { get; set; }

Property Value

FirefoxProfile

Methods

AddAdditionalFirefoxOption(string, object)

Provides a means to add additional capabilities not yet added as type safe options for the Firefox driver.

public void AddAdditionalFirefoxOption(string optionName, object optionValue)

Parameters

optionName string: The name of the capability to add.
optionValue object: The value of the capability to add.

Remarks

Calling AddAdditionalFirefoxOption(string, object) where optionName has already been added will overwrite the existing value with the new value in optionValue. Calling this method adds capabilities to the Firefox-specific options object passed to geckodriver.exe (property name 'moz:firefoxOptions').

Exceptions

ArgumentException: thrown when attempting to add a capability for which there is already a type safe option, or when optionName is null or the empty string.

AddArgument(string)

Adds an argument to be used in launching the Firefox browser.

public void AddArgument(string argumentName)

Parameters

argumentName string: The argument to add.

Remarks

Arguments must be preceeded by two dashes ("--").

AddArguments(IEnumerable<string>)

Adds a list arguments to be used in launching the Firefox browser.

public void AddArguments(IEnumerable<string> argumentsToAdd)

Parameters

argumentsToAdd IEnumerable<string>: An array of arguments to add.

AddArguments(params string[])

Adds a list arguments to be used in launching the Firefox browser.

public void AddArguments(params string[] argumentsToAdd)

Parameters

argumentsToAdd string[]: An array of arguments to add.

Remarks

Each argument must be preceeded by two dashes ("--").

SetEnvironmentVariable(string, string)

Sets an environment variable to be set in the operating system's environment under which the Firerox browser is launched.

public void SetEnvironmentVariable(string variableName, string variableValue)