Class SetScrollbarTypeOverrideCommandParameters

Namespace

WebDriverBiDi.Emulation

Assembly

WebDriverBiDi.dll

Provides parameters for setting the scroll bar type override for the browser.

public class SetScrollbarTypeOverrideCommandParameters : CommandParameters<SetScrollbarTypeOverrideCommandResult>

Inheritance

object

CommandParameters

CommandParameters<SetScrollbarTypeOverrideCommandResult>

SetScrollbarTypeOverrideCommandParameters

Inherited Members

CommandParameters<SetScrollbarTypeOverrideCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SetScrollbarTypeOverrideCommandParameters()

Initializes a new instance of the SetScrollbarTypeOverrideCommandParameters class.

public SetScrollbarTypeOverrideCommandParameters()

Properties

Contexts

Gets the browsing contexts for which to set the scroll bar type override.

[JsonIgnore]
public List<string> Contexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

ResetScrollbarTypeOverride

Gets a pre-initialized instance of SetScrollbarTypeOverrideCommandParameters with the ScrollbarType property set to null to clear any existing scroll bar type override. Returns a new instance on each access to allow for modification of the properties without affecting other uses. Functionally equivalent to using the parameterless constructor, but provided as a named property to make the intent of clearing the override more explicit in code that uses this property.

public static SetScrollbarTypeOverrideCommandParameters ResetScrollbarTypeOverride { get; }

Property Value

SetScrollbarTypeOverrideCommandParameters

ScrollbarType

Gets or sets the type of scroll bar to be emulated. When null, clears the override.

[JsonPropertyName("scrollbarType")]
public ScrollbarType? ScrollbarType { get; set; }

Property Value

ScrollbarType?

UserContexts

Gets the user contexts for which to set the scroll bar type override.

[JsonIgnore]
public List<string> UserContexts { get; }

Property Value

List<string>

Remarks

The protocol requires this property, when present, to contain at least one entry. An empty list therefore means "not specified": the property is omitted from the JSON payload entirely, and an empty array is never sent. Add entries to the list to scope the command.

The two scopes are mutually exclusive: a command that names both browsing contexts and user contexts is rejected by the remote end with an invalid argument error. Scope the command one way or the other.