Table of Contents

Class FirefoxOptions

Namespace
OpenQA.Selenium.Firefox
Assembly
WebDriver.dll

Class to manage options specific to FirefoxDriver

public class FirefoxOptions : DriverOptions
Inheritance
FirefoxOptions
Inherited Members

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 preceded by two dashes ("--").

Exceptions

ArgumentException

If argumentName is null or Empty.

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.

Exceptions

ArgumentNullException

If argumentsToAdd is null.

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 preceded by two dashes ("--").

Exceptions

ArgumentNullException

If argumentsToAdd is null.

SetEnvironmentVariable(string, string?)

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

public void SetEnvironmentVariable(string variableName, string? variableValue)

Parameters

variableName string

The name of the environment variable.

variableValue string

The value of the environment variable.

Exceptions

ArgumentException

If variableName is null or Empty.

SetPreference(string, bool)

Sets a preference in the profile used by Firefox.

public void SetPreference(string preferenceName, bool preferenceValue)

Parameters

preferenceName string

Name of the preference to set.

preferenceValue bool

Value of the preference to set.

Exceptions

ArgumentException

If preferenceName is null or Empty.

SetPreference(string, double)

Sets a preference in the profile used by Firefox.

public void SetPreference(string preferenceName, double preferenceValue)

Parameters

preferenceName string

Name of the preference to set.

preferenceValue double

Value of the preference to set.

Exceptions

ArgumentException

If preferenceName is null or Empty.

SetPreference(string, int)

Sets a preference in the profile used by Firefox.

public void SetPreference(string preferenceName, int preferenceValue)

Parameters

preferenceName string

Name of the preference to set.

preferenceValue int

Value of the preference to set.

Exceptions

ArgumentException

If preferenceName is null or Empty.

SetPreference(string, long)

Sets a preference in the profile used by Firefox.

public void SetPreference(string preferenceName, long preferenceValue)

Parameters

preferenceName string

Name of the preference to set.

preferenceValue long

Value of the preference to set.

Exceptions

ArgumentException

If preferenceName is null or Empty.

SetPreference(string, string)

Sets a preference in the profile used by Firefox.

public void SetPreference(string preferenceName, string preferenceValue)

Parameters

preferenceName string

Name of the preference to set.

preferenceValue string

Value of the preference to set.

Exceptions

ArgumentException

If preferenceName is null or Empty.

ToCapabilities()

Returns DesiredCapabilities for Firefox with these options included as capabilities. This does not copy the options. Further changes will be reflected in the returned capabilities.

public override ICapabilities ToCapabilities()

Returns

ICapabilities

The DesiredCapabilities for Firefox with these options.

Edit this page